NAME¶

Catalyst::Plugin::Session::Store::DBIC - Store your sessions via DBIx::Class

SYNOPSIS¶

    # Create a table in your database for sessions
    CREATE TABLE sessions (
        id           CHAR(72) PRIMARY KEY,
        session_data TEXT,
        expires      INTEGER
    );
    # Create the corresponding table class
    package MyApp::Schema::Session;
    use base qw/DBIx::Class/;
    __PACKAGE__->load_components(qw/Core/);
    __PACKAGE__->table('sessions');
    __PACKAGE__->add_columns(qw/id session_data expires/);
    __PACKAGE__->set_primary_key('id');
    1;
    # In your application
    use Catalyst qw/Session Session::Store::DBIC Session::State::Cookie/;
    __PACKAGE__->config(
        # ... other items ...
        'Plugin::Session' => {
            dbic_class => 'DBIC::Session',  # Assuming MyApp::Model::DBIC
            expires    => 3600,
        },
    );
    # Later, in a controller action
    $c->session->{foo} = 'bar';

DESCRIPTION¶

This Catalyst::Plugin::Session storage module saves session data in your database via DBIx::Class. It's actually just a wrapper around Catalyst::Plugin::Session::Store::Delegate; if you need complete control over how your sessions are stored, you probably want to use that instead.

METHODS¶

CONFIGURATION¶

The following parameters should be placed in your application configuration under the "Plugin::Session" key.

SCHEMA¶

Your sessions table should contain the following columns:

    id           CHAR(72) PRIMARY KEY
    session_data TEXT
    expires      INTEGER

The "id" column should probably be 72 characters. It needs to handle the longest string that can be returned by "generate_session_id" in Catalyst::Plugin::Session, plus another eight characters for internal use. This is less than 72 characters when SHA-1 or MD5 is used, but SHA-256 will need all 72 characters.

The "session_data" column should be a long text field. Session data is encoded using MIME::Base64 before being stored in the database.

Note that MySQL "TEXT" fields only store 64 kB, so if your session data will exceed that size you'll want to use "MEDIUMTEXT", "MEDIUMBLOB", or larger. If you configure your DBIx::Class::ResultSource to include the size of the column, you will receive warnings for this problem:

    This session requires 1180 bytes of storage, but your database
    column 'session_data' can only store 200 bytes. Storing this
    session may not be reliable; increase the size of your data field

See "add_columns" in DBIx::Class::ResultSource for more information.

The "expires" column stores the future expiration time of the session. This may be null for per-user and flash sessions.

Note that you can change the column names using the "id_field", "data_field", and "expires_field" configuration parameters. However, the column types must match the above.

AUTHOR¶

Daniel Westermann-Clark <danieltwc@cpan.org>

ACKNOWLEDGMENTS¶

• Andy Grundman, for Catalyst::Plugin::Session::Store::DBI
• David Kamholz, for most of the testing code (from
  Catalyst::Plugin::Authentication::Store::DBIC)
• Yuval Kogman, for assistance in converting to
  Catalyst::Plugin::Session::Store::Delegate
• Jay Hannah, for tests and warning when session size
  exceeds DBIx::Class storage size.

COPYRIGHT¶

Copyright (c) 2006 - 2009 the Catalyst::Plugin::Session::Store::DBIC "AUTHOR" as listed above.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.