Chamar procedimentos armazenados a partir do Django

Este artigo explica como criar e chamar procedimentos armazenados do SQL Server a partir de aplicações Django usando o mssql-django backend.

Criar um procedimento armazenado numa migração

Use migrations.RunSQL para criar um procedimento armazenado como parte do seu fluxo de trabalho de migração para o Django:

from django.db import migrations

class Migration(migrations.Migration):

    dependencies = [
        ("myapp", "0001_initial"),
    ]

    operations = [
        migrations.RunSQL(
            sql="""
                CREATE PROCEDURE GetProductsByCategory
                    @CategoryName NVARCHAR(100)
                AS
                BEGIN
                    SET NOCOUNT ON;
                    SELECT id, name, price
                    FROM myapp_product
                    WHERE category = @CategoryName;
                END;
            """,
            reverse_sql="DROP PROCEDURE IF EXISTS GetProductsByCategory;",
        ),
    ]

Aplicar a migração:

python manage.py migrate

Chamar um procedimento armazenado

Use o Django connection.cursor() para chamar procedimentos armazenados com SQL bruto:

from django.db import connection

def get_products_by_category(category_name):
    with connection.cursor() as cursor:
        cursor.execute("EXECUTE GetProductsByCategory @CategoryName = %s;", [category_name])
        results = cursor.fetchall()
    return results

Chamar um procedimento armazenado com múltiplos parâmetros

Passe vários parâmetros como uma lista:

from django.db import connection

def search_products(category_name, min_price):
    with connection.cursor() as cursor:
        cursor.execute(
            "EXECUTE SearchProducts @CategoryName = %s, @MinPrice = %s;",
            [category_name, min_price],
        )
        results = cursor.fetchall()
    return results

Leia os nomes das colunas a partir dos resultados

Aceder aos nomes das colunas a partir de cursor.description:

from django.db import connection

def get_products_as_dicts(category_name):
    with connection.cursor() as cursor:
        cursor.execute("EXECUTE GetProductsByCategory @CategoryName = %s;", [category_name])
        columns = [col[0] for col in cursor.description]
        results = [dict(zip(columns, row)) for row in cursor.fetchall()]
    return results

Lidar com múltiplos conjuntos de resultados

Alguns procedimentos armazenados retornam múltiplos conjuntos de resultados. Use cursor.nextset() para navegar entre eles:

from django.db import connection

def get_dashboard_data():
    with connection.cursor() as cursor:
        cursor.execute("EXECUTE GetDashboardData;")

        # First result set
        products = cursor.fetchall()

        # Move to second result set
        cursor.nextset()
        categories = cursor.fetchall()

    return products, categories

Envolver num manager do Django

Encapsular chamadas de procedimentos armazenados num gestor personalizado para um código mais limpo:

from django.db import connection, models

class ProductManager(models.Manager):
    def by_category(self, category_name):
        with connection.cursor() as cursor:
            cursor.execute(
                "EXECUTE GetProductsByCategory @CategoryName = %s;",
                [category_name],
            )
            columns = [col[0] for col in cursor.description]
            return [dict(zip(columns, row)) for row in cursor.fetchall()]

class Product(models.Model):
    name = models.CharField(max_length=100)
    price = models.DecimalField(max_digits=10, decimal_places=2)
    category = models.CharField(max_length=100)

    objects = ProductManager()

Utilização:

products = Product.objects.by_category("Electronics")

Conteúdo relacionado

  • Last updated on