Classe « Cursor »

Informations générales

Héritage

builtins.object
    Generic
        Cursor

Définition

class Cursor(Generic):

Constructeur(s)

Signature du constructeur	Description
__init__(self, collection: 'Collection[_DocumentType]', filter: 'Optional[Mapping[str, Any]]' = None, projection: 'Optional[Union[Mapping[str, Any], Iterable[str]]]' = None, skip: 'int' = 0, limit: 'int' = 0, no_cursor_timeout: 'bool' = False, cursor_type: 'int' = 0, sort: 'Optional[_Sort]' = None, allow_partial_results: 'bool' = False, oplog_replay: 'bool' = False, batch_size: 'int' = 0, collation: 'Optional[_CollationIn]' = None, hint: 'Optional[_Hint]' = None, max_scan: 'Optional[int]' = None, max_time_ms: 'Optional[int]' = None, max: 'Optional[_Sort]' = None, min: 'Optional[_Sort]' = None, return_key: 'Optional[bool]' = None, show_record_id: 'Optional[bool]' = None, snapshot: 'Optional[bool]' = None, comment: 'Optional[Any]' = None, session: 'Optional[ClientSession]' = None, allow_disk_use: 'Optional[bool]' = None, let: 'Optional[bool]' = None) -> 'None'	Create a new cursor. _{[extrait de __init__.__doc__]}

__init__(self, collection: 'Collection[_DocumentType]', filter: 'Optional[Mapping[str, Any]]' = None, projection: 'Optional[Union[Mapping[str, Any], Iterable[str]]]' = None, skip: 'int' = 0, limit: 'int' = 0, no_cursor_timeout: 'bool' = False, cursor_type: 'int' = 0, sort: 'Optional[_Sort]' = None, allow_partial_results: 'bool' = False, oplog_replay: 'bool' = False, batch_size: 'int' = 0, collation: 'Optional[_CollationIn]' = None, hint: 'Optional[_Hint]' = None, max_scan: 'Optional[int]' = None, max_time_ms: 'Optional[int]' = None, max: 'Optional[_Sort]' = None, min: 'Optional[_Sort]' = None, return_key: 'Optional[bool]' = None, show_record_id: 'Optional[bool]' = None, snapshot: 'Optional[bool]' = None, comment: 'Optional[Any]' = None, session: 'Optional[ClientSession]' = None, allow_disk_use: 'Optional[bool]' = None, let: 'Optional[bool]' = None) -> 'None'

Create a new cursor. _{[extrait de __init__.__doc__]}

Liste des propriétés

Nom de la propriété	Description
address	The (host, port) of the server used, or None. _{[extrait de address.__doc__]}
alive	Does this cursor have the potential to return more data? _{[extrait de alive.__doc__]}
collection	The :class:`~pymongo.collection.Collection` that this _{[extrait de collection.__doc__]}
cursor_id	Returns the id of the cursor _{[extrait de cursor_id.__doc__]}
retrieved	The number of documents retrieved so far. _{[extrait de retrieved.__doc__]}
session	The cursor's :class:`~pymongo.client_session.ClientSession`, or None. _{[extrait de session.__doc__]}

Liste des opérateurs

