view release on metacpan or  search on metacpan

lib/Alzabo/QuickRef.pod  view on Meta::CPAN

=item * connect (%params)

=for html_docs type=object

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

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

=for html_docs link=L<More|Alzabo::Runtime::Schema/connect (%params)>

=item * join

=for html_docs type=object

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

=for html_docs link=L<More|Alzabo::Runtime::Schema/join>

=item * function/select

=for html_docs type=object

Allows you to execute arbitrary column aggregate SQL functions such as
C<AVG> or C<MAX> with a multi-table join.

=for html_docs link=L<More|Alzabo::Runtime::Schema/function and select>

=item * table ($name)

=for html_docs type=object

Returns an L<C<Alzabo::Runtime::Table>|Alzabo::Runtime::Table> object.
This is important because most of the row fetching operations are
table object methods.

=for html_docs link=L<More|Alzabo::Runtime::Schema/table ($name)>

=back

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

All methods that return a single row return an
L<C<Alzabo::Runtime::Row>|Alzabo::Runtime::Row> object.

All methods that return multiple rows return an
L<C<Alzabo::Runtime::RowCursor>|Alzabo::Runtime::RowCursor> object.

All methods that return rows can be given the C<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
L<C<Alzabo::Runtime::Row>|Alzabo::Runtime::Row> documentation for more
details.

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

=over 4

=item * insert

=for html_docs type=object

Insert a new row and return it.

=for html_docs link=L<More|Alzabo::Runtime::Table/insert>

=item * row_by_pk

=for html_docs type=object

Returns the row identified by the primary key give.

=for html_docs link=L<More|Alzabo::Runtime::Table/row_by_pk>

=item * rows_where

=for html_docs 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.

=for html_docs link=L<More|Alzabo::Runtime::Table/rows_where>

=item * all_rows

=for html_docs type=object

Retrieves all the rows in the table.

=for html_docs link=L<More|Alzabo::Runtime::Table/all_rows>

=item * function/select

=for html_docs type=object

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

=for html_docs link=L<More|Alzabo::Runtime::Table/function and select>

=item * potential_row

=for html_docs type=object

Make a new L<C<Alzabo::Runtime::Row>|Alzabo::Runtime::Row> in the
"potential" state.