diff options
Diffstat (limited to 'htdocs/docs/man/dbdef_colgroup.txt')
-rw-r--r-- | htdocs/docs/man/dbdef_colgroup.txt | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/htdocs/docs/man/dbdef_colgroup.txt b/htdocs/docs/man/dbdef_colgroup.txt new file mode 100644 index 000000000..a7eebc6c7 --- /dev/null +++ b/htdocs/docs/man/dbdef_colgroup.txt @@ -0,0 +1,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 + |