easy_sql.sql_processor.backend.base

Module Contents

Classes

Backend

Partition

Row

SaveMode

Generic enumeration.

Table

TableMeta

class easy_sql.sql_processor.backend.base.Backend
abstract broadcast_table(self, table, name)
Parameters
abstract clean(self)
abstract clear_cache(self)
abstract clear_temp_tables(self, exclude=None)
Parameters

exclude (Optional[List[str]]) –

abstract create_cache_table(self, table, name)
Parameters
abstract create_empty_table(self)
abstract create_table_with_data(self, full_table_name, values, schema, partitions)
Parameters

  • full_table_name (str) –

  • values (List[List[Any]]) –

  • schema (Union[pyspark.sql.types.StructType, List[Col]]) –

  • partitions (List[Partition]) –

abstract create_temp_table(self, table, name)
Parameters
abstract create_temp_table_with_data(self, table_name, values, schema)
Parameters

  • table_name (str) –

  • values (List[List[Any]]) –

  • schema (Union[pyspark.sql.types.StructType, List[Col]]) –

abstract exec_native_sql(self, sql)
Parameters

sql (str) –

Return type

Any

abstract exec_sql(self, sql)
Parameters

sql (str) –

Return type

Table

abstract init_udfs(self, *args, **kwargs)
property is_bigquery_backend(self)
property is_clickhouse_backend(self)
property is_postgres_backend(self)
property is_rdb_backend(self)
property is_spark_backend(self)
abstract refresh_table_partitions(self, table)
Parameters

table (TableMeta) –

abstract register_udfs(self, funcs)
Parameters

funcs (Dict[str, Callable]) –

abstract reset(self)
abstract save_table(self, source_table, target_table, save_mode, create_target_table)
Parameters
abstract save_table_sql(self, source_table, source_table_sql, target_table)
Parameters
Return type

str

table_exists(self, table)
Parameters

table (TableMeta) –

abstract temp_tables(self)
Return type

List[str]

class easy_sql.sql_processor.backend.base.Partition(field, value=None)
Parameters

field (str) –

class easy_sql.sql_processor.backend.base.Row
abstract as_dict(self)
Return type

Dict[str, Any]

abstract as_tuple(self)
Return type

Tuple

class easy_sql.sql_processor.backend.base.SaveMode

Bases: enum.Enum

digraph inheritanced03f8233e5 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Enum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Generic enumeration."]; "SaveMode" [URL="#easy_sql.sql_processor.backend.base.SaveMode",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Enum" -> "SaveMode" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Generic enumeration.

Derive from this class to define new enumerations.

append = 1
overwrite = [0]
class easy_sql.sql_processor.backend.base.Table
abstract collect(self)
Return type

List[Row]

abstract count(self)
Return type

int

abstract field_names(self)
Return type

List[str]

abstract first(self)
Return type

Row

abstract is_empty(self)
Return type

bool

abstract limit(self, count)
Parameters

count (int) –

Return type

Table

abstract show(self, count)
Parameters

count (int) –

abstract with_column(self, name, value)
Parameters

  • name (str) –

  • value (Any) –

Return type

Table

class easy_sql.sql_processor.backend.base.TableMeta(table_name, partitions=None)
Parameters

  • table_name (str) –

  • partitions (Optional[List[Partition]]) –

clone_with_name(self, table_name)
Parameters

table_name (str) –

Return type

TableMeta

clone_with_partitions(self, partitions)
Parameters

partitions (List[Partition]) –

Return type

TableMeta

get_full_table_name(self, temp_db=None)
Parameters

temp_db (Optional[str]) –

has_dynamic_partition(self)
has_partitions(self)
update_partitions(self, partitions)
Parameters

partitions (List[Partition]) –

Return type

TableMeta