Easy SQL
stable
  • Easy SQL
  • Build and install Easy SQL
  • Quick start
  • Syntax
  • Debug ETL
  • Test ETL
  • Linter
  • Functions
  • UDFs
  • Variables
  • Flink backend
  • API Reference
    • ingest_funcs
    • ingest_hudi_funcs
    • easy_sql
      • Subpackages
        • easy_sql.cli
        • easy_sql.sql_linter
        • easy_sql.sql_processor
        • easy_sql.udf
        • easy_sql.utils
      • Submodules
    • sql_config
Easy SQL
  • »
  • API Reference »
  • easy_sql »
  • easy_sql.sql_processor »
  • easy_sql.sql_processor.funcs_flink
  • Edit on GitHub

easy_sql.sql_processor.funcs_flink

Module Contents

Classes

AlertFunc

AnalyticsFuncs

ColumnFuncs

ParallelismFuncs

StreamingFuncs

TableFuncs

TestFuncs

class easy_sql.sql_processor.funcs_flink.AlertFunc(backend, alerter)
Parameters
  • backend (Optional[easy_sql.sql_processor.backend.Backend]) –

  • alerter (Alerter) –

alert(self, step, context, rule_name, pass_condition, alert_template, mentioned_users)
Parameters
  • step (easy_sql.sql_processor.step.Step) –

  • context (easy_sql.sql_processor.context.ProcessorContext) –

  • rule_name (str) –

  • pass_condition (str) –

  • alert_template (str) –

  • mentioned_users (str) –

alert_exception_handler(self, rule_name, mentioned_users)
Parameters
  • rule_name (str) –

  • mentioned_users (str) –

alert_with_backend(self, backend, step, context, rule_name, pass_condition, alert_template, mentioned_users)
Parameters
  • backend (easy_sql.sql_processor.backend.Backend) –

  • step (easy_sql.sql_processor.step.Step) –

  • context (easy_sql.sql_processor.context.ProcessorContext) –

  • rule_name (str) –

  • pass_condition (str) –

  • alert_template (str) –

  • mentioned_users (str) –

class easy_sql.sql_processor.funcs_flink.AnalyticsFuncs(backend)
Parameters

backend (easy_sql.sql_processor.backend.Backend) –

data_profiling_report(self, table, query, output_folder, max_count='50000', include_correlations='true', types='html')
Parameters
  • table (str) –

  • query (str) –

  • output_folder (str) –

  • max_count (str) –

  • include_correlations (str) –

  • types (Union[str, List[str]]) –

class easy_sql.sql_processor.funcs_flink.ColumnFuncs(backend)
Parameters

backend (easy_sql.sql_processor.backend.Backend) –

all_cols_prefixed_with_exclusion_expr(self, table_name, prefix, *cols_to_exclude)
Parameters
  • table_name (str) –

  • prefix (str) –

  • cols_to_exclude (str) –

Return type

str

all_cols_with_exclusion_expr(self, table_name, *cols_to_exclude)
Parameters
  • table_name (str) –

  • cols_to_exclude (str) –

Return type

str

all_cols_without_one_expr(self, table_name, *cols_to_exclude)
Parameters
  • table_name (str) –

  • cols_to_exclude (str) –

Return type

str

class easy_sql.sql_processor.funcs_flink.ParallelismFuncs(flink)
Parameters

flink (easy_sql.sql_processor.backend.FlinkBackend) –

set_parallelism(self, partitions)
Parameters

partitions (str) –

class easy_sql.sql_processor.funcs_flink.StreamingFuncs(flink)
Parameters

flink (easy_sql.sql_processor.backend.FlinkBackend) –

execute_streaming_inserts(self)
class easy_sql.sql_processor.funcs_flink.TableFuncs(backend)
Parameters

backend (easy_sql.sql_processor.backend.Backend) –

check_not_null_column_in_table(self, step, table_name, not_null_column, query=None)
Parameters
  • step (easy_sql.sql_processor.step.Step) –

  • table_name (str) –

  • not_null_column (str) –

  • query (Optional[str]) –

Return type

bool

ensure_no_null_data_in_table(self, step, table_name, query=None)
Parameters
  • step (easy_sql.sql_processor.step.Step) –

  • table_name (str) –

  • query (Optional[str]) –

Return type

bool

class easy_sql.sql_processor.funcs_flink.TestFuncs(flink)

Bases: easy_sql.sql_processor.funcs_common.TestFuncs

digraph inheritancea645f0ecb5 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "TestFuncs" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "TestFuncs" [URL="#easy_sql.sql_processor.funcs_flink.TestFuncs",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"]; "TestFuncs" -> "TestFuncs" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
Parameters

flink (easy_sql.sql_processor.backend.FlinkBackend) –

exec_sql_in_source(self, step, db, connector)
Parameters
  • step (easy_sql.sql_processor.step.Step) –

  • db (str) –

  • connector (str) –

test_run_etl(self, config, etl_file)
Parameters
  • config (Any) –

  • etl_file (str) –

Previous Next

© Copyright 2022, easysql. Revision 246073b9.

Built with Sphinx using a theme provided by Read the Docs.