view release on metacpan or  search on metacpan

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

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

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

=back

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

=over 4

=item * select (@list_of_column_names)

=for html_docs type=object

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

=for html_docs link=L<More|Alzabo::Runtime::Row/select (@list_of_column_names)>

=item * update (%hash_of_columns_and_values)

=for html_docs type=object

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

=for html_docs link=L<More|Alzabo::Runtime::Row/update (%hash_of_columns_and_values)>

=item * delete

=for html_docs type=object

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

=for html_docs link=L<More|Alzabo::Runtime::Row/delete>

=item * rows_by_foreign_key

=for html_docs type=object

Given a foreign key object from the row's table to another table,
returns either an L<C<Alzabo::Runtime::Row>|Alzabo::Runtime::Row>
object or an
L<C<Alzabo::Runtime::RowCursor>|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 C<no_cache> and/or C<order_by> parameter.

=for html_docs link=L<More|Alzabo::Runtime::Row/rows_by_foreign_key>

=back

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

=over 4

=item * next

=for html_docs type=object

Returns the next L<C<Alzabo::Runtime::Row>|Alzabo::Runtime::Row>
object, or undef if there are no more.

=for html_docs link=L<More|Alzabo::Runtime::RowCursor/next>

=item * all_rows

=for html_docs type=object

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

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

=back

=head2 Creating/removing a schema

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

=over 4