pystratum_mysql.wrapper package

Submodules

pystratum_mysql.wrapper.MySqlBulkWrapper module

class pystratum_mysql.wrapper.MySqlBulkWrapper.MySqlBulkWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.BulkWrapper.BulkWrapper

Wrapper method generator for stored procedures with large result sets.

pystratum_mysql.wrapper.MySqlFunctionsWrapper module

class pystratum_mysql.wrapper.MySqlFunctionsWrapper.MySqlFunctionsWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.FunctionsWrapper.FunctionsWrapper

Wrapper method generator for stored functions.

pystratum_mysql.wrapper.MySqlLogWrapper module

class pystratum_mysql.wrapper.MySqlLogWrapper.MySqlLogWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.LogWrapper.LogWrapper

Wrapper method generator for stored procedures with designation type log.

pystratum_mysql.wrapper.MySqlMultiWrapper module

class pystratum_mysql.wrapper.MySqlMultiWrapper.MySqlMultiWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.MultiWrapper.MultiWrapper

Wrapper method generator for stored procedures with designation type multi.

pystratum_mysql.wrapper.MySqlNoneWrapper module

class pystratum_mysql.wrapper.MySqlNoneWrapper.MySqlNoneWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.NoneWrapper.NoneWrapper

Wrapper method generator for stored procedures without any result set.

pystratum_mysql.wrapper.MySqlRow0Wrapper module

class pystratum_mysql.wrapper.MySqlRow0Wrapper.MySqlRow0Wrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.Row0Wrapper.Row0Wrapper

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

pystratum_mysql.wrapper.MySqlRow1Wrapper module

class pystratum_mysql.wrapper.MySqlRow1Wrapper.MySqlRow1Wrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.Row1Wrapper.Row1Wrapper

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

pystratum_mysql.wrapper.MySqlRowsWithIndexWrapper module

class pystratum_mysql.wrapper.MySqlRowsWithIndexWrapper.MySqlRowsWithIndexWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_common.wrapper.RowsWithIndexWrapper.RowsWithIndexWrapper, pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper

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

pystratum_mysql.wrapper.MySqlRowsWithKeyWrapper module

class pystratum_mysql.wrapper.MySqlRowsWithKeyWrapper.MySqlRowsWithKeyWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_common.wrapper.RowsWithKeyWrapper.RowsWithKeyWrapper, pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper

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

pystratum_mysql.wrapper.MySqlRowsWrapper module

class pystratum_mysql.wrapper.MySqlRowsWrapper.MySqlRowsWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.RowsWrapper.RowsWrapper

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

pystratum_mysql.wrapper.MySqlSingleton0Wrapper module

class pystratum_mysql.wrapper.MySqlSingleton0Wrapper.MySqlSingleton0Wrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.Singleton0Wrapper.Singleton0Wrapper

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

pystratum_mysql.wrapper.MySqlSingleton1Wrapper module

class pystratum_mysql.wrapper.MySqlSingleton1Wrapper.MySqlSingleton1Wrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_common.wrapper.Singleton1Wrapper.Singleton1Wrapper, pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper

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

pystratum_mysql.wrapper.MySqlTableWrapper module

class pystratum_mysql.wrapper.MySqlTableWrapper.MySqlTableWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper, pystratum_common.wrapper.TableWrapper.TableWrapper

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

pystratum_mysql.wrapper.MySqlWrapper module

class pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper(routine: Dict[str, Any], lob_as_string_flag: bool)[source]

Bases: pystratum_common.wrapper.Wrapper.Wrapper, abc.ABC

Parent class for wrapper method generators for stored procedures and functions.

is_lob_parameter(parameters: List[Dict[str, Any]]) → bool[source]

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

Parameters:parameters – The parameters of a stored routine.
Return type:bool:

Module contents

pystratum_mysql.wrapper.create_routine_wrapper(routine: Dict[str, Any], lob_as_string_flag: bool) → pystratum_mysql.wrapper.MySqlWrapper.MySqlWrapper[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:

MySqlWrapper