databay-cli 0.1.0__py3-none-any.whl

databay/operations/source_catalog.py

@@ -0,0 +1,135 @@
+"""The ``source-catalog`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+SOURCE_CATALOG_LIST = Operation(
+    operation_id='source_catalog_list',
+    noun='source-catalog',
+    verb='list',
+    method='get',
+    path='/api/configstore/source-catalog',
+    summary='Connected Source Catalog',
+    description='Source-type catalog for the create wizard.\n\nPer type: display name, auth kind, and the form fields to render. Shopify is an\nOAuth entry whose only field is the shop domain.\n\nOnly the types this deployment offers are listed, and an organization may see its\nown variant of an entry.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_catalog:SourceCatalogListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay source-catalog list',
+    ),
+    columns=(
+        'type',
+        'display_name',
+        'auth_kind',
+    ),
+)
+
+SOURCE_CATALOG_SETUP_SCRIPT = Operation(
+    operation_id='source_catalog_setup_script',
+    noun='source-catalog',
+    verb='setup-script',
+    method='get',
+    path='/api/configstore/source-catalog/{source_type}/setup.sql',
+    summary='Connected Source Setup Script',
+    description="Download everything ``source_type`` needs as one script for a DBA.\n\nNames are quoted for the dialect; a blank name renders as ``<your_user>`` /\n``<your_database>``. Ends with read-only queries that print PASS/FAIL per requirement.\n\nWith ``step``, only that step's SQL for what's on the guided setup's screen; 422\n``setup_step_unknown`` names the steps there are. With no known ``provider``, each provider's\nvariant comes as a commented alternative.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_type',
+            location='path',
+            kind='string',
+            required=True,
+            description='source type',
+            choices=(
+                'postgres',
+                'mysql',
+                'mssql',
+                'mongodb',
+                'shopify',
+                'meta_ads',
+                'google_ads',
+                'ga4',
+                'instagram',
+                'linkedin_pages',
+                'x',
+                'tiktok_ads',
+                'file_upload',
+            ),
+        ),
+        Param(
+            name='username',
+            location='query',
+            kind='string',
+            required=False,
+            description='the database user Databay will use',
+        ),
+        Param(
+            name='db_name',
+            location='query',
+            kind='string',
+            required=False,
+            description='the database to replicate',
+        ),
+        Param(
+            name='provider',
+            location='query',
+            kind='string',
+            required=False,
+            description='who runs the database',
+            choices=(
+                'rds',
+                'cloudsql',
+                'azure',
+                'atlas',
+                'self_managed',
+                'unknown',
+            ),
+        ),
+        Param(
+            name='step',
+            location='query',
+            kind='string',
+            required=False,
+            description='only this step of the guided setup: replication or databay_user, and publication_admin or publication_databay where the deployment offers the choice',
+            nullable=True,
+        ),
+        Param(
+            name='publication_mode',
+            location='query',
+            kind='string',
+            required=False,
+            description='the publication path the whole script prepares for',
+            choices=(
+                'customer_managed',
+                'databay_managed',
+            ),
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='text',
+    ),
+    examples=(
+        'databay source-catalog setup-script postgres --username databay --db-name shop --provider rds',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_CATALOG_LIST,
+    SOURCE_CATALOG_SETUP_SCRIPT,
+)

databay/operations/source_check_run.py

@@ -0,0 +1,242 @@
+"""The ``source-check-run`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SOURCE_CHECK_RUN_GET = Operation(
+    operation_id='source_check_run_get',
+    noun='source-check-run',
+    verb='get',
+    method='get',
+    path='/api/configstore/source/check-runs/{run_id}',
+    summary='Source Check Run Get',
+    description="Read a run: the data the socket's events only announce.\n\nA saved run is authorized like its source; an unsaved one only for the user and project that started it. A run\npast ``expires_at`` reads as ``interrupted``, and one past its 24-hour retention is 404\n``source_check_run_not_found``.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='run_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='the id the start answered',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:CheckRunResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-check-run get <run_id>',
+    ),
+)
+
+SOURCE_CHECK_RUN_LATEST = Operation(
+    operation_id='source_check_run_latest',
+    noun='source-check-run',
+    verb='latest',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/check-runs/latest',
+    summary='Source Check Run Latest',
+    description="Read the source's running run, with who started it; ``null`` when none is running.",
+    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_check_run:SourceCheckRunLatestResponse',
+    ),
+    examples=(
+        'databay source-check-run latest <source_uuid>',
+    ),
+)
+
+SOURCE_CHECK_RUN_START = Operation(
+    operation_id='source_check_run_start',
+    noun='source-check-run',
+    verb='start',
+    method='post',
+    path='/api/configstore/source/check-runs',
+    summary='Source Check Run Start',
+    description="Start checking a source and answer at once, with the run's id, its ordered checks and its deadlines.\n\nThe checks run one at a time in the background; each result is written, then sent on ``user:{sub}``. A new source\nsaves encrypted, as ``setup_incomplete``, the moment its login passes; a failed login saves nothing. Closing the\npage doesn't stop a run. ``active_probes`` also opens a real replication connection and creates a temporary slot,\nwhich a new pipe on a guided-setup type needs passed. Refusals: 409 ``source_name_taken``, 409\n``source_check_run_active`` (naming who started the running one), 409 ``quota_reached``, 422 ``host_not_allowed``,\n429 ``precheck_rate_limited``, and 503 ``precheck_busy`` or, on Check again only, ``precheck_limiter_unavailable``.\nA repeated ``Idempotency-Key`` answers the same run as it is now.",
+    project='header',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='CheckRunStartRequest',
+        fields=(
+            Param(
+                name='active_probes',
+                location='body',
+                kind='boolean',
+                required=False,
+                description="also run the type's active probes (Postgres: open a real replication connection and create a temporary replication slot; a type with none runs only its catalog checks); passing them is what lets a new pipe use this source",
+            ),
+            Param(
+                name='config',
+                location='body',
+                kind='json',
+                required=False,
+                description="a new source's connection",
+                nullable=True,
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=False,
+                description="a new source's name",
+                nullable=True,
+            ),
+            Param(
+                name='password',
+                location='body',
+                kind='string',
+                required=False,
+                description="a new source's password",
+                secret=True,
+                nullable=True,
+            ),
+            Param(
+                name='source_id',
+                location='body',
+                kind='string',
+                required=False,
+                description='the saved source to check again; null for a new source',
+                nullable=True,
+            ),
+            Param(
+                name='source_type',
+                location='body',
+                kind='string',
+                required=False,
+                description="a new source's type",
+                choices=(
+                    'postgres',
+                    'mysql',
+                    'mssql',
+                    'mongodb',
+                    'shopify',
+                    'meta_ads',
+                    'google_ads',
+                    'ga4',
+                    'instagram',
+                    'linkedin_pages',
+                    'x',
+                    'tiktok_ads',
+                    'file_upload',
+                ),
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:CheckRunResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-check-run start --source-id <source_id> --active-probes',
+        'databay source-check-run start --file <file>',
+    ),
+)
+
+SOURCE_CHECK_RUN_TABLES = Operation(
+    operation_id='source_check_run_tables',
+    noun='source-check-run',
+    verb='tables',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/check-runs/{run_id}/tables',
+    summary='Source Check Run Tables',
+    description="Page and search the table list the run read, without touching the customer's database.\n\nThe list is as of the run: partition children aren't listed. Rows are capped and totals are not, ``read_status``\n``failed`` says the read failed (which blocks nothing), and past retention this is 404\n``source_check_run_not_found``, for Check again.",
+    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='run_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='a run of this source',
+        ),
+        Param(
+            name='group',
+            location='query',
+            kind='string',
+            required=True,
+            description='in: can be replicated. out: needs a fix first. in_publication and not_in_publication: whether databay_publication lists the table.',
+            choices=(
+                'in',
+                'out',
+                'in_publication',
+                'not_in_publication',
+            ),
+        ),
+        Param(
+            name='q',
+            location='query',
+            kind='string',
+            required=False,
+            description='search by schema.table',
+        ),
+        Param(
+            name='offset',
+            location='query',
+            kind='integer',
+            required=False,
+            description='Offset',
+        ),
+        Param(
+            name='limit',
+            location='query',
+            kind='integer',
+            required=False,
+            description='Limit',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_check_run:CheckRunTablesResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-check-run tables <source_uuid> <run_id> --group in',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_CHECK_RUN_GET,
+    SOURCE_CHECK_RUN_LATEST,
+    SOURCE_CHECK_RUN_START,
+    SOURCE_CHECK_RUN_TABLES,
+)

databay/operations/source_hidden_type.py

@@ -0,0 +1,59 @@
+"""The ``source-hidden-type`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+SOURCE_HIDDEN_TYPE_LIST = Operation(
+    operation_id='source_hidden_type_list',
+    noun='source-hidden-type',
+    verb='list',
+    method='get',
+    path='/api/configstore/source/hidden-types',
+    summary='Connected Source Hidden Types',
+    description='List the given source types the caller cannot fully see: Insights locks a section reading them.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='type',
+            location='query',
+            kind='list',
+            required=True,
+            description='source types to check',
+            choices=(
+                'postgres',
+                'mysql',
+                'mssql',
+                'mongodb',
+                'shopify',
+                'meta_ads',
+                'google_ads',
+                'ga4',
+                'instagram',
+                'linkedin_pages',
+                'x',
+                'tiktok_ads',
+                'file_upload',
+            ),
+            item_kind='string',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_hidden_type:HiddenSourceTypesResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-hidden-type list --type shopify --type ga4',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_HIDDEN_TYPE_LIST,
+)