Signature de l'opérateur	Description
__getitem__(self, index: 'Union[int, slice]') -> 'Union[_DocumentType, Cursor[_DocumentType]]'	Get a single document or a slice of documents from this cursor. _{[extrait de __getitem__.__doc__]}

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

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

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__]}
__copy__(self) -> 'Cursor[_DocumentType]'	Support function for `copy.copy()`. _{[extrait de __copy__.__doc__]}
__deepcopy__(self, memo: 'Any') -> 'Any'	Support function for `copy.deepcopy()`. _{[extrait de __deepcopy__.__doc__]}
__del__(self) -> 'None'
__enter__(self) -> 'Cursor[_DocumentType]'
__exit__(self, exc_type: 'Any', exc_val: 'Any', exc_tb: 'Any') -> 'None'
__iter__(self) -> 'Cursor[_DocumentType]'
__next__(self) -> '_DocumentType'
add_option(self, mask: 'int') -> 'Cursor[_DocumentType]'	Set arbitrary query flags using a bitmask. _{[extrait de add_option.__doc__]}
allow_disk_use(self, allow_disk_use: 'bool') -> 'Cursor[_DocumentType]'	Specifies whether MongoDB can use temporary disk files while _{[extrait de allow_disk_use.__doc__]}
batch_size(self, batch_size: 'int') -> 'Cursor[_DocumentType]'	Limits the number of documents returned in one batch. Each batch _{[extrait de batch_size.__doc__]}
clone(self) -> 'Cursor[_DocumentType]'	Get a clone of this cursor. _{[extrait de clone.__doc__]}
close(self) -> 'None'	Explicitly close / kill this cursor. _{[extrait de close.__doc__]}
collation(self, collation: 'Optional[_CollationIn]') -> 'Cursor[_DocumentType]'	Adds a :class:`~pymongo.collation.Collation` to this query. _{[extrait de collation.__doc__]}
comment(self, comment: 'Any') -> 'Cursor[_DocumentType]'	Adds a 'comment' to the cursor. _{[extrait de comment.__doc__]}
distinct(self, key: 'str') -> 'list'	Get a list of distinct values for `key` among all documents _{[extrait de distinct.__doc__]}
explain(self) -> '_DocumentType'	Returns an explain plan record for this cursor. _{[extrait de explain.__doc__]}
hint(self, index: 'Optional[_Hint]') -> 'Cursor[_DocumentType]'	Adds a 'hint', telling Mongo the proper index to use for the query. _{[extrait de hint.__doc__]}
limit(self, limit: 'int') -> 'Cursor[_DocumentType]'	Limits the number of results to be returned by this cursor. _{[extrait de limit.__doc__]}
max(self, spec: '_Sort') -> 'Cursor[_DocumentType]'	Adds ``max`` operator that specifies upper bound for specific index. _{[extrait de max.__doc__]}
max_await_time_ms(self, max_await_time_ms: 'Optional[int]') -> 'Cursor[_DocumentType]'	Specifies a time limit for a getMore operation on a _{[extrait de max_await_time_ms.__doc__]}
max_scan(self, max_scan: 'Optional[int]') -> 'Cursor[_DocumentType]'	DEPRECATED - Limit the number of documents to scan when _{[extrait de max_scan.__doc__]}
max_time_ms(self, max_time_ms: 'Optional[int]') -> 'Cursor[_DocumentType]'	Specifies a time limit for a query operation. If the specified _{[extrait de max_time_ms.__doc__]}
min(self, spec: '_Sort') -> 'Cursor[_DocumentType]'	Adds ``min`` operator that specifies lower bound for specific index. _{[extrait de min.__doc__]}
next(self) -> '_DocumentType'	Advance the cursor. _{[extrait de next.__doc__]}
remove_option(self, mask: 'int') -> 'Cursor[_DocumentType]'	Unset arbitrary query flags using a bitmask. _{[extrait de remove_option.__doc__]}
rewind(self) -> 'Cursor[_DocumentType]'	Rewind this cursor to its unevaluated state. _{[extrait de rewind.__doc__]}
skip(self, skip: 'int') -> 'Cursor[_DocumentType]'	Skips the first `skip` results of this cursor. _{[extrait de skip.__doc__]}
sort(self, key_or_list: '_Hint', direction: 'Optional[Union[int, str]]' = None) -> 'Cursor[_DocumentType]'	Sorts this cursor's results. _{[extrait de sort.__doc__]}
to_list(self, length: 'Optional[int]' = None) -> 'list[_DocumentType]'	Converts the contents of this cursor to a list more efficiently than ``[doc for doc in cursor]``. _{[extrait de to_list.__doc__]}
where(self, code: 'Union[str, Code]') -> 'Cursor[_DocumentType]'	Adds a `$where`_ clause to this query. _{[extrait de where.__doc__]}