pystratum_pgsql.wrapper package¶

Submodules¶

pystratum_pgsql.wrapper.PgSqlFunctionsWrapper module¶

class pystratum_pgsql.wrapper.PgSqlFunctionsWrapper.PgSqlFunctionsWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.FunctionsWrapper.FunctionsWrapper

Wrapper method generator for stored functions.

pystratum_pgsql.wrapper.PgSqlLogWrapper module¶

class pystratum_pgsql.wrapper.PgSqlLogWrapper.PgSqlLogWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.LogWrapper.LogWrapper

Wrapper method generator for stored procedures with designation type log.

pystratum_pgsql.wrapper.PgSqlNoneWrapper module¶

class pystratum_pgsql.wrapper.PgSqlNoneWrapper.PgSqlNoneWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.NoneWrapper.NoneWrapper

Wrapper method generator for stored procedures without any result set.

pystratum_pgsql.wrapper.PgSqlRow0Wrapper module¶

class pystratum_pgsql.wrapper.PgSqlRow0Wrapper.PgSqlRow0Wrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.Row0Wrapper.Row0Wrapper

Wrapper method generator for stored procedures that are selecting 0 or 1 row.

pystratum_pgsql.wrapper.PgSqlRow1Wrapper module¶

class pystratum_pgsql.wrapper.PgSqlRow1Wrapper.PgSqlRow1Wrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.Row1Wrapper.Row1Wrapper

Wrapper method generator for stored procedures that are selecting 1 row.

pystratum_pgsql.wrapper.PgSqlRowsWithIndexWrapper module¶

class pystratum_pgsql.wrapper.PgSqlRowsWithIndexWrapper.PgSqlRowsWithIndexWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_common.wrapper.RowsWithIndexWrapper.RowsWithIndexWrapper, pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper

Wrapper method generator for stored procedures whose result set must be returned using tree structure using a combination of non-unique columns.

pystratum_pgsql.wrapper.PgSqlRowsWithKeyWrapper module¶

class pystratum_pgsql.wrapper.PgSqlRowsWithKeyWrapper.PgSqlRowsWithKeyWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_common.wrapper.RowsWithKeyWrapper.RowsWithKeyWrapper, pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper

Wrapper method generator for stored procedures whose result set must be returned using tree structure using a combination of unique columns.

pystratum_pgsql.wrapper.PgSqlRowsWrapper module¶

class pystratum_pgsql.wrapper.PgSqlRowsWrapper.PgSqlRowsWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.RowsWrapper.RowsWrapper

Wrapper method generator for stored procedures that are selecting 0, 1, or more rows.

pystratum_pgsql.wrapper.PgSqlSingleton0Wrapper module¶

class pystratum_pgsql.wrapper.PgSqlSingleton0Wrapper.PgSqlSingleton0Wrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.Singleton0Wrapper.Singleton0Wrapper

Wrapper method generator for stored procedures that are selecting 0 or 1 row with one column only.

pystratum_pgsql.wrapper.PgSqlSingleton1Wrapper module¶

class pystratum_pgsql.wrapper.PgSqlSingleton1Wrapper.PgSqlSingleton1Wrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.Singleton1Wrapper.Singleton1Wrapper

Wrapper method generator for stored procedures that are selecting 1 row with one column only.

pystratum_pgsql.wrapper.PgSqlTableWrapper module¶

class pystratum_pgsql.wrapper.PgSqlTableWrapper.PgSqlTableWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper, pystratum_common.wrapper.TableWrapper.TableWrapper

Wrapper method generator for printing the result set of stored procedures in a table format.

pystratum_pgsql.wrapper.PgSqlWrapper module¶

class pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]¶

Bases: pystratum_common.wrapper.Wrapper.Wrapper

Parent class for wrapper method generators for stored functions.

is_lob_parameter(parameters)[source]¶

Returns True if one of the parameters is a BLOB or CLOB. Otherwise, returns False.

Parameters:	parameters (list[dict[str,str]]) – The parameters of a stored routine.
Return type:	bool

Module contents¶

PyStratum

pystratum_pgsql.wrapper.create_routine_wrapper(routine: Dict[KT, VT], lob_as_string_flag: bool) → pystratum_pgsql.wrapper.PgSqlWrapper.PgSqlWrapper[source]¶

A factory for creating the appropriate object for generating a wrapper method for a stored routine.

Parameters:	routine (dict[str,str]) – The metadata of the sored routine. lob_as_string_flag (bool) – If True BLOBs and CLOBs must be treated as strings.
Return type:	PgSqlWrapper