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  -  ALZABO::TABLE (3)

.ds Aq ’

NAME

Alzabo::Table - Table objects

CONTENTS

SYNOPSIS



  use Alzabo::Table;

  my $t = $schema->table(foo);

  foreach $pk ($t->primary_keys)
  {
     print $pk->name;
  }



DESCRIPTION

Objects in this class represent tables. They contain foreign key, index, and column objects.

METHODS

    schema

Returns the Alzabo::Schema object to which this table belongs.

    name

Returns the name of the table.

    column ($name)

Returns the Alzabo::Column object that matches the name given.

An Alzabo::Exception::Params exception is throws if the table does not contain the column.

    columns (@optional_list_of_column_names)

If no arguments are given, returns a list of all Alzabo::Column objects in the schema, or in a scalar context the number of such tables. If one or more arguments are given, returns a list of table objects with those names, in the same order given.

An Alzabo::Exception::Params exception is throws if the table does not contain one or more of the specified columns.

    has_column ($name)

Returns a voolean value indicating whether the column exists in the table.

    primary_key

In array context, return an ordered list of column objects that make up the primary key for the table. In scalar context, it returns the first element of that list.

    primary_key_size

The number of columns in the table’s primary key.

column_is_primary_key (CWAlzabo::Column object)

Returns a boolean value indicating whether the column given is part of the table’s primary key.

This method is really only needed if you’re not sure that the column belongs to the table. Otherwise just call the Alzabo::Column->is_primary_key method on the column object.

    attributes

A table’s attributes are strings describing the table (for example, valid attributes in MySQL are thing like TYPE = INNODB.

Returns a list of strings.

    has_attribute

This method can be used to test whether or not a table has a particular attribute. By default, the check is case-insensitive.
o attribute => $attribute
o case_sensitive => 0 or 1 (defaults to 0)
Returns a boolean value indicating whether the table has this particular attribute.

    foreign_keys

Thie method takes two parameters:
o column => Alzabo::Column object
o table => Alzabo::Table object
It returns a list of Alzabo::ForeignKey objects <B>fromB> the given column <B>toB> the given table, if they exist. In scalar context, it returns the first item in the list. There is no guarantee as to what the first item will be.

An Alzabo::Exception::Params exception is throws if the table does not contain the specified column.

foreign_keys_by_table (CWAlzabo::Table object)

Returns a list of all the Alzabo::ForeignKey objects <B>toB> the given table. In scalar context, it returns the first item in the list. There is no guarantee as to what the first item will be.

foreign_keys_by_column (CWAlzabo::Column object)

Returns a list of all the Alzabo::ForeignKey objects that the given column is a part of, if any. In scalar context, it returns the first item in the list. There is no guarantee as to what the first item will be.

An Alzabo::Exception::Params exception is throws if the table does not contain the specified column.

    all_foreign_keys

Returns a list of all the Alzabo::ForeignKey objects for this table. In scalar context, it returns the first item in the list. There is no guarantee as to what the first item will be.

    index ($index_id)

This method expects an index id as returned by the Alzabo::Index->id method as its parameter.

The Alzabo::Index object matching this id, if it exists in the table.

An Alzabo::Exception::Params exception is throws if the table does not contain the specified index.

    has_index ($index_id)

This method expects an index id as returned by the Alzabo::Index->id method as its parameter.

Returns a boolean indicating whether the table has an index with the same id.

    indexes

Returns all the Alzabo::Index objects for the table.

    comment

Returns the comment associated with the table object, if any.

AUTHOR

Dave Rolsky, <autarch@urth.org>
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 ALZABO::TABLE (3) 2016-04-03

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