.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "MongoDB 3pm" .TH MongoDB 3pm "2014-10-09" "perl v5.20.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" MongoDB \- Official MongoDB Driver for Perl .SH "VERSION" .IX Header "VERSION" version v0.705.0.0 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use MongoDB; \& \& my $client = MongoDB::MongoClient\->new(host => \*(Aqlocalhost\*(Aq, port => 27017); \& my $database = $client\->get_database( \*(Aqfoo\*(Aq ); \& my $collection = $database\->get_collection( \*(Aqbar\*(Aq ); \& my $id = $collection\->insert({ some => \*(Aqdata\*(Aq }); \& my $data = $collection\->find_one({ _id => $id }); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is the official Perl driver for MongoDB. MongoDB is an open-source document database that provides high performance, high availability, and easy scalability. .PP A MongoDB server (or cluster) 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. 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. .PP Here are some resources for learning more about MongoDB: .IP "\(bu" 4 MongoDB Manual .IP "\(bu" 4 MongoDB \s-1CRUD\s0 Introduction .IP "\(bu" 4 MongoDB Data Modeling Introductions .PP For getting started with the Perl driver, see these pages: .IP "\(bu" 4 MongoDB Perl Driver Tutorial .IP "\(bu" 4 MongoDB Perl Driver Examples .PP Extensive documentation and support resources are available via the MongoDB community website . .SH "USAGE" .IX Header "USAGE" The MongoDB driver is organized into a set of classes representing different levels of abstraction and functionality. .PP As a user, you first create and configure a MongoDB::MongoClient object to connect to a MongoDB server (or cluster). From that client object, you can get a MongoDB::Database object for interacting with a specific database. .PP From a database object you can get a MongoDB::Collection object for \s-1CRUD\s0 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. .PP See the documentation of those classes for more details or the MongoDB Perl Driver Tutorial for an example. .SH "FUNCTIONS (DEPRECATED)" .IX Header "FUNCTIONS (DEPRECATED)" The following low-level functions are deprecated and will be removed in a future release. .IP "\(bu" 4 write_insert .IP "\(bu" 4 write_query .IP "\(bu" 4 write_update .IP "\(bu" 4 write_remove .IP "\(bu" 4 read_documents .SH "SEMANTIC VERSIONING SCHEME" .IX Header "SEMANTIC VERSIONING SCHEME" Starting with MongoDB v0.704.0.0, the driver will be using a modified semantic versioning scheme. .PP Versions will have a \f(CW\*(C`vX.Y.Z.N\*(C'\fR tuple scheme with the following properties: .IP "\(bu" 4 \&\f(CW\*(C`X\*(C'\fR will be incremented for incompatible \s-1API\s0 changes .IP "\(bu" 4 \&\f(CW\*(C`Y\*(C'\fR will be incremented for new functionality that is backwards compatible .IP "\(bu" 4 \&\f(CW\*(C`Z\*(C'\fR will be incremented for backwards-compatible bug fixes .IP "\(bu" 4 \&\f(CW\*(C`N\*(C'\fR will be zero for a stable release; \f(CW\*(C`N\*(C'\fR will be non-zero for development releases .PP We use \f(CW\*(C`N\*(C'\fR because \s-1CPAN\s0 does not support pre-release version labels (e.g. \&\*(L"\-alpha1\*(R") and requires non-decreasing version numbers for releases. .PP When \f(CW\*(C`N\*(C'\fR is non-zero, \f(CW\*(C`X\*(C'\fR, \f(CW\*(C`Y\*(C'\fR, and \f(CW\*(C`Z\*(C'\fR have no semantic meaning except to indicate the last stable release. .PP For example, v0.704.0.1 is merely the first development release after v0.704.0.0. The next stable release could be a bug fix (v0.704.1.0), a feature enhancement (v0.705.0.0), or an \s-1API\s0 change (v1.0.0.0). .PP See the Changes file included with development releases for an indication of the nature of changes involved. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 David Golden .IP "\(bu" 4 Mike Friedman .IP "\(bu" 4 Kristina Chodorow .IP "\(bu" 4 Florian Ragwitz .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2014 by MongoDB, Inc.. .PP This is free software, licensed under: .PP .Vb 1 \& The Apache License, Version 2.0, January 2004 .Ve