Home
Resources
News Support SourceDocs
Module Docs Wiki FAQ Change History Articles Presentations Todo list Bug listMiscellaneous
Mason GUI License
Alzabo (version 0.92) - Method Quick Reference
NAME
Alzabo::QuickRef - A quick reference to methods in the Alzabo classes
GENERAL
This reference is intended to provide a quick reference to some of the more commonly used methods that Alzabo provides. In addition, this reference can give you an idea of what classes contain certain types of methods, so you have an idea of where to look in order to figure out how to achieve a certain task.
Alzabo, Alzabo::Create, and Alzabo::Runtime
These modules are mostly used just to load other modules. The
Alzabo::Runtime module can be used to preload schemas at compile
time by doing:
use Alzabo::Runtime qw( schema1 schema2 schema3 );
Alzabo::MethodMaker
This module can be used to generate many useful convenience methods. This is done by auto-generating methods in new packages and re-blessing some of the schema objects into these packages. To have it generate all the possible methods for a schema you would do:
use Alzabo::MethodMaker ( schema => 'some_schema',
# Root for new packages
class_root => 'My::Data',
# Make all possible methods
all => 1 );
This will make convenience methods for such things as getting table and column objects, following various types of foreign keys, and getting data from row objects.
METHODS
Retrieving data
Alzabo::Runtime::Schema | |||
This object allows you to connect to the database. It contains
several data retrieval methods including
| |||
| method | class/object | description | more info |
|---|---|---|---|
load_from_file |
class | Load an existing schema object from disk. Returns a new schema object. | More |
set_user ($user) |
object | Set the username to be used when connecting to the database. | More |
set_password ($password) |
object | Set the password to be used when connecting to the database. | More |
set_host ($host) |
object | Set the host to be used when connecting to the database. | More |
connect (%params) |
object | Connect to the RDBMS. This will use the previously set
username/password/host, though these can be overridden by the
Important: This method must be called before any data retrieval is attempted. | More |
join |
object | Fetch rows from one or more tables based on a table join. Returns
either a | More |
function/select |
object | Allows you to execute arbitrary column aggregate SQL functions such as
| More |
table ($name) |
object | Returns an | More |
Alzabo::Runtime::Table | |||
Objects in this class have methods allowing you to insert new rows as
well as retrieving exist data in the form of
All methods that return a single row return an
All methods that return multiple rows return an
All methods that return rows can be given the All methods that return multiple rows in the form of a cursor object
can take an | |||
| method | class/object | description | more info |
|---|---|---|---|
insert |
object | Insert a new row and return it. | More |
row_by_pk |
object | Returns the row identified by the primary key give. | More |
rows_where |
object | Retrieves a set of rows based on a where clause. Please see the method documentation for details on how where clauses are constructed. | More |
all_rows |
object | Retrieves all the rows in the table. | More |
function/select |
object | Allows you to execute arbitrary column aggregate SQL functions such as
| More |
potential_row |
object | Make a new | More |
Alzabo::Runtime::Row | |||
Objects in this class represent a single row of data. You can retrieve the actual column values from it, update it, or delete it. | |||
| method | class/object | description | more info |
|---|---|---|---|
select (@list_of_column_names) |
object | Given a list of column names, this method returns the values for those columns. | More |
update (%hash_of_columns_and_values) |
object | Given a hash of columns and values, this method will update the database and the object to match those values. | More |
delete |
object | Deletes the row from the database. Further attempts to retrieve data from this row will throw an exception. | More |
rows_by_foreign_key |
object | Given a foreign key object from the row's table to another table,
returns either an This method can also take a | More |
Alzabo::Runtime::RowCursor | |||
Objects in this class are used to return multiple rows as a cursor, rather than as a list. This is much more efficient, at the expense of a few extra lines in your code. | |||
| method | class/object | description | more info |
|---|---|---|---|
next |
object | Returns the next | More |
all_rows |
object | Returns a list of all the remaining
| More |
Creating/removing a schema
Alzabo::Create::Schema | |||
This object represents a schema, and contains one or more table
objects. It is only used when creating or altering a schema, as
opposed to when fetching data. Data manipulation is done via the
| |||
| method | class/object | description | more info |
|---|---|---|---|
reverse_engineer |
class | Connect to a database and reverse engineer a schema. Returns a new schema object. | More |
load_from_file |
class | Load an existing schema object from disk. Returns a new schema object. | More |
create |
object | If the schema has not yet been instantiated in an RDBMS, this method will instantiate the schema. If it has been previously instantiated, it will bring the schema in the RDBMS into sync with its object representation (altering tables/columns, etc.) Where possible, exist data will be preserved. | More |
make_sql |
object | Returns an array, each element of which is a SQL statement. The SQL
is either the SQL to create the schema from scratch or the SQL needed
to update the RDBMS to match the current object. See the
| More |
drop |
object | Drop the database from the RDBMS where it was created. Does not remove the schema object itself from disk. | More |
delete |
object | Delete the schema object files from disk. Does not drop the database from the RDBMS. | More |
AUTHOR
Dave Rolsky, <autarch@urth.org>