databay-cli 0.1.0__py3-none-any.whl

databay/operations/metrics.py

@@ -0,0 +1,218 @@
+"""The ``metrics`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+METRICS_DESCRIBE = Operation(
+    operation_id='metrics_describe',
+    noun='metrics',
+    verb='describe',
+    method='get',
+    path='/api/semantic/projects/{project_id}/metrics/{metric}',
+    summary='Get Metric',
+    description='Describe one metric you can query.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='metric',
+            location='path',
+            kind='string',
+            required=True,
+            description='Metric',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='metrics:MetricOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metrics describe net_sales',
+    ),
+)
+
+METRICS_LIST = Operation(
+    operation_id='metrics_list',
+    noun='metrics',
+    verb='list',
+    method='get',
+    path='/api/semantic/projects/{project_id}/metrics',
+    summary='Get Metrics',
+    description='List the metrics you can query, each with its dimensions, grains, warehouses and state.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='metrics:MetricListOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metrics list',
+    ),
+)
+
+METRICS_QUERY = Operation(
+    operation_id='metrics_query',
+    noun='metrics',
+    verb='query',
+    method='post',
+    path='/api/semantic/projects/{project_id}/metrics/query',
+    summary='Post Metric Query',
+    description="Query one metric, or several of one cube (``metrics``), by dimensions and time grain.\n\n``explain`` adds the metric's definition, SQL and lineage, for one metric only.\n\n``dry_run`` answers the explain without running the query. ``rows`` hold at most ``limit`` rows, and\n``truncated`` says when there were more.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='X-Databay-Caller',
+            location='header',
+            kind='string',
+            required=False,
+            description='X-Databay-Caller',
+            choices=(
+                'cli',
+                'agent',
+                'api',
+            ),
+            nullable=True,
+        ),
+    ),
+    body=Body(
+        schema='MetricQuery',
+        fields=(
+            Param(
+                name='dimensions',
+                location='body',
+                kind='list',
+                required=False,
+                description='Dimensions',
+                item_kind='string',
+            ),
+            Param(
+                name='dry_run',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Dry Run',
+            ),
+            Param(
+                name='explain',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Explain',
+            ),
+            Param(
+                name='filters',
+                location='body',
+                kind='json',
+                required=False,
+                description='Filters',
+            ),
+            Param(
+                name='limit',
+                location='body',
+                kind='integer',
+                required=False,
+                description='Limit',
+            ),
+            Param(
+                name='metric',
+                location='body',
+                kind='string',
+                required=False,
+                description='Metric',
+                nullable=True,
+            ),
+            Param(
+                name='metrics',
+                location='body',
+                kind='list',
+                required=False,
+                description='Metrics',
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='model_version',
+                location='body',
+                kind='integer',
+                required=False,
+                description='Model Version',
+                nullable=True,
+            ),
+            Param(
+                name='order',
+                location='body',
+                kind='json',
+                required=False,
+                description='Order',
+            ),
+            Param(
+                name='time',
+                location='body',
+                kind='json',
+                required=False,
+                nullable=True,
+            ),
+            Param(
+                name='warehouse',
+                location='body',
+                kind='string',
+                required=False,
+                description='Warehouse',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='metrics:MetricQueryOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metrics query net_sales --grain day --last 30d',
+        'databay metrics query channel_sessions --by channel --grain week --last 90d --where channel=Direct',
+        'databay metrics query net_sales --grain day --last 30d --explain',
+    ),
+)
+
+OPERATIONS = (
+    METRICS_DESCRIBE,
+    METRICS_LIST,
+    METRICS_QUERY,
+)

databay/operations/models.py

@@ -0,0 +1,123 @@
+"""The ``models`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response, Verdict
+
+
+MODELS_CHECK = Operation(
+    operation_id='models_check',
+    noun='models',
+    verb='check',
+    method='post',
+    path='/api/elt/git/connection/check',
+    summary='Check',
+    description="Check a branch's tip as a sync would, with ``EXPLAIN ESTIMATE`` advice; nothing is applied or built.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='BranchCheckRequest',
+        fields=(
+            Param(
+                name='ref',
+                location='body',
+                kind='string',
+                required=True,
+                description='Ref',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='models:CommitCheck',
+        shape='object',
+    ),
+    examples=(
+        'databay models check --ref main',
+    ),
+    columns=(
+        'commit',
+        'passed',
+        'problems',
+    ),
+    verdict=Verdict(
+        field='/passed',
+        ok=(
+            'true',
+        ),
+        not_ready=(
+            'false',
+        ),
+    ),
+)
+
+MODELS_SYNC = Operation(
+    operation_id='models_sync',
+    noun='models',
+    verb='sync',
+    method='post',
+    path='/api/elt/git/connection/sync',
+    summary='Sync Now',
+    description='Read the branch on the next pass; its outcome shows in the status.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='models:GitConnectionOut',
+        shape='object',
+    ),
+    examples=(
+        'databay models sync',
+    ),
+    columns=(
+        'applied_commit',
+        'next_sync_at',
+        'error',
+    ),
+)
+
+MODELS_SYNC_STATUS = Operation(
+    operation_id='models_sync_status',
+    noun='models',
+    verb='sync-status',
+    method='get',
+    path='/api/elt/git/connection',
+    summary='Connection Status',
+    description='',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='models:GitConnectionOut',
+        shape='object',
+    ),
+    examples=(
+        'databay models sync-status',
+    ),
+    columns=(
+        'repo_url',
+        'branch',
+        'folder',
+        'applied_commit',
+        'last_sync_at',
+        'error',
+    ),
+)
+
+OPERATIONS = (
+    MODELS_CHECK,
+    MODELS_SYNC,
+    MODELS_SYNC_STATUS,
+)

databay/operations/nlq.py

@@ -0,0 +1,100 @@
+"""The ``nlq`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+NLQ_ASK = Operation(
+    operation_id='nlq_ask',
+    noun='nlq',
+    verb='ask',
+    method='post',
+    path='/api/nlq/ask',
+    summary='Ask',
+    description='',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='AskRequest',
+        fields=(
+            Param(
+                name='conversation_id',
+                location='body',
+                kind='string',
+                required=False,
+                description="The caller's conversation this question continues; its last turns are the follow-up context. Null starts a new conversation.",
+                nullable=True,
+            ),
+            Param(
+                name='database_name',
+                location='body',
+                kind='string',
+                required=False,
+                description="Optional ClickHouse database (schema) on the selected connection. When set, the assistant looks for the question's tables in this database.",
+                nullable=True,
+            ),
+            Param(
+                name='database_uuid',
+                location='body',
+                kind='string',
+                required=True,
+                description='UUID of the database connection to query against',
+            ),
+            Param(
+                name='history',
+                location='body',
+                kind='json',
+                required=False,
+                description='Up to three earlier turns, oldest first, for a question outside any stored conversation',
+            ),
+            Param(
+                name='question',
+                location='body',
+                kind='string',
+                required=True,
+                description='Natural language question',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='nlq:NlqAskResponse',
+    ),
+    examples=(
+        'databay nlq ask --database-uuid <db_uuid> --question "How many orders did we get last week?"',
+    ),
+)
+
+NLQ_USAGE = Operation(
+    operation_id='nlq_usage',
+    noun='nlq',
+    verb='usage',
+    method='get',
+    path='/api/nlq/usage',
+    summary='Usage',
+    description='',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='nlq:AiUsageResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay nlq usage',
+    ),
+)
+
+OPERATIONS = (
+    NLQ_ASK,
+    NLQ_USAGE,
+)

