#NAME

Yancy::Model::Schema - Interface to a single schema

#VERSION

version 1.081

#SYNOPSIS

my $schema = $app->model->schema( 'foo' );

my $id = $schema->create( $data );
my $item = $schema->get( $id );
my $count = $schema->delete( $id );
my $count = $schema->delete( $where );
my $count = $schema->set( $id, $data );
my $count = $schema->set( $where, $data );

my $res = $schema->list( $where, $opts );
for my $item ( @{ $res->{items} } ) { ... }

#DESCRIPTION

NOTE: This module is experimental and its API may change before Yancy v2!

For information on how to extend this module to add your own schema and item methods, see Yancy::Guides::Model.

#ATTRIBUTES

#model

The Yancy::Model object that created this schema object.

#METHODS

#id_field

The ID field for this schema. Either a single string, or an arrayref of strings (for composite keys).

#build_item

Turn a hashref of row data into a Yancy::Model::Item object using "find_class" in Yancy::Model to find the correct class.

#validate

Validate an item. Returns a list of errors (if any).

#get

Get an item by its ID. Returns a Yancy::Model::Item object.

List items. Returns a hash reference with items and total keys. The items is an array ref of Yancy::Model::Item objects. total is the total number of items that would be returned without any offset or limit options.