NAME

Starch::Store::DBI - Starch storage backend using DBI.

SYNOPSIS

    my $starch = Starch->new(
        store => {
            class => '::DBI',
            dbh => [
                $dsn,
                $username,
                $password,
                { RaiseError => 1 },
            ],
            table => 'my_states',
        },
    );

DESCRIPTION

This Starch store uses DBI to set and get state data.

Consider using Starch::Store::DBIx::Connector instead of this store as DBIx::Connector provides superior re-connection and transaction handling capabilities.

The table in your database should contain three columns. This is the SQLite syntax for creating a compatible table which you can modify to work for your particular database's syntax:

    CREATE TABLE starch_states (
        key TEXT NOT NULL PRIMARY KEY,
        data TEXT NOT NULL,
        expiration INTEGER NOT NULL
    )

REQUIRED ARGUMENTS

dbh

This must be set to either array ref arguments for "connect" in DBI or a pre-built object (often retrieved using a method proxy).

When configuring Starch from static configuration files using a method proxy is a good way to link your existing DBI object constructor in with Starch so that starch doesn't build its own.

OPTIONAL ARGUMENTS

serializer

A Data::Serializer::Raw for serializing the state data for storage in the "data_column". Can be specified as string containing the serializer name, a hash ref of Data::Serializer::Raw arguments, or as a pre-created Data::Serializer::Raw object. Defaults to JSON.

Consider using the JSON::XS or Sereal serializers for speed.

Sereal will likely be the fastest and produce the most compact data.

table

The table name where states are stored in the database. Defaults to starch_states.

key_column

The column in the "table" where the state ID is stored. Defaults to key.

data_column

The column in the "table" which will hold the state data. Defaults to data.

expiration_column

The column in the "table" which will hold the epoch time when the state should be expired. Defaults to expiration.

ATTRIBUTES

insert_sql

The SQL used to create state data.

update_sql

The SQL used to update state data.

exists_sql

The SQL used to confirm whether state data already exists.

select_sql

The SQL used to retrieve state data.

delete_sql

The SQL used to delete state data.

METHODS

set

Set "set" in Starch::Store.

get

Set "get" in Starch::Store.

remove

Set "remove" in Starch::Store.

SUPPORT

Please submit bugs and feature requests to the Starch-Store-DBI GitHub issue tracker:

https://github.com/bluefeet/Starch-Store-DBI/issues

AUTHOR

Aran Clary Deltac <bluefeet@gmail.com>

ACKNOWLEDGEMENTS

Thanks to ZipRecruiter for encouraging their employees to contribute back to the open source ecosystem. Without their dedication to quality software development this distribution would not exist.

LICENSE

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

cpanm Starch::Store::DBI

perl -MCPAN -e shell
install Starch::Store::DBI