oracular (3) MongoDB.3pm.gz

Provided by: libmongodb-perl_2.2.2-2_all bug

NAME

       MongoDB - Official MongoDB Driver for Perl (EOL)

VERSION

       version v2.2.2

END OF LIFE NOTICE

       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
       <https://www.mongodb.com/blog/post/the-mongodb-perl-driver-is-being-deprecated> 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
       <https://github.com/mongodb/specifications/tree/master/source>.

SYNOPSIS

           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::GridFSBucket 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.

       MongoDB::ClientSession objects are generated from a MongoDB::MongoClient and allow for advanced
       consistency options, like causal-consistency and transactions.

   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");

SUPPORTED MONGODB VERSIONS

       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.

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.

       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.)

THREADS

       Per threads 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.

AUTHORS

       •   David Golden <david@mongodb.com>

       •   Rassi <rassi@mongodb.com>

       •   Mike Friedman <friedo@friedo.com>

       •   Kristina Chodorow <k.chodorow@gmail.com>

       •   Florian Ragwitz <rafl@debian.org>

CONTRIBUTORS

       •   Andrew Page <andrew@infosiftr.com>

       •   Andrey Khozov <avkhozov@gmail.com>

       •   Ashley Willis <ashleyw@cpan.org>

       •   Ask Bjørn Hansen <ask@develooper.com>

       •   Bernard Gorman <bernard.gorman@mongodb.com>

       •   Brendan W. McAdams <brendan@mongodb.com>

       •   Brian Moss <kallimachos@gmail.com>

       •   Casey Rojas <casey.j.rojas@gmail.com>

       •   Christian Hansen <chansen@cpan.org>

       •   Christian Sturm <kind@gmx.at>

       •   Christian Walde <walde.christian@googlemail.com>

       •   Colin Cyr <ccyr@sailingyyc.com>

       •   Danny Raetzsch <danny@paperskymedia.com>

       •   David Morrison <dmorrison@venda.com>

       •   David Nadle <david@nadle.com>

       •   David Steinbrunner <dsteinbrunner@pobox.com>

       •   David Storch <david.storch@mongodb.com>

       •   diegok <diego@freekeylabs.com>

       •   D. Ilmari Mannsåker <ilmari.mannsaker@net-a-porter.com>

       •   Eric Daniels <eric.daniels@mongodb.com>

       •   Finn Kempers (Shadowcat Systems Ltd) <toyou1995@gmail.com>

       •   Gerard Goossen <gerard@ggoossen.net>

       •   Glenn Fowler <cebjyre@cpan.org>

       •   Graham Barr <gbarr@pobox.com>

       •   Hao Wu <echowuhao@gmail.com>

       •   Harish Upadhyayula <hupadhyayula@dealersocket.com>

       •   Jason Carey <jason.carey@mongodb.com>

       •   Jason Toffaletti <jason@topsy.com>

       •   Johann Rolschewski <rolschewski@gmail.com>

       •   John A. Kunze <jak@ucop.edu>

       •   Joseph Harnish <bigjoe1008@gmail.com>

       •   Josh Matthews <joshua.matthews@mongodb.com>

       •   Joshua Juran <jjuran@metamage.com>

       •   J. Stewart <jstewart@langley.theshire>

       •   Kamil Slowikowski <kslowikowski@gmail.com>

       •   Ken Williams <kwilliams@cpan.org>

       •   Matthew Shopsin <matt.shopsin@mongodb.com>

       •   Matt S Trout <mst@shadowcat.co.uk>

       •   Michael Langner <langner@fch.de>

       •   Michael Rotmanov <rotmanov@sipgate.de>

       •   Mike Dirolf <mike@mongodb.com>

       •   Mohammad S Anwar <mohammad.anwar@yahoo.com>

       •   Nickola Trupcheff <n.trupcheff@gmail.com>

       •   Nigel Gregoire <nigelg@airg.com>

       •   Niko Tyni <ntyni@debian.org>

       •   Nuno Carvalho <mestre.smash@gmail.com>

       •   Orlando Vazquez <ovazquez@gmail.com>

       •   Othello Maurer <omaurer@venda.com>

       •   Pan Fan <nightsailer@gmail.com>

       •   Pavel Denisov <pavel.a.denisov@gmail.com>

       •   Rahul Dhodapkar <rahul@mongodb.com>

       •   Robert Sedlacek (Shadowcat Systems Ltd) <phaylon@cpan.org>

       •   Robin Lee <cheeselee@fedoraproject.org>

       •   Roman Yerin <kid@cpan.org>

       •   Ronald J Kimball <rkimball@pangeamedia.com>

       •   Ryan Chipman <ryan@ryanchipman.com>

       •   Slaven Rezic <slaven.rezic@idealo.de>

       •   Slaven Rezic <srezic@cpan.org>

       •   Stephen Oberholtzer <stevie@qrpff.net>

       •   Steve Sanbeg <stevesanbeg@buzzfeed.com>

       •   Stuart Watt <stuart@morungos.com>

       •   Thomas Bloor (Shadowcat Systems Ltd) <tbsliver@cpan.org>

       •   Tobias Leich <email@froggs.de>

       •   Uwe Voelker <uwe.voelker@xing.com>

       •   Wallace Reis <wallace@reis.me>

       •   Wan Bachtiar <sindbach@gmail.com>

       •   Whitney Jackson <whjackson@gmail.com>

       •   Xavier Guimard <x.guimard@free.fr>

       •   Xtreak <tirkarthi@users.noreply.github.com>

       •   Zhihong Zhang <zzh_621@yahoo.com>

       This software is Copyright (c) 2020 by MongoDB, Inc.

       This is free software, licensed under:

         The Apache License, Version 2.0, January 2004