.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Alzabo::Create::Index 3pm"
.TH Alzabo::Create::Index 3pm "2022-06-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"
Alzabo::Create::Index \- Index objects for schema creation
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Alzabo::Create::Index;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object represents an index on a table.  Indexes consist of
columns and optional prefixes for each column.  The prefix specifies
how many characters of the columns should be indexes (the first X
chars).  Some \s-1RDBMS\s0's do not have a concept of index prefixes.  Not
all column types are likely to allow prefixes though this depends on
the \s-1RDBMS.\s0  The order of the columns is significant.
.SH "INHERITS FROM"
.IX Header "INHERITS FROM"
\&\f(CW\*(C`Alzabo::Index\*(C'\fR
.PP
Note: all relevant documentation from the superclass has been merged into this document.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
The constructor takes the following parameters:
.IP "\(bu" 4
table => \f(CW\*(C`Alzabo::Create::Table\*(C'\fR object
.Sp
The table that this index is indexing.
.IP "\(bu" 4
columns => [ \f(CW\*(C`Alzabo::Create::Column\*(C'\fR object, .. ]
.IP "\(bu" 4
columns => [ { column => \f(CW\*(C`Alzabo::Create::Column\*(C'\fR object,
                       prefix => \f(CW$prefix\fR },
                      repeat as needed ...
                   ]
.Sp
This parameter indicates which columns that are being indexed.  It can
either be an array reference of column objects, or an array reference
of hash references, each with a key called column and one called
prefix.
.Sp
The prefix key is optional.
.IP "\(bu" 4
unique => \f(CW$boolean\fR
.Sp
Indicates whether or not this is a unique index.
.IP "\(bu" 4
fulltext => \f(CW$boolean\fR
.Sp
Indicates whether or not this is a fulltext index.
.IP "\(bu" 4
function => \f(CW$string\fR
.Sp
This can be used to create a function index where supported. The value
of this parameter should be the full function, with column names, such
as \f(CW\*(C`LCASE( username )\*(C'\fR.
.Sp
The \*(L"columns\*(R" parameter should include all the columns used in the
function.
.PP
Returns a new \f(CW\*(C`Alzabo::Create::Index\*(C'\fR object.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "table"
.IX Subsection "table"
Returns the \f(CW\*(C`Alzabo::Create::Table\*(C'\fR object to which the
index belongs.
.SS "columns"
.IX Subsection "columns"
Returns an ordered list of the \f(CW\*(C`Alzabo::Create::Column\*(C'\fR
objects that are being indexed.
.SS "add_column"
.IX Subsection "add_column"
Adds a column to the index.
.PP
This method takes the following parameters:
.IP "\(bu" 4
column => \f(CW\*(C`Alzabo::Create::Column\*(C'\fR object
.IP "\(bu" 4
prefix => \f(CW$prefix\fR (optional)
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.ie n .SS "delete_column (""Alzabo::Create::Column"" object)"
.el .SS "delete_column (\f(CWAlzabo::Create::Column\fP object)"
.IX Subsection "delete_column (Alzabo::Create::Column object)"
Deletes the given column from the index.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.ie n .SS "prefix (""Alzabo::Create::Column"" object)"
.el .SS "prefix (\f(CWAlzabo::Create::Column\fP object)"
.IX Subsection "prefix (Alzabo::Create::Column object)"
A column prefix is, to the best of my knowledge, a MySQL specific
concept, and as such cannot be set when using an RDBMSRules module for
a different \s-1RDBMS.\s0  However, it is important enough for MySQL to have
the functionality be present.  It allows you to specify that the index
should only look at a certain portion of a field (the first N
characters).  This prefix is required to index any sort of \s-1BLOB\s0 column
in MySQL.
.PP
This method returns the prefix for the column in the index.  If there
is no prefix for this column in the index, then it returns undef.
.SS "set_prefix"
.IX Subsection "set_prefix"
This method takes the following parameters:
.IP "\(bu" 4
column => \f(CW\*(C`Alzabo::Create::Column\*(C'\fR object
.IP "\(bu" 4
prefix => \f(CW$prefix\fR
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "unique"
.IX Subsection "unique"
Returns a boolean value indicating whether the index is a unique
index.
.SS "set_unique ($boolean)"
.IX Subsection "set_unique ($boolean)"
Sets whether or not the index is a unique index.
.SS "fulltext"
.IX Subsection "fulltext"
Returns a boolean value indicating whether the index is a fulltext
index.
.SS "set_fulltext ($boolean)"
.IX Subsection "set_fulltext ($boolean)"
Set whether or not the index is a fulltext index.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "register_column_name_change"
.IX Subsection "register_column_name_change"
This method takes the following parameters:
.IP "\(bu" 4
column => \f(CW\*(C`Alzabo::Create::Column\*(C'\fR object
.Sp
The column (with the new name already set).
.IP "\(bu" 4
old_name => \f(CW$old_name\fR
.PP
This method is called by the table object which owns the index when a
column name changes.  You should never need to call this yourself.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR
.SS "id"
.IX Subsection "id"
The id is generated from the table, column and prefix information for
the index.  This is useful as a canonical name for a hash key, for
example.
.PP
Returns a string that is the id which uniquely identifies the index in
this schema.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky, <autarch@urth.org>