Dave Rolsky

NAME

Alzabo::QuickRef - A quick reference to methods in the Alzabo classes

METHODS

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 Alzabo::Runtime::* classes.

  • reverse_engineer

    type=class

    Connect to a database and reverse engineer a schema. Returns a new schema object.

    link=L.
  • load_from_file

    type=class

    Load an existing schema object from disk. Returns a new schema object.

    link=L.
  • create

    type=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.

    link=L
  • make_sql

    type=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 create method for more details.

    link=L
  • drop

    type=object

    Drop the database from the RDBMS where it was created. Does not remove the schema object itself from disk.

    link=L
  • delete

    type=object

    Delete the schema object files from disk. Does not drop the database from the RDBMS.

    link=L

Retrieving data

Alzabo::Runtime::Schema

This object allows you to connect to the database. It contains one data retrieval, method join.

  • load_from_file

    type=class

    Load an existing schema object from disk. Returns a new schema object.

    link=L.
  • set_user ($user)

    type=object

    Set the username to be used when connecting to the database.

    link=L
  • set_password ($password)

    type=object

    Set the password to be used when connecting to the database.

    link=L
  • set_host ($host)

    type=object

    Set the host to be used when connecting to the database.

    link=L
  • connect (%params)

    type=object

    Connect to the RDBMS. This will use the previously set username/password/host, though these can be overridden by the %params given to the call.

    Important: This method must be called before any data retrieval is attempted.

    link=L
  • join

    type=object

    Fetch rows from one or more tables based on a table join. Returns either a Alzabo::Runtime::RowCursor or Alzabo::Runtime::JoinCursor object.

    link=L
  • table ($name)

    type=object

    Returns an Alzabo::Runtime::Table object. This is important because most the row fetching operations are part of that class.

    link=L

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 Alzabo::Runtime::Row or Alzabo::Runtime::RowCursor objects.

All methods that return a single row return an Alzabo::Runtime::Row object.

All methods that return multiple rows return an Alzabo::Runtime::RowCursor object.

All methods that return rows can be given the no_cache parameter, which ensures that the row(s) returned will not be cached. Rows obtained in this manner should not be updated or deleted, as this will play havoc with the caching system. See the Alzabo::Runtime::Row documentation for more details.

All methods that return multiple rows in the form of a cursor object can take an order_by parameter. See the Alzabo::Runtime::Table documentation for more details.

  • insert

    type=object

    Insert a new row and return it.

    link=L
  • row_by_pk

    type=object

    Returns the row identified by the primary key give.

    link=L
  • rows_where

    type=object

    Retrieves a set of rows based on a where clause. Please see the method documentation for details on how where clauses are constructed.

    link=L
  • all_rows

    type=object

    Retrieves all the rows in the table.

    link=L
  • func

    type=object

    Allows you to execute arbitrary column aggregate SQL functions such as AVG or MAX.

    link=L

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.

  • select (@list_of_column_names)

    type=object

    Given a list of column names, this method returns the values for those columns.

    link=L
  • update (%hash_of_columns_and_values)

    type=object

    Given a hash of columns and values, this method will update the database and the object to match those values.

    link=L
  • delete

    type=object

    Deletes the row from the database. Further attempts to retrieve data from this row will throw an exception.

    link=L
  • rows_by_foreign_key

    type=object

    Given a foreign key object from the row's table to another table, returns either an Alzabo::Runtime::Row object or an Alzabo::Runtime::RowCursor object for the row(s) in the table to which the relationship exists, based on the value of the relevant column(s) in the current row.

    This method can also take a no_cache and/or order_by parameter.

    link=L

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.

  • next_row

    type=object

    Returns the next Alzabo::Runtime::Row object, or undef if there are no more.

    link=L
  • all_rows

    type=object

    Returns a list of all the remaining Alzabo::Runtime::Row objects, or an empty list if there are no more.

    link=L

AUTHOR

Dave Rolsky, <autarch@urth.org>