עידו פרלמוטר (Ido Perlmuter) > MorboDB-0.001001 > MorboDB::Database

Download:
MorboDB-0.001001.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.001001   Source   Latest Release: MorboDB-1.000000

NAME ^

MorboDB::Database - A MorboDB database

VERSION ^

version 0.001001

SYNOPSIS ^

        use MorboDB;

        my $morbodb = MorboDB->new;

        my $db = $morbodb->get_database('my_database');
        my $coll = $db->get_collection('articles');
        # use $coll as described in MorboDB::Collection

DESCRIPTION ^

This module is the API for handling databases in a MorboDB container.

ATTRIBUTES ^

name

The name of the database. String, required.

OBJECT METHODS ^

collection_names()

Returns a list with the names of all collections in the database.

get_collection( $name )

Returns a MorboDB::Collection object with the given name. There are two ways to call this method:

        my $db = $morbodb->get_database('users');
        my $coll = $db->get_collection('users');
        # or
        my $coll = $db->users; # just like MongoDB

Like MongoDB, you can create a child-collection (purely semantics really) by using dots, so 'users.admins' can be thought of as a child collection of users. There are two ways to get 'users.admins':

        my $admins = $db->get_collection('users.admins');
        # or
        my $admins = $db->users->admins; # just like MongoDB

get_gridfs()

Not implemented. Doesn't do anything here except returning false.

drop()

Drops the database, removes any collections it had and data they had.

last_error()

Not implemented. Doesn't do anything here except returning false.

run_command()

Not implemented. Doesn't do anything here except returning false.

eval()

Not implemented. Doesn't do anything here except returning false.

DIAGNOSTICS ^

You must provide the name of the collection to get.

This error is returned by the get_collection() method when you do not provide it with the name of the database you want to get/create.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-MorboDB@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MorboDB.

SEE ALSO ^

MongoDB::Database.

AUTHOR ^

Ido Perlmuter <ido@ido50.net>

LICENSE AND COPYRIGHT ^

Copyright (c) 2011, Ido Perlmuter ido@ido50.net.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either version 5.8.1 or any later version. See perlartistic and perlgpl.

The full text of the license can be found in the LICENSE file included with this module.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: