.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Rose::DB::Object::Metadata::UniqueKey 3pm"
.TH Rose::DB::Object::Metadata::UniqueKey 3pm "2022-10-14" "perl v5.34.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"
Rose::DB::Object::Metadata::UniqueKey \- Unique key metadata.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Rose::DB::Object::Metadata::UniqueKey;
\&
\&  $uk = Rose::DB::Object::Metadata::UniqueKey\->new(
\&          columns => [ \*(Aqname\*(Aq, \*(Aqcolor\*(Aq ]);
\&
\&  MyClass\->meta\->add_unique_key($uk);
\&  ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Objects of this class store and manipulate metadata for unique keys in a database table.  Each unique key is made up of one or more columns.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.IP "\fBadd_column [\s-1COLUMNS\s0]\fR" 4
.IX Item "add_column [COLUMNS]"
This method is an alias for the add_columns method.
.IP "\fBadd_columns [\s-1COLUMNS\s0]\fR" 4
.IX Item "add_columns [COLUMNS]"
Add \s-1COLUMNS\s0 to the list of columns that make up the unique key.  \s-1COLUMNS\s0 must be a list or reference to an array of  column names or Rose::DB::Object::Metadata::Column\-derived objects.
.IP "\fBcolumns [\s-1COLUMNS\s0]\fR" 4
.IX Item "columns [COLUMNS]"
Get or set the list of columns that make up the unique key.  \s-1COLUMNS\s0 must a list or reference to an array of column names or Rose::DB::Object::Metadata::Column\-derived objects.
.Sp
This method returns all of the columns that make up the unique key.  Each column is a Rose::DB::Object::Metadata::Column\-derived column object if the unique key's parent has a column object with the same name, or just the column name otherwise.  In scalar context, a reference to an array of columns is returned.  In list context, a list is returned.
.IP "\fBcolumn_names\fR" 4
.IX Item "column_names"
Returns a list (in list context) or reference to an array (in scalar context) of the names of the columns that make up the unique key.
.IP "\fBdelete_columns\fR" 4
.IX Item "delete_columns"
Delete the entire list of columns that make up the unique key.
.IP "\fBname [\s-1NAME\s0]\fR" 4
.IX Item "name [NAME]"
Get or set the name of the unique key.  This name should be unique among all unique keys for a given table.  Traditionally, it is the name of the index that the database uses to maintain the unique key, but practices vary.  If left undefined, the default value is a string created by joining the column_names with underscores.
.IP "\fBparent [\s-1META\s0]\fR" 4
.IX Item "parent [META]"
Get or set the Rose::DB::Object::Metadata\-derived object that this unique key belongs to.
.SH "AUTHOR"
.IX Header "AUTHOR"
John C. Siracusa (siracusa@gmail.com)
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2010 by John C. Siracusa.  All rights reserved.  This program is
free software; you can redistribute it and/or modify it under the same terms
as Perl itself.