databay-cli 0.1.0__py3-none-any.whl

databay/operations/pipe.py

@@ -0,0 +1,882 @@
+"""The ``pipe`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response, Wait
+
+
+PIPE_CREATE = Operation(
+    operation_id='pipe_create',
+    noun='pipe',
+    verb='create',
+    method='post',
+    path='/api/cdc/pipe',
+    summary='Create Pipe',
+    description="Create a pipe asynchronously for any registered source type.\n\nThe request validates the source (404 missing, 412 needs re-auth, 409 uninstalled),\nresolves the sink (``sink_db_uuid`` or the organization's default), runs the\ndestination guards, and stores the pipe. A database pipe returns ``status=pending`` at once;\nprovisioning continues in the background until the pipe is ACTIVE or FAILED with\n``last_error``. Poll ``GET /pipe/{uuid}/status`` for progress. A pipe on an API source that\nloads on demand has nothing to provision: it returns ACTIVE and its first load is queued.",
+    project='body:project_id',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='PipeV2Create',
+        fields=(
+            Param(
+                name='acknowledge_org_visible',
+                location='body',
+                kind='boolean',
+                required=False,
+                description="Consent to land a restricted project's tables in an organization-wide warehouse, where every organization member can see them. Without it such a create is a 422 `org_visible_destination`.",
+            ),
+            Param(
+                name='backend',
+                location='body',
+                kind='string',
+                required=False,
+                description="The engine that backs this pipe. 'ingest' is the only one a request may name; omit it to take the same default.",
+                choices=(
+                    'dlt',
+                    'ingest',
+                ),
+                nullable=True,
+            ),
+            Param(
+                name='column_types',
+                location='body',
+                kind='json',
+                required=False,
+                description='Per-column destination type, overriding the recommended one. Omit for recommendations.',
+                nullable=True,
+            ),
+            Param(
+                name='columns',
+                location='body',
+                kind='list',
+                required=False,
+                description='Source columns to replicate. Omit to replicate every column. Columns left out never land in the destination: a SQL batch read selects only the chosen columns, CDC filters the rest out inside the connector, and SaaS sources drop them before they are queued. The key, merge key and account columns are always kept. Fixed at create.',
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='cron_expression',
+                location='body',
+                kind='string',
+                required=False,
+                description='Quartz cron expression (only used when schedule_type=cron). Default: every 5 minutes.',
+            ),
+            Param(
+                name='dest_table_name',
+                location='body',
+                kind='string',
+                required=True,
+                description='Destination table name in the sink',
+            ),
+            Param(
+                name='mask_fields',
+                location='body',
+                kind='json',
+                required=False,
+                description='Columns to encrypt or hash on the way into the destination. Each masked column is stored as String.',
+            ),
+            Param(
+                name='mask_secret',
+                location='body',
+                kind='string',
+                required=False,
+                description="Shared symmetric key for any 'reversible' (encrypt) columns. Required iff one is present, and must be exactly 16 printable ASCII characters with no spaces — it is used verbatim as a 16-byte AES-128 key, so any other length silently yields an UNENCRYPTED column.",
+                secret=True,
+                nullable=True,
+            ),
+            Param(
+                name='new_columns',
+                location='body',
+                kind='string',
+                required=False,
+                description="Whether new source columns are added automatically (`add`) or wait for a decision (`ask`). Omitted: the project's default.",
+                choices=(
+                    'add',
+                    'ask',
+                ),
+                nullable=True,
+            ),
+            Param(
+                name='nullable_overrides',
+                location='body',
+                kind='json',
+                required=False,
+                description="Per-column destination nullability, overriding the source's. A replication-key column is always written NOT NULL regardless of this.",
+                nullable=True,
+            ),
+            Param(
+                name='primary_key',
+                location='body',
+                kind='list',
+                required=False,
+                description="Columns to use as the replication key, IN KEY ORDER. Becomes the destination table's ORDER BY, which is what deduplication happens on. Overrides the source table's own primary key, and is what lets a table with no primary key be replicated at all. Omit to use the source's key. IMMUTABLE after create — the destination's sort order cannot be altered, so changing it means deleting the pipe AND dropping the destination table.",
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='project_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='The workspace project the pipe belongs to; the caller needs edit there',
+            ),
+            Param(
+                name='reader_id',
+                location='body',
+                kind='string',
+                required=False,
+                description="The reader to join: the new pipe reads its table through that reader's engine and replication slot instead of its own. Omit it to give the pipe a reader of its own.",
+                nullable=True,
+            ),
+            Param(
+                name='schedule_type',
+                location='body',
+                kind='string',
+                required=False,
+                description='Schedule type (manual, cron, basic). Defaults to cron.',
+            ),
+            Param(
+                name='schema_name',
+                location='body',
+                kind='string',
+                required=False,
+                description="Source schema / stream namespace (e.g. '' for Shopify, 'public' for Postgres)",
+            ),
+            Param(
+                name='sink_db_uuid',
+                location='body',
+                kind='string',
+                required=False,
+                description="UUID of the destination warehouse (defaults to the organization's default warehouse)",
+                nullable=True,
+            ),
+            Param(
+                name='source_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='UUID of the connected source',
+            ),
+            Param(
+                name='sync_mode',
+                location='body',
+                kind='string',
+                required=False,
+                description='Requested sync mode; the pipe stores the mode its engine resolved.',
+                choices=(
+                    'incremental_deduped_history',
+                    'incremental_append',
+                    'full_refresh_overwrite',
+                    'full_refresh_append',
+                ),
+            ),
+            Param(
+                name='table_name',
+                location='body',
+                kind='string',
+                required=True,
+                description='Source table / stream to replicate',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='pipe:PipeV2CreateResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe create --source-id <source_id> --schema-name public --table-name orders --dest-table-name orders',
+    ),
+    wait=Wait(
+        status_operation='pipe_status',
+        bind=(
+            (
+                'pipe_uuid',
+                '/uuid',
+            ),
+        ),
+        field='/pipe_status',
+        pending=(
+            'pending',
+            'creating',
+        ),
+        success=(
+            'active',
+        ),
+        failure=(
+            'failed',
+            'inactive',
+            'paused_quota',
+            'deprecated',
+            'deleting',
+            'deleted',
+        ),
+        error_field='/last_error',
+    ),
+)
+
+PIPE_DELETE = Operation(
+    operation_id='pipe_delete',
+    noun='pipe',
+    verb='delete',
+    method='delete',
+    path='/api/cdc/pipe/{pipe_uuid}',
+    summary='Delete Pipe',
+    description="Delete a pipe asynchronously.\n\nMarks the pipe DELETING and returns 202; its connections, row and dependent\nresources are cleaned up in the background, and its warehouse table too with\n``drop_destination``. A deleted pipe whose cleanup never finished is sent to cleanup\nagain (202), with the first delete's choice. 404 if the pipe does not exist or is\nalready cleaned up, 409 if it is being deleted.",
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='pipe_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='pipe uuid',
+        ),
+        Param(
+            name='drop_destination',
+            location='query',
+            kind='boolean',
+            required=False,
+            description="Also drop the pipe's warehouse table (and a SaaS pipe's sync state). Off by default: the table stays with the data already landed. A table another pipe writes to, or one databay did not create for this pipe, is kept and reported.",
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe:PipeDeleteAccepted',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe delete <pipe_uuid> --yes',
+        'databay pipe delete <pipe_uuid> --yes --drop-destination',
+    ),
+)
+
+PIPE_GET = Operation(
+    operation_id='pipe_get',
+    noun='pipe',
+    verb='get',
+    method='get',
+    path='/api/cdc/pipe/{pipe_uuid}',
+    summary='Get Pipe',
+    description='',
+    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:PipeV2DetailResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe get <pipe_uuid>',
+    ),
+)
+
+PIPE_LIST = Operation(
+    operation_id='pipe_list',
+    noun='pipe',
+    verb='list',
+    method='get',
+    path='/api/cdc/pipe',
+    summary='List Pipes',
+    description="Return the organization's pipes: a bare list by default, a page when you ask for one.\n\nWith no paging or filter params the response is a bare ``list`` of every pipe; with any\nof them it is a ``PipeV2Page`` envelope.",
+    project='query:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only accessible pipelines in this project.',
+            nullable=True,
+        ),
+        Param(
+            name='q',
+            location='query',
+            kind='string',
+            required=False,
+            description='Case-insensitive substring over schema, table and destination table names.',
+            nullable=True,
+        ),
+        Param(
+            name='status',
+            location='query',
+            kind='list',
+            required=False,
+            description='Coarse status buckets; repeat the param to select several. See /pipe/status-buckets.',
+            choices=(
+                'running',
+                'paused',
+                'error',
+                'provisioning',
+                'unknown',
+            ),
+            item_kind='string',
+            nullable=True,
+        ),
+        Param(
+            name='source_id',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only pipes reading from this ConnectedSource.',
+            nullable=True,
+        ),
+        Param(
+            name='sink_db_uuid',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only pipes writing into this sink.',
+            nullable=True,
+        ),
+        Param(
+            name='not_landing',
+            location='query',
+            kind='boolean',
+            required=False,
+            description='Only pipes that provisioned fine and are landing NOTHING — lifecycle ACTIVE with replication in the failing state. Orthogonal to `status`, not another bucket: these pipes ARE `running`, which is exactly why a lifecycle badge reports them as healthy. Combine with `status=running` to narrow, or use alone.',
+            nullable=True,
+        ),
+        Param(
+            name='broken',
+            location='query',
+            kind='boolean',
+            required=False,
+            description='Only pipes that are NOT WORKING, by either route: lifecycle FAILED, or provisioned-fine-and-landing-nothing. The union `not_landing` and `status=error` would have to be OR-ed to produce, which no other filter on this endpoint does. This is what a list UI should offer as one control — the difference between the two halves is a REMEDIATION difference (Retry vs Restart) and belongs on the row, not in a fleet header.',
+            nullable=True,
+        ),
+        Param(
+            name='uuid',
+            location='query',
+            kind='list',
+            required=False,
+            description="Only these pipes; repeat the param to name several (at most 200, the same ceiling as `page_size`, so one full chunk fits one request; more is a 422). Org-scoped like every other filter: another tenant's uuid matches nothing.",
+            item_kind='string',
+            nullable=True,
+        ),
+        Param(
+            name='attach_state',
+            location='query',
+            kind='list',
+            required=False,
+            description='Only pipes on a reader whose subscription is in one of these states; repeat the param to name several. A pipe that runs its own engine has none and never matches.',
+            choices=(
+                'attaching',
+                'snapshotting',
+                'live',
+                'detached',
+                'needs_resync',
+            ),
+            item_kind='string',
+            nullable=True,
+        ),
+        Param(
+            name='sort',
+            location='query',
+            kind='string',
+            required=False,
+            description="Column to order by. 'lag' orders by last_change_at, which is a proxy.",
+            choices=(
+                'created_at',
+                'status',
+                'table',
+                'dest_table_name',
+                'lag',
+                'severity',
+            ),
+        ),
+        Param(
+            name='order',
+            location='query',
+            kind='string',
+            required=False,
+            description='Sort direction.',
+            choices=(
+                'asc',
+                'desc',
+            ),
+        ),
+        Param(
+            name='page',
+            location='query',
+            kind='integer',
+            required=False,
+            description='1-based page index.',
+        ),
+        Param(
+            name='page_size',
+            location='query',
+            kind='integer',
+            required=False,
+            description='Rows per page. OMIT to receive every pipe as a bare list.',
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe:PipeListResponse',
+    ),
+    examples=(
+        'databay pipe list',
+        'databay pipe list --status error',
+    ),
+)
+
+PIPE_MOVE = Operation(
+    operation_id='pipe_move',
+    noun='pipe',
+    verb='move',
+    method='post',
+    path='/api/cdc/pipe/{pipe_uuid}/move',
+    summary='Move Pipe',
+    description='Move a pipe to ``target_project_id``; admin on both projects. Its drafts leave the source canvas.',
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='pipe_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='pipe uuid',
+        ),
+        Param(
+            name='X-Realtime-Conn-Id',
+            location='header',
+            kind='string',
+            required=False,
+            description='X-Realtime-Conn-Id',
+            nullable=True,
+        ),
+    ),
+    body=Body(
+        schema='MovePipeline',
+        fields=(
+            Param(
+                name='target_project_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Target Project Id',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='pipe:PipelineMoved',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe move <pipe_uuid> --target-project-id <project_id> --yes',
+    ),
+)
+
+PIPE_PAUSE = Operation(
+    operation_id='pipe_pause',
+    noun='pipe',
+    verb='pause',
+    method='put',
+    path='/api/cdc/pipe/{pipe_uuid}/pause',
+    summary='Pause Pipe',
+    description='',
+    project=None,
+    destructive=True,
+    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:PipePauseResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe pause <pipe_uuid> --yes',
+    ),
+)
+
+PIPE_REBUILD = Operation(
+    operation_id='pipe_rebuild',
+    noun='pipe',
+    verb='rebuild',
+    method='post',
+    path='/api/cdc/pipe/{pipe_uuid}/rebuild',
+    summary='Rebuild Pipe',
+    description="Rebuild an ingest pipe's table from ``source``; one rebuild runs per pipe at a time.\n\n202 with the rebuild id. Repeating a request with the same ``Idempotency-Key`` returns the\nsame rebuild. A ``retype`` rebuild ends a held ``retype`` rebuild and drops its backup table.\n409 ``rebuild_in_progress`` while another is open, 409 ``quota_reached`` for a\n``snapshot`` of a pipe a quota pause covers; 422 for a source the pipe cannot serve (a batch\npipe has no snapshot).",
+    project=None,
+    destructive=True,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='pipe_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='pipe uuid',
+        ),
+    ),
+    body=Body(
+        schema='PipeRebuildRequest',
+        fields=(
+            Param(
+                name='reason',
+                location='body',
+                kind='string',
+                required=False,
+                description='Recorded with the rebuild.',
+                nullable=True,
+            ),
+            Param(
+                name='source',
+                location='body',
+                kind='string',
+                required=True,
+                description="Where the rebuilt table's rows come from: a copy of the current table, a full re-read of the source, (streaming pipes) a new snapshot that replaces the table's rows and deletes the keys the source no longer has, or a copy that gives the columns a pipe halted on their new types (a CDC pipe halted with cdc_schema_retype_unsupported).",
+                choices=(
+                    'warehouse-copy',
+                    're-extract',
+                    'snapshot',
+                    'retype',
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='pipe:PipeRebuildAccepted',
+        shape='object',
+    ),
+    examples=(
+        "databay pipe rebuild <pipe_uuid> --source re-extract --reason 'schema drift' --yes",
+    ),
+)
+
+PIPE_RESTART = Operation(
+    operation_id='pipe_restart',
+    noun='pipe',
+    verb='restart',
+    method='put',
+    path='/api/cdc/pipe/{pipe_uuid}/restart',
+    summary='Restart Pipe',
+    description="Bring a pipe's replication back up after it died, without recreating the pipe.\n\nA replication task that fails during startup is never retried by the engine, and\npause/resume does not restart it. Use this after fixing the source; it keeps the\npipe's position, unlike deleting and recreating it. Restarts are manual so a\nmisconfigured source is not retried forever.\n\nThe recorded health and cause are not cleared; the next health check, within a minute,\nre-derives them. 202: tasks come back asynchronously. Poll ``GET /pipe/{uuid}/status``\nand read ``health``.",
+    project=None,
+    destructive=True,
+    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:PipeRestartAccepted',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe restart <pipe_uuid> --yes',
+    ),
+)
+
+PIPE_RESUME = Operation(
+    operation_id='pipe_resume',
+    noun='pipe',
+    verb='resume',
+    method='put',
+    path='/api/cdc/pipe/{pipe_uuid}/resume',
+    summary='Resume Pipe',
+    description="Resume a paused pipe.\n\n409 ``resync_required`` when changes the pipe had not landed are gone; the body's ``next``\nnames the resync call.",
+    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:PipeResumeResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe resume <pipe_uuid>',
+    ),
+)
+
+PIPE_RETRY = Operation(
+    operation_id='pipe_retry',
+    noun='pipe',
+    verb='retry',
+    method='put',
+    path='/api/cdc/pipe/{pipe_uuid}/retry',
+    summary='Retry Pipe',
+    description='Re-run provisioning for a FAILED pipe, keeping its identity and its row.\n\nUnlike ``/restart``, which restarts replication on a pipe that provisioned and later\nbroke, this re-runs provisioning from the start. The pipe goes back to pending and\nis provisioned again in the background; a delete issued mid-retry still wins.\n``last_error`` stays until the retry actually starts.\n\n202: accepted, not done. Poll ``GET /pipe/{uuid}/status``.',
+    project=None,
+    destructive=True,
+    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:PipeRetryAccepted',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe retry <pipe_uuid> --yes',
+    ),
+    wait=Wait(
+        status_operation='pipe_status',
+        bind=(
+            (
+                'pipe_uuid',
+                'path:pipe_uuid',
+            ),
+        ),
+        field='/pipe_status',
+        pending=(
+            'pending',
+            'creating',
+        ),
+        success=(
+            'active',
+        ),
+        failure=(
+            'failed',
+            'inactive',
+            'paused_quota',
+            'deprecated',
+            'deleting',
+            'deleted',
+        ),
+        error_field='/last_error',
+    ),
+)
+
+PIPE_ROLLUP = Operation(
+    operation_id='pipe_rollup',
+    noun='pipe',
+    verb='rollup',
+    method='get',
+    path='/api/cdc/pipe/rollup',
+    summary='Get Pipe Rollup',
+    description='Pipe counts, freshness and rows in warehouse per source or destination.\n\nOne group per key. Pipes in projects the caller cannot see are counted in\n``hidden_pipe_count`` and nowhere else. ``stored_rows`` is null when nothing was measured.',
+    project='query:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='by',
+            location='query',
+            kind='string',
+            required=True,
+            description='Group by source (`source_id`) or destination (`sink_db_uuid`).',
+            choices=(
+                'source',
+                'sink',
+            ),
+        ),
+        Param(
+            name='keys',
+            location='query',
+            kind='list',
+            required=True,
+            description='The source or sink ids the page lists; repeat the param (1 to 200). Only these come back, so the response never names a resource the page did not already show.',
+            item_kind='string',
+        ),
+        Param(
+            name='project_id',
+            location='query',
+            kind='string',
+            required=False,
+            description='Only pipes in this project.',
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='pipe:PipeRollup',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe rollup --by source --keys <source_id>',
+    ),
+)
+
+PIPE_STATUS = Operation(
+    operation_id='pipe_status',
+    noun='pipe',
+    verb='status',
+    method='get',
+    path='/api/cdc/pipe/{pipe_uuid}/status',
+    summary='Get Pipe Status',
+    description="Return the shape the wizard polls: ``pipe_status``, ``last_error`` and the pipe's health.\n\n``pipe_status`` (pending/creating/active/...) and ``last_error`` are returned in every\nstate.",
+    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:PipeV2StatusResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe status <pipe_uuid>',
+    ),
+    resumes=Wait(
+        status_operation='pipe_status',
+        bind=(
+            (
+                'pipe_uuid',
+                'path:pipe_uuid',
+            ),
+        ),
+        field='/pipe_status',
+        pending=(
+            'pending',
+            'creating',
+        ),
+        success=(
+            'active',
+        ),
+        failure=(
+            'failed',
+            'inactive',
+            'paused_quota',
+            'deprecated',
+            'deleting',
+            'deleted',
+        ),
+        error_field='/last_error',
+    ),
+)
+
+PIPE_UPDATE = Operation(
+    operation_id='pipe_update',
+    noun='pipe',
+    verb='update',
+    method='patch',
+    path='/api/cdc/pipe/{pipe_uuid}',
+    summary='Update Pipe',
+    description='Change whether new source columns are added automatically or wait for a decision.\n\n422 ``new_columns_unsupported`` for ``ask`` on a pipe that syncs on a schedule, in a Shopify store, or\nwhere source schema changes are not tracked.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='pipe_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='pipe uuid',
+        ),
+    ),
+    body=Body(
+        schema='PipeUpdate',
+        fields=(
+            Param(
+                name='new_columns',
+                location='body',
+                kind='string',
+                required=True,
+                description='Whether new source columns are added automatically (`add`) or wait for a decision (`ask`). Switching to `add` adds every column waiting for a decision; a skipped column stays out.',
+                choices=(
+                    'add',
+                    'ask',
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='pipe:PipeNewColumnsResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay pipe update <pipe_uuid> --new-columns ask',
+    ),
+)
+
+OPERATIONS = (
+    PIPE_CREATE,
+    PIPE_DELETE,
+    PIPE_GET,
+    PIPE_LIST,
+    PIPE_MOVE,
+    PIPE_PAUSE,
+    PIPE_REBUILD,
+    PIPE_RESTART,
+    PIPE_RESUME,
+    PIPE_RETRY,
+    PIPE_ROLLUP,
+    PIPE_STATUS,
+    PIPE_UPDATE,
+)