HOWTO · Django
Manipulation von Rohabfragen in Django
Wir werden mit dieser Erklärung lernen, was die Methode raw() tut und wie wir rohe Abfragen manipulieren können. Wir werden auch lernen, wie man SQL in unsere Anwendungen in Django einfügt.
Auf dieser Seite
Djangos Methode raw() führt eine rohe SQL-Abfrage aus und ordnet jede zurückgegebene Zeile einer Modellinstanz zu. Verwenden Sie sie, wenn sich eine Abfrage mit dem ORM nicht klar oder effizient ausdrücken lässt. Für gewöhnliche Filter und Aktualisierungen ist das ORM vorzuziehen, da es eine umfangreichere, kombinierbare API bietet. Auch bei rohem SQL müssen Parameter sorgfältig behandelt werden, und die Abfrage muss die Spalten zurückgeben, die Django zum Erstellen der Modellinstanzen benötigt.
Was Django’s raw() tut und wann Sie es verwenden sollten
Rufen Sie Student.objects.raw(sql, params=...) über einen Modellmanager auf. Das Ergebnis ist ein RawQuerySet: Sie können es durchlaufen und dabei Student-Objekte erhalten, es bietet jedoch nicht alle Operationen eines normalen QuerySet. Gehen Sie insbesondere nicht davon aus, dass Sie ORM-Filter verketten oder es als direkten Ersatz für Student.objects.filter(...) verwenden können.
Die Abfrage sollte die Primärschlüsselspalte des Modells auswählen. Django verwendet diesen Wert, um jede Modellinstanz zu identifizieren und zu erstellen. Ohne ihn kann die Abfrage nicht die erwarteten Modellergebnisse liefern. Der Tabellenname im SQL hängt vom App-Label und der Modellkonfiguration ab. Die folgenden Beispiele verwenden student_student, den üblichen Tabellennamen für ein Student-Modell in einer App namens student. Prüfen Sie vor der Anpassung, wie die Tabelle für Ihr Modell tatsächlich konfiguriert ist.
Modell und View-Beispiel vorbereiten
Nehmen wir an, models.py definiert wie im ursprünglichen Beispiel ein Student-Modell mit den Feldern FIRST_NAME, SR_NAME, age, CLASS_ROOM und TEACHER. Sein Manager ist Student.objects. Importieren Sie in views.py Student aus dem models-Modul Ihrer App und Djangos Hilfsfunktion render. Rufen Sie anschließend Student.objects.raw(sql, params=params) auf und übergeben Sie das Ergebnis an render(request, "output.html", {"data": students}). Die Beispiele verwenden die vorhandenen großgeschriebenen Feldnamen, damit SQL-Abfrage und Vorlage zu diesem Modell passen. Für ein neues Modell sind kleingeschriebene Feldnamen üblicher.
Für diese View wird angenommen, dass das Modell den Primärschlüssel id sowie die Felder FIRST_NAME, SR_NAME, age, CLASS_ROOM und TEACHER hat und dass die SQL-Tabelle student_student heißt. Ein kurzes Beispiel für views.py:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
# Minimal stand-ins make the view shape runnable outside a Django project.
# Replace these with Django's render helper and your actual Student model.
class StudentManager:
def raw(self, sql, params):
return [(sql, params)]
class Student:
objects = StudentManager()
def render(request, template_name, context):
return template_name, context
def student_data(request):
sql = "SELECT id, FIRST_NAME, SR_NAME, age, CLASS_ROOM, TEACHER FROM student_student WHERE age = %s"
students = Student.objects.raw(sql, params=[21])
return render(request, "output.html", {"data": students})
student_data(None)
Die obigen Platzhalter veranschaulichen den Aufruf. Importieren Sie in einem Django-Projekt render aus django.shortcuts und Student aus dem models-Modul Ihrer App. Abfrage und Vorlage gehören in ein Django-Projekt, nicht in ein eigenständiges Skript. Passen Sie den Tabellennamen an die konfigurierte Tabelle Ihres Modells an und legen Sie die Vorlage an einem Ort ab, an dem Django sie finden kann. Der Kontextschlüssel data sowie die Felder FIRST_NAME und age in der Vorlage stimmen mit der View und der Abfrage überein.
Rohe SQL-Abfrage ausführen und filtern
Wählen Sie neben den benötigten Feldern auch den Primärschlüssel aus. SELECT * ist beim Lernen praktisch, doch mit ausdrücklich angegebenen Spalten lassen sich die Modellzuordnung und die übertragenen Daten leichter überprüfen. Der Filter gehört in die SQL-Anweisung, zum Beispiel SELECT id, FIRST_NAME, SR_NAME, age, CLASS_ROOM, TEACHER FROM student_student WHERE age = %s. Die Spaltennamen müssen zum Datenbankschema passen. Wenn sich die Datenbankspaltennamen von den Modellfeldnamen unterscheiden, verwenden Sie db_column-Zuordnungen oder SQL-Aliase.
Führen Sie dieses Beispiel aus:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
sql = "SELECT id, FIRST_NAME, age FROM student_student WHERE age = %s"
params = [21]
print(sql)
print(params[0])
SELECT id, FIRST_NAME, age FROM student_student WHERE age = %s
21
Dieses eigenständige Beispiel gibt das SQL und den separat gebundenen Wert aus. Es verbindet sich weder mit Django noch führt es eine Datenbankabfrage aus. Übergeben Sie in der View beide Werte an Student.objects.raw(sql, params=params).
Zur Fehlersuche kann django.db.connection.queries Abfragen anzeigen, die Django aufgezeichnet hat, sofern die Abfrageprotokollierung aktiviert ist (häufig über DEBUG). Die Liste dient der Überprüfung, nicht als Leistungsmessung: Die Protokollierung verursacht zusätzlichen Aufwand, und anhand der aufgezeichneten Abfragen lässt sich nicht feststellen, wie sich eine Abfrage unter Produktionslast verhält.
Parameter sicher verwenden und zurückgegebene Modellinstanzen verstehen
Übergeben Sie Werte über params; formatieren Sie Benutzereingaben nicht in die SQL-Zeichenfolge und verketten Sie sie auch nicht damit. Django übermittelt SQL und Werte getrennt an den Datenbanktreiber. Verwenden Sie für Positionsparameter Djangos Platzhalterstil %s, auch bei Datenbank-Backends mit einer anderen nativen Platzhaltersyntax, und setzen Sie den Platzhalter nicht in Anführungszeichen. Die View übergibt den Wert separat mit Student.objects.raw(sql, params=params).
Die ausgewählten Spalten werden anhand ihres Namens den Modellfeldern zugeordnet. Wird ein Feld ausgelassen, stellt Django dessen Laden zurück. Ein späterer Zugriff auf dieses Attribut kann eine weitere Datenbankabfrage auslösen. Nehmen Sie die für die Antwort benötigten Felder auf, um unerwartete Folgeabfragen zu vermeiden, und wählen Sie immer den Primärschlüssel aus.
Ergebnisse roher Abfragen durchlaufen und begrenzen
Durchlaufen Sie das Ergebnis, um Modellinstanzen zu verarbeiten, zum Beispiel mit for student in Student.objects.raw(sql, params=params). Ein RawQuerySet lässt sich durchlaufen, unterstützt aber nicht die vollständige QuerySet-API. Das Aufteilen eines rohen Abfrageergebnisses ist keine zuverlässige Methode, um die Datenbankarbeit zu begrenzen: Die Begrenzung kann erst angewendet werden, nachdem Zeilen gelesen wurden. Legen Sie die Grenze stattdessen im SQL fest, etwa mit ... WHERE age = %s LIMIT 2 und params=[21], sofern die Datenbank LIMIT unterstützt. Die SQL-Syntax für die Seitennavigation unterscheidet sich je nach Backend. Verwenden Sie daher die Syntax der in Ihrem Projekt konfigurierten Datenbank.
Achten Sie außerdem auf eine ausdrückliche Sortierung, wenn es auf die konkret zuerst zurückgegebenen Zeilen ankommt. Ohne ORDER BY garantiert die Datenbank keine stabile Reihenfolge.
Ergebnisse in einer Django-Vorlage anzeigen
Die View übergibt ihr RawQuerySet unter dem Schlüssel data. Durchlaufen Sie in output.html diesen Kontextwert und zeigen Sie die Modellfelder an, zum Beispiel {% for student in data %}<div>{{ student.FIRST_NAME }} — {{ student.age }}</div>{% endfor %}. Django-Vorlagen maskieren die Ausgabe von Variablen standardmäßig, was für gewöhnliche Textfelder geeignet ist. So werden die ausgewählten Spalten und Modellfelder mit dem Inhalt verknüpft, den die Seite anzeigt. Nehmen Sie jedes von der Vorlage verwendete Feld in die Abfrage auf, damit Django es nicht erst verzögert laden muss.