| MongoDB::Connection - A connection to a Mongo server |
get_database($name)send($str)recv(\%info)
MongoDB::Connection - A connection to a Mongo server
The MongoDB::Connection class creates a connection to the MongoDB server.
By default, it connects to a single server running on the local machine listening on the default port:
# connects to localhost:27017
my $connection = MongoDB::Connection->new;
It can connect to a database server running anywhere, though:
my $connection = MongoDB::Connection->new(host => 'example.com:12345');
See the host section for more options for connecting to MongoDB.
Core documentation on connections: http://dochub.mongodb.org/core/connections.
Server or servers to connect to. Defaults to mongodb://localhost:27017.
To connect to more than one database server, use the format:
mongodb://host1[:port1][,host2[:port2],...[,hostN[:portN]]]
An arbitrary number of hosts can be specified.
The connect method will return success if it can connect to at least one of the hosts listed. If it cannot connect to any hosts, it will die.
If a port is not specified for a given host, it will default to 27017. For
example, to connecting to localhost:27017 and localhost:27018:
$conn = MongoDB::Connection->new("host" => "mongodb://localhost,localhost:27018");
This will succeed if either localhost:27017 or localhost:27018 are available.
The connect method will also try to determine who is master if more than one server is given. It will try the hosts in order from left to right. As soon as one of the hosts reports that it is master, the connect will return success. If no hosts report themselves as masters, the connect will die, reporting that it could not find a master.
If username and password are given, success is conditional on being able to log
into the database as well as connect. By default, the driver will attempt to
authenticate with the admin database. If a different database is specified
using the db_name property, it will be used instead.
Only supported in MongoDB server version 1.5+.
The default number of mongod slaves to replicate a change to before reporting success for all operations on this collection.
Defaults to 1 (just the current master).
If this is not set, a safe insert will wait for 1 machine (the master) to ack the operation, then return that it was successful. If the master has slaves, the slaves may not yet have a record of the operation when success is reported. Thus, if the master goes down, the slaves will never get this operation.
To prevent this, you can set w to a value greater than 1. If you set w to
<N>, it means that safe operations must have succeeded on the master and N-1
slaves before the client is notified that the operation succeeded. If the
operation did not succeed or could not be replicated to N-1 slaves within the
timeout (see wtimeout below), the safe operation will fail (croak).
Some examples of a safe insert with w set to 3 and wtimeout set to 100:
The number of milliseconds an operation should wait for w slaves to replicate
it.
Defaults to 1000 (1 second).
See w above for more information.
Boolean indicating whether or not to reconnect if the connection is
interrupted. Defaults to 1.
Boolean indication whether or not to connect automatically on object
construction. Defaults to 1.
Connection timeout in milliseconds. Defaults to 20000.
Username for this connection. Optional. If this and the password field are set, the connection will attempt to authenticate on connection/reconnection.
Password for this connection. Optional. If this and the username field are set, the connection will attempt to authenticate on connection/reconnection.
Database to authenticate on for this connection. Optional. If this, the username, and the password fields are set, the connection will attempt to authenticate against this database on connection/reconnection. Defaults to "admin".
This will cause all queries (including find_ones and run_commands) to die
after this period if the database has not responded.
This value is in milliseconds and defaults to the value of timeout in the MongoDB::Cursor manpage.
A value of -1 will cause the driver to wait forever for responses and 0 will cause it to die immediately.
This value overrides timeout in the MongoDB::Cursor manpage.
Use host instead.
Port to use when connecting. Defaults to 27017.
Use host instead.
Paired connection host to connect to. Can be master or slave.
Use host instead.
Port to use when connecting to left_host. Defaults to 27017.
Use host instead.
Paired connection host to connect to. Can be master or slave.
Use host instead.
Port to use when connecting to right_host. Defaults to 27017.
$connection->connect;
Connects to the mongo server. Called automatically on object construction if
auto_connect is true.
my @dbs = $connection->database_names;
Lists all databases on the mongo server.
get_database($name)
my $database = $connection->get_database('foo');
Returns a the MongoDB::Database manpage instance for database with the given $name.
$master = $connection->find_master
Determines which host of a paired connection is master. Does nothing for a non-paired connection. This need never be invoked by a user, it is called automatically by internal functions. Returns the index of the master connection in the list of connections or -1 if it cannot be determined.
$connection->authenticate('foo', 'username', 'secret');
Attempts to authenticate for use of the $dbname database with $username
and $password. Passwords are expected to be cleartext and will be
automatically hashed before sending over the wire, unless $is_digest is
true, which will assume you already did the hashing on yourself.
See also the core documentation on authentication: http://dochub.mongodb.org/core/authentication.
send($str)
my ($insert, $ids) = MongoDB::write_insert('foo.bar', [{name => "joe", age => 40}]);
$conn->send($insert);
Low-level function to send a string directly to the database. Use the MongoDB::write_insert manpage, the MongoDB::write_update manpage, the MongoDB::write_remove manpage, or the MongoDB::write_query manpage to create a valid string.
recv(\%info)
my $cursor = $conn->recv({ns => "foo.bar"});
Low-level function to receive a response from the database. Returns a
MongoDB::Cursor. At the moment, the only required field for $info is
"ns", although "request_id" is likely to be required in the future. The
$info hash will be automatically created for you by the MongoDB::write_query manpage.
Kristina Chodorow <kristina@mongodb.org>
| MongoDB::Connection - A connection to a Mongo server |