Alzabo (version 0.64) - Alzabo::Runtime::JoinCursor

Index



NAME

Alzabo::Runtime::JoinCursor - Cursor that returns arrays of Alzabo::Runtime::Row objects


SYNOPSIS

  use Alzabo::Runtime::JoinCursor;
  my $cursor = $schema->join( tables => [ $foo, $bar ],
                              where => [ $foo->column('foo_id') => 1 ] );
  while ( my @rows = $cursor->next )
  {
      print $rows[0]->select('foo'), "\n";
      print $rows[1]->select('bar'), "\n";
  }


DESCRIPTION

Objects in this class are used to return arrays Alzabo::Runtime::Row objects when requested. The cursor does not preload objects but rather creates them on demand, which is much more efficient. For more details on the rational please see the HANDLING ERRORS section in Alzabo::Runtime::Cursor.


INHERITS FROM

Alzabo::Runtime::Cursor


METHODS

new

Parameters

next

Returns

The next array of Alzabo::Runtime::Row objects or an empty list if no more are available.

This behavior can mask errors in your database's referential integrity. For more information on how to deal with this see the HANDLING ERRORS section in Alzabo::Runtime::Cursor.

all_rows

Returns

All the rows available from the current point onwards. These are returned as an array of array references. Each reference is to an array of Alzabo::Runtime::Row objects.

This means that if there are five set of rows that will be returned when the object is created and you call next twice, calling all_rows after it will only return three sets. Calling the errors method after this will return all errors trapped during the fetching of these sets of rows. The return value is an array of array references. Each of these references represents a single set of rows as they would be returned from the next method.

errors

See Alzabo::Runtime::Cursor.

reset

Resets the cursor so that the next next call will return the first row of the set.


AUTHOR

Dave Rolsky, <autarch@urth.org>