1DBSchema::Index(3)    User Contributed Perl Documentation   DBSchema::Index(3)
2
3
4

NAME

6       DBIx::DBSchema::Index - Index objects
7

SYNOPSYS

9         use DBIx::DBSchema::Index;
10
11         $index = new DBIx::DBSchema::Index (
12           {
13           }
14         );
15

DESCRIPTION

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

METHODS

21       new HASHREF | OPTION, VALUE, ...
22           Creates a new DBIx::DBschema::Index object.
23
24           Accepts either a hashref or a list of options and values.
25
26           Options are:
27
28           name - Index name
29           using - Optional index method
30           unique - Boolean indicating whether or not this is a unique index.
31           columns - List reference of column names (or expressions)
32       name [ INDEX_NAME ]
33           Returns or sets the index name.
34
35       using [ INDEX_METHOD ]
36           Returns or sets the optional index method.
37
38       unique [ BOOL ]
39           Returns or sets the unique flag.
40
41       columns [ LISTREF ]
42           Returns or sets the indexed columns (or expressions).
43
44       columns_sql
45           Returns a comma-joined list of columns, suitable for an SQL
46           statement.
47
48       sql_create_index TABLENAME
49           Returns an SQL statment to create this index on the specified
50           table.
51
52       cmp OTHER_INDEX_OBJECT
53           Compares this object to another supplied object.  Returns true if
54           they are identical, or false otherwise.
55
56       cmp_noname OTHER_INDEX_OBJECT
57           Compares this object to another supplied object.  Returns true if
58           they are identical, disregarding index name, or false otherwise.
59

AUTHOR

61       Ivan Kohler <ivan-dbix-dbschema@420.am>
62
63       Copyright (c) 2007 Ivan Kohler Copyright (c) 2007 Freeside Internet
64       Services, Inc.  All rights reserved.  This program is free software;
65       you can redistribute it and/or modify it under the same terms as Perl
66       itself.
67

BUGS

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

SEE ALSO

73       DBIx::DBSchema::Table, DBIx::DBSchema, DBI
74
75
76
77perl v5.28.0                      2012-06-26                DBSchema::Index(3)