databay/operations/notebook_credential.py

@@ -0,0 +1,95 @@
+"""The ``notebook-credential`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+NOTEBOOK_CREDENTIAL_GET_BINDING = Operation(
+    operation_id='notebook_credential_get_binding',
+    noun='notebook-credential',
+    verb='get-binding',
+    method='get',
+    path='/api/configstore/notebook-credentials/binding',
+    summary='Notebook Binding',
+    description='Name the project of the caller\'s most recent notebook issuance (``last_used_at``).\n\nLets the UI show which project a running server uses and offer "Restart in {new}".\nWith ``project_id`` (the notebook server, about the server it is running), answer for that project\ninstead: launching from another project issues that project\'s reader first, so the\nlatest issuance is no longer the server\'s project. The project is re-checked live and\nomitted when the caller can no longer view it, so the route never names a project the\ncaller lost.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='query',
+            kind='string',
+            required=False,
+            description="answer for this project (the running server's) instead of the latest",
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='notebook_credential:NotebookBindingResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay notebook-credential get-binding',
+        'databay notebook-credential get-binding --project-id <project_id>',
+    ),
+)
+
+NOTEBOOK_CREDENTIAL_ISSUE = Operation(
+    operation_id='notebook_credential_issue',
+    noun='notebook-credential',
+    verb='issue',
+    method='post',
+    path='/api/configstore/notebook-credentials',
+    summary='Notebook Credentials',
+    description="Issue notebook ClickHouse credentials for the caller.\n\nPOST because it provisions. Idempotent: the same credentials come back every time,\nbecause this runs on every notebook spawn and rotating here would invalidate a running\nkernel. Rotation is the ``renew`` route.\n\nThe caller's own reader in the active project (``X-Databay-Project-ID``; the notebook server\nforwards it), whose grants are exactly the project's visible managed warehouses plus the project scratch.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='notebook_credential:NotebookCredentialsResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay notebook-credential issue',
+    ),
+)
+
+NOTEBOOK_CREDENTIAL_RENEW = Operation(
+    operation_id='notebook_credential_renew',
+    noun='notebook-credential',
+    verb='renew',
+    method='post',
+    path='/api/configstore/notebook-credentials/renew',
+    summary='Renew Notebook Credentials',
+    description="Mint a new notebook password.\n\nRotates only the caller's reader in the active project; READER is enough because nobody\nelse's kernel is affected.",
+    project='header',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='notebook_credential:NotebookCredentialsRotateResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay notebook-credential renew --yes',
+    ),
+)
+
+OPERATIONS = (
+    NOTEBOOK_CREDENTIAL_GET_BINDING,
+    NOTEBOOK_CREDENTIAL_ISSUE,
+    NOTEBOOK_CREDENTIAL_RENEW,
+)

databay/operations/org.py

@@ -0,0 +1,79 @@
+"""The ``org`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+ORG_LIST = Operation(
+    operation_id='org_list',
+    noun='org',
+    verb='list',
+    method='get',
+    path='/api/auth/me/organizations',
+    summary='Get My Organizations',
+    description="List the organizations the caller belongs to, their role in each, and which one is stored as active.\n\n`active_org` and `is_active` are the stored choice: the organization the next refreshed token names.\nThe caller's current token may still name another one until it is refreshed. `needs_org_choice` is\ntrue when no usable organization is stored and one is usable: choose with `PUT /api/auth/me/active-org`,\nthen refresh the token. `usable_orgs` 0 means every organization is disabled, or there is none.\nAn org API key is refused with 403 `api_key_not_allowed`; 503 `auth_unavailable` means retry later.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='org:MyOrganizationsResponse',
+        shape='object',
+        rows='/organizations',
+    ),
+    examples=(
+        'databay org list',
+    ),
+    columns=(
+        'organization',
+        'display_name',
+        'role',
+        'is_active',
+        'enabled',
+    ),
+)
+
+ORG_SWITCH = Operation(
+    operation_id='org_switch',
+    noun='org',
+    verb='switch',
+    method='put',
+    path='/api/auth/me/active-org',
+    summary='Put Active Org',
+    description="Store one of the caller's organizations as active; the token in hand still names the previous one.\n\nRefresh the token (refresh-token grant at the identity provider's token endpoint; `databay org switch`\ndoes it) and the new token names this one. Refusals:\n\n- 403 `org_not_member`: the caller does not belong to that organization;\n- 403 `org_disabled`: the organization is disabled, so no token could name it;\n- 403 `api_key_not_allowed`: the caller is an org API key, which belongs to one organization;\n- 503 `auth_unavailable`: the identity provider could not be read or written; retry later;\n- 500 `active_org_not_stored`: the identity provider dropped the choice; nothing was switched.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='SwitchActiveOrgRequest',
+        fields=(
+            Param(
+                name='organization',
+                location='body',
+                kind='string',
+                required=True,
+                description='The organization key to make active.',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='org:ActiveOrgResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay org switch <organization>',
+    ),
+)
+
+OPERATIONS = (
+    ORG_LIST,
+    ORG_SWITCH,
+)