databay-cli 0.1.0__py3-none-any.whl

databay/operations/api_key.py

@@ -0,0 +1,198 @@
+"""The ``api-key`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+API_KEY_CREATE = Operation(
+    operation_id='api_key_create',
+    noun='api-key',
+    verb='create',
+    method='post',
+    path='/api/auth/api-keys',
+    summary='Create Key',
+    description='Create a key for CI or an agent; its secret is shown once, in this answer.',
+    project=None,
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='ApiKeyCreateRequest',
+        fields=(
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='What the key is for, e.g. `ci-nightly`.',
+            ),
+            Param(
+                name='project_ids',
+                location='body',
+                kind='list',
+                required=True,
+                description='The projects the key may reach; each must be one you administer.',
+                item_kind='string',
+            ),
+            Param(
+                name='role',
+                location='body',
+                kind='string',
+                required=True,
+                description='The realm role the key acts with; it gets the same role in its projects.',
+                choices=(
+                    'reader',
+                    'editor',
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='api_key:ApiKeyCreated',
+        shape='object',
+    ),
+    examples=(
+        'databay api-key create --name ci-nightly --role reader --project-ids <project_id>',
+    ),
+)
+
+API_KEY_GET = Operation(
+    operation_id='api_key_get',
+    noun='api-key',
+    verb='get',
+    method='get',
+    path='/api/auth/api-keys/{key_id}',
+    summary='Get Key',
+    description='',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='key_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Key Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='api_key:ApiKeyOut',
+        shape='object',
+    ),
+    examples=(
+        'databay api-key get <key_id>',
+    ),
+)
+
+API_KEY_LIST = Operation(
+    operation_id='api_key_list',
+    noun='api-key',
+    verb='list',
+    method='get',
+    path='/api/auth/api-keys',
+    summary='List Keys',
+    description='Every key of the organization, revoked ones included; never a secret.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='api_key:ApiKeyList',
+        shape='object',
+        rows='/keys',
+    ),
+    examples=(
+        'databay api-key list',
+    ),
+    columns=(
+        'id',
+        'name',
+        'role',
+        'status',
+        'project_ids',
+        'created_at',
+    ),
+)
+
+API_KEY_REVOKE = Operation(
+    operation_id='api_key_revoke',
+    noun='api-key',
+    verb='revoke',
+    method='delete',
+    path='/api/auth/api-keys/{key_id}',
+    summary='Revoke Key',
+    description='Revoke the key: its tokens stop working and it leaves every project.',
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='key_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Key Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='api_key:ApiKeyOut',
+        shape='object',
+    ),
+    examples=(
+        'databay api-key revoke <key_id> --yes',
+    ),
+)
+
+API_KEY_ROTATE = Operation(
+    operation_id='api_key_rotate',
+    noun='api-key',
+    verb='rotate',
+    method='post',
+    path='/api/auth/api-keys/{key_id}/rotate',
+    summary='Rotate Key',
+    description="Replace the key's secret; the old secret and its tokens stop working at once.",
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='key_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Key Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='api_key:ApiKeyRotated',
+        shape='object',
+    ),
+    examples=(
+        'databay api-key rotate <key_id> --yes',
+    ),
+)
+
+OPERATIONS = (
+    API_KEY_CREATE,
+    API_KEY_GET,
+    API_KEY_LIST,
+    API_KEY_REVOKE,
+    API_KEY_ROTATE,
+)

databay/operations/api_key_project.py

@@ -0,0 +1,130 @@
+"""The ``api-key-project`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+API_KEY_PROJECT_ADD = Operation(
+    operation_id='api_key_project_add',
+    noun='api-key-project',
+    verb='add',
+    method='put',
+    path='/api/auth/api-keys/{key_id}/projects/{project_id}',
+    summary='Add Project',
+    description='Let the key reach one more project, with its role.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='key_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Key Id',
+        ),
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='api_key_project:ApiKeyProjectOut',
+        shape='object',
+    ),
+    examples=(
+        'databay api-key-project add <key_id> <project_id>',
+    ),
+)
+
+API_KEY_PROJECT_BI_CONNECTION = Operation(
+    operation_id='api_key_project_bi_connection',
+    noun='api-key-project',
+    verb='bi-connection',
+    method='get',
+    path='/api/auth/api-keys/{key_id}/projects/{project_id}/bi-connection',
+    summary='Bi Connection',
+    description="Where a BI tool signs in with the key for this project; the password is the key's secret, not shown here.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='key_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Key Id',
+        ),
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='api_key_project:ApiKeyBiConnectionOut',
+        shape='object',
+    ),
+    examples=(
+        'databay api-key-project bi-connection <key_id> <project_id>',
+    ),
+)
+
+API_KEY_PROJECT_REMOVE = Operation(
+    operation_id='api_key_project_remove',
+    noun='api-key-project',
+    verb='remove',
+    method='delete',
+    path='/api/auth/api-keys/{key_id}/projects/{project_id}',
+    summary='Remove Project',
+    description='Take one project from the key; a key keeps at least one.',
+    project='path:project_id',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='key_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Key Id',
+        ),
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='api_key_project:ApiKeyProjectOut',
+        shape='object',
+    ),
+    examples=(
+        'databay api-key-project remove <key_id> <project_id> --yes',
+    ),
+)
+
+OPERATIONS = (
+    API_KEY_PROJECT_ADD,
+    API_KEY_PROJECT_BI_CONNECTION,
+    API_KEY_PROJECT_REMOVE,
+)

databay/operations/backfill_reason_code.py

@@ -0,0 +1,35 @@
+"""The ``backfill-reason-code`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+BACKFILL_REASON_CODE_LIST = Operation(
+    operation_id='backfill_reason_code_list',
+    noun='backfill-reason-code',
+    verb='list',
+    method='get',
+    path='/api/cdc/backfill/reason-codes',
+    summary='List Backfill Reason Codes',
+    description='Return the ``reason_code`` vocabulary a client may receive.\n\nClients must treat an unrecognised code as a generic failure and show ``reason``:\nnew codes are added without a version bump.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='backfill_reason_code:BackfillReasonCodeListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay backfill-reason-code list',
+    ),
+)
+
+OPERATIONS = (
+    BACKFILL_REASON_CODE_LIST,
+)

