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 Decoding
  • BSON
  • decode()
  • decode_all()
  • decode_file_iter()
  • decode_iter()
  • encode()
  • gen_list_name()
  • has_c()
  • is_valid()
  • binary – Tools for representing binary data to be stored in MongoDB
  • code – Tools for representing JavaScript code
  • codec_options – Tools for specifying BSON codec options
  • datetime_ms – Support for BSON UTC Datetime
  • dbref – Tools for manipulating DBRefs (references to documents stored in MongoDB)
  • decimal128 – Support for BSON Decimal128
  • errors – Exceptions raised by the bson package
  • int64 – Tools for representing BSON int64
  • json_util – Tools for using Python’s json module with BSON documents
  • max_key – Representation for the MongoDB internal MaxKey type
  • min_key – Representation for the MongoDB internal MinKey type
  • objectid – Tools for working with MongoDB ObjectIds
  • raw_bson – Tools for representing raw BSON documents.
  • regex – Tools for representing MongoDB regular expressions
  • son – Tools for working with SON, an ordered mapping
  • timestamp – Tools for representing MongoDB internal Timestamps
  • tz_util – Utilities for dealing with timezones in Python
• pymongo – Python driver for MongoDB
  • version
  • MongoClient
  • AsyncMongoClient
  • ReadPreference
  • has_c()
  • MIN_SUPPORTED_WIRE_VERSION
  • MAX_SUPPORTED_WIRE_VERSION
  • timeout()
  • pymongo async – Async Python driver for MongoDB
  • auth_oidc – MONGODB-OIDC Authentication
  • change_stream – Watch changes on a collection, database, or cluster
  • client_options – Read only configuration options for a MongoClient.
  • client_session – Logical sessions for sequential operations
  • collation – Tools for working with collations.
  • collection – Collection level operations
  • command_cursor – Tools for iterating over MongoDB command results
  • cursor – Tools for iterating over MongoDB query results
  • database – Database level operations
  • driver_info
  • encryption – Client-Side Field Level Encryption
  • encryption_options – Automatic Client-Side Field Level Encryption
  • errors – Exceptions raised by the pymongo package
  • mongo_client – Tools for connecting to MongoDB
  • monitoring – Tools for monitoring driver events.
  • operations – Operation class definitions
  • pool – 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 definitions
  • server_api – Support for MongoDB Stable API
  • server_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 URI
  • write_concern – Tools for specifying write concern
  • event_loggers – Example loggers
• gridfs – Tools for working with GridFS
  • GridFS
  • GridFSBucket
  • gridfs async – Async tools for working with GridFS
  • errors – Exceptions raised by the gridfs package
  • grid_file – Tools for representing files stored in GridFS