Django Queryset

Queryset c'est quoi?

Lorsque vous avez crée un modèle, vous pouvez utiliser un manager de ce modèle avec la syntaxe suivante:

Product.objects

Ce manager génère des queryset qui sont des points d'entrée vers l'ORM de Django . C'est grâce à ce manager que vous allez pouvoir communiquer avec votre base de données. Un queryset est donc une liste d'objets d'un modèle donné.

Voic un exemple de queryset :

Product.objects.all()

Ce queryset vous retournera une liste avec toutes les entrées en base du modèle Product .

Il existe d'autres possibilités de recherche:

# Retourne tous les produits où la date est supérieure à 2010
Product.objects.filter(date__gt=2010)

# Retourne les produits à 15 euros
Product.objects.filter(price_ttc=15)

# Retourner les produits qui ne sont pas à 15 euros
Product.objects.exclude(price_ttc=15)

Il est d'ailleurs possible de chainer les filtres pour affiner sa recherche:

Product.objects.filter(date__lt=2010).exclude(price_ttc=15).order_by(name)

Les relations dans les queryset

Rapidement vous lierez les objets entre eux. Pour les retrouver vous pouvez partir de l'objet que vous voulez:

product_item = ProductItem.objects.filter(product__id=1)

Revient au meme que:

product_item = Product.objects.get(id=1).productitem_set.all()

Modifier des données

Exemple de modification:

p = Product.objects.get(pk=1)
p.name = "ipod"
p.save()

Ou cette syntaxe

Product.object.get(pk=1).update(name="ipod")

Supprimer des données

Pour supprimer des entrées dans votre base, vous pouvez utiliser la méthode delete :

Product.objects.find(id=1).delete()

Faire des modifications groupées

Si vous voulez faire une modification de données sur plusieurs items vous pouvez utiliser la méthode update :

Product.objects.filter(date__year=2019).update(name="ipad")

Les méthodes qui retournent un queryset

Les méthodes qui ne retournent pas un queryset

Les champs de recherche

Les fonctions de regroupement / calcul

Avg       → moyenne
Count     → nombre occurences
Max       → maximum
Min       → minimum
StdDev    → écart-type
Sum       → somme
Variance  → variance

Exemples d'utilisation

la méthode annotate

>>> from django.db.models import Count

>>> p = Product.objects.annotate(nb_items=Count("product_item")).get(pk=1)
>>> p.nb_items
2

les méthodes values et values_list

>>> Product.objects.filter(pk=1)
[Product object]
>>> Product.objects.filter(pk=1).values()
[{'code': u'a0', 'name': u'Tshirt', 'price_ht': Decimal('25'), 'date_creation': datetime.datetime(2010, 9, 7, 12, 55, 55, 935974, tzinfo=), 'price_ttc': Decimal('30'), u'id': 1}]
>>> Product.objects.filter(pk=1).values_list()
[(1, u'Tshirt', u'a0', Decimal('25'), Decimal('30'), 0, datetime.datetime(2019, 9, 7, 12, 55, 55, 935974, tzinfo=))]
>>> Product.objects.filter(pk=1).values("code")
[{'code': u'a0'}]
>>> Product.objects.filter(pk=1).values_list("code")
[(u'a0',)]

La méthode extra

>>> p = Product.objects.extra(select={'items_count': 'SELECT COUNT(*) FROM backoffice_productitem WHERE backoffice_productitem.product_id = backoffice_product.id'})
>>> p[0].items_count
2

Voir la requete SQL

Vous pouvez voir quelle sera la requete SQL utilisé par le manager avec l'attribut query

Product.object.all().query

Retournera:

SELECT "backoffice_product"."id", "backoffice_product"."name", "backoffice_product"."code", "backoffice_product"."price_ht", "backoffice_product"."price_ttc" FROM "backoffice_product"

L'objet Q

Les requètes de base proposées par l'ORM Django reste simple et donc limité. Lorsque vous chainez les méthodes, l'opérateur "AND" sera utilisé, si vous voulez utiliser l'opérateur "OR", il vous faudra utiliser l'objet Q

Pour importer le module:

from django.db.model import Q

Exemple d'utilisation:

Product.objects.filter(Q(id=1))

Avec l'opérateur AND:

Product.objects.filter(Q(id=1) & Q(name="TEST"))

Et avec l'opérateur OR:

Product.objects.filter(Q(id=1) | Q(id=2))

Utiliser le notion de contraire:

Product.objects.filter(~Q(id=1))

Pensez à utiliser l'attribut query pour vérifier vos requètes SQL en cas de doute:

print Product.objects.filter(~Q(id=1))
# SELECT "backoffice_product"."id", "backoffice_product"."name", "backoffice_product"."code", "backoffice_product"."price_ht", "backoffice_product"."price_ttc" FROM "backoffice_product" WHERE NOT ("backoffice_product"."id" = 1 )

L'objet F

L'objet F vous permet d'incrémenter des valeurs d'une colonne:

Product.objects.filter(code="0001").update(stock=F("stock")+1)