NAME

Fey::Table::Alias - Represents an alias for a table

SYNOPSIS

  my $alias = $user_table->alias();

  my $alias = $user_table->alias( alias_name => 'User2' );

DESCRIPTION

This class represents an alias for a table. Table aliases allow you to join the same table more than once in a query, which makes certain types of queries simpler to express.

METHODS

This class provides the following methods:

Fey::Table::Alias->new()

This method constructs a new Fey::Table::Alias object. It takes the following parameters:

• table - required

  This is the Fey::Table object which we are aliasing.

• alias_name - optional

  This should be a valid table name for your DBMS. If not provided, a unique name is automatically created.

$alias->table()

Returns the Fey::Table object for which this object is an alias.

$alias->alias_name()

Returns the name for this alias.

$alias->name()

$alias->schema()

These methods work like the corresponding methods in Fey::Table. The name() method returns the real table name.

$alias->column($name)

$alias->columns()

$alias->columns(@names)

$alias->primary_key()

These methods work like the corresponding methods in Fey::Table. However, the columns they return will return the alias object when $column->table() is called.

$alias->is_alias()

Always returns true.

$alias->sql_with_alias()

Returns the appropriate SQL snippet for the alias.

$alias->id()

Returns a unique string identifying the alias.

ROLES

This class does the Fey::Role::Joinable role.

AUTHOR

Dave Rolsky, <autarch@urth.org>

BUGS

See Fey for details on how to report bugs.

COPYRIGHT & LICENSE

Copyright 2006-2008 Dave Rolsky, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.