MongoDB - Official MongoDB Driver for Perl (EOL)
version v2.2.2
Version v2.2.0 was the final feature release of the MongoDB Perl driver and
version v2.2.2 is the final patch release.
As of August 13, 2020, the MongoDB Perl driver and related libraries have
reached end of life and are no longer supported by MongoDB. See the
August 2019 deprecation notice
for rationale.
If members of the community wish to continue development, they are welcome
to fork the code under the terms of the Apache 2 license and release it
under a new namespace. Specifications and test files for MongoDB drivers
and libraries are published in an open repository:
mongodb/specifications.
use MongoDB;
my $client = MongoDB->connect('mongodb://localhost');
my $collection = $client->ns('foo.bar'); # database foo, collection bar
my $result = $collection->insert_one({ some => 'data' });
my $data = $collection->find_one({ _id => $result->inserted_id });
This is the official Perl driver for MongoDB.
MongoDB is an open-source document database that provides high performance,
high availability, and easy scalability.
A MongoDB server (or multi-server deployment) hosts a number of databases. A
database holds a set of collections. A collection holds a set of documents. A
document is a set of key-value pairs. Documents have dynamic schema. Using dynamic
schema means that documents in the same collection do not need to have the same
set of fields or structure, and common fields in a collection's documents may
hold different types of data.
Here are some resources for learning more about MongoDB:
-
MongoDB Manual
-
MongoDB CRUD Introduction
-
MongoDB Data Modeling Introductions
To get started with the Perl driver, see these pages:
Extensive documentation and support resources are available via the
MongoDB community website.
The MongoDB driver is organized into a set of classes representing
different levels of abstraction and functionality.
As a user, you first create and configure a the MongoDB::MongoClient manpage object
to connect to a MongoDB deployment. From that client object, you can get a
the MongoDB::Database manpage object for interacting with a specific database.
From a database object, you can get a the MongoDB::Collection manpage object for
CRUD operations on that specific collection, or a the MongoDB::GridFSBucket manpage
object for working with an abstract file system hosted on the database.
Each of those classes may return other objects for specific features or
functions.
See the documentation of those classes for more details or the
MongoDB Perl Driver Tutorial for an example.
the MongoDB::ClientSession manpage objects are generated from a
the MongoDB::MongoClient manpage and allow for advanced consistency options, like
causal-consistency and transactions.
Unless otherwise documented, errors result in fatal exceptions. See
the MongoDB::Error manpage for a list of exception classes and error code
constants.
$client = MongoDB->connect(); # localhost, port 27107
$client = MongoDB->connect($host_uri);
$client = MongoDB->connect($host_uri, $options);
This function returns a the MongoDB::MongoClient manpage object. The first parameter is
used as the host argument and must be a host name or connection string URI. The second argument is
optional. If provided, it must be a hash reference of constructor arguments
for MongoDB::MongoClient::new.
If an error occurs, a the MongoDB::Error manpage object will be thrown.
NOTE: To connect to a replica set, a replica set name must be provided.
For example, if the set name is "setA":
$client = MongoDB->connect("mongodb://example.com/?replicaSet=setA");
The driver has been tested against MongoDB versions 2.6 through 4.2. All
features of these versions are supported, except for field-level
encryption. The driver may work with future versions of MongoDB, but will
not include support for new MongoDB features and should be thoroughly
tested within applications before deployment.
Starting with MongoDB v1.0.0, the driver reverts to the more familiar
three-part version-tuple numbering scheme used by both Perl and MongoDB:
vX.Y.Z
-
X will be incremented for incompatible API changes.
-
Even-value increments of
Y indicate stable releases with new functionality. Z will be incremented for bug fixes.
-
Odd-value increments of
Y indicate unstable (``development'') releases that should not be used in production. Z increments have no semantic meaning; they indicate only successive development releases.
See the Changes file included with releases for an indication of the nature of
changes involved.
If the PERL_MONGO_WITH_ASSERTS environment variable is true before the
MongoDB module is loaded, then its various classes will be generated with
internal type assertions enabled. This has a severe performance cost and
is not recommended for production use. It may be useful in diagnosing
bugs.
If the PERL_MONGO_NO_DEP_WARNINGS environment variable is true, then
deprecated methods will not issue warnings when used. (Normally, a
deprecation warning is issued once per call-site for deprecated methods.)
Per the threads manpage documentation, use of Perl threads is discouraged by the
maintainers of Perl and the MongoDB Perl driver does not test or provide support
for use with threads.
This software is Copyright (c) 2020 by MongoDB, Inc.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
|