databay/operations/backfill_run.py

@@ -0,0 +1,245 @@
+"""The ``backfill-run`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response, Wait
+
+
+BACKFILL_RUN_CANCEL = Operation(
+    operation_id='backfill_run_cancel',
+    noun='backfill-run',
+    verb='cancel',
+    method='delete',
+    path='/api/cdc/backfill/runs/{run_uuid}',
+    summary='Cancel Backfill',
+    description="Force a stuck backfill run terminal so the pipe can be backfilled again.\n\nUse this when a run never finishes and the pipe keeps answering 409 to new backfills.\nIt does not stop work already running on the engine; it closes the run record as\n``failed`` (kept in history) and releases the pipe.\n\n404 covers a missing run, another organization's run and an already-terminal run.",
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='run_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the backfill run to cancel',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='backfill_run:BackfillRunCancelResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay backfill-run cancel <run_uuid> --yes',
+    ),
+)
+
+BACKFILL_RUN_CREATE = Operation(
+    operation_id='backfill_run_create',
+    noun='backfill-run',
+    verb='create',
+    method='post',
+    path='/api/cdc/backfill',
+    summary='Trigger Backfill',
+    description="Re-read the pipe's table.\n\nA streaming pipe is resynced: its table is copied again from a new snapshot (the rebuild\nroute's ``snapshot`` source), and ``Idempotency-Key``, when sent, is that rebuild's key: repeating\nit returns that rebuild, whatever the body says. Any other pipe ignores the key.",
+    project=None,
+    destructive=True,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='BackfillV2Create',
+        fields=(
+            Param(
+                name='cursor_field',
+                location='body',
+                kind='string',
+                required=False,
+                description="Optional cursor column to scope the backfill (e.g. 'updated_at'); the sync resumes from the given cursor. Not every engine supports it.",
+                nullable=True,
+            ),
+            Param(
+                name='pipe_uuid',
+                location='body',
+                kind='string',
+                required=True,
+                description='UUID of the v2 pipe to sync',
+            ),
+            Param(
+                name='snapshot_type',
+                location='body',
+                kind='string',
+                required=False,
+                description='How the re-read is performed on a streaming pipe. `incremental` walks the table by primary key while replication keeps running, reconciling against the live stream. `blocking` pauses replication, re-reads the table in one pass, then resumes from the paused offset — faster and point-in-time consistent, at the cost of replication lag for the duration. `where_clause` means the same thing in both modes. Requesting `blocking` on a backend that cannot pause its own stream is a 422 rather than a signal that would be silently dropped.',
+                choices=(
+                    'incremental',
+                    'blocking',
+                ),
+            ),
+            Param(
+                name='start_date',
+                location='body',
+                kind='string',
+                required=False,
+                description="Re-read history from this ISO date (YYYY-MM-DD). Only pipes whose engine re-runs a source from a date accept it (scheduled SaaS pipes); anywhere else it is a 422, never a silently ignored window. Clamped server-side to the source's backfill ceiling (see GET /api/cdc/backfill/limits); omit it for 'as far back as this source allows'. The response says what actually ran.",
+                nullable=True,
+            ),
+            Param(
+                name='where_clause',
+                location='body',
+                kind='string',
+                required=False,
+                description='Row filter scoping the backfill, e.g. "status = \'pending\' AND amount > 100". Accepted only where the pipe\'s engine supports a filtered backfill (`supports_filtered_backfill` in GET /api/cdc/pipe/config-options); elsewhere it is a 422. NOT arbitrary SQL: the expression is parsed against a restricted grammar — columns this pipe replicates, comparison and boolean operators, IS NULL, IN, BETWEEN, and literals — and rebuilt from the parse tree before use. Function calls, subqueries, casts and comments are rejected with 422. A full `SELECT ... FROM ... WHERE ...` is therefore invalid in either snapshot mode: pass only the condition that would follow WHERE.',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='backfill_run:BackfillV2Response',
+        shape='object',
+    ),
+    examples=(
+        'databay backfill-run create --pipe-uuid <pipe_uuid> --yes',
+    ),
+    wait=Wait(
+        status_operation='backfill_run_get',
+        bind=(
+            (
+                'run_uuid',
+                '/run_uuid',
+            ),
+        ),
+        field='/state',
+        pending=(
+            'running',
+        ),
+        success=(
+            'finished',
+        ),
+        failure=(
+            'failed',
+            'rejected',
+        ),
+        error_field='/reason',
+    ),
+)
+
+BACKFILL_RUN_GET = Operation(
+    operation_id='backfill_run_get',
+    noun='backfill-run',
+    verb='get',
+    method='get',
+    path='/api/cdc/backfill/runs/{run_uuid}',
+    summary='Get Backfill Run Detail',
+    description='One backfill run, by the ``run_uuid`` the trigger response returned.\n\nPoll it until it reaches a terminal state.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='run_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the backfill run',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:BackfillRunResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay backfill-run get <run_uuid>',
+    ),
+    resumes=Wait(
+        status_operation='backfill_run_get',
+        bind=(
+            (
+                'run_uuid',
+                'path:run_uuid',
+            ),
+        ),
+        field='/state',
+        pending=(
+            'running',
+        ),
+        success=(
+            'finished',
+        ),
+        failure=(
+            'failed',
+            'rejected',
+        ),
+        error_field='/reason',
+    ),
+)
+
+BACKFILL_RUN_LIST = Operation(
+    operation_id='backfill_run_list',
+    noun='backfill-run',
+    verb='list',
+    method='get',
+    path='/api/cdc/backfill/runs',
+    summary='List Backfill Run History',
+    description='Every backfill this organization has run, newest first.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        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 backfill-run list',
+        'databay backfill-run list --state running',
+    ),
+)
+
+OPERATIONS = (
+    BACKFILL_RUN_CANCEL,
+    BACKFILL_RUN_CREATE,
+    BACKFILL_RUN_GET,
+    BACKFILL_RUN_LIST,
+)