databay-cli 0.1.0__py3-none-any.whl

databay/operations/pipe_backfill_run.py

@@ -0,0 +1,72 @@
+"""The ``pipe-backfill-run`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+PIPE_BACKFILL_RUN_LIST = Operation(
+    operation_id='pipe_backfill_run_list',
+    noun='pipe-backfill-run',
+    verb='list',
+    method='get',
+    path='/api/cdc/pipe/{pipe_uuid}/backfill/runs',
+    summary='List Pipe Backfill Run History',
+    description="One pipe's backfill history, newest first.\n\n404 for an unknown or another organization's pipe, so a wrong uuid is not mistaken\nfor a pipe that was never backfilled.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='pipe_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the pipe',
+        ),
+        Param(
+            name='state',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only runs in this state',
+            choices=(
+                'running',
+                'finished',
+                'failed',
+                'rejected',
+            ),
+            nullable=True,
+        ),
+        Param(
+            name='cursor',
+            location='query',
+            kind='string',
+            required=False,
+            description='Opaque page cursor from a previous response',
+            nullable=True,
+        ),
+        Param(
+            name='limit',
+            location='query',
+            kind='integer',
+            required=False,
+            description='Page size',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:BackfillRunPage',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-backfill-run list <pipe_uuid>',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_BACKFILL_RUN_LIST,
+)

databay/operations/pipe_config_option.py

@@ -0,0 +1,50 @@
+"""The ``pipe-config-option`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+PIPE_CONFIG_OPTION_GET = Operation(
+    operation_id='pipe_config_option_get',
+    noun='pipe-config-option',
+    verb='get',
+    method='get',
+    path='/api/cdc/pipe/config-options',
+    summary='Get Pipe Config Options',
+    description='Which create-time controls the wizard should render for this source.\n\nSchedule and sync mode only apply to scheduled-batch pipes; on a streaming pipe\nthey are ignored, so the wizard hides them. The answer is resolved against the\nengine a new pipe would get on this deployment. Static capability facts, no\norganization data.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_type',
+            location='query',
+            kind='string',
+            required=True,
+            description="ConnectedSource type the pipe will read, e.g. 'postgres'",
+        ),
+        Param(
+            name='sink_type',
+            location='query',
+            kind='string',
+            required=True,
+            description="Warehouse type the pipe will write, e.g. 'clickhouse'",
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_config_option:PipeConfigOptionsResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-config-option get --source-type postgres --sink-type clickhouse',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_CONFIG_OPTION_GET,
+)

databay/operations/pipe_destination.py

@@ -0,0 +1,178 @@
+"""The ``pipe-destination`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+PIPE_DESTINATION_CHECK = Operation(
+    operation_id='pipe_destination_check',
+    noun='pipe-destination',
+    verb='check',
+    method='post',
+    path='/api/cdc/pipe/destination-check',
+    summary='Check Destinations',
+    description='Check draft tables against the warehouse as it is now, without creating anything.\n\nFor each table: whether its destination name is taken, by another pipeline or an existing\ntable, and if so whether its first batch could land there. Reads only.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='DestinationCheckRequest',
+        fields=(
+            Param(
+                name='sink_db_uuid',
+                location='body',
+                kind='string',
+                required=True,
+                description='warehouse uuid',
+            ),
+            Param(
+                name='source_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='connected source uuid',
+            ),
+            Param(
+                name='tables',
+                location='body',
+                kind='json',
+                required=True,
+                description='tables',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='pipe_destination:DestinationCheckResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-destination check --file check.json',
+    ),
+)
+
+PIPE_DESTINATION_GET = Operation(
+    operation_id='pipe_destination_get',
+    noun='pipe-destination',
+    verb='get',
+    method='get',
+    path='/api/cdc/pipe/{pipe_uuid}/destination',
+    summary='Get Pipe Destination',
+    description="Measure this pipe's destination table: how much is in it, and how current it is.\n\n404 for an unknown pipe and for another organization's pipe alike. Once the pipe is\nfound the answer is always 200: a warehouse that is down, a destination that cannot be\ninspected or a dropped table is a coded reason on the body, so the page still renders.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='pipe_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='pipe uuid',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_destination:PipeDestinationResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-destination get <pipe_uuid>',
+    ),
+)
+
+PIPE_DESTINATION_PREVIEW = Operation(
+    operation_id='pipe_destination_preview',
+    noun='pipe-destination',
+    verb='preview',
+    method='get',
+    path='/api/cdc/pipe/destination-preview',
+    summary='Get Destination Preview',
+    description="Show what DataBay would create in the warehouse for one source table.\n\nOne read of the source table returns the columns with their recommended destination\ntypes, the source's primary key, and the destination table's engine, sort key and\ncontrol columns. It uses the same planner as pipe creation, so the preview matches\nwhat is created. Pass ``primary_key`` (repeated) to preview a chosen key instead.\n\nA keyless table returns 200 with a blocking warning so the wizard can offer a key\npicker; pipe creation still rejects it.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_id',
+            location='query',
+            kind='string',
+            required=True,
+            description='connected source uuid',
+        ),
+        Param(
+            name='table_name',
+            location='query',
+            kind='string',
+            required=True,
+            description='source table',
+        ),
+        Param(
+            name='schema_name',
+            location='query',
+            kind='string',
+            required=False,
+            description='source schema',
+        ),
+        Param(
+            name='primary_key',
+            location='query',
+            kind='list',
+            required=False,
+            description='replication key to preview',
+            item_kind='string',
+            nullable=True,
+        ),
+        Param(
+            name='sink_db_uuid',
+            location='query',
+            kind='string',
+            required=False,
+            description='sink db uuid',
+            nullable=True,
+        ),
+        Param(
+            name='dest_table_name',
+            location='query',
+            kind='string',
+            required=False,
+            description='destination table name',
+            nullable=True,
+        ),
+        Param(
+            name='sync_mode',
+            location='query',
+            kind='string',
+            required=False,
+            description="The draft's sync mode; a streamed Postgres table is previewed at the types the CDC engine lands it as.",
+            choices=(
+                'incremental_deduped_history',
+                'incremental_append',
+                'full_refresh_overwrite',
+                'full_refresh_append',
+            ),
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_destination:DestinationPreviewResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-destination preview --source-id <uuid> --schema-name public --table-name orders',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_DESTINATION_CHECK,
+    PIPE_DESTINATION_GET,
+    PIPE_DESTINATION_PREVIEW,
+)

