databay-cli 0.1.0__py3-none-any.whl

databay/operations/source_publication.py

@@ -0,0 +1,139 @@
+"""The ``source-publication`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SOURCE_PUBLICATION_CHECK = Operation(
+    operation_id='source_publication_check',
+    noun='source-publication',
+    verb='check',
+    method='post',
+    path='/api/configstore/source/{source_uuid}/publication/check',
+    summary='Source Publication Check',
+    description="Read one path's publication state and the source's table list, and answer at once with a check run.\n\nRuns no probes, so it can't re-block a source that passed: the admin path reads whether ``databay_publication``\nexists (not finding it doesn't block), the Databay path whether the user has ``CREATE``. Read the tables with\n``source-check-run tables --group in_publication``. Refusals: 409 ``not_checked`` before the source's first check,\n409 ``publication_modes_off``, 409 ``publication_mode_not_applicable``, 409 ``source_check_run_active``, 429\n``precheck_rate_limited``, and 503 ``precheck_busy`` or ``precheck_limiter_unavailable``.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=Body(
+        schema='PublicationModeRequest',
+        fields=(
+            Param(
+                name='publication_mode',
+                location='body',
+                kind='string',
+                required=True,
+                description="who creates the source's publication",
+                choices=(
+                    'customer_managed',
+                    'databay_managed',
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:CheckRunResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-publication check <source_uuid> --publication-mode customer_managed',
+    ),
+)
+
+SOURCE_PUBLICATION_GET = Operation(
+    operation_id='source_publication_get',
+    noun='source-publication',
+    verb='get',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/publication',
+    summary='Source Publication Get',
+    description="Read who creates this Postgres source's publication, and which paths this server can use.\n\nBoth paths always come back in the same order, and one this server can't use says why. 409\n``publication_modes_off`` where the deployment offers no choice, 409 ``publication_mode_not_applicable`` on a type\nwith no publication, and 503 ``publication_state_unavailable`` when it cannot be read.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_publication:SourcePublicationResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-publication get <source_uuid>',
+    ),
+)
+
+SOURCE_PUBLICATION_SET = Operation(
+    operation_id='source_publication_set',
+    noun='source-publication',
+    verb='set',
+    method='put',
+    path='/api/configstore/source/{source_uuid}/publication',
+    summary='Source Publication Set',
+    description="Save who creates this Postgres source's publication: ``customer_managed`` (your admin) or ``databay_managed``.\n\nThe source is then held to that path's checks: the admin path finishes setup whether or not the publication exists\nyet, and the Databay path waits for ``CREATE`` on the database to pass. Refusals: 409\n``publication_mode_locked`` once the source has pipelines, 409 ``publication_mode_unsupported`` where the admin path\ncan't run (``reason``: ``engine``, ``postgres_version`` or ``version_unknown``), 409 ``publication_modes_off``, 409\n``publication_mode_not_applicable``, and 503 ``publication_state_unavailable`` when it cannot be read.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=Body(
+        schema='PublicationModeRequest',
+        fields=(
+            Param(
+                name='publication_mode',
+                location='body',
+                kind='string',
+                required=True,
+                description="who creates the source's publication",
+                choices=(
+                    'customer_managed',
+                    'databay_managed',
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:ConnectedSourceResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-publication set <source_uuid> --publication-mode customer_managed',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_PUBLICATION_CHECK,
+    SOURCE_PUBLICATION_GET,
+    SOURCE_PUBLICATION_SET,
+)

databay/operations/source_readiness_override.py

@@ -0,0 +1,96 @@
+"""The ``source-readiness-override`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SOURCE_READINESS_OVERRIDE_DELETE = Operation(
+    operation_id='source_readiness_override_delete',
+    noun='source-readiness-override',
+    verb='delete',
+    method='delete',
+    path='/api/configstore/source/{source_uuid}/readiness-override',
+    summary='Connected Source Clear Readiness Override',
+    description="Withdraw a readiness override; the source's status goes back to what its checks say.",
+    project='header',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:ConnectedSourceResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-readiness-override delete <source_uuid> --yes',
+    ),
+)
+
+SOURCE_READINESS_OVERRIDE_SET = Operation(
+    operation_id='source_readiness_override_set',
+    noun='source-readiness-override',
+    verb='set',
+    method='post',
+    path='/api/configstore/source/{source_uuid}/readiness-override',
+    summary='Connected Source Readiness Override',
+    description='Accept failing setup checks on a source, audited.\n\nA source type with guided setup takes no new override from anyone: 403 ``source_override_not_offered``.\nOn any other type, support (superadmin) may accept any failing check: the escape hatch when\na check is wrong about a database, until the check is fixed. Anyone else may only acknowledge\na check Databay couldn\'t verify ("I\'ve verified this manually"); a failed check needs\nsupport. The override survives re-checks for the checks it accepted and clears itself\nonce they pass. 409 ``not_checked`` before the first check; 422 ``not_blocking``;\n403 ``requires_support``.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=Body(
+        schema='ReadinessOverrideRequest',
+        fields=(
+            Param(
+                name='reason',
+                location='body',
+                kind='string',
+                required=True,
+                description='why, for the audit record',
+            ),
+            Param(
+                name='requirement_ids',
+                location='body',
+                kind='list',
+                required=False,
+                description='checks to accept; all current blockers when omitted',
+                item_kind='string',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:ConnectedSourceResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-readiness-override set <source_uuid> --reason "checked REPLICA IDENTITY by hand"',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_READINESS_OVERRIDE_DELETE,
+    SOURCE_READINESS_OVERRIDE_SET,
+)

databay/operations/source_setup_choice.py

@@ -0,0 +1,161 @@
+"""The ``source-setup-choice`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SOURCE_SETUP_CHOICE_CHECK = Operation(
+    operation_id='source_setup_choice_check',
+    noun='source-setup-choice',
+    verb='check',
+    method='post',
+    path='/api/configstore/source/{source_uuid}/setup/choices/{choice}/check',
+    summary='Setup Choice Check',
+    description="Start the source's check run for one option, without saving it; answers at once with the run.\n\n422 ``request_invalid`` for an unknown ``value``. ``publication`` answers the publication check's refusals: 409\n``not_checked``, ``publication_modes_off``, ``publication_mode_not_applicable`` or ``source_check_run_active``, 429\n``precheck_rate_limited``, and 503 ``precheck_busy`` or ``precheck_limiter_unavailable``.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+        Param(
+            name='choice',
+            location='path',
+            kind='string',
+            required=True,
+            description='the choice a journey recipe names',
+            choices=(
+                'publication',
+            ),
+        ),
+    ),
+    body=Body(
+        schema='SetupChoiceRequest',
+        fields=(
+            Param(
+                name='value',
+                location='body',
+                kind='string',
+                required=True,
+                description="the option to save or check, one of the choice's option values",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:CheckRunResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-setup-choice check <source_uuid> publication --value customer_managed',
+    ),
+)
+
+SOURCE_SETUP_CHOICE_GET = Operation(
+    operation_id='source_setup_choice_get',
+    noun='source-setup-choice',
+    verb='get',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/setup/choices/{choice}',
+    summary='Setup Choice Get',
+    description="Read one guided-setup choice: its saved option, whether it can still change, and every option with why one is off.\n\n``publication`` answers the publication route's refusals: 409 ``publication_modes_off``, 409\n``publication_mode_not_applicable`` and 503 ``publication_state_unavailable``.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+        Param(
+            name='choice',
+            location='path',
+            kind='string',
+            required=True,
+            description='the choice a journey recipe names',
+            choices=(
+                'publication',
+            ),
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_setup_choice:SetupChoiceResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-setup-choice get <source_uuid> publication',
+    ),
+)
+
+SOURCE_SETUP_CHOICE_SET = Operation(
+    operation_id='source_setup_choice_set',
+    noun='source-setup-choice',
+    verb='set',
+    method='put',
+    path='/api/configstore/source/{source_uuid}/setup/choices/{choice}',
+    summary='Setup Choice Set',
+    description="Save a guided-setup choice; the source is then held to that option's checks.\n\n422 ``request_invalid`` when ``value`` is not one of the choice's options (``allowed`` lists them). ``publication``\nanswers the publication route's refusals: 409 ``publication_mode_locked``, ``publication_mode_unsupported``,\n``publication_modes_off`` or ``publication_mode_not_applicable``, and 503 ``publication_state_unavailable``.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+        Param(
+            name='choice',
+            location='path',
+            kind='string',
+            required=True,
+            description='the choice a journey recipe names',
+            choices=(
+                'publication',
+            ),
+        ),
+    ),
+    body=Body(
+        schema='SetupChoiceRequest',
+        fields=(
+            Param(
+                name='value',
+                location='body',
+                kind='string',
+                required=True,
+                description="the option to save or check, one of the choice's option values",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:ConnectedSourceResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-setup-choice set <source_uuid> publication --value customer_managed',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_SETUP_CHOICE_CHECK,
+    SOURCE_SETUP_CHOICE_GET,
+    SOURCE_SETUP_CHOICE_SET,
+)

databay/operations/source_stream.py

@@ -0,0 +1,99 @@
+"""The ``source-stream`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+SOURCE_STREAM_GET = Operation(
+    operation_id='source_stream_get',
+    noun='source-stream',
+    verb='get',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/streams/shape',
+    summary='Connected Source Stream Shape',
+    description='Describe one stream: its columns, declared key, unique-key candidates and replica identity.\n\n404 ``stream_not_found`` when the source has no such stream; the other error codes are those\nof ``GET /source/{source_uuid}/streams``.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+        Param(
+            name='namespace',
+            location='query',
+            kind='string',
+            required=True,
+            description='The stream\'s schema or database; "" for SaaS.',
+        ),
+        Param(
+            name='stream',
+            location='query',
+            kind='string',
+            required=True,
+            description="The stream's name.",
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_stream:StreamShapeResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-stream get <source_uuid> --namespace public --stream orders',
+    ),
+)
+
+SOURCE_STREAM_LIST = Operation(
+    operation_id='source_stream_list',
+    noun='source-stream',
+    verb='list',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/streams',
+    summary='Connected Source Streams',
+    description="List any connected source's streams: a database's schemas and tables, or a SaaS source's reports.\n\n412 ``source_needs_reauth`` and 409 ``source_uninstalled`` name the fix.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+        Param(
+            name='namespace',
+            location='query',
+            kind='string',
+            required=False,
+            description='Omit to list namespaces; a schema or database name to list its streams; "" for SaaS.',
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_stream:StreamCatalogResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-stream list <source_uuid>',
+        'databay source-stream list <source_uuid> --namespace public',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_STREAM_GET,
+    SOURCE_STREAM_LIST,
+)

databay/operations/source_table.py

@@ -0,0 +1,59 @@
+"""The ``source-table`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response, Verdict
+
+
+SOURCE_TABLE_CHECK = Operation(
+    operation_id='source_table_check',
+    noun='source-table',
+    verb='check',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/schemas/{schema_name}/tables/readiness',
+    summary='Connected Source Table Readiness',
+    description='Per-table setup checks for the pipe wizard.\n\nEach table says whether it can be replicated and backfilled without a blocking\nsnapshot, and if not, the exact fix: a primary key, ``REPLICA IDENTITY`` other than\nNOTHING and ownership (Postgres), CDC on the table (SQL Server). One catalog query.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+        Param(
+            name='schema_name',
+            location='path',
+            kind='string',
+            required=True,
+            description='schema name',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_table:TableReadinessReport',
+        shape='object',
+    ),
+    examples=(
+        'databay source-table check <source_uuid> public',
+    ),
+    verdict=Verdict(
+        field='/ready',
+        ok=(
+            'true',
+        ),
+        not_ready=(
+            'false',
+        ),
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_TABLE_CHECK,
+)

databay/operations/sql.py

@@ -0,0 +1,54 @@
+"""The ``sql`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SQL_EXECUTE = Operation(
+    operation_id='sql_execute',
+    noun='sql',
+    verb='execute',
+    method='post',
+    path='/api/configstore/sql/execute',
+    summary='Execute Sql',
+    description="Run one read-only statement for the SQL editor.\n\nRuns server-side, so ClickHouse need not be reachable from the browser and its\ncredentials stay on the server. ``db_uuid`` picks the warehouse (the org default when\nomitted). On a project-scoped console the statement runs as the caller's console\nreader in the active project (``X-Databay-Project-ID``), which can read only the\nproject's visible managed warehouses; 404 ``warehouse_not_visible`` / 409\n``warehouse_not_queryable``. ClickHouse's ``readonly=1`` is set on every request.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='SqlExecuteRequest',
+        fields=(
+            Param(
+                name='db_uuid',
+                location='body',
+                kind='string',
+                required=False,
+                description="The warehouse to run against: the request's default database. Omitted: the organization default warehouse. When the console is project-scoped it must be a managed warehouse visible in the active project (404 ``warehouse_not_visible``, 409 ``warehouse_not_queryable``).",
+                nullable=True,
+            ),
+            Param(
+                name='query',
+                location='body',
+                kind='string',
+                required=True,
+                description="A single read-only statement (SELECT, WITH, SHOW, DESCRIBE, EXPLAIN). Executed against the caller's organization database with ClickHouse's readonly setting applied; writes and DDL are refused.",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='sql:SqlExecuteResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay sql --db <db_uuid> "select count(*) from analytics.orders"',
+    ),
+)
+
+OPERATIONS = (
+    SQL_EXECUTE,
+)