connection¶

  $mango->on(connection => sub {
    my ($mango, $id) = @_;
    ...
  });

Emitted when a new connection has been established.

default_db¶

  my $name = $mango->default_db;
  $mango   = $mango->default_db('test');

Default database, defaults to "admin".

hosts¶

  my $hosts = $mango->hosts;
  $mango    = $mango->hosts([['localhost', 3000], ['localhost', 4000]]);

Servers to connect to, defaults to "localhost" and port 27017.

inactivity_timeout¶

  my $timeout = $mango->inactivity_timeout;
  $mango      = $mango->inactivity_timeout(15);

Maximum amount of time in seconds a connection can be inactive before getting closed, defaults to 0. Setting the value to 0 will allow connections to be inactive indefinitely.

ioloop¶

  my $loop = $mango->ioloop;
  $mango   = $mango->ioloop(Mojo::IOLoop->new);

Event loop object to use for blocking I/O operations, defaults to a Mojo::IOLoop object.

j¶

  my $j  = $mango->j;
  $mango = $mango->j(1);

Wait for all operations to have reached the journal, defaults to 0.

max_bson_size¶

  my $max = $mango->max_bson_size;
  $mango  = $mango->max_bson_size(16777216);

Maximum size for BSON documents in bytes, defaults to 16777216 (16MB).

max_connections¶

  my $max = $mango->max_connections;
  $mango  = $mango->max_connections(5);

Maximum number of connections to use for non-blocking operations, defaults to 5.

max_write_batch_size¶

  my $max = $mango->max_write_batch_size;
  $mango  = $mango->max_write_batch_size(1000);

Maximum number of write operations to batch together, defaults to 1000.

protocol¶

  my $protocol = $mango->protocol;
  $mango       = $mango->protocol(Mango::Protocol->new);

Protocol handler, defaults to a Mango::Protocol object.

w¶

  my $w  = $mango->w;
  $mango = $mango->w(2);

Wait for all operations to have reached at least this many servers, 1 indicates just primary, 2 indicates primary and at least one secondary, defaults to 1.

wtimeout¶

  my $timeout = $mango->wtimeout;
  $mango      = $mango->wtimeout(1);

Timeout for write propagation in milliseconds, defaults to 1000.

backlog¶

  my $num = $mango->backlog;

Number of queued operations that have not yet been assigned to a connection.

db¶

  my $db = $mango->db;
  my $db = $mango->db('test');

Build Mango::Database object for database, uses "default_db" if no name is provided. Note that the reference "mango" in Mango::Database is weakened, so the Mango object needs to be referenced elsewhere as well.

from_string¶

  $mango
    = $mango->from_string('mongodb://sri:s3cret@localhost:3000/test?w=2');

Parse configuration from connection string.

get_more¶

  my $reply = $mango->get_more($namespace, $return, $cursor);

Perform low level "GET_MORE" operation. You can also append a callback to perform operation non-blocking.

  $mango->get_more(($namespace, $return, $cursor) => sub {
    my ($mango, $err, $reply) = @_;
    ...
  });
  Mojo::IOLoop->start unless Mojo::IOLoop->is_running;

kill_cursors¶

  $mango->kill_cursors(@ids);

Perform low level "KILL_CURSORS" operation. You can also append a callback to perform operation non-blocking.

    $mango->kill_cursors(@ids => sub {
      my ($mango, $err) = @_;
      ...
    });
    Mojo::IOLoop->start unless Mojo::IOLoop->is_running;

new¶

  my $mango = Mango->new;
  my $mango = Mango->new('mongodb://sri:s3cret@localhost:3000/test?w=2');
  # Using TLS encryption
  my $mango = Mango->new('mongodb://127.0.0.1:27017', tls => 1,
    tls_cert => '/path/to/certificate.pem');

Construct a new Mango object and parse connection string with "from_string" if necessary.

Not that is is strongly recommended to build your Mango object inside a helper function like shown in the synopsis. This is because the Mango's object reference inside Mango::Database objects is weakened to avoid memory leaks. This means your Mango instance is quickly going to get undefined after you use the "db" method. So, use a helper to prevent that.

If a username and password are provided, Mango will try to authenticate using SCRAM-SHA1. Warning: this will require Authen::SCRAM which is not installed by default.

Any extra arguments given after the connection string will be passed to the "connect" method from Mojo::IOLoop::Client. To connect to a server using TLS, use the options "tls" (boolean), "tls_cert" and optionally "tls_ca".

query¶

  my $reply
    = $mango->query($namespace, $flags, $skip, $return, $query, $fields);

Perform low level "QUERY" operation. You can also append a callback to perform operation non-blocking.

  $mango->query(($namespace, $flags, $skip, $return, $query, $fields) => sub {
    my ($mango, $err, $reply) = @_;
    ...
  });
  Mojo::IOLoop->start unless Mojo::IOLoop->is_running;