.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Class::DBI::ColumnGrouper 3pm"
.TH Class::DBI::ColumnGrouper 3pm "2020-12-28" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Class::DBI::ColumnGrouper \- Columns and Column Groups
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        my $colg = Class::DBI::ColumnGrouper\->new;
\&           $colg\->add_group(People => qw/star director producer/);
\&
\&        my @cols = $colg\->group_cols($group);
\&
\&        my @all            = $colg\->all_columns;
\&        my @pri_col        = $colg\->primary;
\&        my @essential_cols = $colg\->essential;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Each Class::DBI class maintains a list of its columns as class data.
This provides an interface to that. You probably don't want to be dealing
with this directly.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&        my $colg = Class::DBI::ColumnGrouper\->new;
.Ve
.PP
A new blank ColumnnGrouper object.
.SS "clone"
.IX Subsection "clone"
.Vb 1
\&        my $colg2 = $colg\->clone;
.Ve
.PP
Clone an existing ColumnGrouper.
.SS "add_column / find_column"
.IX Subsection "add_column / find_column"
.Vb 2
\&        $colg\->add_column($name);
\&        my Class::DBI::Column $col = $colg\->find_column($name);
.Ve
.PP
Add or return a Column object for the given column name.
.SS "add_group"
.IX Subsection "add_group"
.Vb 1
\&        $colg\->add_group(People => qw/star director producer/);
.Ve
.PP
This adds a list of columns as a column group.
.SS "group_cols / groups_for"
.IX Subsection "group_cols / groups_for"
.Vb 2
\&        my @colg = $cols\->group_cols($group);
\&        my @groups = $cols\->groups_for(@cols);
.Ve
.PP
This returns a list of all columns which are in the given group, or the
groups a given column is in.
.SS "columns_in"
.IX Subsection "columns_in"
.Vb 1
\&        my @cols = $colg\->columns_in(@groups);
.Ve
.PP
This returns a list of all columns which are in the given groups.
.SS "all_columns"
.IX Subsection "all_columns"
.Vb 1
\&        my @all = $colg\->all_columns;
.Ve
.PP
This returns a list of all the real columns.
.SS "primary"
.IX Subsection "primary"
.Vb 1
\&        my $pri_col = $colg\->primary;
.Ve
.PP
This returns a list of the columns in the Primary group.
.SS "essential"
.IX Subsection "essential"
.Vb 1
\&        my @essential_cols = $colg\->essential;
.Ve
.PP
This returns a list of the columns in the Essential group.