databay-cli 0.1.0__py3-none-any.whl

databay/operations/schema_change.py

@@ -0,0 +1,222 @@
+"""The ``schema-change`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SCHEMA_CHANGE_APPLY = Operation(
+    operation_id='schema_change_apply',
+    noun='schema-change',
+    verb='apply',
+    method='post',
+    path='/api/schema-evolution/schema-change-event/{event_uuid}/apply',
+    summary='Apply Schema Change Event',
+    description='Remove a column the source dropped, or add a new column that waits for a decision (``backfill`` required).',
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='event_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the schema change event to apply',
+        ),
+    ),
+    body=Body(
+        schema='ApplyChangeInfo',
+        fields=(
+            Param(
+                name='backfill',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Required to add a column that waits for a decision, refused for any other change. `true` reloads the table from the source so existing rows get the column; `false` fills it only in rows that change from now on.',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay schema-change apply <event_uuid> --yes',
+        'databay schema-change apply <event_uuid> --backfill --yes',
+    ),
+)
+
+SCHEMA_CHANGE_IGNORE = Operation(
+    operation_id='schema_change_ignore',
+    noun='schema-change',
+    verb='ignore',
+    method='post',
+    path='/api/schema-evolution/schema-change-event/{event_uuid}/ignore',
+    summary='Ignore Schema Change Event',
+    description='Keep a column the source dropped, or skip a new column that waits for a decision.',
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='event_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the schema change event to ignore',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay schema-change ignore <event_uuid> --yes',
+    ),
+)
+
+SCHEMA_CHANGE_LIST = Operation(
+    operation_id='schema_change_list',
+    noun='schema-change',
+    verb='list',
+    method='get',
+    path='/api/schema-evolution/schema-change-events',
+    summary='Get All Schema Change Events',
+    description='',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='status',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only events in this status, e.g. `detected` for pending ones.',
+            choices=(
+                'detected',
+                'applied',
+                'ignored',
+                'superseded',
+            ),
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='schema_change:SchemaChangeListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay schema-change list',
+        'databay schema-change list --status detected',
+    ),
+)
+
+SCHEMA_CHANGE_PENDING = Operation(
+    operation_id='schema_change_pending',
+    noun='schema-change',
+    verb='pending',
+    method='get',
+    path='/api/schema-evolution/pipe/{pipe_uuid}/schema-change-events',
+    summary='Get Schema Change Events',
+    description='',
+    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='status',
+            location='query',
+            kind='list',
+            required=False,
+            description='Only events in these statuses; repeat the parameter for several. Defaults to `detected`.',
+            choices=(
+                'detected',
+                'applied',
+                'ignored',
+                'superseded',
+            ),
+            item_kind='string',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='schema_change:SchemaChangePendingResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay schema-change pending <pipe_uuid>',
+        'databay schema-change pending <pipe_uuid> --status applied --status ignored',
+    ),
+)
+
+SCHEMA_CHANGE_STATE = Operation(
+    operation_id='schema_change_state',
+    noun='schema-change',
+    verb='state',
+    method='get',
+    path='/api/schema-evolution/pipes/state',
+    summary='Get Pipe Schema States',
+    description='Each pipe with a schema change that is not done, worst first (stopped, then needs_decision).',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='pipe_uuid',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only this pipe.',
+            nullable=True,
+        ),
+        Param(
+            name='state',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only pipes in this state.',
+            choices=(
+                'stopped',
+                'needs_decision',
+                'done',
+            ),
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='schema_change:SchemaChangeStateResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay schema-change state',
+        'databay schema-change state --pipe-uuid <pipe_uuid> --state stopped',
+    ),
+)
+
+OPERATIONS = (
+    SCHEMA_CHANGE_APPLY,
+    SCHEMA_CHANGE_IGNORE,
+    SCHEMA_CHANGE_LIST,
+    SCHEMA_CHANGE_PENDING,
+    SCHEMA_CHANGE_STATE,
+)

databay/operations/schema_history.py

@@ -0,0 +1,136 @@
+"""The ``schema-history`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SCHEMA_HISTORY_CREATE = Operation(
+    operation_id='schema_history_create',
+    noun='schema-history',
+    verb='create',
+    method='post',
+    path='/api/schema-evolution/schema-history',
+    summary='Create Schema History',
+    description='',
+    project=None,
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='SchemaHistoryCreate',
+        fields=(
+            Param(
+                name='ddl',
+                location='body',
+                kind='string',
+                required=True,
+                description='DDL statement representing the schema change',
+            ),
+            Param(
+                name='pipe_uuid',
+                location='body',
+                kind='string',
+                required=True,
+                description='UUID of the pipe to which the schema change belongs',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:SchemaHistoryResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay schema-history create --pipe-uuid <pipe_uuid> --ddl <ddl>',
+    ),
+)
+
+SCHEMA_HISTORY_GET = Operation(
+    operation_id='schema_history_get',
+    noun='schema-history',
+    verb='get',
+    method='get',
+    path='/api/schema-evolution/pipe/{pipe_uuid}/schema-history',
+    summary='Get Pipe Schema History',
+    description='',
+    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',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='schema_history:SchemaHistoryGetResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay schema-history get <pipe_uuid>',
+    ),
+)
+
+SCHEMA_HISTORY_LIST = Operation(
+    operation_id='schema_history_list',
+    noun='schema-history',
+    verb='list',
+    method='get',
+    path='/api/schema-evolution/schema-history',
+    summary='Get All Schema History',
+    description='',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='schema_history:SchemaHistoryListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay schema-history list',
+    ),
+)
+
+SCHEMA_HISTORY_SUMMARY = Operation(
+    operation_id='schema_history_summary',
+    noun='schema-history',
+    verb='summary',
+    method='get',
+    path='/api/schema-evolution/schema-history/summary',
+    summary='Get Schema History Summary',
+    description="One entry per pipe with history: latest version, when, and how many.\n\nThe Schema Evolution page's load call. No DDL and no version list, so it scales with\nthe number of pipes, not with accumulated history. Versions come from\n``/pipe/{uuid}/schema-versions`` on expand, DDL from ``/pipe/{uuid}/schema-history/{v}``.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='schema_history:SchemaHistorySummaryResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay schema-history summary',
+    ),
+)
+
+OPERATIONS = (
+    SCHEMA_HISTORY_CREATE,
+    SCHEMA_HISTORY_GET,
+    SCHEMA_HISTORY_LIST,
+    SCHEMA_HISTORY_SUMMARY,
+)

databay/operations/schema_version.py

@@ -0,0 +1,115 @@
+"""The ``schema-version`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+SCHEMA_VERSION_CURRENT = Operation(
+    operation_id='schema_version_current',
+    noun='schema-version',
+    verb='current',
+    method='get',
+    path='/api/schema-evolution/pipe/{pipe_uuid}/current_schema_version',
+    summary='Get Current Schema Version',
+    description='',
+    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',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='schema_version:SchemaVersionCurrentResponse',
+    ),
+    examples=(
+        'databay schema-version current <pipe_uuid>',
+    ),
+)
+
+SCHEMA_VERSION_GET = Operation(
+    operation_id='schema_version_get',
+    noun='schema-version',
+    verb='get',
+    method='get',
+    path='/api/schema-evolution/pipe/{pipe_uuid}/schema-history/{version}',
+    summary='Get Schema History By Version',
+    description='',
+    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='version',
+            location='path',
+            kind='integer',
+            required=True,
+            description='Version of the schema',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:SchemaHistoryResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay schema-version get <pipe_uuid> 3',
+    ),
+)
+
+SCHEMA_VERSION_LIST = Operation(
+    operation_id='schema_version_list',
+    noun='schema-version',
+    verb='list',
+    method='get',
+    path='/api/schema-evolution/pipe/{pipe_uuid}/schema-versions',
+    summary='Get Pipe Schema Versions',
+    description="List the pipe's versions, newest first, without DDL. Loaded when a card expands.\n\nA pipe with history but no stored version 0 (its first alter landed at version 1\nbecause the baseline could not be built then) still lists a version 0, under the\nsynthetic id: opening it rebuilds the baseline via ``/schema-history/0``.",
+    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',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='schema_version:SchemaVersionListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay schema-version list <pipe_uuid>',
+    ),
+)
+
+OPERATIONS = (
+    SCHEMA_VERSION_CURRENT,
+    SCHEMA_VERSION_GET,
+    SCHEMA_VERSION_LIST,
+)

