databay-cli 0.1.0__py3-none-any.whl

databay/operations/ssbi_job.py

@@ -0,0 +1,242 @@
+"""The ``ssbi-job`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SSBI_JOB_CREATE = Operation(
+    operation_id='ssbi_job_create',
+    noun='ssbi-job',
+    verb='create',
+    method='post',
+    path='/api/ssbi/jobs',
+    summary='Create a new Job',
+    description='',
+    project='header',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='JobCreate',
+        fields=(
+            Param(
+                name='destination_table',
+                location='body',
+                kind='string',
+                required=True,
+                description='Destination table name for the job',
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='Unique name for the  job',
+            ),
+            Param(
+                name='resource',
+                location='body',
+                kind='json',
+                required=True,
+            ),
+            Param(
+                name='schedule',
+                location='body',
+                kind='json',
+                required=True,
+            ),
+            Param(
+                name='transformation',
+                location='body',
+                kind='json',
+                required=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='ssbi_job:JobResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay ssbi-job create --file <job_json_file>',
+    ),
+)
+
+SSBI_JOB_DELETE = Operation(
+    operation_id='ssbi_job_delete',
+    noun='ssbi-job',
+    verb='delete',
+    method='delete',
+    path='/api/ssbi/jobs/{job_uuid}',
+    summary='Delete an Job',
+    description='',
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='job_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='The UUID of the job to delete',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay ssbi-job delete <job_uuid> --yes',
+    ),
+)
+
+SSBI_JOB_GET = Operation(
+    operation_id='ssbi_job_get',
+    noun='ssbi-job',
+    verb='get',
+    method='get',
+    path='/api/ssbi/jobs/{job_uuid}',
+    summary='Get a specific Job by UUID',
+    description='',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='job_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='The unique identifier of the  job',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='ssbi_job:JobResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay ssbi-job get <job_uuid>',
+    ),
+)
+
+SSBI_JOB_LIST = Operation(
+    operation_id='ssbi_job_list',
+    noun='ssbi-job',
+    verb='list',
+    method='get',
+    path='/api/ssbi/jobs',
+    summary='List all Jobs',
+    description='',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='skip',
+            location='query',
+            kind='integer',
+            required=False,
+            description='Number of records to skip for pagination',
+        ),
+        Param(
+            name='limit',
+            location='query',
+            kind='integer',
+            required=False,
+            description='Maximum number of records to return',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='ssbi_job:SsbiJobListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay ssbi-job list',
+        'databay ssbi-job list --skip 100 --limit 50',
+    ),
+)
+
+SSBI_JOB_UPDATE = Operation(
+    operation_id='ssbi_job_update',
+    noun='ssbi-job',
+    verb='update',
+    method='patch',
+    path='/api/ssbi/jobs/{job_uuid}',
+    summary='Update an Job',
+    description='',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='job_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='The UUID of the job to update',
+        ),
+    ),
+    body=Body(
+        schema='JobUpdate',
+        fields=(
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=False,
+                description='Job Name',
+                nullable=True,
+            ),
+            Param(
+                name='resource',
+                location='body',
+                kind='json',
+                required=False,
+                nullable=True,
+            ),
+            Param(
+                name='schedule',
+                location='body',
+                kind='json',
+                required=False,
+                nullable=True,
+            ),
+            Param(
+                name='transformation',
+                location='body',
+                kind='json',
+                required=False,
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='ssbi_job:JobResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay ssbi-job update <job_uuid> --name daily_revenue',
+    ),
+)
+
+OPERATIONS = (
+    SSBI_JOB_CREATE,
+    SSBI_JOB_DELETE,
+    SSBI_JOB_GET,
+    SSBI_JOB_LIST,
+    SSBI_JOB_UPDATE,
+)

databay/operations/transform_type.py

@@ -0,0 +1,35 @@
+"""The ``transform-type`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+TRANSFORM_TYPE_LIST = Operation(
+    operation_id='transform_type_list',
+    noun='transform-type',
+    verb='list',
+    method='get',
+    path='/api/cdc/transform-types',
+    summary='Get Transform Types',
+    description='List the transform types a pipe can be shaped with, available ones and those coming soon.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='transform_type:TransformTypeListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay transform-type list',
+    ),
+)
+
+OPERATIONS = (
+    TRANSFORM_TYPE_LIST,
+)

databay/operations/usage.py

@@ -0,0 +1,35 @@
+"""The ``usage`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+USAGE_GET = Operation(
+    operation_id='usage_get',
+    noun='usage',
+    verb='get',
+    method='get',
+    path='/api/entitlements/usage',
+    summary='Get Usage',
+    description="Return the period's usage and limits; per-project lines only for projects the caller can see.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='usage:UsageView',
+        shape='object',
+    ),
+    examples=(
+        'databay usage get',
+    ),
+)
+
+OPERATIONS = (
+    USAGE_GET,
+)

databay/operations/warehouse.py

