OpenQuizz
Une application de gestion des contenus pédagogiques
IndexModel Class Reference
Inheritance diagram for IndexModel:
Collaboration diagram for IndexModel:

Public Member Functions

def __init__ (self, keys, **kwargs)
 
def document (self)
 

Detailed Description

Represents an index to create.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  keys,
**  kwargs 
)
Create an Index instance.

For use with :meth:`~pymongo.collection.Collection.create_indexes`.

Takes either a single key or a list of (key, direction) pairs.
The key(s) must be an instance of :class:`basestring`
(:class:`str` in python 3), and the direction(s) must be one of
(:data:`~pymongo.ASCENDING`, :data:`~pymongo.DESCENDING`,
:data:`~pymongo.GEO2D`, :data:`~pymongo.GEOHAYSTACK`,
:data:`~pymongo.GEOSPHERE`, :data:`~pymongo.HASHED`,
:data:`~pymongo.TEXT`).

Valid options include, but are not limited to:

  - `name`: custom name to use for this index - if none is
    given, a name will be generated.
  - `unique`: if ``True``, creates a uniqueness constraint on the index.
  - `background`: if ``True``, this index should be created in the
    background.
  - `sparse`: if ``True``, omit from the index any documents that lack
    the indexed field.
  - `bucketSize`: for use with geoHaystack indexes.
    Number of documents to group together within a certain proximity
    to a given longitude and latitude.
  - `min`: minimum value for keys in a :data:`~pymongo.GEO2D`
    index.
  - `max`: maximum value for keys in a :data:`~pymongo.GEO2D`
    index.
  - `expireAfterSeconds`: <int> Used to create an expiring (TTL)
    collection. MongoDB will automatically delete documents from
    this collection after <int> seconds. The indexed field must
    be a UTC datetime or the data will not expire.
  - `partialFilterExpression`: A document that specifies a filter for
    a partial index. Requires MongoDB >= 3.2.
  - `collation`: An instance of :class:`~pymongo.collation.Collation`
    that specifies the collation to use in MongoDB >= 3.4.
  - `wildcardProjection`: Allows users to include or exclude specific
    field paths from a `wildcard index`_ using the { "$**" : 1} key
    pattern. Requires MongoDB >= 4.2.
  - `hidden`: if ``True``, this index will be hidden from the query
    planner and will not be evaluated as part of query plan
    selection. Requires MongoDB >= 4.4.

See the MongoDB documentation for a full list of supported options by
server version.

:Parameters:
  - `keys`: a single key or a list of (key, direction)
    pairs specifying the index to create
  - `**kwargs` (optional): any additional index creation
    options (see the above list) should be passed as keyword
    arguments

.. versionchanged:: 3.11
   Added the ``hidden`` option.
.. versionchanged:: 3.2
   Added the ``partialFilterExpression`` option to support partial
   indexes.

.. _wildcard index: https://docs.mongodb.com/master/core/index-wildcard/#wildcard-index-core

Member Function Documentation

◆ document()

def document (   self)
An index document suitable for passing to the createIndexes
command.

The documentation for this class was generated from the following file: