Author image Binary.com
and 1 contributors

NAME

Data::CouchDB - CouchDB document management

VERSION

Version 0.14

NAME

Data::CouchDB

SYNOPSYS

    my $couchdb = Data::CouchDB->new(
        replica_host => 'localhost',
        replica_port => 5432,
        master_host  => 'localhost',
        master_port  => 5432,
        couch        => 'testdb',
    );

DESCRIPTION

This class represents couchdb as a datasource.

ATTRIBUTES

db

db with which to operate.

couchdb

password for "couchdb" user

replica_host

name of the host to read from.

replica_port

port number in replica_host through which we can read.

replica_protocol

 protcol used to read.

master_host

name of the host to write to

master_port

port number in master_host through which we can write.

master_protocol

protocol used to write.

replica

The internal ds used to read from couchdb

master

The internal ds used to write to couchdb

ua

Optionally passed ua(user_agent). If not passed the couchdb's default ua is used.

METHODS

document

Get or set a couch document.

Usage, To get a document $couchdb->document($doc_id);

    To set a document
        $couchdb->document($doc_id, $data);

        $data is a HashRef

view

Query a couchdb view

Usage, Without Parameters $couchdb->view($db, $viewname);

    With Parameters
        $couchdb->view($db, $viewname, $parameters);

        $parameters is a HashRef

document_present

A syntatic sugar to check if a document

Usage, if ($couchdb->document_present($doc_id)) { .... }

Throws, Nothing

Returns, 1 - if document is found. undef - if document is not found.

create_document

Creates a couch document

Usage, my $doc_id = $couchdb->create_document($doc_id);

delete_document

Deletes a couch document

Usage, $couchdb->delete_document($doc_id);

create_database

Creates a CouchDB Database.

Usage, $couchdb->create_database();

can_read

Confirms that you can read from this couchdb

Usage, if($couchdb->can_read) { ... }

Returns, 1 - can read undef - otherwise

can_write

Confirms that you can write to this couchdb

Usage, if($couchdb->can_write) { ... }

Returns, 1 - can write undef - otherwise

AUTHOR

Binary.com, <support at binary.com>

BUGS

Please report any bugs or feature requests to bug-data-couchdb at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-CouchDB. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Data::CouchDB

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2015 Binary.com.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.