.\" 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 "DBSchema::Index 3pm"
.TH DBSchema::Index 3pm "2022-09-10" "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"
DBIx::DBSchema::Index \- Index objects
.SH "SYNOPSYS"
.IX Header "SYNOPSYS"
.Vb 1
\&  use DBIx::DBSchema::Index;
\&
\&  $index = new DBIx::DBSchema::Index (
\&    {
\&    }
\&  );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
DBIx::DBSchema::Index objects represent a unique or non-unique database index.
.SH "METHODS"
.IX Header "METHODS"
.IP "new \s-1HASHREF\s0 | \s-1OPTION, VALUE, ...\s0" 4
.IX Item "new HASHREF | OPTION, VALUE, ..."
Creates a new DBIx::DBschema::Index object.
.Sp
Accepts either a hashref or a list of options and values.
.Sp
Options are:
.RS 4
.IP "name \- Index name" 8
.IX Item "name - Index name"
.PD 0
.IP "using \- Optional index method" 8
.IX Item "using - Optional index method"
.IP "unique \- Boolean indicating whether or not this is a unique index." 8
.IX Item "unique - Boolean indicating whether or not this is a unique index."
.IP "columns \- List reference of column names (or expressions)" 8
.IX Item "columns - List reference of column names (or expressions)"
.RE
.RS 4
.RE
.IP "name [ \s-1INDEX_NAME\s0 ]" 4
.IX Item "name [ INDEX_NAME ]"
.PD
Returns or sets the index name.
.IP "using [ \s-1INDEX_METHOD\s0 ]" 4
.IX Item "using [ INDEX_METHOD ]"
Returns or sets the optional index method.
.IP "unique [ \s-1BOOL\s0 ]" 4
.IX Item "unique [ BOOL ]"
Returns or sets the unique flag.
.IP "columns [ \s-1LISTREF\s0 ]" 4
.IX Item "columns [ LISTREF ]"
Returns or sets the indexed columns (or expressions).
.IP "columns_sql" 4
.IX Item "columns_sql"
Returns a comma-joined list of columns, suitable for an \s-1SQL\s0 statement.
.IP "sql_create_index \s-1TABLENAME\s0" 4
.IX Item "sql_create_index TABLENAME"
Returns an \s-1SQL\s0 statment to create this index on the specified table.
.IP "cmp \s-1OTHER_INDEX_OBJECT\s0" 4
.IX Item "cmp OTHER_INDEX_OBJECT"
Compares this object to another supplied object.  Returns true if they are
identical, or false otherwise.
.IP "cmp_noname \s-1OTHER_INDEX_OBJECT\s0" 4
.IX Item "cmp_noname OTHER_INDEX_OBJECT"
Compares this object to another supplied object.  Returns true if they are
identical, disregarding index name, or false otherwise.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ivan Kohler <ivan\-dbix\-dbschema@420.am>
.PP
Copyright (c) 2007 Ivan Kohler
Copyright (c) 2007 Freeside Internet Services, Inc.
All rights reserved.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
.SH "BUGS"
.IX Header "BUGS"
Is there any situation in which sql_create_index needs to return a list of
multiple statements?
.SH "SEE ALSO"
.IX Header "SEE ALSO"
DBIx::DBSchema::Table, DBIx::DBSchema, \s-1DBI\s0