pytsql package

Submodules

• pytsql.tsql module
  • execute()
  • executes()
  • iter_executes_batches()

Module contents

Pytsql allows to run mssql scripts, typically run via GUIs, via CLI.

pytsql.execute(path: str | Path, engine: Engine, parameters: dict[str, Any] | None = None, isolate_top_level_statements=True, encoding: str = 'utf-8') → None

Execute a given sql script through a sqlalchemy.engine.Engine connection.

Returns:

None

pytsql.executes(code: str, engine: Engine, parameters: dict[str, Any] | None = None, isolate_top_level_statements=True) → None

Execute a given sql string through a sqlalchemy.engine.Engine connection.

Please note either no parameters should be used or all parameters marked in a sql script should be given.

Returns:

None

pytsql.iter_executes_batches(code: str, engine: Engine, parameters: dict[str, Any] | None = None, isolate_top_level_statements: bool = True) → Iterator[tuple[str, Callable[[], None]]]

Yields (sql_batch_string, run) for each batch. Mimics executes() but returns a generator where run() can be called to execute each batch.

Returns:

Iterator of (sql_batch_string, run) tuples where run() executes the batch.