MongoDB - phpMan

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-depr
    ecated> 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 AT mongodb.com>

    *   Rassi <rassi AT mongodb.com>

    *   Mike Friedman <friedo AT friedo.com>

    *   Kristina Chodorow <k.chodorow AT gmail.com>

    *   Florian Ragwitz <rafl AT debian.org>

CONTRIBUTORS
    *   Andrew Page <andrew AT infosiftr.com>

    *   Andrey Khozov <avkhozov AT gmail.com>

    *   Ashley Willis <ashleyw AT cpan.org>

    *   Ask Bjørn Hansen <ask AT develooper.com>

    *   Bernard Gorman <bernard.gorman AT mongodb.com>

    *   Brendan W. McAdams <brendan AT mongodb.com>

    *   Brian Moss <kallimachos AT gmail.com>

    *   Casey Rojas <casey.j.rojas AT gmail.com>

    *   Christian Hansen <chansen AT cpan.org>

    *   Christian Sturm <kind AT gmx.at>

    *   Christian Walde <walde.christian AT googlemail.com>

    *   Colin Cyr <ccyr AT sailingyyc.com>

    *   Danny Raetzsch <danny AT paperskymedia.com>

    *   David Morrison <dmorrison AT venda.com>

    *   David Nadle <david AT nadle.com>

    *   David Steinbrunner <dsteinbrunner AT pobox.com>

    *   David Storch <david.storch AT mongodb.com>

    *   diegok <diego AT freekeylabs.com>

    *   D. Ilmari Mannsåker <ilmari.mannsaker AT net-a-porter.com>

    *   Eric Daniels <eric.daniels AT mongodb.com>

    *   Finn Kempers (Shadowcat Systems Ltd) <toyou1995 AT gmail.com>

    *   Gerard Goossen <gerard AT ggoossen.net>

    *   Glenn Fowler <cebjyre AT cpan.org>

    *   Graham Barr <gbarr AT pobox.com>

    *   Hao Wu <echowuhao AT gmail.com>

    *   Harish Upadhyayula <hupadhyayula AT dealersocket.com>

    *   Jason Carey <jason.carey AT mongodb.com>

    *   Jason Toffaletti <jason AT topsy.com>

    *   Johann Rolschewski <rolschewski AT gmail.com>

    *   John A. Kunze <jak AT ucop.edu>

    *   Joseph Harnish <bigjoe1008 AT gmail.com>

    *   Josh Matthews <joshua.matthews AT mongodb.com>

    *   Joshua Juran <jjuran AT metamage.com>

    *   J. Stewart <jstewart AT langley.theshire>

    *   Kamil Slowikowski <kslowikowski AT gmail.com>

    *   Ken Williams <kwilliams AT cpan.org>

    *   Matthew Shopsin <matt.shopsin AT mongodb.com>

    *   Matt S Trout <mst AT shadowcat.uk>

    *   Michael Langner <langner AT fch.de>

    *   Michael Rotmanov <rotmanov AT sipgate.de>

    *   Mike Dirolf <mike AT mongodb.com>

    *   Mohammad S Anwar <mohammad.anwar AT yahoo.com>

    *   Nickola Trupcheff <n.trupcheff AT gmail.com>

    *   Nigel Gregoire <nigelg AT airg.com>

    *   Niko Tyni <ntyni AT debian.org>

    *   Nuno Carvalho <mestre.smash AT gmail.com>

    *   Orlando Vazquez <ovazquez AT gmail.com>

    *   Othello Maurer <omaurer AT venda.com>

    *   Pan Fan <nightsailer AT gmail.com>

    *   Pavel Denisov <pavel.a.denisov AT gmail.com>

    *   Rahul Dhodapkar <rahul AT mongodb.com>

    *   Robert Sedlacek (Shadowcat Systems Ltd) <phaylon AT cpan.org>

    *   Robin Lee <cheeselee AT fedoraproject.org>

    *   Roman Yerin <kid AT cpan.org>

    *   Ronald J Kimball <rkimball AT pangeamedia.com>

    *   Ryan Chipman <ryan AT ryanchipman.com>

    *   Slaven Rezic <slaven.rezic AT idealo.de>

    *   Slaven Rezic <srezic AT cpan.org>

    *   Stephen Oberholtzer <stevie AT qrpff.net>

    *   Steve Sanbeg <stevesanbeg AT buzzfeed.com>

    *   Stuart Watt <stuart AT morungos.com>

    *   Thomas Bloor (Shadowcat Systems Ltd) <tbsliver AT cpan.org>

    *   Tobias Leich <email AT froggs.de>

    *   Uwe Voelker <uwe.voelker AT xing.com>

    *   Wallace Reis <wallace AT reis.me>

    *   Wan Bachtiar <sindbach AT gmail.com>

    *   Whitney Jackson <whjackson AT gmail.com>

    *   Xavier Guimard <x.guimard AT free.fr>

    *   Xtreak <tirkarthi AT users.com>

    *   Zhihong Zhang <zzh_621 AT yahoo.com>

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

    This is free software, licensed under:

      The Apache License, Version 2.0, January 2004