Data::Chronicle::Writer - Provides writing to an efficient data storage for volatile and time-based data
This module contains helper methods which can be used to store and retrieve information on an efficient storage with below properties:
It is assumed that data to be stored are time-based meaning they change over time and the latest version is most important for us.
The module uses Redis cache to provide efficient data storage and retrieval.
In addition to caching every incoming data, it is also stored in PostgreSQL for future retrieval.
This modules hides all the details about distribution, caching, database structure and ... from developer. He only needs to call a method to save data and another method to retrieve it. All the underlying complexities are handled by the module.
my $d = get_some_log_data(); my $chronicle_w = Data::Chronicle::Writer->new( cache_writer => $writer, dbic => $dbic, ttl => 86400); my $chronicle_r = Data::Chronicle::Reader->new( cache_reader => $reader, dbic => $dbic); #store data into Chronicle - each time we call `set` it will also store #a copy of the data for historical data retrieval $chronicle_w->set("log_files", "syslog", $d); #retrieve latest data stored for syslog under log_files category my $dt = $chronicle_r->get("log_files", "syslog"); #find historical data for `syslog` at given point in time my $some_old_data = $chronicle_r->get_for("log_files", "syslog", $epoch1);
If a TTL value is provided when constructing the instance, this will be used as the expiry time for the data.
Expiry time is not currently recorded in the PostgreSQL database backend - it is only used for the cache layer.
This represents the seconds until expiry, and default is undef, meaning that keys will not expire.
undef
Will invoke
$cache_writer->publish("$category::$name1", $value);
if set to true. This is useful, if to provide redis or postgres notificaitons on new data.
Default value: 0 (false)
Example:
$chronicle_writer->set("category1", "name1", $value1);
Store a piece of data "value1" under key "category1::name1" in Pg and Redis. Will publish "category1::name1" in Redis if publish_on_set is true.
publish_on_set
$chronicle_writer->mset([["category1", "name1", $value1], ["category2, "name2", $value2], ...]);
Store a piece of data "value1" under key "category1::name1", "category2::name2", etc in Pg and Redis. Will publish "category1::name1", "category2::name2", etc in Redis if publish_on_set is true.
$chronicle_writer->subscribe("category1", "name1", $code_ref);
$chronicle_writer->unsubscribe("category1", "name1", $code_ref);
Binary.com, <support at binary.com>
<support at binary.com>
Please report any bugs or feature requests to bug-data-chronicle at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Chronicle. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-data-chronicle at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Data::Chronicle::Writer
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Data-Chronicle
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Data-Chronicle
CPAN Ratings
http://cpanratings.perl.org/d/Data-Chronicle
Search CPAN
http://search.cpan.org/dist/Data-Chronicle/
To install Data::Chronicle, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Chronicle
CPAN shell
perl -MCPAN -e shell install Data::Chronicle
For more information on module installation, please visit the detailed CPAN module installation guide.