この記事では、mssql-django バックエンドを使用して Django アプリケーションからSQL Serverストアド プロシージャを作成して呼び出す方法について説明します。
移行でストアド プロシージャを作成する
migrations.RunSQLを使用して、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;",
),
]
移行を適用します。
python manage.py migrate
ストアド プロシージャを呼び出す
Django の connection.cursor() を使用して、生の SQL でストアド プロシージャを呼び出します。
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
複数のパラメーターを使用してストアド プロシージャを呼び出す
複数のパラメーターをリストとして渡します。
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
結果から列名を読み取る
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
複数の結果セットの処理
一部のストアド プロシージャでは、複数の結果セットが返されます。
cursor.nextset()を使用してそれらの間を移動します。
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
Django マネージャーで包む
よりクリーンなコードのために、カスタム マネージャーでストアド プロシージャの呼び出しをカプセル化します。
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()
使用法:
products = Product.objects.by_category("Electronics")