databay/operations/shopify_store.py

@@ -0,0 +1,40 @@
+"""The ``shopify-store`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+SHOPIFY_STORE_LIST = Operation(
+    operation_id='shopify_store_list',
+    noun='shopify-store',
+    verb='list',
+    method='get',
+    path='/api/configstore/shopify/stores',
+    summary='List Stores',
+    description="List the org's connected Shopify stores usable in the active project (token never serialized).",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shopify_store:ShopifyStoreListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay shopify-store list',
+    ),
+    columns=(
+        'uuid',
+        'shop_domain',
+        'status',
+    ),
+)
+
+OPERATIONS = (
+    SHOPIFY_STORE_LIST,
+)

databay/operations/sink_data_type.py

@@ -0,0 +1,43 @@
+"""The ``sink-data-type`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+SINK_DATA_TYPE_LIST = Operation(
+    operation_id='sink_data_type_list',
+    noun='sink-data-type',
+    verb='list',
+    method='get',
+    path='/api/cdc/pipe/data-types/{db_uuid}',
+    summary='Get Available Data Types',
+    description='List sink-side data types available on the configured sink DB.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='db uuid',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='sink_data_type:SinkDataTypeListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay sink-data-type list <db_uuid>',
+    ),
+)
+
+OPERATIONS = (
+    SINK_DATA_TYPE_LIST,
+)