Classe « MongoClient »

Informations générales

Héritage

builtins.object
    Generic
builtins.object
    BaseObject
        MongoClient

Définition

class MongoClient(BaseObject, Generic):

Constructeur(s)

Signature du constructeur	Description
__init__(self, host: 'Optional[Union[str, Sequence[str]]]' = None, port: 'Optional[int]' = None, document_class: 'Optional[Type[_DocumentType]]' = None, tz_aware: 'Optional[bool]' = None, connect: 'Optional[bool]' = None, type_registry: 'Optional[TypeRegistry]' = None, **kwargs: 'Any') -> 'None'	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 address.__doc__]}
arbiters	Arbiters in the replica set. _{[extrait de arbiters.__doc__]}
codec_options	Read only access to the :class:`~bson.codec_options.CodecOptions` _{[extrait de codec_options.__doc__]}
is_mongos	If this client is connected to mongos. If the client is not _{[extrait de is_mongos.__doc__]}
is_primary	If this client is connected to a server that can accept writes. _{[extrait de is_primary.__doc__]}
nodes	Set of all currently connected servers. _{[extrait de nodes.__doc__]}
options	The configuration options for this client. _{[extrait de options.__doc__]}
primary	The (host, port) of the current primary of the replica set. _{[extrait de primary.__doc__]}
read_concern	Read only access to the :class:`~pymongo.read_concern.ReadConcern` _{[extrait de read_concern.__doc__]}
read_preference	Read only access to the read preference of this instance. _{[extrait de read_preference.__doc__]}
secondaries	The secondary members known to this client. _{[extrait de secondaries.__doc__]}
topology_description	The description of the connected MongoDB deployment. _{[extrait de topology_description.__doc__]}
write_concern	Read only access to the :class:`~pymongo.write_concern.WriteConcern` _{[extrait de write_concern.__doc__]}

Liste des opérateurs

Signature de l'opérateur	Description
__eq__(self, other: 'Any') -> 'bool'
__getitem__(self, name: 'str') -> 'database.Database[_DocumentType]'	Get a database by name. _{[extrait de __getitem__.__doc__]}
__ne__(self, other: 'Any') -> 'bool'

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
__class_getitem__	Parameterizes a generic class. _{[extrait de __class_getitem__.__doc__]}
__del__(self) -> 'None'	Check that this MongoClient has been closed and issue a warning if not. _{[extrait de __del__.__doc__]}
__enter__(self) -> 'MongoClient[_DocumentType]'
__exit__(self, exc_type: 'Any', exc_val: 'Any', exc_tb: 'Any') -> 'None'
__getattr__(self, name: 'str') -> 'database.Database[_DocumentType]'	Get a database by name. _{[extrait de __getattr__.__doc__]}
__hash__(self) -> 'int'
__next__(self) -> 'NoReturn'
__repr__(self) -> 'str'
bulk_write(self, models: 'Sequence[_WriteOp[_DocumentType]]', session: 'Optional[ClientSession]' = None, ordered: 'bool' = True, verbose_results: 'bool' = False, bypass_document_validation: 'Optional[bool]' = None, comment: 'Optional[Any]' = None, let: 'Optional[Mapping]' = None, write_concern: 'Optional[WriteConcern]' = None) -> 'ClientBulkWriteResult'	Send a batch of write operations, potentially across multiple namespaces, to the server. _{[extrait de bulk_write.__doc__]}
close(self) -> 'None'	Cleanup client resources and disconnect from MongoDB. _{[extrait de close.__doc__]}
drop_database(self, name_or_database: 'Union[str, database.Database[_DocumentTypeArg]]', session: 'Optional[client_session.ClientSession]' = None, comment: 'Optional[Any]' = None) -> 'None'	Drop a database. _{[extrait de drop_database.__doc__]}
get_database(self, name: 'Optional[str]' = None, codec_options: 'Optional[CodecOptions[_DocumentTypeArg]]' = None, read_preference: 'Optional[_ServerMode]' = None, write_concern: 'Optional[WriteConcern]' = None, read_concern: 'Optional[ReadConcern]' = None) -> 'database.Database[_DocumentType]'	Get a :class:`~pymongo.database.Database` with the given name and _{[extrait de get_database.__doc__]}
get_default_database(self, default: 'Optional[str]' = None, codec_options: 'Optional[CodecOptions[_DocumentTypeArg]]' = None, read_preference: 'Optional[_ServerMode]' = None, write_concern: 'Optional[WriteConcern]' = None, read_concern: 'Optional[ReadConcern]' = None) -> 'database.Database[_DocumentType]'	Get the database named in the MongoDB connection URI. _{[extrait de get_default_database.__doc__]}
list_database_names(self, session: 'Optional[client_session.ClientSession]' = None, comment: 'Optional[Any]' = None) -> 'list[str]'	Get a list of the names of all databases on the connected server. _{[extrait de list_database_names.__doc__]}
list_databases(self, session: 'Optional[client_session.ClientSession]' = None, comment: 'Optional[Any]' = None, **kwargs: 'Any') -> 'CommandCursor[dict[str, Any]]'	Get a cursor over the databases of the connected server. _{[extrait de list_databases.__doc__]}
next(self) -> 'NoReturn'
server_info(self, session: 'Optional[client_session.ClientSession]' = None) -> 'dict[str, Any]'	Get information about the MongoDB server we're connected to. _{[extrait de server_info.__doc__]}
start_session(self, causal_consistency: 'Optional[bool]' = None, default_transaction_options: 'Optional[client_session.TransactionOptions]' = None, snapshot: 'Optional[bool]' = False) -> 'client_session.ClientSession'	Start a logical session. _{[extrait de start_session.__doc__]}
watch(self, pipeline: 'Optional[_Pipeline]' = None, full_document: 'Optional[str]' = None, resume_after: 'Optional[Mapping[str, Any]]' = None, max_await_time_ms: 'Optional[int]' = None, batch_size: 'Optional[int]' = None, collation: 'Optional[_CollationIn]' = None, start_at_operation_time: 'Optional[Timestamp]' = None, session: 'Optional[client_session.ClientSession]' = None, start_after: 'Optional[Mapping[str, Any]]' = None, comment: 'Optional[Any]' = None, full_document_before_change: 'Optional[str]' = None, show_expanded_events: 'Optional[bool]' = None) -> 'ChangeStream[_DocumentType]'	Watch changes on this cluster. _{[extrait de watch.__doc__]}