NAME
ABSTRACT
SYNOPSIS
DESCRIPTION
INHERITS
LIBRARIES
ATTRIBUTES
- encoder
METHODS
- args
- decode
- drop
- encode
- keys
- lpull
- lpush
- recv
- rpull
- rpush
- send
- size
- slot
- test
AUTHOR
LICENSE
PROJECT

NAME

Zing::Store - Storage Abstraction

ABSTRACT

Data Storage Abstraction

SYNOPSIS

  use Zing::Store;

  my $store = Zing::Store->new;

  # $store->drop;

DESCRIPTION

This package provides a data persistence interface to be implemented by data storage abstractions.

INHERITS

This package inherits behaviors from:

Zing::Entity

LIBRARIES

This package uses type constraints from:

Zing::Types

ATTRIBUTES

This package has the following attributes:

encoder

  encoder(Encoder)

This attribute is read-only, accepts (Encoder) values, and is optional.

METHODS

This package implements the following methods:

args

  args(Str $env) : (Any)

The args method parses strings with key/value data (typically from an environment variable) meant to be used in object construction.

args example #1

  # given: synopsis

  [$store->args('port=0001,debug=0')]

args example #2

  # given: synopsis

  [$store->args('ports=0001|0002,debug=0')]

decode

  decode(Str $data) : HashRef

The decode method should decode the data provided and returns the data as a hashref.

decode example #1

  # given: synopsis

  $store->decode('{ status => "ok" }');

  # e.g.
  # $ENV{ZING_ENCODER} # Zing::Encoder::Dump

drop

  drop(Str $key) : Int

The drop method should remove items from the datastore by key.

drop example #1

  # given: synopsis

  $store->drop('model');

encode

  encode(HashRef $data) : Str

The encode method should encode and return the data provided in a format suitable for the underlying storage mechanism.

encode example #1

  # given: synopsis

  $store->encode({ status => 'ok' });

keys

  keys(Str @keys) : ArrayRef[Str]

The keys method should return a list of keys under the namespace provided including itself.

keys example #1

  # given: synopsis

  my $keys = $store->keys('zing:main:global:model:temp');

lpull

  lpull(Str $key) : Maybe[HashRef]

The lpull method should pop data off of the top of a list in the datastore.

lpull example #1

  # given: synopsis

  $store->lpull('zing:main:global:model:items');

lpush

  lpush(Str $key) : Int

The lpush method should push data onto the top of a list in the datastore.

lpush example #1

  # given: synopsis

  # $store->rpush('zing:main:global:model:items', { status => '1' });
  # $store->rpush('zing:main:global:model:items', { status => '2' });

  $store->lpush('zing:main:global:model:items', { status => '0' });

recv

  recv(Str $key) : Maybe[HashRef]

The recv method should fetch and return data from the datastore by its key.

recv example #1

  # given: synopsis

  $store->recv('zing:main:global:model:temp');

rpull

  rpull(Str $key) : Maybe[HashRef]

The rpull method should pop data off of the bottom of a list in the datastore.

rpull example #1

  # given: synopsis

  $store->rpull('zing:main:global:model:items');

rpush

  rpush(Str $key, HashRef $val) : Int

The rpush method should push data onto the bottom of a list in the datastore.

rpush example #1

  # given: synopsis

  $store->rpush('zing:main:global:model:items', { status => 'ok' });

send

  send(Str $key, HashRef $val) : Str

The send method should commit data to the datastore with its key and return truthy (or falsy if not).

send example #1

  # given: synopsis

  $store->send('zing:main:global:model:temp', { status => 'ok' });

size

  size(Str $key) : Int

The size method should return the size of a list in the datastore.

size example #1

  # given: synopsis

  my $size = $store->size('zing:main:global:model:items');

slot

  slot(Str $key, Int $pos) : Maybe[HashRef]

The slot method should return the data from a list in the datastore by its position in the list.

slot example #1

  # given: synopsis

  my $model = $store->slot('zing:main:global:model:items', 0);

test

  test(Str $key) : Int

The test method should return truthy if the specific key exists in the datastore.

test example #1

  # given: synopsis

  # $store->rpush('zing:main:global:model:items', { status => 'ok' });

  $store->test('zing:main:global:model:items');

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

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".