Classe « Cursor »

Informations générales

Héritage

builtins.object
    Cursor

Définition

class Cursor(builtins.object):

Description _{[extrait de Cursor.doc]}

A cursor / iterator over Mongo query results.

Constructeur(s)

Signature du constructeur	Description
__init__(self, collection, filter=None, projection=None, skip=0, limit=0, no_cursor_timeout=False, cursor_type=0, sort=None, allow_partial_results=False, oplog_replay=False, modifiers=None, batch_size=0, manipulate=True, collation=None, hint=None, max_scan=None, max_time_ms=None, max=None, min=None, return_key=False, show_record_id=False, snapshot=False, comment=None, session=None, allow_disk_use=None)	Create a new cursor. _{[extrait de __init__.__doc__]}

__init__(self, collection, filter=None, projection=None, skip=0, limit=0, no_cursor_timeout=False, cursor_type=0, sort=None, allow_partial_results=False, oplog_replay=False, modifiers=None, batch_size=0, manipulate=True, collation=None, hint=None, max_scan=None, max_time_ms=None, max=None, min=None, return_key=False, show_record_id=False, snapshot=False, comment=None, session=None, allow_disk_use=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 __doc__]}
alive	Does this cursor have the potential to return more data? _{[extrait de __doc__]}
collection	The :class:`~pymongo.collection.Collection` that this _{[extrait de __doc__]}
cursor_id	Returns the id of the cursor _{[extrait de __doc__]}
retrieved	The number of documents retrieved so far. _{[extrait de __doc__]}
session	The cursor's :class:`~pymongo.client_session.ClientSession`, or None. _{[extrait de __doc__]}

Liste des opérateurs

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