sqlmeta.objects.procedure

Classes

Parameter(name, data_type[, direction, ...])

Represents a stored procedure parameter.

Procedure(name[, schema, parameters, body, ...])

Represents a stored procedure or function.
class sqlmeta.objects.procedure.Parameter(name: str, data_type: str, direction: str = 'IN', default_value: str | None = None, dialect: str | None = None)[source]

Represents a stored procedure parameter.

__init__(name: str, data_type: str, direction: str = 'IN', default_value: str | None = None, dialect: str | None = None)[source]

Initialize a procedure parameter.

Parameters:

  • name – Parameter name

  • data_type – Parameter data type

  • direction – Parameter direction (IN, OUT, INOUT)

  • default_value – Default value for the parameter

  • dialect – SQL dialect (optional)

__str__() → str[source]

String representation of the parameter.

to_dict() → Dict[str, Any][source]

Convert parameter to dictionary.

classmethod from_dict(data: Dict[str, Any]) → Parameter[source]

Create parameter from dictionary.

class sqlmeta.objects.procedure.Procedure(name: str, schema: str | None = None, parameters: List[Parameter] | None = None, body: str | None = None, language: str = 'SQL', dialect: str | None = None, is_function: bool = False, return_type: str | None = None, comment: str | None = None, definition: str | None = None)[source]

Represents a stored procedure or function.

__init__(name: str, schema: str | None = None, parameters: List[Parameter] | None = None, body: str | None = None, language: str = 'SQL', dialect: str | None = None, is_function: bool = False, return_type: str | None = None, comment: str | None = None, definition: str | None = None)[source]

Initialize a stored procedure or function.

Parameters:

  • name – Procedure/function name

  • schema – Schema name

  • parameters – List of procedure/function parameters

  • body – Procedure/function body

  • language – Procedure language (SQL, PLSQL, PLPGSQL, TSQL, etc.)

  • dialect – SQL dialect

  • is_function – Whether this is a function (vs procedure)

  • return_type – Return type for functions

  • comment – Procedure/function comment/description

  • definition – Full procedure/function definition SQL

property create_statement: str

Generate CREATE PROCEDURE or CREATE FUNCTION statement.

The syntax varies by dialect.

Returns:

Dialect-specific CREATE PROCEDURE/FUNCTION statement

property drop_statement: str

Generate DROP PROCEDURE or DROP FUNCTION statement.

Returns:

SQL DROP PROCEDURE/FUNCTION statement

classmethod from_dict(data: Dict[str, Any]) → Procedure[source]

Create procedure/function from dictionary representation.

Parameters:

data – Dictionary with procedure/function attributes

Returns:

Procedure object

to_dict() → Dict[str, Any][source]

Convert procedure/function to dictionary representation.

Returns:

Dictionary with procedure/function attributes