Realizar consultas de base de datos sin procesar

API de consulta

La API de Django QuerySet proporciona un método raw(), que permite realizar queries SQL en bases de datos relacionales. Sin embargo, Django MongoDB Backend no soporta el método raw(). En vez de esto, el ODM ofrece el método raw_aggregate(), que se puede utilizar para enviar instrucciones a la base de datos en etapas de un pipeline.

Puedes ejecutar consultas a la base de datos llamando a los métodos QuerySet en el Manager de tu modelo. La clase Manager gestiona las operaciones con la base de datos y permite interactuar con los datos de MongoDB haciendo referencia a modelos de Django. Por defecto, Django añade a cada clase de modelo un Manager denominado objects. Este Manager por defecto no es compatible con el método raw_aggregate(). Para utilizar este método específico de MongoDB, configura el campo objects de tu modelo en un administrador personalizado llamado MongoManager.

Datos de muestra

Los ejemplos de esta guía usan los modelos Movie y Theater, que representan colecciones en la base de datos sample_mflix de los conjuntos de datos de muestra de Atlas. Estos modelos configuran explícitamente el campo objects para utilizar un MongoManager personalizado, en lugar de la clase Manager por defecto de Django. Esta guía también utiliza un modelo incrustado Location para representar el campo de ubicación del modelo Theater. Las clases de modelo tienen las siguientes definiciones:

from django.db import models
from django.contrib.gis.db import models
from django_mongodb_backend.fields import ArrayField, EmbeddedModelField
from django_mongodb_backend.models import EmbeddedModel
from django_mongodb_backend.managers import MongoManager
class Movie(models.Model):
    title = models.CharField(max_length=200)
    plot = models.TextField(blank=True)
    runtime = models.IntegerField(default=0)
    released = models.DateTimeField("release date", null=True, blank=True)
    genres = ArrayField(models.CharField(max_length=100), null=True, blank=True)
    objects = MongoManager()
    class Meta:
        db_table = "movies"
        managed = False
    def __str__(self):
        return self.title
class Location(EmbeddedModel):
    address = models.JSONField(null=True)
    geo = models.PointField()
class Theater(models.Model):
    theaterId = models.IntegerField(default=0)
    location = EmbeddedModelField(Location, null=True, blank=True)
    class Meta:
        db_table = "theaters"
        managed = False
    
    def __str__(self):
        return self.theaterId

Los modelos Movie y Theater incluyen una clase interna Meta, que especifica los metadatos del modelo, y un método __str__(), que define la representación de cadena del modelo. Para obtener más información sobre estas características del modelo, consulte Defina un modelo en la guía Crear modelos.

python manage.py shell

from <your application name>.models import Movie, Theater, Location
from django.utils import timezone
from datetime import datetime

Campos de filtro y documentos del proyecto

Este ejemplo ejecuta una query bruta a la base de datos llamando al método raw_aggregate() en el MongoManager de tu modelo Movie, que consulta la colección sample_mflix.movies. El código pasa las siguientes etapas del pipeline de agregación a raw_aggregate():

• $match: Filtra los documentos que tienen un valor de campo title de "The Parent Trap"

• $project: Incluye los campos title y released de los objetos del modelo devueltos

movies = Movie.objects.raw_aggregate([
    {"$match": {"title": "The Parent Trap"}},
    {"$project": {
        "title": 1,
        "released": 1
    }
}])
for m in movies:
    print(f"Plot of {m.title}, released on {m.released}: {m.plot}\n")

Plot of The Parent Trap, released on 1961-06-21 00:00:00+00:00:
Teenage twin girls swap places and scheme to reunite their divorced parents.
Plot of The Parent Trap, released on 1998-07-29 00:00:00+00:00:
Identical twins, separated at birth and each raised by one of their
biological parents, discover each other for the first time at summer
camp and make a plan to bring their wayward parents back together.

Ejecuta una MongoDB Search query

Puedes ejecutar queries MongoDB Search en tu base de datos para realizar búsquedas de texto detalladas. Estas queries ofrecen funcionalidades avanzadas de búsqueda, como coincidencia de frases, puntuación de resultados según relevancia y resaltado de coincidencias.

Para especificar una consulta de búsqueda de MongoDB, cree un índice de búsqueda que cubra los campos que desea consultar. A continuación, pase una etapa $search o $searchMeta en un parámetro de canalización de agregación al método raw_aggregate().

Este ejemplo ejecuta una query de MongoDB Search pasando la etapa de pipeline $search al método raw_aggregate(). El código realiza las siguientes acciones:

• Especifica el índice de búsqueda que abarca el campo plot

• Queries para documentos cuyos valores de plot contienen la string "whirlwind romance" con no más de 3 palabras entre ellos

• Devuelve partes de los valores de cadena plot que coinciden con la query y metadatos que indican dónde se produjeron las coincidencias

• Incluye el campo title y el highlight, o el texto coincidente, de cada resultado

