/ 
DBIx-Class-Async-0.55
/ DBIx::Class::Async::Storage

NAME

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

VERSION

Version 0.55

SYNOPSIS

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

# Typically instantiated automatically via DBIx::Class::Async::Schema
my $storage = $schema->storage;

# Connection Management

# Check if the worker pool is currently connected
if ( $storage->connected ) {
    say "Worker pool is active and ready.";
}

# Gracefully shut down all background worker processes and disconnect
$storage->disconnect;

# Metadata & Configuration

# Access the underlying schema instance
my $schema = $storage->schema;

# Inspect the DSN (Data Source Name) currently in use
my $dsn = $storage->connect_info->[0];

# Debugging

# Storage acts as the gateway for the debug environment
$storage->debug(1) if $ENV{DBIC_TRACE};

DESCRIPTION

DBIx::Class::Async::Storage is the orchestration layer for the asynchronous bridge. Unlike standard DBIx::Class::Storage::DBI, this class does not connect to the database directly. Instead, it manages the life-cycle of a background worker pool.

CONSTRUCTOR

new

my $storage = DBIx::Class::Async::Storage->new(
    schema   => $schema,
    async_db => $bridge_engine,
);

async_db is the internal engine (the 'bridge') that handles communication with the worker processes.

This constructor automatically weakens the reference to the parent schema to prevent circular reference leaks, ensuring that worker processes are correctly reaped when the schema object goes out of scope.

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 this architecture, the Parent process must not touch the database. This method always returns undef. Any code relying on $schema->storage->dbh will fail, which is intentional to prevent accidental blocking I/O in the main event loop.

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;

Signals the background worker pool to shut down. This is an asynchronous-safe cleanup:

1. It stops the worker processes.

2. It closes IPC pipes or sockets used by the bridge.

3. It clears the local query cache.

INTERNAL NOTES

This class implements a specialised "Proxy Storage" layer for the DBIx::Class::Async ecosystem. Unlike standard DBIC storage, this layer does not hold a local database connection. Instead, it acts as a Command Dispatcher.

Key Architectural Differences:

  • Proxied Execution

    SQL generation and execution occur within persistent background workers via IO::Async::Function.

  • Asynchronous Transactions

    Transactional integrity is maintained by routing related commands (txn_do, txn_batch) to a single dedicated worker to ensure atomicity.

  • Distributed State

    Database handle management is isolated to the worker process, utilising

    InactiveDestroy to prevent handle leakage or cross-process corruption.

  • Compatibility Shim

    It provides enough of the DBIx::Class::Storage API to allow standard ResultSets to function while redirecting all I/O to the IO::Async event loop.

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.