/ 
DBIx-Class-Async-0.40
/ DBIx::Class::Async::Storage

NAME

DBIx::Class::Async::Storage - Storage Layer for DBIx::Class::Async

VERSION

Version 0.40

SYNOPSIS

use DBIx::Class::Async::Storage;

# Typically created internally by DBIx::Class::Async::Schema
my $storage = DBIx::Class::Async::Storage->new(
    _schema => $schema_instance,
);

# Get the schema
my $schema = $storage->schema;

# Disconnect
$storage->disconnect;

DESCRIPTION

DBIx::Class::Async::Storage provides a minimal storage layer implementation for DBIx::Class::Async. This class exists primarily for compatibility with the DBIx::Class ecosystem, providing the expected storage interface without direct database handle management.

In the asynchronous architecture, database operations are delegated to a separate worker process or service, so this storage layer does not manage traditional database connections.

CONSTRUCTOR

new

my $storage = DBIx::Class::Async::Storage->new(
    _schema => $schema,  # DBIx::Class::Async::Schema instance
);

Creates a new storage object.

Parameters
_schema

A DBIx::Class::Async::Schema instance. This is typically passed internally.

Returns

A new DBIx::Class::Async::Storage object.

METHODS

cursor

my $cursor = $storage->cursor($resultset);

Creates and returns a cursor object for iterating through a ResultSet's rows.

This is an abstract method that must be implemented by storage subclasses (such as DBIx::Class::Async::Storage::DBI). Calling this method directly on the base storage class will throw an error.

Arguments

Returns

A cursor object appropriate for the storage type. For DBI-based storage, this returns a DBIx::Class::Async::Storage::DBI::Cursor object.

# Don't call on base class directly
my $cursor = $storage->cursor($rs);  # Dies!

# Use through a DBI storage subclass
my $dbi_storage = DBIx::Class::Async::Storage::DBI->new(...);
my $cursor = $dbi_storage->cursor($rs);  # Works!

Subclasses should override this method to return storage-specific cursor implementations.

dbh

my $dbh = $storage->dbh;

Returns undef in async storage mode.

Unlike traditional DBIx::Class::Storage, the async storage layer does not maintain a database handle in the parent process. Instead, database handles are held by worker processes in the background worker pool, which execute queries asynchronously.

This method exists for API compatibility with standard DBIx::Class storage objects, but always returns undef to indicate that direct database handle access is not available in async mode.

my $storage = $schema->storage;
my $dbh = $storage->dbh;  # Always undef in async mode

if (!defined $dbh) {
    say "Running in async mode - no direct DBH access";
}

If you need to perform database operations, use the ResultSet and Row methods which handle async execution transparently through the worker pool.

schema

my $schema = $storage->schema;

Returns the DBIx::Class::Async::Schema object that this storage layer is associated with.

This provides a back-reference from the storage to its parent schema, allowing storage components to access schema-level information and other ResultSources when needed.

Note: The schema reference is weakened internally to prevent circular reference memory leaks between the schema and storage objects.

my $storage = $schema->storage;
my $parent_schema = $storage->schema;

# Access schema configuration
my $source = $parent_schema->source('User');

disconnect

$storage->disconnect;

Disconnects from the database.

Returns

True (1) on success.

Notes

This method calls disconnect on the associated schema object if it exists.

INTERNAL NOTES

This class implements a minimal subset of the DBIx::Class::Storage interface required for compatibility with the DBIx::Class ecosystem. Key differences:

  • No direct database handle management

  • No SQL generation or execution

  • No transaction management at this level

  • Debug methods are no-ops or return mock objects

Database operations in DBIx::Class::Async are performed by a separate worker process or service, so this storage layer acts primarily as a compatibility shim.

SEE ALSO

AUTHOR

Mohammad Sajid Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/manwar/DBIx-Class-Async

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/manwar/DBIx-Class-Async/issues. I will be notified and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc DBIx::Class::Async::Storage

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2026 Mohammad Sajid Anwar.

This program is free software; you can redistribute it and / or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.