etlplus 0.4.7__py3-none-any.whl → 0.7.0__py3-none-any.whl

etlplus/cli/app.py

@@ -25,6 +25,7 @@ Subcommands
 - ``validate``: validate data against rules
 - ``transform``: transform records
 - ``load``: load data to files, databases, or REST APIs
+- ``render``: render SQL DDL from table schema specs
 
 Notes
 -----
@@ -56,13 +57,14 @@ from .. import __version__
 from ..enums import DataConnectorType
 from ..enums import FileFormat
 from ..utils import json_type
-from .handlers import cmd_extract
-from .handlers import cmd_list
-from .handlers import cmd_load
-from .handlers import cmd_pipeline
-from .handlers import cmd_run
-from .handlers import cmd_transform
-from .handlers import cmd_validate
+from .handlers import check_handler
+from .handlers import extract_handler
+from .handlers import load_handler
+from .handlers import pipeline_handler
+from .handlers import render_handler
+from .handlers import run_handler
+from .handlers import transform_handler
+from .handlers import validate_handler
 
 # SECTION: EXPORTS ========================================================== #
 
@@ -125,62 +127,90 @@ PROJECT_URL: Final[str] = 'https://github.com/Dagitali/ETLPlus'
 # SECTION: TYPE ALIASES ==================================================== #
 
 
