|
| 1 | +# src/rhosocial/activerecord/backend/impl/sqlserver/expression/ddl/routine.py |
| 2 | +"""SQL Server stored procedure / function DDL expressions. |
| 3 | +
|
| 4 | +T-SQL routines use a distinctive syntax compared to SQL/PSM: |
| 5 | +
|
| 6 | + CREATE PROCEDURE [dbo].[p] @x INT AS BEGIN SET NOCOUNT ON; SELECT @x + 1; END; |
| 7 | + CREATE FUNCTION dbo.f (@x INT) RETURNS INT AS BEGIN RETURN @x * 2; END; |
| 8 | + DROP PROCEDURE p; DROP FUNCTION f; |
| 9 | +
|
| 10 | +SQL generation and version gating are delegated to the dialect's |
| 11 | +``format_create_procedure_statement`` / ``format_create_function_statement`` |
| 12 | +/ ``format_drop_routine_statement`` formatters. Bodies are passed through |
| 13 | +verbatim as raw T-SQL strings. |
| 14 | +""" |
| 15 | + |
| 16 | +from typing import Any, List, Optional, TYPE_CHECKING |
| 17 | + |
| 18 | +from rhosocial.activerecord.backend.expression.bases import BaseExpression, SQLQueryAndParams |
| 19 | + |
| 20 | +if TYPE_CHECKING: |
| 21 | + from ...dialect import SQLServerDialect |
| 22 | + |
| 23 | + |
| 24 | +class SQLServerCreateProcedureExpression(BaseExpression): |
| 25 | + """SQL Server CREATE PROCEDURE statement (2005+). |
| 26 | +
|
| 27 | + Attributes: |
| 28 | + name: Procedure name (may be schema-qualified like ``dbo.p``). |
| 29 | + parameters: List of parameters. Each entry is either a raw |
| 30 | + ``"@x INT"`` string or a ``{"name": "@x", "type": "INT"}`` dict. |
| 31 | + body: Raw T-SQL body passed through verbatim. |
| 32 | + schema: Optional schema qualifier (rendered as ``[schema].[name]``). |
| 33 | + or_alter: Whether to render ``CREATE OR ALTER PROCEDURE``. |
| 34 | +
|
| 35 | + Example: |
| 36 | + >>> expr = SQLServerCreateProcedureExpression( |
| 37 | + ... dialect, "p", ["@x INT"], body="SET NOCOUNT ON; SELECT @x + 1;", |
| 38 | + ... schema="dbo", |
| 39 | + ... ) |
| 40 | + >>> sql, params = expr.to_sql() |
| 41 | + >>> assert sql == "CREATE PROCEDURE [dbo].[p] @x INT AS BEGIN SET NOCOUNT ON; SELECT @x + 1; END;" |
| 42 | + """ |
| 43 | + |
| 44 | + def __init__( |
| 45 | + self, |
| 46 | + dialect: "SQLServerDialect", |
| 47 | + name: str, |
| 48 | + parameters: Optional[List[Any]] = None, |
| 49 | + body: str = "", |
| 50 | + *, |
| 51 | + schema: Optional[str] = None, |
| 52 | + or_alter: bool = False, |
| 53 | + ): |
| 54 | + super().__init__(dialect) |
| 55 | + self.name = name |
| 56 | + self.parameters = list(parameters or []) |
| 57 | + self.body = body |
| 58 | + self.schema = schema |
| 59 | + self.or_alter = or_alter |
| 60 | + |
| 61 | + def validate(self, strict: bool = True) -> None: |
| 62 | + if not strict: |
| 63 | + return |
| 64 | + if not self.name: |
| 65 | + raise ValueError("procedure name is required") |
| 66 | + if not self.body: |
| 67 | + raise ValueError("procedure body is required") |
| 68 | + |
| 69 | + def to_sql(self) -> SQLQueryAndParams: |
| 70 | + return self.dialect.format_create_procedure_statement(self) |
| 71 | + |
| 72 | + |
| 73 | +class SQLServerCreateFunctionExpression(BaseExpression): |
| 74 | + """SQL Server CREATE FUNCTION (scalar) statement (2005+). |
| 75 | +
|
| 76 | + Attributes: |
| 77 | + name: Function name (may be schema-qualified like ``dbo.f``). |
| 78 | + parameters: List of parameters (see |
| 79 | + ``SQLServerCreateProcedureExpression``). |
| 80 | + returns: Scalar return data type, e.g. ``INT``. |
| 81 | + body: Raw T-SQL body passed through verbatim. |
| 82 | + schema: Optional schema qualifier. |
| 83 | + or_alter: Whether to render ``CREATE OR ALTER FUNCTION``. |
| 84 | +
|
| 85 | + Example: |
| 86 | + >>> expr = SQLServerCreateFunctionExpression( |
| 87 | + ... dialect, "f", ["@x INT"], returns="INT", |
| 88 | + ... body="RETURN @x * 2;", schema="dbo", |
| 89 | + ... ) |
| 90 | + >>> sql, params = expr.to_sql() |
| 91 | + >>> assert sql == "CREATE FUNCTION [dbo].[f] (@x INT) RETURNS INT AS BEGIN RETURN @x * 2; END;" |
| 92 | + """ |
| 93 | + |
| 94 | + def __init__( |
| 95 | + self, |
| 96 | + dialect: "SQLServerDialect", |
| 97 | + name: str, |
| 98 | + parameters: Optional[List[Any]] = None, |
| 99 | + returns: Optional[str] = None, |
| 100 | + body: str = "", |
| 101 | + *, |
| 102 | + schema: Optional[str] = None, |
| 103 | + or_alter: bool = False, |
| 104 | + ): |
| 105 | + super().__init__(dialect) |
| 106 | + self.name = name |
| 107 | + self.parameters = list(parameters or []) |
| 108 | + self.returns = returns |
| 109 | + self.body = body |
| 110 | + self.schema = schema |
| 111 | + self.or_alter = or_alter |
| 112 | + |
| 113 | + def validate(self, strict: bool = True) -> None: |
| 114 | + if not strict: |
| 115 | + return |
| 116 | + if not self.name: |
| 117 | + raise ValueError("function name is required") |
| 118 | + if not self.returns: |
| 119 | + raise ValueError("RETURNS type is required for a scalar function") |
| 120 | + if not self.body: |
| 121 | + raise ValueError("function body is required") |
| 122 | + |
| 123 | + def to_sql(self) -> SQLQueryAndParams: |
| 124 | + return self.dialect.format_create_function_statement(self) |
| 125 | + |
| 126 | + |
| 127 | +class SQLServerDropRoutineExpression(BaseExpression): |
| 128 | + """SQL Server DROP PROCEDURE / DROP FUNCTION statement (2005+). |
| 129 | +
|
| 130 | + Attributes: |
| 131 | + name: Routine name (may be schema-qualified). |
| 132 | + kind: Either ``PROCEDURE`` or ``FUNCTION``. |
| 133 | + schema: Optional schema qualifier. |
| 134 | + if_exists: Render ``IF EXISTS`` (SQL Server 2016+ only). |
| 135 | +
|
| 136 | + Example: |
| 137 | + >>> expr = SQLServerDropRoutineExpression(dialect, "p", "PROCEDURE") |
| 138 | + >>> sql, params = expr.to_sql() |
| 139 | + >>> assert sql == "DROP PROCEDURE [p]" |
| 140 | + """ |
| 141 | + |
| 142 | + def __init__( |
| 143 | + self, |
| 144 | + dialect: "SQLServerDialect", |
| 145 | + name: str, |
| 146 | + kind: str = "PROCEDURE", |
| 147 | + *, |
| 148 | + schema: Optional[str] = None, |
| 149 | + if_exists: bool = False, |
| 150 | + ): |
| 151 | + super().__init__(dialect) |
| 152 | + self.name = name |
| 153 | + self.kind = kind |
| 154 | + self.schema = schema |
| 155 | + self.if_exists = if_exists |
| 156 | + |
| 157 | + def validate(self, strict: bool = True) -> None: |
| 158 | + if not strict: |
| 159 | + return |
| 160 | + if not self.name: |
| 161 | + raise ValueError("routine name is required") |
| 162 | + if self.kind.upper() not in ("PROCEDURE", "FUNCTION"): |
| 163 | + raise ValueError("kind must be either PROCEDURE or FUNCTION") |
| 164 | + |
| 165 | + def to_sql(self) -> SQLQueryAndParams: |
| 166 | + return self.dialect.format_drop_routine_statement(self) |
0 commit comments