alzabo::foreignkey(3pm) [debian man page]
Alzabo::ForeignKey(3pm) User Contributed Perl Documentation Alzabo::ForeignKey(3pm) NAME
Alzabo::ForeignKey - Foreign key (relation) objects SYNOPSIS
use Alzabo::ForeignKey; foreach my $fk ($table->foreign_keys) { print $fk->cardinality; } DESCRIPTION
A foreign key is an object defined by several properties. It represents a relationship from a column or columns in one table to a column or columns in another table. This relationship is defined by its cardinality (one to one, one to many, or many to one) and its dependencies (whether or not table X is dependent on table Y, and vice versa). Many to many relationships are not allowed. However, you may indicate such a relationship when using the Alzabo::Create::Schema->add_rela- tion method method, and it will create the necessary intermediate linking table for you. METHODS
table_from table_to Returns the relevant "Alzabo::Table" object. columns_from columns_to Returns the relevant "Alzabo::Column" object(s) for the property as an array. column_pairs Returns an array of array references. The references are to two column array of "Alzabo::Column" objects. These two columns correspond in the tables being linked together. cardinality Returns a two element array containing the two portions of the cardinality of the relationship. Each portion will be either '1' or 'n'. from_is_dependent to_is_dependent Returns a boolean value indicating whether there is a dependency from one table to the other. is_one_to_one is_one_to_many is_many_to_one Returns a boolean value indicating what kind of relationship the object represents. is_same_relationship_as ($fk) Given a foreign key object, this returns true if the two objects represent the same relationship. However, the two objects may represent the same relationship from different table's points of view. id Returns a string uniquely identifying the foreign key. comment Returns the comment associated with the foreign key object, if any. AUTHOR
Dave Rolsky, <autarch@urth.org> perl v5.8.8 2007-12-23 Alzabo::ForeignKey(3pm)
Check Out this Related Man Page
Alzabo::Runtime::Index(3pm) User Contributed Perl Documentation Alzabo::Runtime::Index(3pm) NAME
Alzabo::Runtime::Index - Index objects SYNOPSIS
use Alzabo::Runtime::Index; 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 RDBMS's do not have a concept of index prefixes. Not all col- umn types are likely to allow prefixes though this depends on the RDBMS. The order of the columns is significant. INHERITS FROM
"Alzabo::Index" Note: all relevant documentation from the superclass has been merged into this document. METHODS
columns Returns an ordered list of the "Alzabo::Runtime::Column" objects that are being indexed. prefix ("Alzabo::Runtime::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 RDBMS. 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 BLOB column in MySQL. 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. unique Returns a boolean value indicating whether the index is a unique index. fulltext Returns a boolean value indicating whether the index is a fulltext index. function For function indexes, this returns the function being indexed. 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. Returns a string that is the id which uniquely identifies the index in this schema. table Returns the "Alzabo::Runtime::Table" object to which the index belongs. AUTHOR
Dave Rolsky, <autarch@urth.org> perl v5.8.8 2007-12-23 Alzabo::Runtime::Index(3pm)