databay/operations/source_name.py

@@ -0,0 +1,69 @@
+"""The ``source-name`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+SOURCE_NAME_CHECK = Operation(
+    operation_id='source_name_check',
+    noun='source-name',
+    verb='check',
+    method='post',
+    path='/api/configstore/source/name-check',
+    summary='Source Name Check',
+    description='Say whether a name is free in the organization, where source names are unique.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='NameCheckRequest',
+        fields=(
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='the name to check',
+            ),
+            Param(
+                name='source_type',
+                location='body',
+                kind='string',
+                required=False,
+                description="when set, also refuses with quota_reached if the organization can't add this type",
+                choices=(
+                    'postgres',
+                    'mysql',
+                    'mssql',
+                    'mongodb',
+                    'shopify',
+                    'meta_ads',
+                    'google_ads',
+                    'ga4',
+                    'instagram',
+                    'linkedin_pages',
+                    'x',
+                    'tiktok_ads',
+                    'file_upload',
+                ),
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='source_name:NameCheckResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source-name check --name <name>',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_NAME_CHECK,
+)

databay/operations/source_pipe.py

@@ -0,0 +1,57 @@
+"""The ``source-pipe`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+SOURCE_PIPE_LIST = Operation(
+    operation_id='source_pipe_list',
+    noun='source-pipe',
+    verb='list',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/pipes',
+    summary='Connected Source Pipes',
+    description='Page through the pipelines depending on one source.\n\nLets the usage panel turn a page without re-fetching the whole detail view.\n\n404s on an unknown source and on another organization\'s source alike, so the uuid\'s\nexistence is not confirmed.\n\nA failed pipeline lookup is a 503, not an empty page: "0 pipelines" would tell someone\nit is safe to delete a source that may have live pipes. The client keeps the page it\nhad and offers a retry. (The detail view degrades to ``pipes_unavailable`` instead.)',
+    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='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.',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source_pipe:DependentPipePage',
+        shape='object',
+    ),
+    examples=(
+        'databay source-pipe list <source_uuid> --page 2 --page-size 50',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_PIPE_LIST,
+)