Dave Rolsky

NAME

Alzabo::Create::Index - Index objects for schema creation

SYNOPSIS

  use Alzabo::Create::Index;

INHERITS FROM

Alzabo::Index

METHODS

new

Parameters

  • table => Alzabo::Create::Table object

    The table that this index is indexing.

  • columns => [ Alzabo::Create::Column object, .. ]

  • columns => [ { column => Alzabo::Create::Column object, prefix => $prefix }, repeat as needed ... ]

    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.

    The prefix key is optional.

  • unique => $boolean

    Indicates whether or not this is a unique index.

  • fulltext => $boolean

    Indicates whether or not this is a fulltext index.

Returns

A new Alzabo::Create::Index object.

add_column

Add a column to the index.

Parameters

  • column => Alzabo::Create::Column object

  • prefix => $prefix (optional)

delete_column (Alzabo::Create::Column object)

Delete the given column from the index.

set_prefix

Parameters

  • column => Alzabo::Create::Column object

  • prefix => $prefix

set_unique ($boolean)

Set whether or not the index is a unique index.

set_fulltext ($boolean)

Set whether or not the index is a fulltext index.

register_column_name_change

Parameters

  • column => Alzabo::Create::Column object

    The column (with the new name already set).

  • old_name => $old_name

Called by the owning table object when a column changes. You should never need to call this yourself.

AUTHOR

Dave Rolsky, <autarch@urth.org>