summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/dbdef_colgroup.txt
blob: a7eebc6c7e7883dfb886a42533b4e299bde2d1a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
NAME
    FS::dbdef_colgroup - Column group objects

SYNOPSIS
      use FS::dbdef_colgroup;

      $colgroup = new FS::dbdef_colgroup ( $lol );
      $colgroup = new FS::dbdef_colgroup (
        [
          [ 'single_column' ],
          [ 'multiple_columns', 'another_column', ],
        ]
      );

      @sql_lists = $colgroup->sql_list;

      @singles = $colgroup->singles;

DESCRIPTION
    FS::dbdef_colgroup objects represent sets of sets of columns.

METHODS
    new Creates a new FS::dbdef_colgroup object.

    sql_list
        Returns a flat list of comma-separated values, for SQL
        statements.

    singles
        Returns a flat list of all single item lists.

BUGS
SEE ALSO
    the FS::dbdef_table manpage, the FS::dbdef_unique manpage, the
    FS::dbdef_index manpage, the FS::dbdef_column manpage, the
    FS::dbdef manpage, the perldsc manpage

HISTORY
    class for dealing with groups of groups of columns (used as a
    base class by FS::dbdef_{unique,index} )

    ivan@sisd.com 98-apr-19

    added singles, fixed sql_list to skip empty lists ivan@sisd.com
    98-jun-2

    untaint things we're returning in sub singels ivan@sisd.com 98-
    jun-4

    pod ivan@sisd.com 98-sep-24