GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DBIX::DBSCHEMA::INDEX (3)

.ds Aq ’

NAME

DBIx::DBSchema::Index - Index objects

CONTENTS

SYNOPSYS



  use DBIx::DBSchema::Index;

  $index = new DBIx::DBSchema::Index (
    {
    }
  );



DESCRIPTION

DBIx::DBSchema::Index objects represent a unique or non-unique database index.

METHODS

new HASHREF | OPTION, VALUE, ... Creates a new DBIx::DBschema::Index object.

Accepts either a hashref or a list of options and values.

Options are:
name - Index name
using - Optional index method
unique - Boolean indicating whether or not this is a unique index.
columns - List reference of column names (or expressions)

name [ INDEX_NAME ] Returns or sets the index name.
using [ INDEX_METHOD ] Returns or sets the optional index method.
unique [ BOOL ] Returns or sets the unique flag.
columns [ LISTREF ] Returns or sets the indexed columns (or expressions).
columns_sql Returns a comma-joined list of columns, suitable for an SQL statement.
sql_create_index TABLENAME Returns an SQL statment to create this index on the specified table.
cmp OTHER_INDEX_OBJECT Compares this object to another supplied object. Returns true if they are identical, or false otherwise.
cmp_noname OTHER_INDEX_OBJECT Compares this object to another supplied object. Returns true if they are identical, disregarding index name, or false otherwise.

AUTHOR

Ivan Kohler <ivan-dbix-dbschema@420.am>

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.

BUGS

Is there any situation in which sql_create_index needs to return a list of multiple statements?

SEE ALSO

DBIx::DBSchema::Table, DBIx::DBSchema, DBI
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 DBSCHEMA::INDEX (3) 2012-06-26

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.