plasoscaffolder.model package

Submodules

plasoscaffolder.model.base_data_model module

The Base data model class.

class plasoscaffolder.model.base_data_model.BaseDataModel(plugin_name: str)

Bases: object

Class for the data for the formatter template.

plasoscaffolder.model.formatter_data_model module

The Formatter Data model class.

class plasoscaffolder.model.formatter_data_model.FormatterDataModel(plugin_name: str, queries: [<class 'plasoscaffolder.model.sql_query_model.SQLQueryModel'>])

Bases: plasoscaffolder.model.base_data_model.BaseDataModel

Class for the data for the formatter template.

plasoscaffolder.model.formatter_test_data_model module

The Formatter Test Data model class.

class plasoscaffolder.model.formatter_test_data_model.FormatterTestDataModel(plugin_name: str, queries: [<class 'plasoscaffolder.model.sql_query_model.SQLQueryModel'>])

Bases: plasoscaffolder.model.base_data_model.BaseDataModel

Class for the data for the formatter test template.

plasoscaffolder.model.init_data_model module

The Init Data model class.

class plasoscaffolder.model.init_data_model.InitDataModel(plugin_name: str, is_create_template: bool)

Bases: plasoscaffolder.model.base_data_model.BaseDataModel

Class for the data for the init template.

plasoscaffolder.model.parser_data_model module

The parser model class.

class plasoscaffolder.model.parser_data_model.ParserDataModel(plugin_name: str, queries: [<class 'plasoscaffolder.model.sql_query_model.SQLQueryModel'>], required_tables: [<class 'str'>], database_name: str)

Bases: plasoscaffolder.model.base_data_model.BaseDataModel

Class for the data for the parser template.

plasoscaffolder.model.parser_test_data_model module

The parser test model class.

class plasoscaffolder.model.parser_test_data_model.ParserTestDataModel(plugin_name: str, queries: [<class 'plasoscaffolder.model.sql_query_model.SQLQueryModel'>], database_name: str)

Bases: plasoscaffolder.model.base_data_model.BaseDataModel

Class for the data for the parser test template.

plasoscaffolder.model.sql_query_column_model module

Model for SQL column.

class plasoscaffolder.model.sql_query_column_model.SQLColumnModel(sql_column: str, sql_column_type: type = None)

Bases: object

Class for columns of a SQL Query.

GetColumnAsDescription() → str

SQL column name to description.

Returns:the column name from the SQL in description form Return type:str

GetColumnAsSnakeCase() → str

SQL column name to snake case.

Returns:the column name from the SQL in snake case Return type:str

GetColumnTypeAsName() → str

The type as the name.

example: <class ‘int’> type will be returned as int

Returns:the type as the name Return type:str

plasoscaffolder.model.sql_query_column_model_data module

Model for SQL column.

class plasoscaffolder.model.sql_query_column_model_data.SQLColumnModelData

Bases: plasoscaffolder.model.sql_query_column_model.SQLColumnModel

Class for columns of a SQL Query.

GetFirstDataForTimeEvent(timestamp: str) → str

The Data for the Time Event.

Parameters:timestamp (str) – the timestamp column name Returns:the data for the timestamp Return type:str

plasoscaffolder.model.sql_query_column_model_timestamp module

Model for SQL column.

class plasoscaffolder.model.sql_query_column_model_timestamp.SQLColumnModelTimestamp(sql_column: str, sql_column_type: type = None, expected_message: str = '', timestamp: str = '')

Bases: plasoscaffolder.model.sql_query_column_model.SQLColumnModel

Class for columns of a SQL Query.

GetShortExpectedMessage() → str

Getting the short expected message.

Returns:the short expected message Return type:str

plasoscaffolder.model.sql_query_model module

The SQL query model class.

class plasoscaffolder.model.sql_query_model.SQLQueryModel(query: str, name: str, columns: [<class 'plasoscaffolder.model.sql_query_column_model_data.SQLColumnModelData'>], timestamp_columns: [<class 'plasoscaffolder.model.sql_query_column_model_timestamp.SQLColumnModelTimestamp'>], needs_customizing: bool, amount_events: int)

Bases: object

A SQL query model.

Module contents