databay-cli 0.1.0__py3-none-any.whl

databay/operations/dashboards_home.py

@@ -0,0 +1,176 @@
+"""The ``dashboards-home`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+DASHBOARDS_HOME_GET = Operation(
+    operation_id='dashboards_home_get',
+    noun='dashboards-home',
+    verb='get',
+    method='get',
+    path='/api/insights/projects/{project_id}/home',
+    summary="Read which dashboard is the project's Overview",
+    description="Answer the dashboard the project's Overview shows; ``dashboard_id`` is null until someone pins or sets one.",
+    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='dashboards_home:ProjectHomeOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-home get',
+    ),
+)
+
+DASHBOARDS_HOME_PIN = Operation(
+    operation_id='dashboards_home_pin',
+    noun='dashboards-home',
+    verb='pin',
+    method='post',
+    path='/api/insights/projects/{project_id}/home/placements',
+    summary="Pin a card to the project's Overview",
+    description='Place a card of the project on its Overview dashboard and answer that dashboard.\n\nThe project\'s first pin creates an ordinary dashboard named "Overview" and makes it the Overview;\na card already there is 409 ``card_already_on_board``.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='PlacementCreate',
+        fields=(
+            Param(
+                name='card_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Card Id',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:BoardOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-home pin --card-id <card_id>',
+    ),
+)
+
+DASHBOARDS_HOME_PIN_MANY = Operation(
+    operation_id='dashboards_home_pin_many',
+    noun='dashboards-home',
+    verb='pin-many',
+    method='post',
+    path='/api/insights/projects/{project_id}/home/placements/batch',
+    summary="Pin several cards to the project's Overview",
+    description='Place 1 to 50 cards of the project on its Overview dashboard in one go, and answer that dashboard.\n\nThe first pin creates the Overview dashboard as a single pin does. A card already there is left as\nit is and listed in ``already_placed``. When any card cannot be placed (``card_not_found``,\n``filter_type_conflict``, ``invalid_layout`` at 100 cards) the whole batch is refused and nothing changes.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='HomePinBatch',
+        fields=(
+            Param(
+                name='card_ids',
+                location='body',
+                kind='list',
+                required=True,
+                description='The cards to pin, 1 to 50, each named once.',
+                item_kind='string',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='dashboards_home:HomePinBatchOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-home pin-many --file <card_ids_json_file>',
+    ),
+)
+
+DASHBOARDS_HOME_SET = Operation(
+    operation_id='dashboards_home_set',
+    noun='dashboards-home',
+    verb='set',
+    method='put',
+    path='/api/insights/projects/{project_id}/home',
+    summary="Make a dashboard the project's Overview",
+    description='Make a dashboard of the project its Overview for everyone in it, replacing the one it showed.',
+    project='path:project_id',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='ProjectHomeSet',
+        fields=(
+            Param(
+                name='dashboard_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Dashboard Id',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='dashboards_home:ProjectHomeOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-home set --dashboard-id <board_id> --yes',
+    ),
+)
+
+OPERATIONS = (
+    DASHBOARDS_HOME_GET,
+    DASHBOARDS_HOME_PIN,
+    DASHBOARDS_HOME_PIN_MANY,
+    DASHBOARDS_HOME_SET,
+)

databay/operations/dashboards_placement.py

@@ -0,0 +1,152 @@
+"""The ``dashboards-placement`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+DASHBOARDS_PLACEMENT_CREATE = Operation(
+    operation_id='dashboards_placement_create',
+    noun='dashboards-placement',
+    verb='create',
+    method='post',
+    path='/api/insights/boards/{board_id}/placements',
+    summary='Place a card on a dashboard',
+    description="Place an existing card of the dashboard's project below its other cards; 409 when it is already there.",
+    project=None,
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='board_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Board Id',
+        ),
+    ),
+    body=Body(
+        schema='PlacementCreate',
+        fields=(
+            Param(
+                name='card_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Card Id',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:BoardOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-placement create <board_id> --card-id <card_id>',
+    ),
+)
+
+DASHBOARDS_PLACEMENT_DELETE = Operation(
+    operation_id='dashboards_placement_delete',
+    noun='dashboards-placement',
+    verb='delete',
+    method='delete',
+    path='/api/insights/boards/{board_id}/placements/{card_id}',
+    summary='Take a card off a dashboard',
+    description='Take a card off the dashboard; the card stays in the project and on its other dashboards.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='board_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Board Id',
+        ),
+        Param(
+            name='card_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Card Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:BoardOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-placement delete <board_id> <card_id>',
+    ),
+)
+
+DASHBOARDS_PLACEMENT_RUN = Operation(
+    operation_id='dashboards_placement_run',
+    noun='dashboards-placement',
+    verb='run',
+    method='post',
+    path='/api/insights/boards/{board_id}/cards/{card_id}/run',
+    summary='Run one card of a dashboard',
+    description="Run one card that sits on the dashboard for the viewer, with the dashboard's filters.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='board_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Board Id',
+        ),
+        Param(
+            name='card_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Card Id',
+        ),
+    ),
+    body=Body(
+        schema='CardRunRequest',
+        fields=(
+            Param(
+                name='filters',
+                location='body',
+                kind='json',
+                required=False,
+                description='Filter values by filter key; absent filters take their defaults.',
+            ),
+            Param(
+                name='refresh',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Skip the per-viewer result cache.',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:CardResult',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-placement run <board_id> <card_id>',
+    ),
+)
+
+OPERATIONS = (
+    DASHBOARDS_PLACEMENT_CREATE,
+    DASHBOARDS_PLACEMENT_DELETE,
+    DASHBOARDS_PLACEMENT_RUN,
+)

databay/operations/db.py

@@ -0,0 +1,337 @@
+"""The ``db`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response, Verdict
+
+
+DB_CREATE = Operation(
+    operation_id='db_create',
+    noun='db',
+    verb='create',
+    method='post',
+    path='/api/configstore/db',
+    summary='Db Instance Create',
+    description='Register a database you run as a warehouse.',
+    project='header',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='DBCreate',
+        fields=(
+            Param(
+                name='db_name',
+                location='body',
+                kind='string',
+                required=True,
+                description='actual database name in the server',
+            ),
+            Param(
+                name='extra_config',
+                location='body',
+                kind='json',
+                required=False,
+                description='optional per-type settings; for ClickHouse this carries the single-node vs cluster topology',
+                nullable=True,
+            ),
+            Param(
+                name='host',
+                location='body',
+                kind='string',
+                required=True,
+                description='host of the db',
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='logical name for the database instance',
+            ),
+            Param(
+                name='password',
+                location='body',
+                kind='string',
+                required=False,
+                description='password of the db instance created',
+                secret=True,
+            ),
+            Param(
+                name='port',
+                location='body',
+                kind='integer',
+                required=True,
+                description='port number of the db',
+            ),
+            Param(
+                name='type',
+                location='body',
+                kind='string',
+                required=True,
+                description='the db type',
+                choices=(
+                    'mysql',
+                    'postgres',
+                    'clickhouse',
+                    'mongodb',
+                    'mssql',
+                ),
+            ),
+            Param(
+                name='username',
+                location='body',
+                kind='string',
+                required=True,
+                description='username for db to login',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='db:WarehouseCreated',
+        shape='object',
+    ),
+    examples=(
+        'databay db create --name <name> --type clickhouse --host <host> --port <port> --db-name <db_name> --username <username> --password-env <password_env>',
+    ),
+)
+
+DB_DELETE = Operation(
+    operation_id='db_delete',
+    noun='db',
+    verb='delete',
+    method='delete',
+    path='/api/configstore/db/{db_uuid}',
+    summary='Delete Db',
+    description="Delete a sink DB that nothing writes into.\n\nIn an org that scopes resources only the home project's editors may delete it (403\n``not_home`` for a shared one; an organization-wide warehouse needs an org admin); one\nthe caller cannot see is a 404.\n\nRefused while pipes still write into it, so no pipe is left pointing at a missing sink.\nFails closed: if the pipeline service cannot be reached, nothing is deleted.",
+    project='header',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the db instance',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:WarehouseAcceptedResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay db delete <db_uuid> --yes',
+    ),
+)
+
+DB_GET = Operation(
+    operation_id='db_get',
+    noun='db',
+    verb='get',
+    method='get',
+    path='/api/configstore/db/{db_uuid}',
+    summary='Get Db',
+    description='One warehouse, with ``relation`` and ``home_project_id`` in an org that scopes resources.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the db instance',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:PublicDBResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay db get <db_uuid>',
+    ),
+)
+
+DB_GET_BY_NAME = Operation(
+    operation_id='db_get_by_name',
+    noun='db',
+    verb='get-by-name',
+    method='get',
+    path='/api/configstore/db/{db_name}/name',
+    summary='Get Db By Name',
+    description='',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='db_name',
+            location='path',
+            kind='string',
+            required=True,
+            description='name of the db instance',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:PublicDBResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay db get-by-name analytics',
+    ),
+)
+
+DB_LIST = Operation(
+    operation_id='db_list',
+    noun='db',
+    verb='list',
+    method='get',
+    path='/api/configstore/db',
+    summary='Get Dbs',
+    description='List the org\'s warehouses; in an org that scopes resources, those usable in the active project.\n\nHome, shared and organization-wide warehouses of ``X-Databay-Project-ID``\n(General with a ``Deprecation`` header when missing), plus ones still pending a home\nthere; quarantined ones ("Needs a home") for org admins only.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='db:DbListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay db list',
+    ),
+    columns=(
+        'uuid',
+        'name',
+        'type',
+        'status',
+    ),
+)
+
+DB_TEST = Operation(
+    operation_id='db_test',
+    noun='db',
+    verb='test',
+    method='post',
+    path='/api/configstore/db/test-connection',
+    summary='Db Test Connection',
+    description='Attempt to connect to a database using provided credentials.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='DBCreate',
+        fields=(
+            Param(
+                name='db_name',
+                location='body',
+                kind='string',
+                required=True,
+                description='actual database name in the server',
+            ),
+            Param(
+                name='extra_config',
+                location='body',
+                kind='json',
+                required=False,
+                description='optional per-type settings; for ClickHouse this carries the single-node vs cluster topology',
+                nullable=True,
+            ),
+            Param(
+                name='host',
+                location='body',
+                kind='string',
+                required=True,
+                description='host of the db',
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='logical name for the database instance',
+            ),
+            Param(
+                name='password',
+                location='body',
+                kind='string',
+                required=False,
+                description='password of the db instance created',
+                secret=True,
+            ),
+            Param(
+                name='port',
+                location='body',
+                kind='integer',
+                required=True,
+                description='port number of the db',
+            ),
+            Param(
+                name='type',
+                location='body',
+                kind='string',
+                required=True,
+                description='the db type',
+                choices=(
+                    'mysql',
+                    'postgres',
+                    'clickhouse',
+                    'mongodb',
+                    'mssql',
+                ),
+            ),
+            Param(
+                name='username',
+                location='body',
+                kind='string',
+                required=True,
+                description='username for db to login',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='db:DBConnectionTestResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay db test --name analytics --type clickhouse --host ch.example.com --port 8123 --db-name analytics --username databay --password-env CH_PASSWORD',
+    ),
+    verdict=Verdict(
+        field='/success',
+        ok=(
+            'true',
+        ),
+        not_ready=(
+            'false',
+        ),
+    ),
+)
+
+OPERATIONS = (
+    DB_CREATE,
+    DB_DELETE,
+    DB_GET,
+    DB_GET_BY_NAME,
+    DB_LIST,
+    DB_TEST,
+)