SQL::Translator::Schema::Table − SQL::Translator table object
use
SQL::Translator::Schema::Table;
my $table = SQL::Translator::Schema::Table−>new(
name => 'foo' );
"SQL::Translator::Schema::Table" is the table object.
Object constructor.
my $table =
SQL::Translator::Schema::Table−>new(
schema => $schema,
name => 'foo',
);
Add a constraint to the table. Returns the newly created "SQL::Translator::Schema::Constraint" object.
my $c1 =
$table−>add_constraint(
name => 'pk',
type => PRIMARY_KEY,
fields => [ 'foo_id' ],
);
my $c2 = SQL::Translator::Schema::Constraint−>new(
name => 'uniq' );
$c2 = $table−>add_constraint( $constraint );
Remove a constraint from the table. Returns the constraint object if the index was found and removed, an error otherwise. The single parameter can be either an index name or an "SQL::Translator::Schema::Constraint" object.
$table−>drop_constraint('myconstraint');
Add an index to the table. Returns the newly created "SQL::Translator::Schema::Index" object.
my $i1 =
$table−>add_index(
name => 'name',
fields => [ 'name' ],
type => 'normal',
);
my $i2 = SQL::Translator::Schema::Index−>new( name
=> 'id' );
$i2 = $table−>add_index( $index );
Remove an index from the table. Returns the index object if the index was found and removed, an error otherwise. The single parameter can be either an index name of an "SQL::Translator::Schema::Index" object.
$table−>drop_index('myindex');
Add an field to the table. Returns the newly created "SQL::Translator::Schema::Field" object. The "name" parameter is required. If you try to create a field with the same name as an existing field, you will get an error and the field will not be created.
my $f1 =
$table−>add_field(
name => 'foo_id',
data_type => 'integer',
size => 11,
);
my $f2 = SQL::Translator::Schema::Field−>new(
name => 'name',
table => $table,
);
$f2 = $table−>add_field( $field2 ) or die
$table−>error;
Remove a field from the table. Returns the field object if the field was found and removed, an error otherwise. The single parameter can be either a field name or an "SQL::Translator::Schema::Field" object.
$table−>drop_field('myfield');
Get or set the comments on a table. May be called several times to set and it will accumulate the comments. Called in an array context, returns each comment individually; called in a scalar context, returns all the comments joined on newlines.
$table−>comments('foo');
$table−>comments('bar');
print join( ', ', $table−>comments ); # prints
"foo, bar"
Returns all the constraint objects as an array or array reference.
my @constraints = $table−>get_constraints;
Returns all the index objects as an array or array reference.
my @indices = $table−>get_indices;
Returns a field by the name provided.
my $field = $table−>get_field('foo');
Returns all the field objects as an array or array reference.
my @fields = $table−>get_fields;
Determine whether the view is valid or not.
my $ok = $view−>is_valid;
True if table has no data (non-key) fields and only uses single key joins.
Returns true if the table has some non-key fields.
Determine whether the table can link two arg tables via many-to-many.
my $ok = $table−>can_link($table1,$table2);
Get or set the table’s name.
Errors ("No table name") if you try to set a blank name.
If provided an argument, checks the schema object for a table of that name and disallows the change if one exists (setting the error to "Can’t use table name "%s": table exists").
my $table_name = $table−>name('foo');
Get or set the table’s schema object.
my $schema = $table−>schema;
Gets or sets the table’s primary key(s). Takes one or more field names (as a string, list or array[ref]) as an argument. If the field names are present, it will create a new PK if none exists, or it will add to the fields of an existing PK (and will unique the field names). Returns the "SQL::Translator::Schema::Constraint" object representing the primary key.
These are equivalent:
$table−>primary_key('id');
$table−>primary_key(['name']);
$table−>primary_key('id','name']);
$table−>primary_key(['id','name']);
$table−>primary_key('id,name');
$table−>primary_key(qw[ id name ]);
my $pk = $table−>primary_key;
Get or append to the table’s options (e.g., table types for MySQL). Returns an array or array reference.
my @options = $table−>options;
Get or set the table’s order.
my $order = $table−>order(3);
Read-only method to return a list or array ref of the field names. Returns undef or an empty list if the table has no fields set. Useful if you want to avoid the overload magic of the Field objects returned by the get_fields method.
my @names = $constraint−>field_names;
Determines if this table is the same as another
my $isIdentical = $table1−>equals( $table2 );
The following
are a set of shortcut methods for getting commonly used
lists of fields and constraints. They all return lists or
array refs of Field or Constraint objects.
pkey_fields
The primary key fields.
fkey_fields
All foreign key fields.
nonpkey_fields
All the fields except the primary key.
data_fields
All non key fields.
unique_fields
All fields with unique constraints.
unique_constraints
All this tables unique constraints.
fkey_constraints
All this tables foreign key constraints. (See primary_key method to get the primary key constraint)
Ken Youens-Clark <[email protected]>, Allen Day <[email protected]>.