File Coverage

blib/lib/Kelp/Module/MongoDB.pm

Criterion	Covered	Total	%
statement	4	6	66.6
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	6	8	75.0

package Kelp::Module::MongoDB;
use Kelp::Base 'Kelp::Module';
use MongoDB;

our $VERSION = '1.000';

sub build {
    my ( $self, %args ) = @_;
    my $mongodb = MongoDB::MongoClient->new(%args);
    $self->register( mongodb => $mongodb );
  }

1;

__END__

=head1 NAME

Kelp::Module::MongoDB - Use MongoDB within Kelp

=head1 DESCRIPTION

L<Kelp::Module::MongoDB> is a L<Kelp> plugin.

=head1 SYNOPSIS

First ...

    # conf/config.pl
  {
        modules      => ['MongoDB'],
        modules_init => {
            MongoDB => {
                host => 'localhost',           # example
                port => 27017,                 # example
            }
        }
    }

Then ...

    package MyApp;
    use Kelp::Base 'Kelp';

    sub some_route {
        my $self       = shift;
        my $db         = $self->mongodb->get_database('foodb');
        my $collection = $db->get_collection('bar');
        my $id         = $collection->insert({some => 'data'});
        my $data       = $collection->find_one({_id => $id});
    }



=head1 METHODS

This module registers only one method into the application: C<mongodb>.
It is an instance of a L<MongoDB> class.

=head1 AUTHOR

Adam Stokes E<lt>[e-mail]<gt>

=head1 COPYRIGHT

Copyright 2013- Adam Stokes

=head1 LICENSE

Licensed under the same terms as Perl.

=head1 SEE ALSO

L<Kelp>.

=cut