VERSION
version v1.2.3SYNOPSIS
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 });
DESCRIPTION
This is the official Perl driver for MongoDB <http://www.mongodb.com>. 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 <http://docs.mongodb.org/manual/contents/>
- MongoDB CRUD Introduction <http://docs.mongodb.org/manual/core/crud-introduction/>
- MongoDB Data Modeling Introductions <http://docs.mongodb.org/manual/core/data-modeling-introduction/>
To get started with the Perl driver, see these pages:
- MongoDB Perl Driver Tutorial
- MongoDB Perl Driver Examples
Extensive documentation and support resources are available via the MongoDB community website <http://www.mongodb.org/>.
USAGE
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 MongoDB::MongoClient object to connect to a MongoDB deployment. From that client object, you can get a MongoDB::Database object for interacting with a specific database.
From a database object, you can get a MongoDB::Collection object for CRUD operations on that specific collection, or a MongoDB::GridFS 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.
Error handling
Unless otherwise documented, errors result in fatal exceptions. See MongoDB::Error for a list of exception classes and error code constants.METHODS
connect
$client = MongoDB->connect(); # localhost, port 27107 $client = MongoDB->connect($host_uri); $client = MongoDB->connect($host_uri, $options);
This function returns a MongoDB::MongoClient 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 MongoDB::Error 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");
SEMANTIC VERSIONING SCHEME
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.
ENVIRONMENT VARIABLES
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.SUPPORT
Bugs / Feature Requests
Please report any bugs or feature requests through the issue tracker at <https://jira.mongodb.org/browse/PERL>. You will be notified automatically of any progress on your issue.Source Code
This is open source software. The code repository is available for public review and contribution under the terms of the license. <https://github.com/mongodb/mongo-perl-driver>
git clone https://github.com/mongodb/mongo-perl-driver.git
AUTHORS
- David Golden <[email protected]>
- Mike Friedman <[email protected]>
- Kristina Chodorow <[email protected]>
- Florian Ragwitz <[email protected]>
CONTRIBUTORS
- Andrew Page <[email protected]>
- Andrey Khozov <[email protected]>
- Ashley Willis <[email protected]>
- Ask Bjørn Hansen <[email protected]>
- Bernard Gorman <[email protected]>
- Brendan W. McAdams <[email protected]>
- Casey Rojas <[email protected]>
- Christian Hansen <[email protected]>
- Christian Sturm <[email protected]>
- Christian Walde <[email protected]>
- Colin Cyr <[email protected]>
- Danny Raetzsch <[email protected]>
- David Morrison <[email protected]>
- David Nadle <[email protected]>
- David Steinbrunner <[email protected]>
- David Storch <[email protected]>
- D. Ilmari Mannsåker <[email protected]>
- Eric Daniels <[email protected]>
- Gerard Goossen <[email protected]>
- Glenn Fowler <[email protected]>
- Graham Barr <[email protected]>
- Hao Wu <[email protected]>
- Jason Carey <[email protected]>
- Jason Toffaletti <[email protected]>
- Johann Rolschewski <[email protected]>
- Joseph Harnish <[email protected]>
- Josh Matthews <[email protected]>
- Joshua Juran <[email protected]>
- J. Stewart <[email protected]>
- Kamil Slowikowski <[email protected]>
- Ken Williams <[email protected]>
- Matthew Shopsin <[email protected]>
- Michael Langner <[email protected]>
- Michael Rotmanov <[email protected]>
- Mike Dirolf <[email protected]>
- Mohammad S Anwar <[email protected]>
- Nickola Trupcheff <[email protected]>
- Nigel Gregoire <[email protected]>
- Niko Tyni <[email protected]>
- Nuno Carvalho <[email protected]>
- Orlando Vazquez <[email protected]>
- Othello Maurer <[email protected]>
- Pan Fan <[email protected]>
- Rahul Dhodapkar <[email protected]>
- Robin Lee <[email protected]>
- Roman Yerin <[email protected]>
- Ronald J Kimball <[email protected]>
- Ryan Chipman <[email protected]>
- Stephen Oberholtzer <[email protected]>
- Steve Sanbeg <[email protected]>
- Stuart Watt <[email protected]>
- Uwe Voelker <[email protected]>
- Whitney Jackson <[email protected]>
- Xtreak <[email protected]>
- Zhihong Zhang <[email protected]>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2016 by MongoDB, Inc..This is free software, licensed under:
The Apache License, Version 2.0, January 2004