movies = Movie.objects.raw_aggregate([
    {
        "$search": {
            "index": "<search-index-name>",
            "phrase": {
                "path": "plot",
                "query": "whirlwind romance",
                "slop": 3
            },
            "highlight": {
                "path": "plot"
            }
        }
    },
    {
        "$project": {
            "title": 1,
            "highlight": {"$meta": "searchHighlights"}
        }
    }
])
for m in movies:
    print(f"Title: {m.title}, text match details: {m.highlight}\n")

Title: Tokyo Fiancèe, text match details: [{'score': 2.3079638481140137, 'path': 'plot',
'texts': [{'value': 'A young Japanophile Belgian woman in Tokyo falls into a ', 'type': 'text'},
{'value': 'whirlwind', 'type': 'hit'}, {'value': ' ', 'type': 'text'}, {'value': 'romance',
'type': 'hit'}, {'value': ' with a Francophile Japanese student.', 'type': 'text'}]}]
Title: Designing Woman, text match details: [{'score': 2.3041324615478516, 'path': 'plot',
'texts': [{'value': 'A sportswriter and a fashion-designer marry after a ', 'type': 'text'},
{'value': 'whirlwind', 'type': 'hit'}, {'value': ' ', 'type': 'text'}, {'value': 'romance',
'type': 'hit'}, {'value': ', and discover they have little in common.', 'type': 'text'}]}]
Title: Vivacious Lady, text match details: [{'score': 2.220963478088379, 'path': 'plot',
'texts': [{'value': 'On a quick trip to the city, young university professor Peter Morgan
falls in love with nightclub performer Francey Brent and marries her after a ', 'type': 'text'},
{'value': 'whirlwind', 'type': 'hit'}, {'value': ' ', 'type': 'text'}, {'value': 'romance',
'type': 'hit'}, {'value': '. ', 'type': 'text'}]}]
Title: Ek Hasina Thi, text match details: [{'score': 3.11773419380188, 'path': 'plot', 'texts':
[{'value': 'The ', 'type': 'text'}, {'value': 'whirlwind', 'type': 'hit'}, {'value': ' ', 'type':
'text'}, {'value': 'romance', 'type': 'hit'}, {'value': ' turns sour when she is framed for his
underworld crimes. ', 'type': 'text'}]}]
Title: Kick, text match details: [{'score': 2.00649356842041, 'path': 'plot', 'texts': [{'value':
'An adrenaline junkie walks away from a ', 'type': 'text'}, {'value': 'whirlwind', 'type': 'hit'},
{'value': ' ', 'type': 'text'}, {'value': 'romance', 'type': 'hit'}, {'value': ' and embraces a new
life as a thief, though he soon finds himself pursued by veteran police officer and engaged in a turf
war with a local gangster.', 'type': 'text'}]}]
Title: A Tale of Winter, text match details: [{'score': 3.3978850841522217, 'path': 'plot', 'texts':
[{'value': 'Felicie and Charles have a serious if ', 'type': 'text'}, {'value': 'whirlwind', 'type':
'hit'}, {'value': ' holiday ', 'type': 'text'}, {'value': 'romance', 'type': 'hit'}, {'value': '. ',
'type': 'text'}]}]

Query datos geoespaciales

Se puede utilizar el método raw_aggregate() para ejecutar consultas en campos que contienen datos geoespaciales. Los datos geoespaciales representan una ubicación geográfica en la superficie de la Tierra o en un plano euclidiano.

Para ejecutar una **query** geoespacial, crea un índice de 2d o 2dsphere en campos que contengan datos geoespaciales. Luego, pasa uno de los siguientes operadores del query en un parámetro de la canalización de agregación al método raw_aggregate():

• $near

• $geoWithin

• $nearSphere

• $geoIntersects

Este ejemplo ejecuta una query geoespacial pasando las etapas de pipeline $match y $geoWithin al método raw_aggregate(). El código realiza las siguientes acciones:

• Especifica una lista de coordenadas que representan los límites de Chicago

• Queries para los documentos en los que el campo location.geo almacena una ubicación dentro del área de Chicago

• Recupera e imprime los theaterId valores de cada sala de cine en Chicago

chicago_bounds = {
    "type": "Polygon",
    "coordinates": [[
        [-87.851, 41.976],
        [-87.851, 41.653],
        [-87.651, 41.653],
        [-87.651, 41.976],
        [-87.851, 41.976] 
    ]]
}
theaters = Theater.objects.raw_aggregate([
    {
        "$match": {
            "location.geo": {
                "$geoWithin": {
                    "$geometry": chicago_bounds
                }
            }
        }
    },
    {
        "$project": {
            "theaterId": 1
        }
    }
])
for t in theaters:
    print(f"Theater ID: {t.theaterId}")

Theater ID: 2447
Theater ID: 311
Theater ID: 320
Theater ID: 2960
Theater ID: 2741
Theater ID: 306
Theater ID: 322
Theater ID: 319
Theater ID: 2862
Theater ID: 1777
Theater ID: 814
Theater ID: 323