Initial revision
[freeside.git] / htdocs / docs / man / dbdef_colgroup.txt
1 NAME
2     FS::dbdef_colgroup - Column group objects
3
4 SYNOPSIS
5       use FS::dbdef_colgroup;
6
7       $colgroup = new FS::dbdef_colgroup ( $lol );
8       $colgroup = new FS::dbdef_colgroup (
9         [
10           [ 'single_column' ],
11           [ 'multiple_columns', 'another_column', ],
12         ]
13       );
14
15       @sql_lists = $colgroup->sql_list;
16
17       @singles = $colgroup->singles;
18
19 DESCRIPTION
20     FS::dbdef_colgroup objects represent sets of sets of columns.
21
22 METHODS
23     new Creates a new FS::dbdef_colgroup object.
24
25     sql_list
26         Returns a flat list of comma-separated values, for SQL
27         statements.
28
29     singles
30         Returns a flat list of all single item lists.
31
32 BUGS
33 SEE ALSO
34     the FS::dbdef_table manpage, the FS::dbdef_unique manpage, the
35     FS::dbdef_index manpage, the FS::dbdef_column manpage, the
36     FS::dbdef manpage, the perldsc manpage
37
38 HISTORY
39     class for dealing with groups of groups of columns (used as a
40     base class by FS::dbdef_{unique,index} )
41
42     ivan@sisd.com 98-apr-19
43
44     added singles, fixed sql_list to skip empty lists ivan@sisd.com
45     98-jun-2
46
47     untaint things we're returning in sub singels ivan@sisd.com 98-
48     jun-4
49
50     pod ivan@sisd.com 98-sep-24
51