@@ -0,0 +1,343 @@
+"""The ``warehouse`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response, Wait
+
+
+WAREHOUSE_CREATE = Operation(
+    operation_id='warehouse_create',
+    noun='warehouse',
+    verb='create',
+    method='post',
+    path='/api/configstore/databases',
+    summary='Create Warehouse',
+    description='Reserve a warehouse and provision it in the background: 202 with ``Location``.\n\nThe warehouse starts ``pending``, homed in the active project.',
+    project='header',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='WarehouseNameBody',
+        fields=(
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description="the warehouse's chosen name, 1-64 characters, unique per organization (any case)",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:WarehouseAcceptedResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse create --name <name>',
+    ),
+    wait=Wait(
+        status_operation='warehouse_get',
+        bind=(
+            (
+                'db_uuid',
+                '/uuid',
+            ),
+        ),
+        field='/status',
+        pending=(
+            'pending',
+            'provisioning',
+        ),
+        success=(
+            'ready',
+        ),
+        failure=(
+            'failed',
+            'deleting',
+        ),
+        error_field='/last_error',
+    ),
+)
+
+WAREHOUSE_DELETE = Operation(
+    operation_id='warehouse_delete',
+    noun='warehouse',
+    verb='delete',
+    method='delete',
+    path='/api/configstore/databases/{db_uuid}',
+    summary='Delete Warehouse',
+    description='Start deleting a ``ready`` or ``failed`` warehouse: 202, then ``deleting`` until it is dropped.\n\n409 ``pipes_present`` while pipelines in any project use it (only the ones the caller\ncan see are listed). 502 when the pipelines using it cannot be read (fails closed).',
+    project='header',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the warehouse',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:WarehouseAcceptedResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse delete <db_uuid> --yes',
+    ),
+)
+
+WAREHOUSE_GET = Operation(
+    operation_id='warehouse_get',
+    noun='warehouse',
+    verb='get',
+    method='get',
+    path='/api/configstore/databases/{db_uuid}',
+    summary='Get Warehouse',
+    description='',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the warehouse',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:PublicDBResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse get <db_uuid>',
+    ),
+    resumes=Wait(
+        status_operation='warehouse_get',
+        bind=(
+            (
+                'db_uuid',
+                'path:db_uuid',
+            ),
+        ),
+        field='/status',
+        pending=(
+            'pending',
+            'provisioning',
+        ),
+        success=(
+            'ready',
+        ),
+        failure=(
+            'failed',
+            'deleting',
+        ),
+        error_field='/last_error',
+    ),
+)
+
+WAREHOUSE_IMPACT = Operation(
+    operation_id='warehouse_impact',
+    noun='warehouse',
+    verb='impact',
+    method='get',
+    path='/api/configstore/databases/{db_uuid}/impact',
+    summary='Warehouse Impact',
+    description='Report what a delete would break: the pipelines that write into the warehouse.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the warehouse',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse:WarehouseImpactResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse impact <db_uuid>',
+    ),
+)
+
+WAREHOUSE_LIST = Operation(
+    operation_id='warehouse_list',
+    noun='warehouse',
+    verb='list',
+    method='get',
+    path='/api/configstore/databases',
+    summary='List Warehouses',
+    description='List the default warehouse first, then home and shared ones of the active project, newest first.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse:WarehouseListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse list',
+    ),
+    columns=(
+        'uuid',
+        'name',
+        'status',
+    ),
+)
+
+WAREHOUSE_RENAME = Operation(
+    operation_id='warehouse_rename',
+    noun='warehouse',
+    verb='rename',
+    method='patch',
+    path='/api/configstore/databases/{db_uuid}',
+    summary='Rename Warehouse',
+    description='Change the chosen name only; the old one stays held for 30 days.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the warehouse',
+        ),
+    ),
+    body=Body(
+        schema='WarehouseNameBody',
+        fields=(
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description="the warehouse's chosen name, 1-64 characters, unique per organization (any case)",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:PublicDBResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse rename <db_uuid> --name marketing',
+    ),
+)
+
+WAREHOUSE_RETRY = Operation(
+    operation_id='warehouse_retry',
+    noun='warehouse',
+    verb='retry',
+    method='post',
+    path='/api/configstore/databases/{db_uuid}/retry',
+    summary='Retry Warehouse',
+    description='From ``failed``: 202 and a new attempt. From ``pending`` / ``provisioning``: 202, nothing to do.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='UUID of the warehouse',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:WarehouseAcceptedResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse retry <db_uuid> --wait',
+    ),
+    wait=Wait(
+        status_operation='warehouse_get',
+        bind=(
+            (
+                'db_uuid',
+                '/uuid',
+            ),
+        ),
+        field='/status',
+        pending=(
+            'pending',
+            'provisioning',
+        ),
+        success=(
+            'ready',
+        ),
+        failure=(
+            'failed',
+            'deleting',
+        ),
+        error_field='/last_error',
+    ),
+)
+
+WAREHOUSE_STATS = Operation(
+    operation_id='warehouse_stats',
+    noun='warehouse',
+    verb='stats',
+    method='get',
+    path='/api/configstore/databases/stats',
+    summary='Warehouse Stats',
+    description='Size and table count per visible warehouse (one ClickHouse query, cached 20 s per org).',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse:WarehouseStatsResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse stats',
+    ),
+)
+
+OPERATIONS = (
+    WAREHOUSE_CREATE,
+    WAREHOUSE_DELETE,
+    WAREHOUSE_GET,
+    WAREHOUSE_IMPACT,
+    WAREHOUSE_LIST,
+    WAREHOUSE_RENAME,
+    WAREHOUSE_RETRY,
+    WAREHOUSE_STATS,
+)