-SourceInputArg = Annotated[
+OperationsJSONOption = Annotated[
     str,
-    typer.Argument(
-        ...,
-        metavar='SOURCE',
-        help=(
-            'Extract from SOURCE. Use --from/--source-type to override the '
-            'inferred connector when needed.'
-        ),
+    typer.Option(
+        '--operations',
+        help='Transformation operations as JSON string.',
     ),
 ]
 
-StreamingSourceArg = Annotated[
+PipelineConfigOption = Annotated[
     str,
-    typer.Argument(
+    typer.Option(
         ...,
-        metavar='SOURCE',
-        help=(
-            'Data source to transform or validate (path, JSON payload, or '
-            '- for stdin).'
-        ),
+        '--config',
+        metavar='PATH',
+        help='Path to pipeline YAML configuration file.',
     ),
 ]
 
-TargetInputArg = Annotated[
-    str,
-    typer.Argument(
-        ...,
-        metavar='TARGET',
-        help=(
-            'Load JSON data from stdin into TARGET. Use --to/--target-type '
-            'to override connector inference when needed. Source data must '
-            'be piped into stdin.'
-        ),
+RenderConfigOption = Annotated[
+    str | None,
+    typer.Option(
+        '--config',
+        metavar='PATH',
+        help='Pipeline YAML that includes table_schemas for rendering.',
+        show_default=False,
     ),
 ]
 
-SourceOverrideOption = Annotated[
+RenderOutputOption = Annotated[
     str | None,
     typer.Option(
-        '--source-type',
-        metavar='CONNECTOR',
-        show_default=False,
-        rich_help_panel='I/O overrides',
-        help='Override the inferred source type (file, database, api).',
+        '--output',
+        '-o',
+        metavar='PATH',
+        help='Write rendered SQL to PATH (default: stdout).',
     ),
 ]
 
-TargetOverrideOption = Annotated[
+RenderSpecOption = Annotated[
     str | None,
     typer.Option(
-        '--target-type',
-        metavar='CONNECTOR',
+        '--spec',
+        metavar='PATH',
+        help='Standalone table spec file (.yml/.yaml/.json).',
         show_default=False,
-        rich_help_panel='I/O overrides',
-        help='Override the inferred target type (file, database, api).',
+    ),
+]
+
+RenderTableOption = Annotated[
+    str | None,
+    typer.Option(
+        '--table',
+        metavar='NAME',
+        help='Filter to a single table name from table_schemas.',
+    ),
+]
+
+RenderTemplateOption = Annotated[
+    str,
+    typer.Option(
+        '--template',
+        '-t',
+        metavar='KEY|PATH',
+        help='Template key (ddl/view) or path to a Jinja template file.',
+        show_default=True,
+    ),
+]
+
+RenderTemplatePathOption = Annotated[
+    str | None,
+    typer.Option(
+        '--template-path',
+        metavar='PATH',
+        help=(
+            'Explicit path to a Jinja template file (overrides template key).'
+        ),
+    ),
+]
+
+RulesJSONOption = Annotated[
+    str,
+    typer.Option(
+        '--rules',
+        help='Validation rules as JSON string.',
     ),
 ]
 
@@ -198,6 +228,29 @@ SourceFormatOption = Annotated[
     ),
 ]
 
+SourceInputArg = Annotated[
+    str,
+    typer.Argument(
+        ...,
+        metavar='SOURCE',
+        help=(
+            'Extract from SOURCE. Use --from/--source-type to override the '
+            'inferred connector when needed.'
+        ),
+    ),
+]
+
+SourceOverrideOption = Annotated[
+    str | None,
+    typer.Option(
+        '--source-type',
+        metavar='CONNECTOR',
+        show_default=False,
+        rich_help_panel='I/O overrides',
+        help='Override the inferred source type (file, database, api).',
+    ),
+]
+
 StdinFormatOption = Annotated[
     str | None,
     typer.Option(
@@ -209,6 +262,18 @@ StdinFormatOption = Annotated[
     ),
 ]
 
+StreamingSourceArg = Annotated[
+    str,
+    typer.Argument(
+        ...,
+        metavar='SOURCE',
+        help=(
+            'Data source to transform or validate (path, JSON payload, or '
+            '- for stdin).'
+        ),
+    ),
+]
+
 TargetFormatOption = Annotated[
     str | None,
     typer.Option(
@@ -223,19 +288,27 @@ TargetFormatOption = Annotated[
     ),
 ]
 
-OperationsJSONOption = Annotated[
+TargetInputArg = Annotated[
     str,
-    typer.Option(
-        '--operations',
-        help='Transformation operations as JSON string.',
+    typer.Argument(
+        ...,
+        metavar='TARGET',
+        help=(
+            'Load JSON data from stdin into TARGET. Use --to/--target-type '
+            'to override connector inference when needed. Source data must '
+            'be piped into stdin.'
+        ),
     ),
 ]
 
-RulesJSONOption = Annotated[
-    str,
+TargetOverrideOption = Annotated[
+    str | None,
     typer.Option(
-        '--rules',
-        help='Validation rules as JSON string.',
+        '--target-type',
+        metavar='CONNECTOR',
+        show_default=False,
+        rich_help_panel='I/O overrides',
+        help='Override the inferred target type (file, database, api).',
     ),
 ]
 
@@ -248,16 +321,6 @@ TargetPathOption = Annotated[
     ),
 ]
 
-PipelineConfigOption = Annotated[
-    str,
-    typer.Option(
-        ...,
-        '--config',
-        metavar='PATH',
-        help='Path to pipeline YAML configuration file.',
-    ),
-]
-
 
 # SECTION: DATA CLASSES ===================================================== #
 
@@ -682,6 +745,83 @@ def _root(
         raise typer.Exit(0)
 
 
+@app.command('check')
+def check_cmd(
+    ctx: typer.Context,
+    config: PipelineConfigOption,
+    jobs: bool = typer.Option(
+        False,
+        '--jobs',
+        help='List available job names and exit',
+    ),
+    pipelines: bool = typer.Option(
+        False,
+        '--pipelines',
+        help='List ETL pipelines',
+    ),
+    sources: bool = typer.Option(
+        False,
+        '--sources',
+        help='List data sources',
+    ),
+    summary: bool = typer.Option(
+        False,
+        '--summary',
+        help='Show pipeline summary (name, version, sources, targets, jobs)',
+    ),
+    targets: bool = typer.Option(
+        False,
+        '--targets',
+        help='List data targets',
+    ),
+    transforms: bool = typer.Option(
+        False,
+        '--transforms',
+        help='List data transforms',
+    ),
+) -> int:
+    """
+    Print ETL entities from a pipeline YAML configuration.
+
+    Parameters
+    ----------
+    ctx : typer.Context
+        Typer execution context provided to the command.
+    config : PipelineConfigOption
+        Path to pipeline YAML configuration file.
+    jobs : bool, optional
+        If True, list available job names and exit.
+    pipelines : bool, optional
+        If True, list ETL pipelines.
+    sources : bool, optional
+        If True, list data sources.
+    summary : bool, optional
+        If True, show pipeline summary (name, version, sources, targets, jobs).
+    targets : bool, optional
+        If True, list data targets.
+    transforms : bool, optional
+        If True, list data transforms.
+
+    Returns
+    -------
+    int
+        Zero on success.
+    """
+    state = _ensure_state(ctx)
+    ns = _stateful_namespace(
+        state,
+        command='check',
+        config=config,
+        summary=summary,
+        pipelines=pipelines,
+        jobs=jobs,
+        sources=sources,
+        targets=targets,
+        transforms=transforms,
+    )
+    return int(check_handler(ns))
+
+
 @app.command('extract')
 def extract_cmd(
     ctx: typer.Context,
@@ -765,68 +905,7 @@ def extract_cmd(
         source=resolved_source,
         **format_kwargs,
     )
-    return int(cmd_extract(ns))
-
-
-@app.command('list')
-def list_cmd(
-    ctx: typer.Context,
-    config: PipelineConfigOption,
-    jobs: bool = typer.Option(
-        False,
-        '--jobs',
-        help='List available job names and exit',
-    ),
-    pipelines: bool = typer.Option(
-        False,
-        '--pipelines',
-        help='List ETL pipelines',
-    ),
-    sources: bool = typer.Option(False, '--sources', help='List data sources'),
-    targets: bool = typer.Option(False, '--targets', help='List data targets'),
-    transforms: bool = typer.Option(
-        False,
-        '--transforms',
-        help='List data transforms',
-    ),
-) -> int:
-    """
-    Print ETL entities from a pipeline YAML configuration.
-
-    Parameters
-    ----------
-    ctx : typer.Context
-        Typer execution context provided to the command.
-    config : PipelineConfigOption
-        Path to pipeline YAML configuration file.
-    jobs : bool, optional
-        If True, list available job names and exit.
-    pipelines : bool, optional
-        If True, list ETL pipelines.
-    sources : bool, optional
-        If True, list data sources.
-    targets : bool, optional
-        If True, list data targets.
-    transforms : bool, optional
-        If True, list data transforms.
-
-    Returns
-    -------
-    int
-        Zero on success.
-    """
-    state = _ensure_state(ctx)
-    ns = _stateful_namespace(
-        state,
-        command='list',
-        config=config,
-        pipelines=pipelines,
-        jobs=jobs,
-        sources=sources,
-        targets=targets,
-        transforms=transforms,
-    )
-    return int(cmd_list(ns))
+    return int(extract_handler(ns))
 
 
 @app.command('load')
@@ -928,7 +1007,7 @@ def load_cmd(
         target=resolved_target,
         **format_kwargs,
     )
-    return int(cmd_load(ns))
+    return int(load_handler(ns))
 
 
 @app.command('pipeline')
@@ -953,7 +1032,7 @@ def pipeline_cmd(
     ),
 ) -> int:
     """
-    Inspect or run a pipeline YAML configuration.
+    Deprecated wrapper to inspect or run a pipeline YAML configuration.
 
     Parameters
     ----------
@@ -982,7 +1061,56 @@ def pipeline_cmd(
         list=jobs,
         run=run_target,
     )
-    return int(cmd_pipeline(ns))
+    return int(pipeline_handler(ns))
+
+
+@app.command('render')
+def render_cmd(
+    ctx: typer.Context,
+    config: RenderConfigOption = None,
+    spec: RenderSpecOption = None,
+    table: RenderTableOption = None,
+    template: RenderTemplateOption = 'ddl',
+    template_path: RenderTemplatePathOption = None,
+    output: RenderOutputOption = None,
+) -> int:
+    """
+    Render SQL DDL from table schemas defined in YAML/JSON configs.
+
+    Parameters
+    ----------
+    ctx : typer.Context
+        Typer execution context provided to the command.
+    config : RenderConfigOption, optional
+        Pipeline YAML containing ``table_schemas`` entries.
+    spec : RenderSpecOption, optional
+        Standalone table spec file (.yml/.yaml/.json).
+    table : RenderTableOption, optional
+        Filter to a single table name within the available specs.
+    template : RenderTemplateOption, optional
+        Built-in template key or template file path.
+    template_path : RenderTemplatePathOption, optional
+        Explicit template file path to render with.
+    output : RenderOutputOption, optional
+        Path to write SQL to (stdout when omitted).
+
+    Returns
+    -------
+    int
+        Zero on success.
+    """
+    state = _ensure_state(ctx)
+    ns = _stateful_namespace(
+        state,
+        command='render',
+        config=config,
+        spec=spec,
+        table=table,
+        template=template,
+        template_path=template_path,
+        output=output,
+    )
+    return int(render_handler(ns))
 
 
 @app.command('run')
@@ -1029,7 +1157,7 @@ def run_cmd(
         job=job,
         pipeline=pipeline,
     )
-    return int(cmd_run(ns))
+    return int(run_handler(ns))
 
 
 @app.command('transform')
@@ -1166,7 +1294,7 @@ def transform_cmd(
         target_format=target_format_kwargs['format'],
         **target_format_kwargs,
     )
-    return int(cmd_transform(ns))
+    return int(transform_handler(ns))
 
 
 @app.command('validate')
@@ -1236,4 +1364,4 @@ def validate_cmd(
         source_format=source_format,
         **source_format_kwargs,
     )
-    return int(cmd_validate(ns))
+    return int(validate_handler(ns))