Référence des index de modèle

Les classes d’index facilitent la création d’index de base de données. Elles peuvent être ajoutées avec l’option Meta.indexes. Ce document détaille les références d’API de Index ce qui inclut les options d’index.

Référencement des index intégrés

Les index sont définis dans django.db.models.indexes, mais par commodité ils sont importés dans django.db.models. La convention standard est d’utiliser from django.db import models et de se référer aux index avec models.<IndexClass>.

Options d”Index

class Index(fields=(), name=None, db_tablespace=None, opclasses=(), condition=None)[source]

Crée un index (B-Tree) dans la base de données.

fields

Index.fields

Une liste ou un tuple de noms de champs sur lesquels l’index doit porter.

Par défaut, les index sont créés avec un tri croissant sur chaque colonne. Pour définir un index avec un tri décroissant sur une certaine colonne, ajoutez un tiret devant le nom du champ.

Par exemple, Index(fields=['headline', '-pub_date']) produit un code SQL contenant (headline, pub_date DESC). Le tri dans les index n’est pas géré par MySQL. Dans ce cas, un index avec tri décroissant est traité comme un index normal.

Changed in Django 2.1:

Les versions précédentes n’acceptaient pas les tuples.

name

Index.name

Le nom de l’index. Si name n’est pas fourni, Django va générer automatiquement un nom. Par compatibilité avec les différentes bases de données, les noms d’index ne peuvent pas être plus longs que 30 caractères et ne doivent pas commencer par un nombre (0-9) ni par un soulignement (_).

Partial indexes in abstract base classes

You must always specify a unique name for an index. As such, you cannot normally specify a partial index on an abstract base class, since the Meta.indexes option is inherited by subclasses, with exactly the same values for the attributes (including name) each time. Instead, specify the indexes option on subclasses directly, providing a unique name for each index.

db_tablespace

Index.db_tablespace

Le nom de l”espace de tables de base de données à utiliser pour cet index. Pour les index sur un seul champ et si db_tablespace n’est pas indiqué, l’index est créé dans l’espace db_tablespace du champ.

Si Field.db_tablespace n’est pas présent (ou si l’index utilise plusieurs champs), l’index est créé dans l’espace de tables défini dans l’option db_tablespace dans la classe Meta du modèle. Si aucun de ces espaces n’est défini, l’index est créé dans le même espace de tables que la table.

Voir aussi

Pour une liste des index spécifiques à PostgreSQL, voir django.contrib.postgres.indexes.

opclasses

Index.opclasses
New in Django 2.2:

Les noms des classes d’opérateurs PostgreSQL à utiliser pour cet index. Si vous nécessitez une classe d’opérateur personnalisée, vous devez en fournir une pour chaque champ de l’index.

Par exemple, GinIndex(name='json_index', fields=['jsonfield'], opclasses=['jsonb_path_ops']) crée un index gin pour le champ jsonfield en utilisant les classes d’opérateurs jsonb_path_ops.

opclasses est ignoré pour les bases de données autres que PostgreSQL.

Index.name est obligatoire quand on utilise opclasses.

condition

Index.condition
New in Django 2.2:

Si la table est très grande et que vos requêtes ciblent principalement un certain sous-ensemble de lignes, il peut être utile de restreindre l’index à ce sous-ensemble. Indiquez une condition sous forme de Q. Par exemple, condition=Q(pages__gt=400) va indexer les lignes dont le champ pages est plus grand que 400.

Index.name est obligatoire quand on utilise condition.

Restrictions pour PostgreSQL

PostgreSQL exige que les fonctions référencées dans la condition soient marquées comme IMMUTABLE. Django ne le vérifie pas, mais PostgreSQL produira une erreur. Cela signifie que des fonctions telles que Fonctions de date et Concat ne sont pas admises. Si vous stockez des dates dans un champ DateTimeField, la comparaison avec des objets datetime peut nécessiter la présence du paramètre tzinfo car sinon la comparaison pourrait aboutir à une fonction « mutable » en raison du forçage de type que Django effectue pour les expressions de requête.

Restrictions pour SQLite

SQLite impose des restrictions sur la façon dont un index partiel peut être construit.

Oracle

Oracle ne prend pas en charge les index partiels. Par contre, les index partiels peuvent être émulés à l’aide d’index fonctionnels. Utilisez une migration pour ajouter l’index avec RunSQL.

MySQL et MariaDB

Le paramètre condition est ignoré avec MySQL et MariaDB, car aucune de ces bases de données ne prend en charge les index conditionnels.

Back to Top