API Documentation¶
The PyMongo distribution contains three top-level packages for
interacting with MongoDB. bson is an implementation of the
BSON format, pymongo is a
full-featured driver for MongoDB, and gridfs is a set of tools
for working with the GridFS storage
specification.
bson– BSON (Binary JSON) Encoding and Decodingbinary– Tools for representing binary data to be stored in MongoDBcode– Tools for representing JavaScript codecodec_options– Tools for specifying BSON codec optionsdbref– Tools for manipulating DBRefs (references to documents stored in MongoDB)decimal128– Support for BSON Decimal128errors– Exceptions raised by thebsonpackageint64– Tools for representing BSON int64json_util– Tools for using Python’sjsonmodule with BSON documentsmax_key– Representation for the MongoDB internal MaxKey typemin_key– Representation for the MongoDB internal MinKey typeobjectid– Tools for working with MongoDB ObjectIdsraw_bson– Tools for representing raw BSON documents.regex– Tools for representing MongoDB regular expressionsson– Tools for working with SON, an ordered mappingtimestamp– Tools for representing MongoDB internal Timestampstz_util– Utilities for dealing with timezones in Python
pymongo– Python driver for MongoDBbulk– The bulk write operations interfacechange_stream– Watch changes on a collection, database, or clusterclient_options– Read only configuration options for a MongoClient.client_session– Logical sessions for sequential operationscollation– Tools for working with collations.collection– Collection level operationscommand_cursor– Tools for iterating over MongoDB command resultscursor– Tools for iterating over MongoDB query resultsdatabase– Database level operationsdriver_infoencryption– Client-Side Field Level Encryptionencryption_options– Automatic Client-Side Field Level Encryptionerrors– Exceptions raised by thepymongopackagemongo_client– Tools for connecting to MongoDBmonitoring– Tools for monitoring driver events.operations– Operation class definitionspool– Pool module for use with a MongoDB client.read_concern– Tools for working with read concern.read_preferences– Utilities for choosing which member of a replica set to read from.results– Result class definitionsserver_api– Support for MongoDB Stable APIserver_description– An object representation of a server the driver is connected to.topology_description– An object representation of a deployment of MongoDB servers.uri_parser– Tools to parse and validate a MongoDB URIwrite_concern– Tools for specifying write concernevent_loggers– Example loggers
gridfs– Tools for working with GridFS