alzabo::runtime::inserthandle(3pm) [debian man page]
Alzabo::Runtime::InsertHandle(3pm) User Contributed Perl Documentation Alzabo::Runtime::InsertHandle(3pm)NAME
Alzabo::Runtime::InsertHandle - A handle representing an insert
SYNOPSIS
my $handle =
$table->insert_handle
( columns => [ $table->columns( 'name', 'job' ) ] );
my $faye_row =
$handle->insert( values =>
{ name => 'Faye',
job => 'HK Pop Chanteuse' } );
my $guesch_row =
$handle->insert( values =>
{ name => 'Guesch',
job => 'French Chanteuse and Dancer' } );
DESCRIPTION
This object is analogous to a DBI statement handle, and can be used to insert multiple rows into a table more efficiently than repeatedly
calling "Alzabo::Runtime::Table->insert()".
METHODS
Objects of this class provide one public method:
insert
This method is used to insert a new row into a table.
It accepts the following parameters:
* values
This should be a hash reference containing the values to be inserted into the table.
If no value is given for a primary key column and the column is "sequenced" then the primary key will be auto-generated.
If values are not provided for other columns which were given when "Alzabo::Runtime::Table->insert_handle" was called, this method
first checks to see if a value was provided for the column when "Alzabo::Runtime::Table->insert_handle" was called. If none was pro-
vided, then the column's default value is used.
If column values were passed to "Alzabo::Runtime::Table->insert_handle", then these can be overridden by values passed to this method.
It is not possible to override column values that were given as SQL functions when "Alzabo::Runtime::Table->insert_handle" was called.
This method returns a new "Alzabo::Runtime::Row" object.
Throws: "Alzabo::Exception::Logic", "Alzabo::Exception::Params"
perl v5.8.8 2007-12-23 Alzabo::Runtime::InsertHandle(3pm)
Check Out this Related Man Page
Alzabo::Table(3pm) User Contributed Perl Documentation Alzabo::Table(3pm)NAME
Alzabo::Table - Table objects
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 ("Alzabo::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::Col-
umn->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.
* attribute => $attribute
* 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:
* column => "Alzabo::Column" object
* table => "Alzabo::Table" object
It returns a list of "Alzabo::ForeignKey" objects from the given column to 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 ("Alzabo::Table" object)
Returns a list of all the "Alzabo::ForeignKey" objects to 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 ("Alzabo::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>
perl v5.8.8 2007-12-23 Alzabo::Table(3pm)