Zing::Store::Pg - Postgres Storage
Postgres Storage Abstraction
use Test::DB::Postgres; use Zing::Encoder::Dump; use Zing::Store::Pg; my $testdb = Test::DB::Postgres->new; my $store = Zing::Store::Pg->new( client => $testdb->create->dbh, encoder => Zing::Encoder::Dump->new ); # $store->drop;
This package provides a Postgres-specific storage adapter for use with data persistence abstractions. The "client" attribute accepts a DBI object configured to connect to a DBD::Pg backend. The ZING_DBNAME environment variable can be used to specify the database name (defaults to "zing"). The ZING_DBHOST environment variable can be used to specify the database host (defaults to "localhost"). The ZING_DBPORT environment variable can be used to specify the database port (defaults to "5432"). The ZING_DBUSER environment variable can be used to specify the database username (defaults to "postgres"). The ZING_DBPASS environment variable can be used to specify the database password. The ZING_DBZONE environment variable can be used to specify the database table name (defaults to "entities").
ZING_DBNAME
ZING_DBHOST
ZING_DBPORT
ZING_DBUSER
ZING_DBPASS
ZING_DBZONE
This package inherits behaviors from:
Zing::Store
This package uses type constraints from:
Zing::Types
This package has the following attributes:
client(InstanceOf["DBI::db"])
This attribute is read-only, accepts (InstanceOf["DBI::db"]) values, and is optional.
(InstanceOf["DBI::db"])
This package implements the following methods:
decode(Str $data) : HashRef
The decode method decodes the JSON data provided and returns the data as a hashref.
# given: synopsis $store->decode('{"status"=>"ok"}');
drop(Str $key) : Int
The drop method removes (drops) the item from the datastore.
# given: synopsis $store->drop('zing:main:global:model:temp');
encode(HashRef $data) : Str
The encode method encodes and returns the data provided as JSON.
# given: synopsis $store->encode({ status => 'ok' });
keys(Str @keys) : ArrayRef[Str]
The keys method returns a list of keys under the namespace of the datastore or provided key.
# given: synopsis my $keys = $store->keys('zing:main:global:model:temp');
# given: synopsis $store->send('zing:main:global:model:temp', { status => 'ok' }); my $keys = $store->keys('zing:main:global:model:temp');
lpull(Str $key) : Maybe[HashRef]
The lpull method pops data off of the top of a list in the datastore.
# given: synopsis $store->lpull('zing:main:global:model:items');
# given: synopsis $store->rpush('zing:main:global:model:items', { status => 'ok' }); $store->lpull('zing:main:global:model:items');
lpush(Str $key, HashRef $val) : Int
The lpush method pushed data onto the top of a list in the datastore.
# given: synopsis $store->lpush('zing:main:global:model:items', { status => '1' });
# given: synopsis $store->lpush('zing:main:global:model:items', { status => '0' }); $store->lpush('zing:main:global:model:items', { status => '0' });
recv(Str $key) : Maybe[HashRef]
The recv method fetches and returns data from the datastore by its key.
# given: synopsis $store->recv('zing:main:global:model:temp');
# given: synopsis $store->send('zing:main:global:model:temp', { status => 'ok' }); $store->recv('zing:main:global:model:temp');
rpull(Str $key) : Maybe[HashRef]
The rpull method pops data off of the bottom of a list in the datastore.
# given: synopsis $store->rpull('zing:main:global:model:items');
# given: synopsis $store->rpush('zing:main:global:model:items', { status => 1 }); $store->rpush('zing:main:global:model:items', { status => 2 }); $store->rpull('zing:main:global:model:items');
rpush(Str $key, HashRef $val) : Int
The rpush method pushed data onto the bottom of a list in the datastore.
# given: synopsis $store->rpush('zing:main:global:model:items', { status => 'ok' });
# given: synopsis $store->rpush('zing:main:global:model:items', { status => 'ok' }); $store->rpush('zing:main:global:model:items', { status => 'ok' });
send(Str $key, HashRef $val) : Str
The send method commits data to the datastore with its key and returns truthy.
# given: synopsis $store->send('zing:main:global:model:temp', { status => 'ok' });
size(Str $key) : Int
The size method returns the size of a list in the datastore.
# given: synopsis my $size = $store->size('zing:main:global:model:items');
# given: synopsis $store->rpush('zing:main:global:model:items', { status => 'ok' }); my $size = $store->size('zing:main:global:model:items');
slot(Str $key, Int $pos) : Maybe[HashRef]
The slot method returns the data from a list in the datastore by its index.
# given: synopsis my $model = $store->slot('zing:main:global:model:items', 0);
# given: synopsis $store->rpush('zing:main:global:model:items', { status => 'ok' }); my $model = $store->slot('zing:main:global:model:items', 0);
test(Str $key) : Int
The test method returns truthy if the specific key (or datastore) exists.
# given: synopsis $store->rpush('zing:main:global:model:items', { status => 'ok' }); $store->test('zing:main:global:model:items');
# given: synopsis $store->drop('zing:main:global:model:items'); $store->test('zing:main:global:model:items');
Al Newkirk, awncorp@cpan.org
awncorp@cpan.org
Copyright (C) 2011-2019, Al Newkirk, et al.
This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated in the "license file".
Wiki
Project
Initiatives
Milestones
Contributing
Issues
To install Zing::Store::Pg, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Zing::Store::Pg
CPAN shell
perl -MCPAN -e shell install Zing::Store::Pg
For more information on module installation, please visit the detailed CPAN module installation guide.