databay/operations/pipe_leftover.py

@@ -0,0 +1,110 @@
+"""The ``pipe-leftover`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+PIPE_LEFTOVER_CHECK = Operation(
+    operation_id='pipe_leftover_check',
+    noun='pipe-leftover',
+    verb='check',
+    method='post',
+    path='/api/cdc/pipe-leftovers/{leftover_id}/check',
+    summary='Check Leftover',
+    description='Ask the source database or warehouse whether the leftover is still there; it is cleared when it is not.\n\n409 ``leftover_source_gone`` when databay no longer has the source (dismiss it instead), 503\n``leftover_check_unavailable`` when the database or warehouse could not be reached.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='leftover_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='leftover id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_leftover:PipeLeftoverResult',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-leftover check <leftover_id>',
+    ),
+)
+
+PIPE_LEFTOVER_DISMISS = Operation(
+    operation_id='pipe_leftover_dismiss',
+    noun='pipe-leftover',
+    verb='dismiss',
+    method='post',
+    path='/api/cdc/pipe-leftovers/{leftover_id}/dismiss',
+    summary='Dismiss Leftover',
+    description='Clear a leftover by hand, once it was dropped or is meant to stay; who dismissed it is recorded.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='leftover_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='leftover id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_leftover:PipeLeftoverResult',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-leftover dismiss <leftover_id>',
+    ),
+)
+
+PIPE_LEFTOVER_LIST = Operation(
+    operation_id='pipe_leftover_list',
+    noun='pipe-leftover',
+    verb='list',
+    method='get',
+    path='/api/cdc/pipe-leftovers',
+    summary='List Leftovers',
+    description='List what deleted pipes left in their source databases and warehouses, unresolved, oldest first.\n\nA replication slot left on a database keeps its write-ahead log until it is dropped; ``drop_sql``\nsays how.',
+    project='query:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only leftovers of pipes in this project.',
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_leftover:PipeLeftoverList',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-leftover list',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_LEFTOVER_CHECK,
+    PIPE_LEFTOVER_DISMISS,
+    PIPE_LEFTOVER_LIST,
+)

databay/operations/pipe_sink_type.py

@@ -0,0 +1,35 @@
+"""The ``pipe-sink-type`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+PIPE_SINK_TYPE_LIST = Operation(
+    operation_id='pipe_sink_type_list',
+    noun='pipe-sink-type',
+    verb='list',
+    method='get',
+    path='/api/cdc/pipe/sink-types',
+    summary='Get Available Sink Types',
+    description='List the canonical sink DB types databay can provision on some backend.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_sink_type:PipeSinkTypeListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay pipe-sink-type list',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_SINK_TYPE_LIST,
+)

databay/operations/pipe_source_type.py

@@ -0,0 +1,35 @@
+"""The ``pipe-source-type`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+PIPE_SOURCE_TYPE_LIST = Operation(
+    operation_id='pipe_source_type_list',
+    noun='pipe-source-type',
+    verb='list',
+    method='get',
+    path='/api/cdc/pipe/source-types',
+    summary='Get Available Source Types',
+    description='List the canonical source DB types databay can provision on some backend.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_source_type:PipeSourceTypeListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay pipe-source-type list',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_SOURCE_TYPE_LIST,
+)

