Module « pymongo »

Classe « MongoClient »

Informations générales

Héritage

builtins.object
    BaseObject
        MongoClient

Définition

class MongoClient(BaseObject):

Description _{[extrait de MongoClient.doc]}

    A client-side representation of a MongoDB cluster.

    Instances can represent either a standalone MongoDB server, a replica
    set, or a sharded cluster. Instances of this class are responsible for
    maintaining up-to-date state of the cluster, and possibly cache
    resources related to this, including background threads for monitoring,
    and connection pools.

Constructeur(s)

Signature du constructeur	Description
__init__(self, host=None, port=None, document_class=<class 'dict'>, tz_aware=None, connect=None, type_registry=None, **kwargs)	Client for a MongoDB instance, a replica set, or a set of mongoses. _{[extrait de __init__.__doc__]}

Liste des attributs statiques

Nom de l'attribut	Valeur
HOST	localhost
PORT	27017

Liste des propriétés

Nom de la propriété	Description
address	(host, port) of the current standalone, primary, or mongos, or None. _{[extrait de __doc__]}
arbiters	Arbiters in the replica set. _{[extrait de __doc__]}
codec_options	Read only access to the :class:`~bson.codec_options.CodecOptions` _{[extrait de __doc__]}
event_listeners	The event listeners registered for this client. _{[extrait de __doc__]}
is_locked	DEPRECATED: Is this server locked? While locked, all write _{[extrait de __doc__]}
is_mongos	If this client is connected to mongos. If the client is not _{[extrait de __doc__]}
is_primary	If this client is connected to a server that can accept writes. _{[extrait de __doc__]}
local_threshold_ms	The local threshold for this instance. _{[extrait de __doc__]}
max_bson_size	The largest BSON object the connected server accepts in bytes. _{[extrait de __doc__]}
max_idle_time_ms	The maximum number of milliseconds that a connection can remain _{[extrait de __doc__]}
max_message_size	The largest message the connected server accepts in bytes. _{[extrait de __doc__]}
max_pool_size	The maximum allowable number of concurrent connections to each _{[extrait de __doc__]}
max_write_batch_size	The maxWriteBatchSize reported by the server. _{[extrait de __doc__]}
min_pool_size	The minimum required number of concurrent connections that the pool _{[extrait de __doc__]}
nodes	Set of all currently connected servers. _{[extrait de __doc__]}
primary	The (host, port) of the current primary of the replica set. _{[extrait de __doc__]}
read_concern	Read only access to the :class:`~pymongo.read_concern.ReadConcern` _{[extrait de __doc__]}
read_preference	Read only access to the read preference of this instance. _{[extrait de __doc__]}
retry_reads	If this instance should retry supported write operations. _{[extrait de __doc__]}
retry_writes	If this instance should retry supported write operations. _{[extrait de __doc__]}
secondaries	The secondary members known to this client. _{[extrait de __doc__]}
server_selection_timeout	The server selection timeout for this instance in seconds. _{[extrait de __doc__]}
topology_description	The description of the connected MongoDB deployment. _{[extrait de __doc__]}
write_concern	Read only access to the :class:`~pymongo.write_concern.WriteConcern` _{[extrait de __doc__]}

Liste des opérateurs

Signature de l'opérateur	Description
__eq__(self, other)
__getitem__(self, name)	Get a database by name. _{[extrait de __getitem__.__doc__]}
__ne__(self, other)

Opérateurs hérités de la classe object

__ge__, __gt__, __le__, __lt__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
__enter__(self)
__exit__(self, exc_type, exc_val, exc_tb)
__getattr__(self, name)	Get a database by name. _{[extrait de __getattr__.__doc__]}
__hash__(self)
__iter__(self)
__next__(self)
__repr__(self)
close(self)	Cleanup client resources and disconnect from MongoDB. _{[extrait de close.__doc__]}
close_cursor(self, cursor_id, address=None)	DEPRECATED - Send a kill cursors message soon with the given id. _{[extrait de close_cursor.__doc__]}
database_names(self, session=None)	DEPRECATED: Get a list of the names of all databases on the _{[extrait de database_names.__doc__]}
drop_database(self, name_or_database, session=None)	Drop a database. _{[extrait de drop_database.__doc__]}
fsync(self, **kwargs)	DEPRECATED: Flush all pending writes to datafiles. _{[extrait de fsync.__doc__]}
get_database(self, name=None, codec_options=None, read_preference=None, write_concern=None, read_concern=None)	Get a :class:`~pymongo.database.Database` with the given name and _{[extrait de get_database.__doc__]}
get_default_database(self, default=None, codec_options=None, read_preference=None, write_concern=None, read_concern=None)	Get the database named in the MongoDB connection URI. _{[extrait de get_default_database.__doc__]}
kill_cursors(self, cursor_ids, address=None)	DEPRECATED - Send a kill cursors message soon with the given ids. _{[extrait de kill_cursors.__doc__]}
list_database_names(self, session=None)	Get a list of the names of all databases on the connected server. _{[extrait de list_database_names.__doc__]}
list_databases(self, session=None, **kwargs)	Get a cursor over the databases of the connected server. _{[extrait de list_databases.__doc__]}
next(self)
server_info(self, session=None)	Get information about the MongoDB server we're connected to. _{[extrait de server_info.__doc__]}
set_cursor_manager(self, manager_class)	DEPRECATED - Set this client's cursor manager. _{[extrait de set_cursor_manager.__doc__]}
start_session(self, causal_consistency=None, default_transaction_options=None, snapshot=False)	Start a logical session. _{[extrait de start_session.__doc__]}
unlock(self, session=None)	DEPRECATED: Unlock a previously locked server. _{[extrait de unlock.__doc__]}
watch(self, pipeline=None, full_document=None, resume_after=None, max_await_time_ms=None, batch_size=None, collation=None, start_at_operation_time=None, session=None, start_after=None)	Watch changes on this cluster. _{[extrait de watch.__doc__]}