databay/operations/pipe_status_bucket.py

@@ -0,0 +1,35 @@
+"""The ``pipe-status-bucket`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+PIPE_STATUS_BUCKET_LIST = Operation(
+    operation_id='pipe_status_bucket_list',
+    noun='pipe-status-bucket',
+    verb='list',
+    method='get',
+    path='/api/cdc/pipe/status-buckets',
+    summary='List Pipe Status Buckets',
+    description='Publish the raw-status to coarse-bucket mapping that ``?status=`` filters on.\n\nStatic data, so clients need not keep their own copy of the vocabulary.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_status_bucket:PipeStatusBucketMap',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-status-bucket list',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_STATUS_BUCKET_LIST,
+)

databay/operations/pipe_stuck_delete.py

@@ -0,0 +1,52 @@
+"""The ``pipe-stuck-delete`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+PIPE_STUCK_DELETE_LIST = Operation(
+    operation_id='pipe_stuck_delete_list',
+    noun='pipe-stuck-delete',
+    verb='list',
+    method='get',
+    path='/api/cdc/pipe-stuck-deletes',
+    summary='List Stuck Deletes',
+    description="List deleted pipes whose cleanup has not finished well after the delete (``CDC_STUCK_DELETE_AFTER_SECONDS``).\n\n``DELETE /pipe/{pipe_uuid}`` sends one to cleanup again, with its first delete's choice.",
+    project='query:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only pipes in this project.',
+            nullable=True,
+        ),
+        Param(
+            name='source_id',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only pipes of this source.',
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe_stuck_delete:StuckDeleteList',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe-stuck-delete list --source-id <source_id>',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_STUCK_DELETE_LIST,
+)

databay/operations/plan.py

@@ -0,0 +1,35 @@
+"""The ``plan`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+PLAN_LIST = Operation(
+    operation_id='plan_list',
+    noun='plan',
+    verb='list',
+    method='get',
+    path='/api/entitlements/plans',
+    summary='Get Plans',
+    description="Return each public plan's current version: price, limits and capabilities.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='plan:PublicPlans',
+        shape='object',
+    ),
+    examples=(
+        'databay plan list',
+    ),
+)
+
+OPERATIONS = (
+    PLAN_LIST,
+)