diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index 0c1f74a988..5d89dc59f3 100644 --- a/.github/workflows/build-docs.yaml +++ b/.github/workflows/build-docs.yaml @@ -78,7 +78,33 @@ jobs: if [ $PROVIDER == "root" ]; then echo "adding vanity url redirects to _redirects file.." touch ./build/_redirects - array=( aws azure azure-extras azure-isv azure-stack digitalocean firebase confluent github openai anthropic google googleadmin k8s linode netlify okta sumologic vercel godaddy pagerduty homebrew datadog ) + array=( + aws + azure + azure-extras + azure-isv + azure-stack + digitalocean + firebase + confluent + databricks-account + databricks-workspace + github + openai + anthropic + google + googleadmin + k8s + linode + netlify + okta + sumologic + vercel + godaddy + pagerduty + homebrew + datadog + ) for i in "${array[@]}" do echo "adding redirects for $i" diff --git a/README.md b/README.md index 0e289b1e0f..ea0b6eccf7 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,16 @@ This repository contains documentation for StackQL providers, which is published | Netlify Deploy OpenAI | [![Netlify Status](https://api.netlify.com/api/v1/badges/6df5743b-8c5d-4949-866e-eda4ca3f74d0/deploy-status)](https://app.netlify.com/sites/stackql-openai-docs/deploys) | [openai-docs.stackql.io](https://openai-docs.stackql.io)
[openai.stackql.io](https://openai.stackql.io) | | Netlify Deploy Anthropic | [![Netlify Status](https://api.netlify.com/api/v1/badges/114c5a2a-9b76-4941-a0e8-3669ee7d2016/deploy-status)](https://app.netlify.com/sites/stackql-anthropic-docs/deploys) | [anthropic-docs.stackql.io](https://anthropic-docs.stackql.io)
[anthropic.stackql.io](https://anthropic.stackql.io) | | Netlify Deploy Confluent | [![Netlify Status](https://api.netlify.com/api/v1/badges/63149c2f-6c3d-43f1-be38-80c55c223ac0/deploy-status)](https://app.netlify.com/sites/stackql-confluent-docs/deploys) | [confluent-docs.stackql.io](https://confluent-docs.stackql.io)
[confluent.stackql.io](https://confluent.stackql.io) | +| Netlify Deploy Databricks Account | [![Netlify Status](https://api.netlify.com/api/v1/badges/9250b360-9e36-49dd-8cc8-b8cbe2f8d983/deploy-status)](https://app.netlify.com/sites/stackql-databricks-account-docs/deploys) | [databricks-account-docs.stackql.io](https://databricks-account-docs.stackql.io)
[databricks-account.stackql.io](https://databricks-account.stackql.io) | +| Netlify Deploy Databricks Workspace | [![Netlify Status](https://api.netlify.com/api/v1/badges/7456d122-1d4a-445c-b410-7a9aa1bd3f05/deploy-status)](https://app.netlify.com/sites/stackql-databricks-workspace-docs/deploys) | [databricks-workspace-docs.stackql.io](https://databricks-workspace-docs.stackql.io)
[databricks-workspace.stackql.io](https://databricks-workspace.stackql.io) | ## Adding Docs for a New Provider Adding docs for a new provider requires creating a new web property (subdomain) and will force an update to the root/base site and all other providers. The steps are: -- [ ] update `scripts/docgen/provider_data.py` with metadata for new provider -- [ ] generate docs for provider using `cd scripts; sh docgen.sh {provider}` -- [ ] publish docs for provider using `cd scripts; sh publish.sh {provider}` +- [ ] update `scripts/docgen/provider_data.py` with metadata for new provider (not applicable if docs are built elsewhere) +- [ ] generate docs for provider using `cd scripts; sh docgen.sh {provider}` (not applicable if docs are built elsewhere) +- [ ] publish docs for provider using `cd scripts; sh publish.sh {provider}` (not applicable if docs are built elsewhere) - [x] add the new provider docs to `docs/{provider}-docs` (following directory structure of existing providers) (done automatically by `scripts/publish.sh`) - [x] update frontmatter in the `index.md` at the root of the new providers docs, set `slug` to `/providers/{provider}` and `id` to `{provider}-doc` (done automatically by `scripts/docgen.sh`) - [x] update `stackql-provider-registry.mdx` in the root of the new provider to add the `currentProvider` prop, e.g. `` (done automatically by `scripts/docgen.sh`) diff --git a/ci-scripts/get-providers-to-deploy.js b/ci-scripts/get-providers-to-deploy.js index b8e1d4d9fc..8fbe49f421 100644 --- a/ci-scripts/get-providers-to-deploy.js +++ b/ci-scripts/get-providers-to-deploy.js @@ -16,6 +16,8 @@ const allProviders = [ 'firebase', 'github', 'confluent', + 'databricks_account', + 'databricks_workspace', 'openai', 'anthropic', 'google', diff --git a/docs/databricks_account-docs/index.md b/docs/databricks_account-docs/index.md new file mode 100644 index 0000000000..24d19d8eb6 --- /dev/null +++ b/docs/databricks_account-docs/index.md @@ -0,0 +1,67 @@ +--- +title: databricks_account +hide_title: false +hide_table_of_contents: false +keywords: + - databricks + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +id: databricks_account-doc +slug: /providers/databricks_account +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +Services from Databricks. + +:::info Provider Summary + +
+
+total services: 7
+total resources: 31
+total methods: 111
+
+
+ +::: + +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation +```bash +REGISTRY PULL databricks_account; +``` + +## Authentication + +To use the databricks_account, set the following environment variables: + +- - a uuid representing your Databricks account id, you can get this from the Databricks UI (see Locate your account id) +- - obtained after creating a service principal through the Databricks UI (see Authenticate access to Databricks with a service principal using OAuth) +- - obtained after creating a service principal secret through the Databricks UI, using the "Generate Secret" function (see Authenticate access to Databricks with a service principal using OAuth) + +These are the same variables that Terraform, the Databricks SDKs, and CLI use. + +## Services +
+
+billing
+iam
+logging
+oauth
+
+
+provisioning
+settings
+unity_catalog
+
+
\ No newline at end of file diff --git a/docs/databricks_account-docs/providers/databricks_account/billing/billable_usage/index.md b/docs/databricks_account-docs/providers/databricks_account/billing/billable_usage/index.md new file mode 100644 index 0000000000..c115cdd5e1 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/billing/billable_usage/index.md @@ -0,0 +1,37 @@ +--- +title: billable_usage +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - billable_usage + - billing + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a billable_usage resource. + +## Overview + + + + +
Namebillable_usage
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `EXEC` | | Returns billable usage logs in CSV format for the specified account and date range. For the data schema, see | diff --git a/docs/databricks_account-docs/providers/databricks_account/billing/budgets/index.md b/docs/databricks_account-docs/providers/databricks_account/billing/budgets/index.md new file mode 100644 index 0000000000..ef071fce20 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/billing/budgets/index.md @@ -0,0 +1,177 @@ +--- +title: budgets +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - budgets + - billing + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a budgets resource. + +## Overview + + + + +
Namebudgets
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `array` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a budget configuration for an account. Both account and budget configuration are specified by ID. | +| | `SELECT` | | Gets all budgets associated with this account. | +| | `INSERT` | | Create a new budget configuration for an account. For full details, see | +| | `DELETE` | | Deletes a budget configuration for an account. Both account and budget configuration are specified by ID. This cannot be undone. | +| | `REPLACE` | | Updates a budget configuration for an account. Both account and budget configuration are specified by ID. | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +alert_configurations, +budget_configuration_id, +create_time, +display_name, +filter, +update_time +FROM databricks_account.billing.budgets +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +alert_configurations, +budget_configuration_id, +create_time, +display_name, +filter, +update_time +FROM databricks_account.billing.budgets +WHERE account_id = '{{ account_id }}' AND +budget_id = '{{ budget_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new budgets resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.billing.budgets ( +account_id, +data__budget +) +SELECT +'{{ account_id }}', +'{{ budget }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: budget + value: + account_id: 449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65 + alert_configurations: + - time_period: MONTH + trigger_type: CUMULATIVE_SPENDING_EXCEEDED + quantity_type: LIST_PRICE_DOLLARS_USD + quantity_threshold: string + action_configurations: + - action_type: EMAIL_NOTIFICATION + target: string + filter: + workspace_id: + operator: IN + values: + - 0 + tags: + - key: string + value: + operator: IN + values: + - string + display_name: string + +``` + + + + +## `REPLACE` example + +Replaces a budgets resource. + +```sql +/*+ update */ +REPLACE databricks_account.billing.budgets +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +budget_id = '{{ budget_id }}'; +``` + +## `DELETE` example + +Deletes a budgets resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.billing.budgets +WHERE account_id = '{{ account_id }}' AND +budget_id = '{{ budget_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/billing/index.md b/docs/databricks_account-docs/providers/databricks_account/billing/index.md new file mode 100644 index 0000000000..dd41ebc63e --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/billing/index.md @@ -0,0 +1,39 @@ +--- +title: billing +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - billing + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +__`billing`__ service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources +
+
+billable_usage
+budgets
+
+
+usage_dashboards
+
+
\ No newline at end of file diff --git a/docs/databricks_account-docs/providers/databricks_account/billing/usage_dashboards/index.md b/docs/databricks_account-docs/providers/databricks_account/billing/usage_dashboards/index.md new file mode 100644 index 0000000000..e27e83c0c9 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/billing/usage_dashboards/index.md @@ -0,0 +1,95 @@ +--- +title: usage_dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - usage_dashboards + - billing + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a usage_dashboards resource. + +## Overview + + + + +
Nameusage_dashboards
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a usage dashboard specified by workspaceId, accountId, and dashboard type. | +| | `INSERT` | | Create a usage dashboard specified by workspaceId, accountId, and dashboard type. | + +## `SELECT` examples + +```sql +SELECT +dashboard_id, +dashboard_url +FROM databricks_account.billing.usage_dashboards +WHERE account_id = '{{ account_id }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new usage_dashboards resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.billing.usage_dashboards ( +account_id, +data__workspace_id, +data__dashboard_type +) +SELECT +'{{ account_id }}', +'{{ workspace_id }}', +'{{ dashboard_type }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: workspace_id + value: 0 + - name: dashboard_type + value: USAGE_DASHBOARD_TYPE_WORKSPACE + +``` + + + diff --git a/docs/databricks_account-docs/providers/databricks_account/iam/assignable_roles/index.md b/docs/databricks_account-docs/providers/databricks_account/iam/assignable_roles/index.md new file mode 100644 index 0000000000..8dba569da6 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/iam/assignable_roles/index.md @@ -0,0 +1,50 @@ +--- +title: assignable_roles +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - assignable_roles + - iam + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a assignable_roles resource. + +## Overview + + + + +
Nameassignable_roles
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the resource can contain an access rule of the role. | + +## `SELECT` examples + +```sql +SELECT +name +FROM databricks_account.iam.assignable_roles +WHERE account_id = '{{ account_id }}' AND +resource = '{{ resource }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/iam/groups/index.md b/docs/databricks_account-docs/providers/databricks_account/iam/groups/index.md new file mode 100644 index 0000000000..f906e154e3 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/iam/groups/index.md @@ -0,0 +1,185 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - groups + - iam + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a groups resource. + +## Overview + + + + +
Namegroups
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the information for a specific group in the Databricks account. | +| | `SELECT` | | Gets all details of the groups associated with the Databricks account. | +| | `INSERT` | | Creates a group in the Databricks account with a unique name, using the supplied group details. | +| | `DELETE` | | Deletes a group from the Databricks account. | +| | `UPDATE` | | Partially updates the details of a group. | +| | `REPLACE` | | Updates the details of a group by replacing the entire group entity. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +displayName, +externalId, +members, +roles +FROM databricks_account.iam.groups +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +id, +displayName, +externalId, +members, +roles +FROM databricks_account.iam.groups +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new groups resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.iam.groups ( +account_id, +data__displayName, +data__members, +data__roles, +data__externalId +) +SELECT +'{{ account_id }}', +'{{ displayName }}', +'{{ members }}', +'{{ roles }}', +'{{ externalId }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: displayName + value: string + - name: members + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: roles + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: externalId + value: string + +``` + + + + +## `UPDATE` example + +Updates a groups resource. + +```sql +/*+ update */ +UPDATE databricks_account.iam.groups +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + +## `REPLACE` example + +Replaces a groups resource. + +```sql +/*+ update */ +REPLACE databricks_account.iam.groups +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + +## `DELETE` example + +Deletes a groups resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.iam.groups +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/iam/index.md b/docs/databricks_account-docs/providers/databricks_account/iam/index.md new file mode 100644 index 0000000000..ac3d979f81 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/iam/index.md @@ -0,0 +1,43 @@ +--- +title: iam +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - iam + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +__`iam`__ service documentation. + +:::info Service Summary + +
+
+total resources: 7
+
+
+ +::: + +## Resources +
+
+assignable_roles
+groups
+rule_sets
+service_principals
+
+
+users
+workspace_permission_assignments
+workspace_permissions
+
+
\ No newline at end of file diff --git a/docs/databricks_account-docs/providers/databricks_account/iam/rule_sets/index.md b/docs/databricks_account-docs/providers/databricks_account/iam/rule_sets/index.md new file mode 100644 index 0000000000..7214e78467 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/iam/rule_sets/index.md @@ -0,0 +1,80 @@ +--- +title: rule_sets +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - rule_sets + - iam + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a rule_sets resource. + +## Overview + + + + +
Namerule_sets
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported. | +| | `SELECT` | | Replace the rules of a rule set. First, use get to read the current version of the rule set before modifying it. This pattern helps prevent conflicts between concurrent updates. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +etag, +grant_rules +FROM databricks_account.iam.rule_sets +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +name, +etag, +grant_rules +FROM databricks_account.iam.rule_sets +WHERE account_id = '{{ account_id }}' AND +etag = '{{ etag }}' AND +name = '{{ name }}'; +``` + + + diff --git a/docs/databricks_account-docs/providers/databricks_account/iam/service_principals/index.md b/docs/databricks_account-docs/providers/databricks_account/iam/service_principals/index.md new file mode 100644 index 0000000000..b5f80a06c5 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/iam/service_principals/index.md @@ -0,0 +1,187 @@ +--- +title: service_principals +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - service_principals + - iam + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a service_principals resource. + +## Overview + + + + +
Nameservice_principals
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the details for a single service principal define in the Databricks account. | +| | `SELECT` | | Gets the set of service principals associated with a Databricks account. | +| | `INSERT` | | Creates a new service principal in the Databricks account. | +| | `DELETE` | | Delete a single service principal in the Databricks account. | +| | `UPDATE` | | Partially updates the details of a single service principal in the Databricks account. | +| | `REPLACE` | | Updates the details of a single service principal. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +active, +applicationId, +displayName, +externalId, +roles +FROM databricks_account.iam.service_principals +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +id, +active, +applicationId, +displayName, +externalId, +roles +FROM databricks_account.iam.service_principals +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_principals resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.iam.service_principals ( +account_id, +data__applicationId, +data__displayName, +data__roles, +data__externalId, +data__active +) +SELECT +'{{ account_id }}', +'{{ applicationId }}', +'{{ displayName }}', +'{{ roles }}', +'{{ externalId }}', +'{{ active }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: applicationId + value: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + - name: displayName + value: etl-service + - name: roles + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: externalId + value: string + - name: active + value: true + +``` + + + + +## `UPDATE` example + +Updates a service_principals resource. + +```sql +/*+ update */ +UPDATE databricks_account.iam.service_principals +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + +## `REPLACE` example + +Replaces a service_principals resource. + +```sql +/*+ update */ +REPLACE databricks_account.iam.service_principals +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + +## `DELETE` example + +Deletes a service_principals resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.iam.service_principals +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/iam/users/index.md b/docs/databricks_account-docs/providers/databricks_account/iam/users/index.md new file mode 100644 index 0000000000..daa1424eda --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/iam/users/index.md @@ -0,0 +1,208 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - users + - iam + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a users resource. + +## Overview + + + + +
Nameusers
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `boolean` | +| | `string` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets information for a specific user in Databricks account. | +| | `SELECT` | | Gets details for all the users associated with a Databricks account. | +| | `INSERT` | | Creates a new user in the Databricks account. This new user will also be added to the Databricks account. | +| | `DELETE` | | Deletes a user. Deleting a user from a Databricks account also removes objects associated with the user. | +| | `UPDATE` | | Partially updates a user resource by applying the supplied operations on specific user attributes. | +| | `REPLACE` | | Replaces a user's information with the data supplied in request. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +active, +displayName, +emails, +externalId, +roles, +userName +FROM databricks_account.iam.users +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +id, +name, +active, +displayName, +emails, +externalId, +roles, +userName +FROM databricks_account.iam.users +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new users resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.iam.users ( +account_id, +data__userName, +data__emails, +data__name, +data__displayName, +data__roles, +data__externalId, +data__active +) +SELECT +'{{ account_id }}', +'{{ userName }}', +'{{ emails }}', +'{{ name }}', +'{{ displayName }}', +'{{ roles }}', +'{{ externalId }}', +'{{ active }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: userName + value: user@example.com + - name: emails + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: name + value: + givenName: string + familyName: string + - name: displayName + value: string + - name: roles + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: externalId + value: string + - name: active + value: true + +``` + + + + +## `UPDATE` example + +Updates a users resource. + +```sql +/*+ update */ +UPDATE databricks_account.iam.users +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + +## `REPLACE` example + +Replaces a users resource. + +```sql +/*+ update */ +REPLACE databricks_account.iam.users +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` + +## `DELETE` example + +Deletes a users resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.iam.users +WHERE account_id = '{{ account_id }}' AND +id = '{{ id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/iam/workspace_permission_assignments/index.md b/docs/databricks_account-docs/providers/databricks_account/iam/workspace_permission_assignments/index.md new file mode 100644 index 0000000000..19f013fa65 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/iam/workspace_permission_assignments/index.md @@ -0,0 +1,112 @@ +--- +title: workspace_permission_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - workspace_permission_assignments + - iam + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a workspace_permission_assignments resource. + +## Overview + + + + +
Nameworkspace_permission_assignments
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `array` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get the permission assignments for the specified Databricks account and Databricks workspace. | +| | `INSERT` | | Creates or updates the workspace permissions assignment in a given account and workspace for the specified principal. | +| | `DELETE` | | Deletes the workspace permissions assignment in a given account and workspace for the specified principal. | + +## `SELECT` examples + +```sql +SELECT +error, +permissions, +principal +FROM databricks_account.iam.workspace_permission_assignments +WHERE account_id = '{{ account_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workspace_permission_assignments resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.iam.workspace_permission_assignments ( +account_id, +principal_id, +workspace_id, +data__permissions +) +SELECT +'{{ account_id }}', +'{{ principal_id }}', +'{{ workspace_id }}', +'{{ permissions }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: permissions + value: + - UNKNOWN + +``` + + + + +## `DELETE` example + +Deletes a workspace_permission_assignments resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.iam.workspace_permission_assignments +WHERE account_id = '{{ account_id }}' AND +principal_id = '{{ principal_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/iam/workspace_permissions/index.md b/docs/databricks_account-docs/providers/databricks_account/iam/workspace_permissions/index.md new file mode 100644 index 0000000000..f6307743f7 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/iam/workspace_permissions/index.md @@ -0,0 +1,52 @@ +--- +title: workspace_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - workspace_permissions + - iam + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a workspace_permissions resource. + +## Overview + + + + +
Nameworkspace_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get an array of workspace permissions for the specified account and workspace. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_account.iam.workspace_permissions +WHERE account_id = '{{ account_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/logging/index.md b/docs/databricks_account-docs/providers/databricks_account/logging/index.md new file mode 100644 index 0000000000..adcacd07bd --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/logging/index.md @@ -0,0 +1,37 @@ +--- +title: logging +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - logging + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +__`logging`__ service documentation. + +:::info Service Summary + +
+
+total resources: 1
+
+
+ +::: + +## Resources +
+
+log_delivery
+
+
+
+
\ No newline at end of file diff --git a/docs/databricks_account-docs/providers/databricks_account/logging/log_delivery/index.md b/docs/databricks_account-docs/providers/databricks_account/logging/log_delivery/index.md new file mode 100644 index 0000000000..07eef60b1a --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/logging/log_delivery/index.md @@ -0,0 +1,163 @@ +--- +title: log_delivery +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - log_delivery + - logging + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a log_delivery resource. + +## Overview + + + + +
Namelog_delivery
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a Databricks log delivery configuration object for an account, both specified by ID. | +| | `SELECT` | | Gets all Databricks log delivery configurations associated with an account specified by ID. | +| | `INSERT` | | Creates a new Databricks log delivery configuration to enable delivery of the specified type of logs to your storage location. This requires that you already created a | +| | `EXEC` | | Enables or disables a log delivery configuration. Deletion of delivery configurations is not supported, so disable log delivery configurations that are no longer needed. Note that you can't re-enable a delivery configuration if this would violate the delivery configuration limits described under | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +config_id, +config_name, +creation_time, +credentials_id, +delivery_path_prefix, +delivery_start_time, +log_delivery_status, +log_type, +output_format, +status, +storage_configuration_id, +update_time, +workspace_ids_filter +FROM databricks_account.logging.log_delivery +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +config_id, +config_name, +creation_time, +credentials_id, +delivery_path_prefix, +delivery_start_time, +log_delivery_status, +log_type, +output_format, +status, +storage_configuration_id, +update_time, +workspace_ids_filter +FROM databricks_account.logging.log_delivery +WHERE account_id = '{{ account_id }}' AND +log_delivery_configuration_id = '{{ log_delivery_configuration_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new log_delivery resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.logging.log_delivery ( +account_id, +data__log_delivery_configuration +) +SELECT +'{{ account_id }}', +'{{ log_delivery_configuration }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: log_delivery_configuration + value: + config_name: string + status: ENABLED + log_type: BILLABLE_USAGE + output_format: CSV + credentials_id: c7814269-df58-4ca3-85e9-f6672ef43d77 + storage_configuration_id: 04aae505-1b1e-4cb9-997d-e1c49282675d + workspace_ids_filter: + - 0 + delivery_path_prefix: string + delivery_start_time: string + +``` + + + diff --git a/docs/databricks_account-docs/providers/databricks_account/oauth/custom_app_integrations/index.md b/docs/databricks_account-docs/providers/databricks_account/oauth/custom_app_integrations/index.md new file mode 100644 index 0000000000..27c4c0798d --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/oauth/custom_app_integrations/index.md @@ -0,0 +1,179 @@ +--- +title: custom_app_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - custom_app_integrations + - oauth + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a custom_app_integrations resource. + +## Overview + + + + +
Namecustom_app_integrations
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `array` | +| | `array` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the Custom OAuth App Integration for the given integration id. | +| | `SELECT` | | Get the list of custom OAuth app integrations for the specified Databricks account | +| | `INSERT` | | Create Custom OAuth App Integration. | +| | `DELETE` | | Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via | +| | `UPDATE` | | Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration via | + +## `SELECT` examples + + + + +```sql +SELECT +name, +client_id, +confidential, +create_time, +created_by, +creator_username, +integration_id, +redirect_urls, +scopes, +token_access_policy +FROM databricks_account.oauth.custom_app_integrations +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +name, +client_id, +confidential, +create_time, +created_by, +creator_username, +integration_id, +redirect_urls, +scopes, +token_access_policy +FROM databricks_account.oauth.custom_app_integrations +WHERE account_id = '{{ account_id }}' AND +integration_id = '{{ integration_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new custom_app_integrations resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.oauth.custom_app_integrations ( +account_id, +data__summary, +data__value +) +SELECT +'{{ account_id }}', +'{{ summary }}', +'{{ value }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: summary + value: Create Tableau Cloud OAuth App Integration + - name: value + value: + name: Example Tableau Server + scopes: + - all-apis + - offline_access + token_access_policy: + access_token_ttl_in_minutes: 120 + refresh_token_ttl_in_minutes: 200 + redirect_urls: + - https://example.online.tableau.com/auth/add_oauth_token + confidential: true + +``` + + + + +## `UPDATE` example + +Updates a custom_app_integrations resource. + +```sql +/*+ update */ +UPDATE databricks_account.oauth.custom_app_integrations +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +integration_id = '{{ integration_id }}'; +``` + +## `DELETE` example + +Deletes a custom_app_integrations resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.oauth.custom_app_integrations +WHERE account_id = '{{ account_id }}' AND +integration_id = '{{ integration_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/oauth/index.md b/docs/databricks_account-docs/providers/databricks_account/oauth/index.md new file mode 100644 index 0000000000..5a67a1f623 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/oauth/index.md @@ -0,0 +1,40 @@ +--- +title: oauth +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - oauth + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +__`oauth`__ service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+
+custom_app_integrations
+published_app_integrations
+
+
+published_apps
+service_principal_secrets
+
+
\ No newline at end of file diff --git a/docs/databricks_account-docs/providers/databricks_account/oauth/published_app_integrations/index.md b/docs/databricks_account-docs/providers/databricks_account/oauth/published_app_integrations/index.md new file mode 100644 index 0000000000..a2bb0b7c04 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/oauth/published_app_integrations/index.md @@ -0,0 +1,163 @@ +--- +title: published_app_integrations +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - published_app_integrations + - oauth + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a published_app_integrations resource. + +## Overview + + + + +
Namepublished_app_integrations
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the Published OAuth App Integration for the given integration id. | +| | `SELECT` | | Get the list of published OAuth app integrations for the specified Databricks account | +| | `INSERT` | | Create Published OAuth App Integration. | +| | `DELETE` | | Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app integration via | +| | `UPDATE` | | Updates an existing published OAuth App Integration. You can retrieve the published OAuth app integration via | + +## `SELECT` examples + + + + +```sql +SELECT +name, +app_id, +create_time, +created_by, +integration_id, +token_access_policy +FROM databricks_account.oauth.published_app_integrations +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +name, +app_id, +create_time, +created_by, +integration_id, +token_access_policy +FROM databricks_account.oauth.published_app_integrations +WHERE account_id = '{{ account_id }}' AND +integration_id = '{{ integration_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new published_app_integrations resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.oauth.published_app_integrations ( +account_id, +data__PowerBI, +data__TableauDesktop +) +SELECT +'{{ account_id }}', +'{{ PowerBI }}', +'{{ TableauDesktop }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: PowerBI + value: + summary: Enable PowerBI OAuth Login + value: + app_id: power-bi + - name: TableauDesktop + value: + summary: Enable Tableau Desktop OAuth Login + value: + app_id: tableau-desktop + +``` + + + + +## `UPDATE` example + +Updates a published_app_integrations resource. + +```sql +/*+ update */ +UPDATE databricks_account.oauth.published_app_integrations +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +integration_id = '{{ integration_id }}'; +``` + +## `DELETE` example + +Deletes a published_app_integrations resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.oauth.published_app_integrations +WHERE account_id = '{{ account_id }}' AND +integration_id = '{{ integration_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/oauth/published_apps/index.md b/docs/databricks_account-docs/providers/databricks_account/oauth/published_apps/index.md new file mode 100644 index 0000000000..328e6c28e3 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/oauth/published_apps/index.md @@ -0,0 +1,61 @@ +--- +title: published_apps +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - published_apps + - oauth + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a published_apps resource. + +## Overview + + + + +
Namepublished_apps
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `array` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get all the available published OAuth apps in Databricks. | + +## `SELECT` examples + +```sql +SELECT +name, +description, +app_id, +client_id, +is_confidential_client, +redirect_urls, +scopes +FROM databricks_account.oauth.published_apps +WHERE account_id = '{{ account_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/oauth/service_principal_secrets/index.md b/docs/databricks_account-docs/providers/databricks_account/oauth/service_principal_secrets/index.md new file mode 100644 index 0000000000..73f27b4418 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/oauth/service_principal_secrets/index.md @@ -0,0 +1,108 @@ +--- +title: service_principal_secrets +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - service_principal_secrets + - oauth + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a service_principal_secrets resource. + +## Overview + + + + +
Nameservice_principal_secrets
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all secrets associated with the given service principal. This operation only returns information about the secrets themselves and does not include the secret values. | +| | `INSERT` | | Create a secret for the given service principal. | +| | `DELETE` | | Delete a secret from the given service principal. | + +## `SELECT` examples + +```sql +SELECT +id, +create_time, +secret_hash, +status, +update_time +FROM databricks_account.oauth.service_principal_secrets +WHERE account_id = '{{ account_id }}' AND +service_principal_id = '{{ service_principal_id }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_principal_secrets resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.oauth.service_principal_secrets ( +account_id, +service_principal_id +) +SELECT +'{{ account_id }}', +'{{ service_principal_id }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: [] # No request body parameters required +``` + + + + +## `DELETE` example + +Deletes a service_principal_secrets resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.oauth.service_principal_secrets +WHERE account_id = '{{ account_id }}' AND +secret_id = '{{ secret_id }}' AND +service_principal_id = '{{ service_principal_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/provisioning/credentials/index.md b/docs/databricks_account-docs/providers/databricks_account/provisioning/credentials/index.md new file mode 100644 index 0000000000..f1f6691586 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/provisioning/credentials/index.md @@ -0,0 +1,143 @@ +--- +title: credentials +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - credentials + - provisioning + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a credentials resource. + +## Overview + + + + +
Namecredentials
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a Databricks credential configuration object for an account, both specified by ID. | +| | `SELECT` | | Gets all Databricks credential configurations associated with an account specified by ID. | +| | `INSERT` | | Creates a Databricks credential configuration that represents cloud cross-account credentials for a specified account. Databricks uses this to set up network infrastructure properly to host Databricks clusters. For your AWS IAM role, you need to trust the External ID (the Databricks Account API account ID) in the returned credential object, and configure the required access policy. | +| | `DELETE` | | Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot delete a credential that is associated with any workspace. | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +aws_credentials, +creation_time, +credentials_id, +credentials_name +FROM databricks_account.provisioning.credentials +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +aws_credentials, +creation_time, +credentials_id, +credentials_name +FROM databricks_account.provisioning.credentials +WHERE account_id = '{{ account_id }}' AND +credentials_id = '{{ credentials_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new credentials resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.provisioning.credentials ( +account_id, +data__credentials_name, +data__aws_credentials +) +SELECT +'{{ account_id }}', +'{{ credentials_name }}', +'{{ aws_credentials }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: credentials_name + value: credential_1 + - name: aws_credentials + value: + sts_role: + role_arn: arn-aws-iam::111110000000:role/test_role + +``` + + + + +## `DELETE` example + +Deletes a credentials resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.provisioning.credentials +WHERE account_id = '{{ account_id }}' AND +credentials_id = '{{ credentials_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/provisioning/encryption_keys/index.md b/docs/databricks_account-docs/providers/databricks_account/provisioning/encryption_keys/index.md new file mode 100644 index 0000000000..11bb2eaf21 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/provisioning/encryption_keys/index.md @@ -0,0 +1,146 @@ +--- +title: encryption_keys +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - encryption_keys + - provisioning + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a encryption_keys resource. + +## Overview + + + + +
Nameencryption_keys
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `integer` | +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a customer-managed key configuration object for an account, specified by ID. This operation uploads a reference to a customer-managed key to Databricks. If assigned as a workspace's customer-managed key for managed services, Databricks uses the key to encrypt the workspaces notebooks and secrets in the control plane, in addition to Databricks SQL queries and query history. If it is specified as a workspace's customer-managed key for storage, the key encrypts the workspace's root S3 bucket (which contains the workspace's root DBFS and system data) and, optionally, cluster EBS volume data. | +| | `SELECT` | | Gets all customer-managed key configuration objects for an account. If the key is specified as a workspace's managed services customer-managed key, Databricks uses the key to encrypt the workspace's notebooks and secrets in the control plane, in addition to Databricks SQL queries and query history. If the key is specified as a workspace's storage customer-managed key, the key is used to encrypt the workspace's root S3 bucket and optionally can encrypt cluster EBS volumes data in the data plane. | +| | `INSERT` | | Creates a customer-managed key configuration object for an account, specified by ID. This operation uploads a reference to a customer-managed key to Databricks. If the key is assigned as a workspace's customer-managed key for managed services, Databricks uses the key to encrypt the workspaces notebooks and secrets in the control plane, in addition to Databricks SQL queries and query history. If it is specified as a workspace's customer-managed key for workspace storage, the key encrypts the workspace's root S3 bucket (which contains the workspace's root DBFS and system data) and, optionally, cluster EBS volume data. | +| | `DELETE` | | Deletes a customer-managed key configuration object for an account. You cannot delete a configuration that is associated with a running workspace. | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +aws_key_info, +creation_time, +customer_managed_key_id, +use_cases +FROM databricks_account.provisioning.encryption_keys +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +aws_key_info, +creation_time, +customer_managed_key_id, +use_cases +FROM databricks_account.provisioning.encryption_keys +WHERE account_id = '{{ account_id }}' AND +customer_managed_key_id = '{{ customer_managed_key_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new encryption_keys resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.provisioning.encryption_keys ( +account_id, +data__aws_key_info, +data__use_cases +) +SELECT +'{{ account_id }}', +'{{ aws_key_info }}', +'{{ use_cases }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: aws_key_info + value: + key_arn: arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321 + key_alias: alias/projectKey + reuse_key_for_cluster_volumes: true + - name: use_cases + value: + - MANAGED_SERVICES + - STORAGE + +``` + + + + +## `DELETE` example + +Deletes a encryption_keys resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.provisioning.encryption_keys +WHERE account_id = '{{ account_id }}' AND +customer_managed_key_id = '{{ customer_managed_key_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/provisioning/index.md b/docs/databricks_account-docs/providers/databricks_account/provisioning/index.md new file mode 100644 index 0000000000..75d7a73f11 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/provisioning/index.md @@ -0,0 +1,44 @@ +--- +title: provisioning +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provisioning + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +__`provisioning`__ service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources +
+
+credentials
+encryption_keys
+networks
+private_access
+
+
+storage
+vpc_endpoints
+vw_workspaces
+workspaces
+
+
\ No newline at end of file diff --git a/docs/databricks_account-docs/providers/databricks_account/provisioning/networks/index.md b/docs/databricks_account-docs/providers/databricks_account/provisioning/networks/index.md new file mode 100644 index 0000000000..e47c2a3003 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/provisioning/networks/index.md @@ -0,0 +1,180 @@ +--- +title: networks +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - networks + - provisioning + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a networks resource. + +## Overview + + + + +
Namenetworks
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `array` | +| | `string` | +| | `string` | +| | `array` | +| | `array` | +| | `object` | +| | `string` | +| | `string` | +| | `array` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a Databricks network configuration, which represents an AWS VPC and its resources. This requires a pre-existing VPC and subnets. | +| | `SELECT` | | Gets a list of all Databricks network configurations for an account, specified by ID. | +| | `INSERT` | | Creates a Databricks network configuration that represents an AWS VPC and its resources. The VPC will be used for new Databricks clusters. This requires a pre-existing VPC and subnets. For VPC requirements, see | +| | `DELETE` | | Deletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace. | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +creation_time, +error_messages, +network_id, +network_name, +security_group_ids, +subnet_ids, +vpc_endpoints, +vpc_id, +vpc_status, +warning_messages, +workspace_id +FROM databricks_account.provisioning.networks +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +creation_time, +error_messages, +network_id, +network_name, +security_group_ids, +subnet_ids, +vpc_endpoints, +vpc_id, +vpc_status, +warning_messages, +workspace_id +FROM databricks_account.provisioning.networks +WHERE account_id = '{{ account_id }}' AND +network_id = '{{ network_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new networks resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.provisioning.networks ( +account_id, +data__network_name, +data__vpc_id, +data__subnet_ids, +data__security_group_ids, +data__vpc_endpoints +) +SELECT +'{{ account_id }}', +'{{ network_name }}', +'{{ vpc_id }}', +'{{ subnet_ids }}', +'{{ security_group_ids }}', +'{{ vpc_endpoints }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: network_name + value: string + - name: vpc_id + value: string + - name: subnet_ids + value: + - string + - name: security_group_ids + value: + - string + - name: vpc_endpoints + value: + rest_api: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + dataplane_relay: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + +``` + + + + +## `DELETE` example + +Deletes a networks resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.provisioning.networks +WHERE account_id = '{{ account_id }}' AND +network_id = '{{ network_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/provisioning/private_access/index.md b/docs/databricks_account-docs/providers/databricks_account/provisioning/private_access/index.md new file mode 100644 index 0000000000..587b71542f --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/provisioning/private_access/index.md @@ -0,0 +1,173 @@ +--- +title: private_access +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - private_access + - provisioning + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a private_access resource. + +## Overview + + + + +
Nameprivate_access
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a private access settings object, which specifies how your workspace is accessed over | +| | `SELECT` | | Gets a list of all private access settings objects for an account, specified by ID. | +| | `INSERT` | | Creates a private access settings object, which specifies how your workspace is accessed over | +| | `DELETE` | | Deletes a private access settings object, which determines how your workspace is accessed over | +| | `REPLACE` | | Updates an existing private access settings object, which specifies how your workspace is accessed over | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +allowed_vpc_endpoint_ids, +private_access_level, +private_access_settings_id, +private_access_settings_name, +public_access_enabled, +region +FROM databricks_account.provisioning.private_access +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +allowed_vpc_endpoint_ids, +private_access_level, +private_access_settings_id, +private_access_settings_name, +public_access_enabled, +region +FROM databricks_account.provisioning.private_access +WHERE account_id = '{{ account_id }}' AND +private_access_settings_id = '{{ private_access_settings_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new private_access resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.provisioning.private_access ( +account_id, +data__private_access_settings_name, +data__region, +data__public_access_enabled, +data__private_access_level, +data__allowed_vpc_endpoint_ids +) +SELECT +'{{ account_id }}', +'{{ private_access_settings_name }}', +'{{ region }}', +'{{ public_access_enabled }}', +'{{ private_access_level }}', +'{{ allowed_vpc_endpoint_ids }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: private_access_settings_name + value: string + - name: region + value: string + - name: public_access_enabled + value: false + - name: private_access_level + value: ENDPOINT + - name: allowed_vpc_endpoint_ids + value: + - 497f6eca-6276-4993-bfeb-53cbbbba6f08 + +``` + + + + +## `REPLACE` example + +Replaces a private_access resource. + +```sql +/*+ update */ +REPLACE databricks_account.provisioning.private_access +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +private_access_settings_id = '{{ private_access_settings_id }}'; +``` + +## `DELETE` example + +Deletes a private_access resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.provisioning.private_access +WHERE account_id = '{{ account_id }}' AND +private_access_settings_id = '{{ private_access_settings_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/provisioning/storage/index.md b/docs/databricks_account-docs/providers/databricks_account/provisioning/storage/index.md new file mode 100644 index 0000000000..382fa7d573 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/provisioning/storage/index.md @@ -0,0 +1,142 @@ +--- +title: storage +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - storage + - provisioning + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a storage resource. + +## Overview + + + + +
Namestorage
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a Databricks storage configuration for an account, both specified by ID. | +| | `SELECT` | | Gets a list of all Databricks storage configurations for your account, specified by ID. | +| | `INSERT` | | Creates new storage configuration for an account, specified by ID. Uploads a storage configuration object that represents the root AWS S3 bucket in your account. Databricks stores related workspace assets including DBFS, cluster logs, and job results. For the AWS S3 bucket, you need to configure the required bucket policy. | +| | `DELETE` | | Deletes a Databricks storage configuration. You cannot delete a storage configuration that is associated with any workspace. | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +creation_time, +root_bucket_info, +storage_configuration_id, +storage_configuration_name +FROM databricks_account.provisioning.storage +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +creation_time, +root_bucket_info, +storage_configuration_id, +storage_configuration_name +FROM databricks_account.provisioning.storage +WHERE account_id = '{{ account_id }}' AND +storage_configuration_id = '{{ storage_configuration_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new storage resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.provisioning.storage ( +account_id, +data__storage_configuration_name, +data__root_bucket_info +) +SELECT +'{{ account_id }}', +'{{ storage_configuration_name }}', +'{{ root_bucket_info }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: storage_configuration_name + value: storage_conf_1 + - name: root_bucket_info + value: + bucket_name: string + +``` + + + + +## `DELETE` example + +Deletes a storage resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.provisioning.storage +WHERE account_id = '{{ account_id }}' AND +storage_configuration_id = '{{ storage_configuration_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/provisioning/vpc_endpoints/index.md b/docs/databricks_account-docs/providers/databricks_account/provisioning/vpc_endpoints/index.md new file mode 100644 index 0000000000..9e679004fd --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/provisioning/vpc_endpoints/index.md @@ -0,0 +1,157 @@ +--- +title: vpc_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - vpc_endpoints + - provisioning + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a vpc_endpoints resource. + +## Overview + + + + +
Namevpc_endpoints
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a VPC endpoint configuration, which represents a | +| | `SELECT` | | Gets a list of all VPC endpoints for an account, specified by ID. | +| | `INSERT` | | Creates a VPC endpoint configuration, which represents a | +| | `DELETE` | | Deletes a VPC endpoint configuration, which represents an | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +aws_account_id, +aws_endpoint_service_id, +aws_vpc_endpoint_id, +region, +state, +use_case, +vpc_endpoint_id, +vpc_endpoint_name +FROM databricks_account.provisioning.vpc_endpoints +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +aws_account_id, +aws_endpoint_service_id, +aws_vpc_endpoint_id, +region, +state, +use_case, +vpc_endpoint_id, +vpc_endpoint_name +FROM databricks_account.provisioning.vpc_endpoints +WHERE account_id = '{{ account_id }}' AND +vpc_endpoint_id = '{{ vpc_endpoint_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new vpc_endpoints resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.provisioning.vpc_endpoints ( +account_id, +data__vpc_endpoint_name, +data__aws_vpc_endpoint_id, +data__region +) +SELECT +'{{ account_id }}', +'{{ vpc_endpoint_name }}', +'{{ aws_vpc_endpoint_id }}', +'{{ region }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: vpc_endpoint_name + value: string + - name: aws_vpc_endpoint_id + value: string + - name: region + value: string + +``` + + + + +## `DELETE` example + +Deletes a vpc_endpoints resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.provisioning.vpc_endpoints +WHERE account_id = '{{ account_id }}' AND +vpc_endpoint_id = '{{ vpc_endpoint_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/provisioning/workspaces/index.md b/docs/databricks_account-docs/providers/databricks_account/provisioning/workspaces/index.md new file mode 100644 index 0000000000..9c85466207 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/provisioning/workspaces/index.md @@ -0,0 +1,287 @@ +--- +title: workspaces +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - workspaces + - provisioning + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a workspaces resource. + +## Overview + + + + +
Nameworkspaces
TypeResource
Id
+ +## Fields + + + +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | + + + +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | + + + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets information including status for a Databricks workspace, specified by ID. In the response, the | +| | `SELECT` | | Gets a list of all workspaces associated with an account, specified by ID. | +| | `INSERT` | | Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using customer-managed keys for managed services), and an optional storage key configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different. | +| | `DELETE` | | Terminates and deletes a Databricks workspace. From an API perspective, deletion is immediate. However, it might take a few minutes for all workspaces resources to be deleted, depending on the size and number of workspace resources. | +| | `UPDATE` | | Updates a workspace configuration for either a running workspace or a failed workspace. The elements that can be updated varies between these two use cases. | + +## `SELECT` examples + + + + +```sql +SELECT +account_id, +aws_region, +creation_time, +credentials_id, +custom_tags, +deployment_name, +is_no_public_ip_enabled, +managed_services_customer_managed_key_id, +network_id, +pricing_tier, +private_access_settings_id, +storage_configuration_id, +storage_customer_managed_key_id, +workspace_id, +workspace_name, +workspace_status, +workspace_status_message +FROM databricks_account.provisioning.vw_workspaces; +``` + + + + +```sql +SELECT +account_id, +aws_region, +creation_time, +credentials_id, +custom_tags, +deployment_name, +is_no_public_ip_enabled, +managed_services_customer_managed_key_id, +network_id, +pricing_tier, +private_access_settings_id, +storage_configuration_id, +storage_customer_managed_key_id, +workspace_id, +workspace_name, +workspace_status, +workspace_status_message +FROM databricks_account.provisioning.workspaces +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +account_id, +aws_region, +creation_time, +credentials_id, +custom_tags, +deployment_name, +is_no_public_ip_enabled, +managed_services_customer_managed_key_id, +network_id, +pricing_tier, +private_access_settings_id, +storage_configuration_id, +storage_customer_managed_key_id, +workspace_id, +workspace_name, +workspace_status, +workspace_status_message +FROM databricks_account.provisioning.workspaces +WHERE account_id = '{{ account_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workspaces resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.provisioning.workspaces ( +account_id, +data__workspace_name, +data__network_id, +data__deployment_name, +data__aws_region, +data__credentials_id, +data__storage_configuration_id, +data__managed_services_customer_managed_key_id, +data__private_access_settings_id, +data__pricing_tier, +data__storage_customer_managed_key_id, +data__custom_tags +) +SELECT +'{{ account_id }}', +'{{ workspace_name }}', +'{{ network_id }}', +'{{ deployment_name }}', +'{{ aws_region }}', +'{{ credentials_id }}', +'{{ storage_configuration_id }}', +'{{ managed_services_customer_managed_key_id }}', +'{{ private_access_settings_id }}', +'{{ pricing_tier }}', +'{{ storage_customer_managed_key_id }}', +'{{ custom_tags }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: workspace_name + value: string + - name: network_id + value: fd0cc5bc-683c-47e9-b15e-144d7744a496 + - name: deployment_name + value: workspace_1 + - name: aws_region + value: us-west-2 + - name: credentials_id + value: ccc64f28-ebdc-4c89-add9-5dcb6d7727d8 + - name: storage_configuration_id + value: b43a6064-04c1-4e1c-88b6-d91e5b136b13 + - name: managed_services_customer_managed_key_id + value: 849b3d6b-e68e-468d-b3e5-deb08b03c56d + - name: private_access_settings_id + value: 3b3bbcb5-46bd-4b03-944e-97eb44ed7991 + - name: pricing_tier + value: PREMIUM + - name: storage_customer_managed_key_id + value: 14138d0f-a575-4ae2-be71-ddfd0b602286 + - name: custom_tags + value: + property1: string + property2: string + +``` + + + + +## `UPDATE` example + +Updates a workspaces resource. + +```sql +/*+ update */ +UPDATE databricks_account.provisioning.workspaces +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` + +## `DELETE` example + +Deletes a workspaces resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.provisioning.workspaces +WHERE account_id = '{{ account_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/settings/compliance_security_profile/index.md b/docs/databricks_account-docs/providers/databricks_account/settings/compliance_security_profile/index.md new file mode 100644 index 0000000000..d624891ff8 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/settings/compliance_security_profile/index.md @@ -0,0 +1,65 @@ +--- +title: compliance_security_profile +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - compliance_security_profile + - settings + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a compliance_security_profile resource. + +## Overview + + + + +
Namecompliance_security_profile
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the compliance security profile setting for new workspaces. | +| | `UPDATE` | | Updates the value of the compliance security profile setting for new workspaces. | + +## `SELECT` examples + +```sql +SELECT +csp_enablement_account, +etag, +setting_name +FROM databricks_account.settings.compliance_security_profile +WHERE account_id = '{{ account_id }}'; +``` + +## `UPDATE` example + +Updates a compliance_security_profile resource. + +```sql +/*+ update */ +UPDATE databricks_account.settings.compliance_security_profile +SET { field = value } +WHERE account_id = '{{ account_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/settings/enhanced_security_monitoring/index.md b/docs/databricks_account-docs/providers/databricks_account/settings/enhanced_security_monitoring/index.md new file mode 100644 index 0000000000..783cdc306b --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/settings/enhanced_security_monitoring/index.md @@ -0,0 +1,65 @@ +--- +title: enhanced_security_monitoring +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - enhanced_security_monitoring + - settings + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a enhanced_security_monitoring resource. + +## Overview + + + + +
Nameenhanced_security_monitoring
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the enhanced security monitoring setting for new workspaces. | +| | `UPDATE` | | Updates the value of the enhanced security monitoring setting for new workspaces. | + +## `SELECT` examples + +```sql +SELECT +esm_enablement_account, +etag, +setting_name +FROM databricks_account.settings.enhanced_security_monitoring +WHERE account_id = '{{ account_id }}'; +``` + +## `UPDATE` example + +Updates a enhanced_security_monitoring resource. + +```sql +/*+ update */ +UPDATE databricks_account.settings.enhanced_security_monitoring +SET { field = value } +WHERE account_id = '{{ account_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/settings/index.md b/docs/databricks_account-docs/providers/databricks_account/settings/index.md new file mode 100644 index 0000000000..2b912e3d8d --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/settings/index.md @@ -0,0 +1,40 @@ +--- +title: settings +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - settings + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +__`settings`__ service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+
+compliance_security_profile
+enhanced_security_monitoring
+
+
+ip_access_lists
+network_connectivity
+
+
\ No newline at end of file diff --git a/docs/databricks_account-docs/providers/databricks_account/settings/ip_access_lists/index.md b/docs/databricks_account-docs/providers/databricks_account/settings/ip_access_lists/index.md new file mode 100644 index 0000000000..ef6e9f07ce --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/settings/ip_access_lists/index.md @@ -0,0 +1,187 @@ +--- +title: ip_access_lists +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - ip_access_lists + - settings + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a ip_access_lists resource. + +## Overview + + + + +
Nameip_access_lists
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `integer` | +| | `integer` | +| | `boolean` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an IP access list, specified by its list ID. | +| | `SELECT` | | Gets all IP access lists for the specified account. | +| | `INSERT` | | Creates an IP access list for the account. | +| | `DELETE` | | Deletes an IP access list, specified by its list ID. | +| | `UPDATE` | | Updates an existing IP access list, specified by its ID. | +| | `REPLACE` | | Replaces an IP access list, specified by its ID. | + +## `SELECT` examples + + + + +```sql +SELECT +address_count, +created_at, +created_by, +enabled, +ip_addresses, +label, +list_id, +list_type, +updated_at, +updated_by +FROM databricks_account.settings.ip_access_lists +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +address_count, +created_at, +created_by, +enabled, +ip_addresses, +label, +list_id, +list_type, +updated_at, +updated_by +FROM databricks_account.settings.ip_access_lists +WHERE account_id = '{{ account_id }}' AND +ip_access_list_id = '{{ ip_access_list_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ip_access_lists resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.settings.ip_access_lists ( +account_id, +data__label, +data__list_type, +data__ip_addresses +) +SELECT +'{{ account_id }}', +'{{ label }}', +'{{ list_type }}', +'{{ ip_addresses }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: label + value: Office VPN + - name: list_type + value: ALLOW + - name: ip_addresses + value: + - 192.168.100.0/22 + +``` + + + + +## `UPDATE` example + +Updates a ip_access_lists resource. + +```sql +/*+ update */ +UPDATE databricks_account.settings.ip_access_lists +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +ip_access_list_id = '{{ ip_access_list_id }}'; +``` + +## `REPLACE` example + +Replaces a ip_access_lists resource. + +```sql +/*+ update */ +REPLACE databricks_account.settings.ip_access_lists +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +ip_access_list_id = '{{ ip_access_list_id }}'; +``` + +## `DELETE` example + +Deletes a ip_access_lists resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.settings.ip_access_lists +WHERE account_id = '{{ account_id }}' AND +ip_access_list_id = '{{ ip_access_list_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/settings/network_connectivity/index.md b/docs/databricks_account-docs/providers/databricks_account/settings/network_connectivity/index.md new file mode 100644 index 0000000000..4251c98c66 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/settings/network_connectivity/index.md @@ -0,0 +1,147 @@ +--- +title: network_connectivity +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - network_connectivity + - settings + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a network_connectivity resource. + +## Overview + + + + +
Namenetwork_connectivity
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a network connectivity configuration. | +| | `SELECT` | | Gets an array of network connectivity configurations. | +| | `INSERT` | | Creates a network connectivity configuration (NCC), which provides stable IP CIDR blocks that are associated with your workspace. You can assign an NCC to one or more workspaces in the same region. Once assigned, the workspace serverless compute resources use the same set of stable IP CIDR blocks to access your resources. | +| | `DELETE` | | Deletes a network connectivity configuration. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +account_id, +creation_time, +egress_config, +network_connectivity_config_id, +region, +updated_time +FROM databricks_account.settings.network_connectivity +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +name, +account_id, +creation_time, +egress_config, +network_connectivity_config_id, +region, +updated_time +FROM databricks_account.settings.network_connectivity +WHERE account_id = '{{ account_id }}' AND +network_connectivity_config_id = '{{ network_connectivity_config_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new network_connectivity resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.settings.network_connectivity ( +account_id, +data__name, +data__region +) +SELECT +'{{ account_id }}', +'{{ name }}', +'{{ region }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: 9ffa9185-7453-4fb2-aa6a-3105a6ae83a8 + - name: region + value: string + +``` + + + + +## `DELETE` example + +Deletes a network_connectivity resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.settings.network_connectivity +WHERE account_id = '{{ account_id }}' AND +network_connectivity_config_id = '{{ network_connectivity_config_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/unity_catalog/index.md b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/index.md new file mode 100644 index 0000000000..7eb212b13b --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/index.md @@ -0,0 +1,40 @@ +--- +title: unity_catalog +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - unity_catalog + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +__`unity_catalog`__ service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+
+metastore_assignments
+metastores
+
+
+storage_credentials
+workspace_assignments
+
+
\ No newline at end of file diff --git a/docs/databricks_account-docs/providers/databricks_account/unity_catalog/metastore_assignments/index.md b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/metastore_assignments/index.md new file mode 100644 index 0000000000..7ac045612b --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/metastore_assignments/index.md @@ -0,0 +1,127 @@ +--- +title: metastore_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - metastore_assignments + - unity_catalog + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a metastore_assignments resource. + +## Overview + + + + +
Namemetastore_assignments
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the metastore assignment, if any, for the workspace specified by ID. If the workspace is assigned a metastore, the mappig will be returned. If no metastore is assigned to the workspace, the assignment will not be found and a 404 returned. | +| | `INSERT` | | Creates an assignment to a metastore for a workspace | +| | `DELETE` | | Deletes a metastore assignment to a workspace, leaving the workspace with no metastore. | +| | `REPLACE` | | Updates an assignment to a metastore for a workspace. Currently, only the default catalog may be updated. | + +## `SELECT` examples + +```sql +SELECT +default_catalog_name, +metastore_id, +workspace_id +FROM databricks_account.unity_catalog.metastore_assignments +WHERE account_id = '{{ account_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new metastore_assignments resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.unity_catalog.metastore_assignments ( +account_id, +metastore_id, +workspace_id, +data__metastore_assignment +) +SELECT +'{{ account_id }}', +'{{ metastore_id }}', +'{{ workspace_id }}', +'{{ metastore_assignment }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: metastore_assignment + value: + metastore_id: string + default_catalog_name: string + +``` + + + + +## `REPLACE` example + +Replaces a metastore_assignments resource. + +```sql +/*+ update */ +REPLACE databricks_account.unity_catalog.metastore_assignments +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` + +## `DELETE` example + +Deletes a metastore_assignments resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.unity_catalog.metastore_assignments +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}' AND +workspace_id = '{{ workspace_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/unity_catalog/metastores/index.md b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/metastores/index.md new file mode 100644 index 0000000000..f028afe294 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/metastores/index.md @@ -0,0 +1,195 @@ +--- +title: metastores +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - metastores + - unity_catalog + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a metastores resource. + +## Overview + + + + +
Namemetastores
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a Unity Catalog metastore from an account, both specified by ID. | +| | `SELECT` | | Gets all Unity Catalog metastores associated with an account specified by ID. | +| | `INSERT` | | Creates a Unity Catalog metastore. | +| | `DELETE` | | Deletes a Unity Catalog metastore for an account, both specified by ID. | +| | `REPLACE` | | Updates an existing Unity Catalog metastore. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +cloud, +created_at, +created_by, +default_data_access_config_id, +delta_sharing_organization_name, +delta_sharing_recipient_token_lifetime_in_seconds, +delta_sharing_scope, +external_access_enabled, +global_metastore_id, +metastore_id, +owner, +privilege_model_version, +region, +storage_root, +storage_root_credential_id, +storage_root_credential_name, +updated_at, +updated_by +FROM databricks_account.unity_catalog.metastores +WHERE account_id = '{{ account_id }}'; +``` + + + + +```sql +SELECT +name, +cloud, +created_at, +created_by, +default_data_access_config_id, +delta_sharing_organization_name, +delta_sharing_recipient_token_lifetime_in_seconds, +delta_sharing_scope, +external_access_enabled, +global_metastore_id, +metastore_id, +owner, +privilege_model_version, +region, +storage_root, +storage_root_credential_id, +storage_root_credential_name, +updated_at, +updated_by +FROM databricks_account.unity_catalog.metastores +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new metastores resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.unity_catalog.metastores ( +account_id, +data__metastore_info +) +SELECT +'{{ account_id }}', +'{{ metastore_info }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: metastore_info + value: + name: string + storage_root: string + region: string + +``` + + + + +## `REPLACE` example + +Replaces a metastores resource. + +```sql +/*+ update */ +REPLACE databricks_account.unity_catalog.metastores +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}'; +``` + +## `DELETE` example + +Deletes a metastores resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.unity_catalog.metastores +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/unity_catalog/storage_credentials/index.md b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/storage_credentials/index.md new file mode 100644 index 0000000000..82c6c1794b --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/storage_credentials/index.md @@ -0,0 +1,189 @@ +--- +title: storage_credentials +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - storage_credentials + - unity_catalog + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a storage_credentials resource. + +## Overview + + + + +
Namestorage_credentials
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `integer` | +| | `string` | +| | `boolean` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have a level of privilege on the storage credential. | +| | `SELECT` | | Gets a list of all storage credentials that have been assigned to given metastore. | +| | `INSERT` | | Creates a new storage credential. The request object is specific to the cloud: | +| | `DELETE` | | Deletes a storage credential from the metastore. The caller must be an owner of the storage credential. | +| | `REPLACE` | | Updates a storage credential on the metastore. The caller must be the owner of the storage credential. If the caller is a metastore admin, only the | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +aws_iam_role, +comment, +created_at, +created_by, +full_name, +isolation_mode, +metastore_id, +owner, +read_only, +updated_at, +updated_by, +used_for_managed_storage +FROM databricks_account.unity_catalog.storage_credentials +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}'; +``` + + + + +```sql +SELECT +id, +name, +aws_iam_role, +comment, +created_at, +created_by, +full_name, +isolation_mode, +metastore_id, +owner, +read_only, +updated_at, +updated_by, +used_for_managed_storage +FROM databricks_account.unity_catalog.storage_credentials +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}' AND +storage_credential_name = '{{ storage_credential_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new storage_credentials resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_account.unity_catalog.storage_credentials ( +account_id, +metastore_id, +data__credential_info +) +SELECT +'{{ account_id }}', +'{{ metastore_id }}', +'{{ credential_info }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: credential_info + value: + name: string + comment: string + read_only: true + aws_iam_role: + role_arn: string + skip_validation: false + +``` + + + + +## `REPLACE` example + +Replaces a storage_credentials resource. + +```sql +/*+ update */ +REPLACE databricks_account.unity_catalog.storage_credentials +SET { field = value } +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}' AND +storage_credential_name = '{{ storage_credential_name }}'; +``` + +## `DELETE` example + +Deletes a storage_credentials resource. + +```sql +/*+ delete */ +DELETE FROM databricks_account.unity_catalog.storage_credentials +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}' AND +storage_credential_name = '{{ storage_credential_name }}'; +``` diff --git a/docs/databricks_account-docs/providers/databricks_account/unity_catalog/workspace_assignments/index.md b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/workspace_assignments/index.md new file mode 100644 index 0000000000..39aa62ec96 --- /dev/null +++ b/docs/databricks_account-docs/providers/databricks_account/unity_catalog/workspace_assignments/index.md @@ -0,0 +1,50 @@ +--- +title: workspace_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - workspace_assignments + - unity_catalog + - databricks_account + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_account/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a workspace_assignments resource. + +## Overview + + + + +
Nameworkspace_assignments
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a list of all Databricks workspace IDs that have been assigned to given metastore. | + +## `SELECT` examples + +```sql +SELECT +workspace_ids +FROM databricks_account.unity_catalog.workspace_assignments +WHERE account_id = '{{ account_id }}' AND +metastore_id = '{{ metastore_id }}'; +``` diff --git a/docs/databricks_account-docs/stackql-provider-registry.mdx b/docs/databricks_account-docs/stackql-provider-registry.mdx new file mode 100644 index 0000000000..1bb64ad0f6 --- /dev/null +++ b/docs/databricks_account-docs/stackql-provider-registry.mdx @@ -0,0 +1,19 @@ +--- +title: StackQL Provider Registry +hide_title: true +hide_table_of_contents: true +keywords: + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query and Deploy Cloud Infrastructure and Resources using SQL +custom_edit_url: null +image: https://storage.googleapis.com/stackql-web-assets/blog/stackql-blog-post-featured-image.png +slug: / +--- +import RegistryPage from '@site/src/shared/shared-stackql-provider-registry.mdx'; + + + +--- diff --git a/docs/databricks_workspace-docs/index.md b/docs/databricks_workspace-docs/index.md new file mode 100644 index 0000000000..74a3be412c --- /dev/null +++ b/docs/databricks_workspace-docs/index.md @@ -0,0 +1,78 @@ +--- +title: databricks_workspace +hide_title: false +hide_table_of_contents: false +keywords: + - databricks + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +id: databricks_workspace-doc +slug: /providers/databricks_workspace +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + +Services from Databricks. + +:::info Provider Summary + +
+
+total services: 18
+total resources: 186
+total methods: 579
+
+
+ +::: + +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation +```bash +REGISTRY PULL databricks_workspace; +``` + +## Authentication + +To use the databricks_workspace, set the following environment variables: + +- - a uuid representing your Databricks account id, you can get this from the Databricks UI (see Locate your account id) +- - obtained after creating a service principal through the Databricks UI (see Authenticate access to Databricks with a service principal using OAuth) +- - obtained after creating a service principal secret through the Databricks UI, using the "Generate Secret" function (see Authenticate access to Databricks with a service principal using OAuth) + +These are the same variables that Terraform, the Databricks SDKs, and CLI use. + +## Services +
+
+apps
+cleanrooms
+compute
+dbsql
+deltalivetables
+deltasharing
+filemanagement
+iam
+lakeview
+
+
+machinelearning
+marketplace
+realtimeserving
+repos
+secrets
+unitycatalog
+vectorsearch
+workflows
+workspace
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/apps/apps/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/apps/index.md new file mode 100644 index 0000000000..487ccc713b --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/apps/index.md @@ -0,0 +1,209 @@ +--- +title: apps +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - apps + - apps + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a apps resource. + +## Overview + + + + +
Nameapps
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `array` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves information for the app with the supplied name. | +| | `SELECT` | | Lists all apps in the workspace. | +| | `INSERT` | | Creates a new app. | +| | `DELETE` | | Deletes an app. | +| | `UPDATE` | | Updates the app with the supplied name. | +| | `EXEC` | | Creates an app deployment for the app with the supplied name. | +| | `EXEC` | | Start the last active deployment of the app in the workspace. | +| | `EXEC` | | Stops the active deployment of the app in the workspace. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +description, +active_deployment, +app_status, +compute_status, +create_time, +creator, +default_source_code_path, +pending_deployment, +resources, +service_principal_client_id, +service_principal_id, +service_principal_name, +update_time, +updater, +url +FROM databricks_workspace.apps.apps +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +description, +active_deployment, +app_status, +compute_status, +create_time, +creator, +default_source_code_path, +pending_deployment, +resources, +service_principal_client_id, +service_principal_id, +service_principal_name, +update_time, +updater, +url +FROM databricks_workspace.apps.apps +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new apps resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.apps.apps ( +deployment_name, +data__name, +data__description, +data__resources +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ description }}', +'{{ resources }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: my-custom-app + - name: description + value: My app description. + - name: resources + value: + - name: api-key + description: API key for external service. + secret: + scope: my-scope + key: my-key + permission: READ + sql_warehouse: + id: e9ca293f79a74b5c + permission: CAN_MANAGE + serving_endpoint: + name: databricks-meta-llama-3-1-70b-instruct + permission: CAN_MANAGE + job: + id: '1234' + permission: CAN_MANAGE + +``` + + + + +## `UPDATE` example + +Updates a apps resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.apps.apps +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a apps resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.apps.apps +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/apps/deployments/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/deployments/index.md new file mode 100644 index 0000000000..b9bc13ba1a --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/deployments/index.md @@ -0,0 +1,96 @@ +--- +title: deployments +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - deployments + - apps + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a deployments resource. + +## Overview + + + + +
Namedeployments
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves information for the app deployment with the supplied name and deployment id. | +| | `SELECT` | | Lists all app deployments for the app with the supplied name. | + +## `SELECT` examples + + + + +```sql +SELECT +create_time, +creator, +deployment_artifacts, +deployment_id, +mode, +source_code_path, +status, +update_time +FROM databricks_workspace.apps.deployments +WHERE app_name = '{{ app_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +create_time, +creator, +deployment_artifacts, +deployment_id, +mode, +source_code_path, +status, +update_time +FROM databricks_workspace.apps.deployments +WHERE app_name = '{{ app_name }}' AND +deployment_id = '{{ deployment_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/apps/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/index.md new file mode 100644 index 0000000000..854bd898c5 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/index.md @@ -0,0 +1,40 @@ +--- +title: apps +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - apps + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`apps`__ service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+
+apps
+deployments
+
+
+permission_levels
+permissions
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/apps/permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/permission_levels/index.md new file mode 100644 index 0000000000..ac874c787f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - permission_levels + - apps + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a permission_levels resource. + +## Overview + + + + +
Namepermission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.apps.permission_levels +WHERE app_name = '{{ app_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/apps/permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/permissions/index.md new file mode 100644 index 0000000000..bacde4877e --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/apps/permissions/index.md @@ -0,0 +1,80 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - permissions + - apps + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a permissions resource. + +## Overview + + + + +
Namepermissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of an app. Apps can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on an app. Apps can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.apps.permissions +WHERE app_name = '{{ app_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.apps.permissions +SET { field = value } +WHERE app_name = '{{ app_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.apps.permissions +SET { field = value } +WHERE app_name = '{{ app_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/assets/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/assets/index.md new file mode 100644 index 0000000000..4873eff4b9 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/assets/index.md @@ -0,0 +1,241 @@ +--- +title: assets +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - assets + - cleanrooms + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a assets resource. + +## Overview + + + + +
Nameassets
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `object` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | | +| | `INSERT` | | Create a clean room asset —share an asset like a notebook or table into the clean room. For each UC asset that is added through this method, the clean room owner must also have enough privilege on the asset to consume it. The privilege must be maintained indefinitely for the clean room to be able to access the asset. Typically, you should use a group as the clean room owner. | +| | `DELETE` | | Delete a clean room asset - unshare/remove the asset from the clean room | +| | `UPDATE` | | Update a clean room asset. For example, updating the content of a notebook; changing the shared partitions of a table; etc. | + +## `SELECT` examples + +```sql +SELECT +name, +added_at, +asset_type, +foreign_table, +foreign_table_local_details, +notebook, +owner_collaborator_alias, +status, +table, +table_local_details, +view, +view_local_details, +volume_local_details +FROM databricks_workspace.cleanrooms.assets +WHERE clean_room_name = '{{ clean_room_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new assets resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.cleanrooms.assets ( +clean_room_name, +deployment_name, +data__name, +data__asset_type, +data__table_local_details, +data__volume_local_details, +data__view_local_details, +data__foreign_table_local_details, +data__table, +data__notebook, +data__view, +data__foreign_table +) +SELECT +'{{ clean_room_name }}', +'{{ deployment_name }}', +'{{ name }}', +'{{ asset_type }}', +'{{ table_local_details }}', +'{{ volume_local_details }}', +'{{ view_local_details }}', +'{{ foreign_table_local_details }}', +'{{ table }}', +'{{ notebook }}', +'{{ view }}', +'{{ foreign_table }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: creator.sales.products + - name: asset_type + value: TABLE + - name: table_local_details + value: + local_name: demo.sales.products + partitions: + - values: + - name: string + value: string + recipient_property_key: string + op: EQUAL + - name: volume_local_details + value: + local_name: demo.sales.products + - name: view_local_details + value: + local_name: demo.sales.products + - name: foreign_table_local_details + value: + local_name: demo.sales.products + - name: table + value: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + - name: notebook + value: + notebook_content: string + etag: string + - name: view + value: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + - name: foreign_table + value: + columns: + - name: string + type_text: string + type_name: BOOLEAN + position: 0 + type_precision: 0 + type_scale: 0 + type_interval_type: string + type_json: string + comment: string + nullable: true + partition_index: 0 + mask: + function_name: string + using_column_names: + - string + +``` + + + + +## `UPDATE` example + +Updates a assets resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.cleanrooms.assets +SET { field = value } +WHERE asset_type = '{{ asset_type }}' AND +clean_room_name = '{{ clean_room_name }}' AND +name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a assets resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.cleanrooms.assets +WHERE asset_full_name = '{{ asset_full_name }}' AND +asset_type = '{{ asset_type }}' AND +clean_room_name = '{{ clean_room_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/clean_rooms/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/clean_rooms/index.md new file mode 100644 index 0000000000..a4083d00a9 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/clean_rooms/index.md @@ -0,0 +1,219 @@ +--- +title: clean_rooms +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - clean_rooms + - cleanrooms + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a clean_rooms resource. + +## Overview + + + + +
Nameclean_rooms
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get the details of a clean room given its name. | +| | `SELECT` | | Get a list of all clean rooms of the metastore. Only clean rooms the caller has access to are returned. | +| | `INSERT` | | Create a new clean room with the specified collaborators. This method is asynchronous; the returned name field inside the clean_room field can be used to poll the clean room status, using the | +| | `DELETE` | | Delete a clean room. After deletion, the clean room will be removed from the metastore. If the other collaborators have not deleted the clean room, they will still have the clean room in their metastore, but it will be in a DELETED state and no operations other than deletion can be performed on it. | +| | `UPDATE` | | Update a clean room. The caller must be the owner of the clean room, have | + +## `SELECT` examples + + + + +```sql +SELECT +name, +access_restricted, +comment, +created_at, +local_collaborator_alias, +output_catalog, +owner, +remote_detailed_info, +status, +updated_at +FROM databricks_workspace.cleanrooms.clean_rooms +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +access_restricted, +comment, +created_at, +local_collaborator_alias, +output_catalog, +owner, +remote_detailed_info, +status, +updated_at +FROM databricks_workspace.cleanrooms.clean_rooms +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new clean_rooms resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.cleanrooms.clean_rooms ( +deployment_name, +data__name, +data__remote_detailed_info, +data__owner, +data__comment +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ remote_detailed_info }}', +'{{ owner }}', +'{{ comment }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: test-clean-room1 + - name: remote_detailed_info + value: + central_clean_room_id: b5c8d856-ff41-4c5f-8ccd-2b13b44fec27 + cloud_vendor: aws + region: us-west-2 + collaborators: + - global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + creator: + global_metastore_id: aws:us-west-2:aff56c64-a34e-4c1f-a24c-c2dd2889517a + organization_name: acme corporation + invite_recipient_workspace_id: 6822898386300992 + invite_recipient_email: john.doe@databricks.com + collaborator_alias: creator + display_name: acme corporation + egress_network_policy: + internet_access: + restriction_mode: FULL_ACCESS + allowed_internet_destinations: + - destination: string + type: FQDN + protocol: TCP + allowed_storage_destinations: + - bucket_name: string + region: string + type: AWS_S3 + azure_storage_account: string + allowed_paths: + - string + azure_storage_service: string + azure_dns_zone: string + azure_container: string + log_only_mode: + log_only_mode_type: ALL_SERVICES + workloads: + - DBSQL + compliance_security_profile: + is_enabled: true + compliance_standards: + - NONE + - name: owner + value: alice@example.com + - name: comment + value: This is a clean room for demo + +``` + + + + +## `UPDATE` example + +Updates a clean_rooms resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.cleanrooms.clean_rooms +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a clean_rooms resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.cleanrooms.clean_rooms +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/index.md new file mode 100644 index 0000000000..e670eecfa1 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/index.md @@ -0,0 +1,40 @@ +--- +title: cleanrooms +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - cleanrooms + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`cleanrooms`__ service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+
+assets
+clean_rooms
+
+
+output_catalog
+task_runs
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/output_catalog/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/output_catalog/index.md new file mode 100644 index 0000000000..529fd83df8 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/output_catalog/index.md @@ -0,0 +1,78 @@ +--- +title: output_catalog +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - output_catalog + - cleanrooms + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a output_catalog resource. + +## Overview + + + + +
Nameoutput_catalog
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `INSERT` | | Create the output catalog of the clean room. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new output_catalog resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.cleanrooms.output_catalog ( +clean_room_name, +deployment_name, +data__catalog_name +) +SELECT +'{{ clean_room_name }}', +'{{ deployment_name }}', +'{{ catalog_name }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: catalog_name + value: string + +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/task_runs/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/task_runs/index.md new file mode 100644 index 0000000000..ba744a5874 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/cleanrooms/task_runs/index.md @@ -0,0 +1,62 @@ +--- +title: task_runs +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - task_runs + - cleanrooms + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a task_runs resource. + +## Overview + + + + +
Nametask_runs
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `object` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all the historical notebook task runs in a clean room. | + +## `SELECT` examples + +```sql +SELECT +collaborator_job_run_info, +notebook_job_run_state, +notebook_name, +output_schema_expiration_time, +output_schema_name, +run_duration, +start_time +FROM databricks_workspace.cleanrooms.task_runs +WHERE clean_room_name = '{{ clean_room_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/all_clusters_policy_compliance/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/all_clusters_policy_compliance/index.md new file mode 100644 index 0000000000..ffecc409e7 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/all_clusters_policy_compliance/index.md @@ -0,0 +1,54 @@ +--- +title: all_clusters_policy_compliance +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - all_clusters_policy_compliance + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a all_clusters_policy_compliance resource. + +## Overview + + + + +
Nameall_clusters_policy_compliance
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns the policy compliance status of all clusters that use a given policy. Clusters could be out of compliance if their policy was updated after the cluster was last edited. | + +## `SELECT` examples + +```sql +SELECT +cluster_id, +is_compliant, +violations +FROM databricks_workspace.compute.all_clusters_policy_compliance +WHERE policy_id = '{{ policy_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_events/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_events/index.md new file mode 100644 index 0000000000..e0440cb6a0 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_events/index.md @@ -0,0 +1,53 @@ +--- +title: cluster_events +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - cluster_events + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a cluster_events resource. + +## Overview + + + + +
Namecluster_events
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `object` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves a list of events about the activity of a cluster. This API is paginated. If there are more events to read, the response includes all the nparameters necessary to request the next page of events. | + +## `SELECT` examples + +```sql +SELECT +events, +next_page, +total_count +FROM databricks_workspace.compute.cluster_events +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_permission_levels/index.md new file mode 100644 index 0000000000..0ed2e852ec --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: cluster_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - cluster_permission_levels + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a cluster_permission_levels resource. + +## Overview + + + + +
Namecluster_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.compute.cluster_permission_levels +WHERE cluster_id = '{{ cluster_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_permissions/index.md new file mode 100644 index 0000000000..c4dbb48088 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: cluster_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - cluster_permissions + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a cluster_permissions resource. + +## Overview + + + + +
Namecluster_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a cluster. Clusters can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on a cluster. Clusters can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.compute.cluster_permissions +WHERE cluster_id = '{{ cluster_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a cluster_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.compute.cluster_permissions +SET { field = value } +WHERE cluster_id = '{{ cluster_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a cluster_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.compute.cluster_permissions +SET { field = value } +WHERE cluster_id = '{{ cluster_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policies/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policies/index.md new file mode 100644 index 0000000000..c71603bab4 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policies/index.md @@ -0,0 +1,170 @@ +--- +title: cluster_policies +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - cluster_policies + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a cluster_policies resource. + +## Overview + + + + +
Namecluster_policies
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `boolean` | +| | `array` | +| | `integer` | +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a cluster policy entity. Creation and editing is available to admins only. | +| | `SELECT` | | Returns a list of policies accessible by the requesting user. | +| | `INSERT` | | Creates a new policy with prescribed settings. | +| | `DELETE` | | Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited. | +| | `REPLACE` | | Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +description, +created_at_timestamp, +creator_user_name, +definition, +is_default, +libraries, +max_clusters_per_user, +policy_family_definition_overrides, +policy_family_id, +policy_id +FROM databricks_workspace.compute.cluster_policies +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +description, +created_at_timestamp, +creator_user_name, +definition, +is_default, +libraries, +max_clusters_per_user, +policy_family_definition_overrides, +policy_family_id, +policy_id +FROM databricks_workspace.compute.cluster_policies +WHERE policy_id = '{{ policy_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cluster_policies resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.compute.cluster_policies ( +deployment_name, +data__definition, +data__name +) +SELECT +'{{ deployment_name }}', +'{{ definition }}', +'{{ name }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: definition + value: '{ "custom_tags.test_tag": { "type": "fixed", "value": "test_value" } }' + - name: name + value: Test policy + +``` + + + + +## `REPLACE` example + +Replaces a cluster_policies resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.compute.cluster_policies +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a cluster_policies resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.compute.cluster_policies +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policies_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policies_permissions/index.md new file mode 100644 index 0000000000..029862ef19 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policies_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: cluster_policies_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - cluster_policies_permissions + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a cluster_policies_permissions resource. + +## Overview + + + + +
Namecluster_policies_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a cluster policy. Cluster policies can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on a cluster policy. Cluster policies can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.compute.cluster_policies_permissions +WHERE cluster_policy_id = '{{ cluster_policy_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a cluster_policies_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.compute.cluster_policies_permissions +SET { field = value } +WHERE cluster_policy_id = '{{ cluster_policy_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a cluster_policies_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.compute.cluster_policies_permissions +SET { field = value } +WHERE cluster_policy_id = '{{ cluster_policy_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policy_compliance/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policy_compliance/index.md new file mode 100644 index 0000000000..1cb9a53cb0 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/cluster_policy_compliance/index.md @@ -0,0 +1,64 @@ +--- +title: cluster_policy_compliance +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - cluster_policy_compliance + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a cluster_policy_compliance resource. + +## Overview + + + + +
Namecluster_policy_compliance
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `boolean` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns the policy compliance status of a cluster. Clusters could be out of compliance if their policy was updated after the cluster was last edited. | +| | `REPLACE` | | Updates a cluster to be compliant with the current version of its policy. A cluster can be updated if it is in a | + +## `SELECT` examples + +```sql +SELECT +is_compliant, +violations +FROM databricks_workspace.compute.cluster_policy_compliance +WHERE cluster_id = '{{ cluster_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a cluster_policy_compliance resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.compute.cluster_policy_compliance +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/clusters/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/clusters/index.md new file mode 100644 index 0000000000..b901a25624 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/clusters/index.md @@ -0,0 +1,249 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - clusters + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a clusters resource. + +## Overview + + + + +
Nameclusters
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `object` | +| | `string` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `object` | +| | `integer` | +| | `string` | +| | `integer` | +| | `integer` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `integer` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves the information for a cluster given its identifier. Clusters can be described while they are running, or up to 60 days after they are terminated. | +| | `SELECT` | | Return information about all pinned and active clusters, and all clusters terminated within the last 30 days. Clusters terminated prior to this period are not included. | +| | `INSERT` | | Creates a new Spark cluster. This method will acquire new instances from the cloud provider if necessary. This method is asynchronous; the returned | +| | `DELETE` | | Terminates the Spark cluster with the specified ID. The cluster is removed asynchronously. Once the termination has completed, the cluster will be in a | +| | `UPDATE` | | Updates the configuration of a cluster to match the partial set of attributes and size. Denote which fields to update using the | +| | `REPLACE` | | Updates the configuration of a cluster to match the provided attributes and size. A cluster can be updated if it is in a | +| | `EXEC` | | Change the owner of the cluster. You must be an admin and the cluster must be terminated to perform this operation. The service principal application ID can be supplied as an argument to | +| | `EXEC` | | Permanently deletes a Spark cluster. This cluster is terminated and resources are asynchronously removed. | +| | `EXEC` | | Pinning a cluster ensures that the cluster will always be returned by the ListClusters API. Pinning a cluster that is already pinned will have no effect. This API can only be called by workspace admins. | +| | `EXEC` | | Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in a | +| | `EXEC` | | Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a | +| | `EXEC` | | Starts a terminated Spark cluster with the supplied ID. This works similar to | +| | `EXEC` | | Unpinning a cluster will allow the cluster to eventually be removed from the ListClusters API. Unpinning a cluster that is not pinned will have no effect. This API can only be called by workspace admins. | + +## `SELECT` examples + + + + +```sql +SELECT +autotermination_minutes, +aws_attributes, +cluster_id, +cluster_name, +cluster_source, +creator_user_name, +default_tags, +disk_spec, +driver_instance_source, +driver_node_type_id, +enable_elastic_disk, +enable_local_disk_encryption, +init_scripts_safe_mode, +instance_source, +last_state_loss_time, +node_type_id, +num_workers, +spark_context_id, +spark_version, +start_time, +state, +state_message, +terminated_time, +termination_reason +FROM databricks_workspace.compute.clusters +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +autotermination_minutes, +aws_attributes, +cluster_id, +cluster_name, +cluster_source, +creator_user_name, +default_tags, +disk_spec, +driver_instance_source, +driver_node_type_id, +enable_elastic_disk, +enable_local_disk_encryption, +init_scripts_safe_mode, +instance_source, +last_state_loss_time, +node_type_id, +num_workers, +spark_context_id, +spark_version, +start_time, +state, +state_message, +terminated_time, +termination_reason +FROM databricks_workspace.compute.clusters +WHERE cluster_id = '{{ cluster_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new clusters resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.compute.clusters ( +deployment_name, +data__cluster_name, +data__is_single_node, +data__kind, +data__spark_version, +data__node_type_id, +data__aws_attributes +) +SELECT +'{{ deployment_name }}', +'{{ cluster_name }}', +'{{ is_single_node }}', +'{{ kind }}', +'{{ spark_version }}', +'{{ node_type_id }}', +'{{ aws_attributes }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: cluster_name + value: single-node-with-kind-cluster + - name: is_single_node + value: true + - name: kind + value: CLASSIC_PREVIEW + - name: spark_version + value: 14.3.x-scala2.12 + - name: node_type_id + value: i3.xlarge + - name: aws_attributes + value: + first_on_demand: 1 + availability: SPOT_WITH_FALLBACK + zone_id: auto + spot_bid_price_percent: 100 + ebs_volume_count: 0 + +``` + + + + +## `UPDATE` example + +Updates a clusters resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.compute.clusters +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a clusters resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.compute.clusters +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a clusters resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.compute.clusters +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/command_status/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/command_status/index.md new file mode 100644 index 0000000000..95a4b16e63 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/command_status/index.md @@ -0,0 +1,53 @@ +--- +title: command_status +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - command_status + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a command_status resource. + +## Overview + + + + +
Namecommand_status
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the status for an execution context. | + +## `SELECT` examples + +```sql +SELECT +id, +status +FROM databricks_workspace.compute.command_status +WHERE clusterId = '{{ clusterId }}' AND +contextId = '{{ contextId }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/commands/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/commands/index.md new file mode 100644 index 0000000000..5370fdeca7 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/commands/index.md @@ -0,0 +1,103 @@ +--- +title: commands +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - commands + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a commands resource. + +## Overview + + + + +
Namecommands
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the status of and, if available, the results from a currently executing command. | +| | `INSERT` | | Creates an execution context for running cluster commands. | +| | `EXEC` | | Cancels a currently running command within an execution context. | +| | `EXEC` | | Deletes an execution context. | +| | `EXEC` | | Runs a cluster command in the given execution context, using the provided language. | + +## `SELECT` examples + +```sql +SELECT +id, +results, +status +FROM databricks_workspace.compute.commands +WHERE clusterId = '{{ clusterId }}' AND +commandId = '{{ commandId }}' AND +contextId = '{{ contextId }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new commands resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.compute.commands ( +deployment_name, +data__clusterId, +data__language +) +SELECT +'{{ deployment_name }}', +'{{ clusterId }}', +'{{ language }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: clusterId + value: string + - name: language + value: python + +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/global_init_scripts/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/global_init_scripts/index.md new file mode 100644 index 0000000000..a954e4080d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/global_init_scripts/index.md @@ -0,0 +1,174 @@ +--- +title: global_init_scripts +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - global_init_scripts + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a global_init_scripts resource. + +## Overview + + + + +
Nameglobal_init_scripts
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `integer` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Manage a specific global init script with ID | +| | `SELECT` | | Manages global init scripts for this workspace. | +| | `INSERT` | | Manages global init scripts for this workspace. | +| | `DELETE` | | Manage a specific global init script with ID | +| | `UPDATE` | | Manage a specific global init script with ID | + +## `SELECT` examples + + + + +```sql +SELECT +name, +created_at, +created_by, +enabled, +position, +script, +script_id, +updated_at, +updated_by +FROM databricks_workspace.compute.global_init_scripts +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +created_at, +created_by, +enabled, +position, +script, +script_id, +updated_at, +updated_by +FROM databricks_workspace.compute.global_init_scripts +WHERE script_id = '{{ script_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new global_init_scripts resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.compute.global_init_scripts ( +deployment_name, +data__name, +data__script, +data__position, +data__enabled +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ script }}', +'{{ position }}', +'{{ enabled }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: My example script name + - name: script + value: ZWNobyBoZWxsbw== + - name: position + value: 0 + - name: enabled + value: false + +``` + + + + +## `UPDATE` example + +Updates a global_init_scripts resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.compute.global_init_scripts +SET { field = value } +WHERE script_id = '{{ script_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a global_init_scripts resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.compute.global_init_scripts +WHERE script_id = '{{ script_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/index.md new file mode 100644 index 0000000000..cf8bcf0abc --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/index.md @@ -0,0 +1,57 @@ +--- +title: compute +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`compute`__ service documentation. + +:::info Service Summary + +
+
+total resources: 21
+
+
+ +::: + +## Resources +
+
+all_clusters_policy_compliance
+cluster_events
+cluster_permission_levels
+cluster_permissions
+cluster_policies
+cluster_policies_permissions
+cluster_policy_compliance
+clusters
+command_status
+commands
+global_init_scripts
+
+
+instance_pool_permission_levels
+instance_pool_permissions
+instance_pools
+instance_profiles
+libraries
+node_types
+policy_families
+policy_permission_levels
+spark_versions
+zones
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pool_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pool_permission_levels/index.md new file mode 100644 index 0000000000..d5ce5d246d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pool_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: instance_pool_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - instance_pool_permission_levels + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a instance_pool_permission_levels resource. + +## Overview + + + + +
Nameinstance_pool_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.compute.instance_pool_permission_levels +WHERE instance_pool_id = '{{ instance_pool_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pool_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pool_permissions/index.md new file mode 100644 index 0000000000..8b2fba4e81 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pool_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: instance_pool_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - instance_pool_permissions + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a instance_pool_permissions resource. + +## Overview + + + + +
Nameinstance_pool_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of an instance pool. Instance pools can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on an instance pool. Instance pools can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.compute.instance_pool_permissions +WHERE instance_pool_id = '{{ instance_pool_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a instance_pool_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.compute.instance_pool_permissions +SET { field = value } +WHERE instance_pool_id = '{{ instance_pool_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a instance_pool_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.compute.instance_pool_permissions +SET { field = value } +WHERE instance_pool_id = '{{ instance_pool_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pools/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pools/index.md new file mode 100644 index 0000000000..d0c3c69b9c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_pools/index.md @@ -0,0 +1,191 @@ +--- +title: instance_pools +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - instance_pools + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a instance_pools resource. + +## Overview + + + + +
Nameinstance_pools
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `object` | +| | `object` | +| | `boolean` | +| | `integer` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `array` | +| | `string` | +| | `object` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve the information for an instance pool based on its identifier. | +| | `SELECT` | | Gets a list of instance pools with their statistics. | +| | `INSERT` | | Creates a new instance pool using idle and ready-to-use cloud instances. | +| | `DELETE` | | Deletes the instance pool permanently. The idle instances in the pool are terminated asynchronously. | +| | `REPLACE` | | Modifies the configuration of an existing instance pool. | + +## `SELECT` examples + + + + +```sql +SELECT +aws_attributes, +default_tags, +disk_spec, +enable_elastic_disk, +idle_instance_autotermination_minutes, +instance_pool_id, +instance_pool_name, +min_idle_instances, +node_type_id, +preloaded_spark_versions, +state, +stats, +status +FROM databricks_workspace.compute.instance_pools +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +aws_attributes, +default_tags, +disk_spec, +enable_elastic_disk, +idle_instance_autotermination_minutes, +instance_pool_id, +instance_pool_name, +min_idle_instances, +node_type_id, +preloaded_spark_versions, +state, +stats, +status +FROM databricks_workspace.compute.instance_pools +WHERE instance_pool_id = '{{ instance_pool_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance_pools resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.compute.instance_pools ( +deployment_name, +data__instance_pool_name, +data__node_type_id, +data__min_idle_instances, +data__aws_attributes, +data__custom_tags +) +SELECT +'{{ deployment_name }}', +'{{ instance_pool_name }}', +'{{ node_type_id }}', +'{{ min_idle_instances }}', +'{{ aws_attributes }}', +'{{ custom_tags }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: instance_pool_name + value: my-pool + - name: node_type_id + value: i3.xlarge + - name: min_idle_instances + value: 10 + - name: aws_attributes + value: + availability: SPOT + - name: custom_tags + value: + - key: my-key + value: my-value + +``` + + + + +## `REPLACE` example + +Replaces a instance_pools resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.compute.instance_pools +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a instance_pools resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.compute.instance_pools +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_profiles/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_profiles/index.md new file mode 100644 index 0000000000..10cfab0c05 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/instance_profiles/index.md @@ -0,0 +1,114 @@ +--- +title: instance_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - instance_profiles + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a instance_profiles resource. + +## Overview + + + + +
Nameinstance_profiles
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List the instance profiles that the calling user can use to launch a cluster. | +| | `INSERT` | | In the UI, you can select the instance profile when launching clusters. This API is only available to admin users. | +| | `DELETE` | | Remove the instance profile with the provided ARN. Existing clusters with this instance profile will continue to function. | +| | `REPLACE` | | The only supported field to change is the optional IAM role ARN associated with the instance profile. It is required to specify the IAM role ARN if both of the following are true: | + +## `SELECT` examples + +```sql +SELECT +instance_profile_arn, +is_meta_instance_profile +FROM databricks_workspace.compute.instance_profiles +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new instance_profiles resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.compute.instance_profiles ( +deployment_name, +data__instance_profile_arn +) +SELECT +'{{ deployment_name }}', +'{{ instance_profile_arn }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: instance_profile_arn + value: arn:aws:iam::123456789012:instance-profile/my-profile + +``` + + + + +## `REPLACE` example + +Replaces a instance_profiles resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.compute.instance_profiles +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a instance_profiles resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.compute.instance_profiles +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/libraries/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/libraries/index.md new file mode 100644 index 0000000000..b96781b2c8 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/libraries/index.md @@ -0,0 +1,145 @@ +--- +title: libraries +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - libraries + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a libraries resource. + +## Overview + + + + +
Namelibraries
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get the status of all libraries on all clusters. A status is returned for all libraries installed on this cluster via the API or the libraries UI. | +| | `SELECT` | | Get the status of libraries on a cluster. A status is returned for all libraries installed on this cluster via the API or the libraries UI. The order of returned libraries is as follows: | +| | `INSERT` | | Add libraries to install on a cluster. The installation is asynchronous; it happens in the background after the completion of this request. | +| | `DELETE` | | Set libraries to uninstall from a cluster. The libraries won't be uninstalled until the cluster is restarted. A request to uninstall a library that is not currently installed is ignored. | + +## `SELECT` examples + + + + +```sql +SELECT +cluster_id, +library_statuses +FROM databricks_workspace.compute.libraries +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +cluster_id, +library_statuses +FROM databricks_workspace.compute.libraries +WHERE cluster_id = '{{ cluster_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new libraries resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.compute.libraries ( +deployment_name, +data__cluster_id, +data__libraries +) +SELECT +'{{ deployment_name }}', +'{{ cluster_id }}', +'{{ libraries }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: cluster_id + value: 1234-56789-abcde + - name: libraries + value: + - pypi: + package: numpy + repo: http://my-pypi-repo.com + - jar: /Workspace/path/to/library.jar + - whl: /Workspace/path/to/library.whl + - maven: + coordinates: com.databricks:spark-csv_2.11:1.5.0 + exclusions: + - org.slf4j:slf4j-log4j12 + repo: http://my-maven-repo.com + - cran: + package: ggplot2 + repo: http://cran.us.r-project.org + - requirements: /Workspace/path/to/requirements.txt + +``` + + + + +## `DELETE` example + +Deletes a libraries resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.compute.libraries +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/node_types/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/node_types/index.md new file mode 100644 index 0000000000..37d69b1bad --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/node_types/index.md @@ -0,0 +1,79 @@ +--- +title: node_types +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - node_types + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a node_types resource. + +## Overview + + + + +
Namenode_types
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `integer` | +| | `object` | +| | `string` | +| | `integer` | +| | `integer` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `boolean` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns a list of supported Spark node types. These node types can be used to launch a cluster. | + +## `SELECT` examples + +```sql +SELECT +description, +category, +display_order, +instance_type_id, +is_deprecated, +is_hidden, +is_io_cache_enabled, +memory_mb, +node_instance_type, +node_type_id, +num_cores, +num_gpus, +support_cluster_tags, +support_ebs_volumes, +support_port_forwarding, +supports_elastic_disk +FROM databricks_workspace.compute.node_types +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/policy_families/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/policy_families/index.md new file mode 100644 index 0000000000..2b6f068b10 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/policy_families/index.md @@ -0,0 +1,82 @@ +--- +title: policy_families +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - policy_families + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a policy_families resource. + +## Overview + + + + +
Namepolicy_families
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve the information for an policy family based on its identifier and version | +| | `SELECT` | | Returns the list of policy definition types available to use at their latest version. This API is paginated. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +description, +definition, +policy_family_id +FROM databricks_workspace.compute.policy_families +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +description, +definition, +policy_family_id +FROM databricks_workspace.compute.policy_families +WHERE policy_family_id = '{{ policy_family_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/policy_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/policy_permission_levels/index.md new file mode 100644 index 0000000000..fb23f5303d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/policy_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: policy_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - policy_permission_levels + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a policy_permission_levels resource. + +## Overview + + + + +
Namepolicy_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.compute.policy_permission_levels +WHERE cluster_policy_id = '{{ cluster_policy_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/spark_versions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/spark_versions/index.md new file mode 100644 index 0000000000..1a540a16a6 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/spark_versions/index.md @@ -0,0 +1,51 @@ +--- +title: spark_versions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - spark_versions + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a spark_versions resource. + +## Overview + + + + +
Namespark_versions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns the list of available Spark versions. These versions can be used to launch a cluster. | + +## `SELECT` examples + +```sql +SELECT +name, +key +FROM databricks_workspace.compute.spark_versions +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/compute/zones/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/zones/index.md new file mode 100644 index 0000000000..f03e2e7f71 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/compute/zones/index.md @@ -0,0 +1,51 @@ +--- +title: zones +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - zones + - compute + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a zones resource. + +## Overview + + + + +
Namezones
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns a list of availability zones where clusters can be created in (For example, us-west-2a). These zones can be used to launch a cluster. | + +## `SELECT` examples + +```sql +SELECT +default_zone, +zones +FROM databricks_workspace.compute.zones +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/alerts/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/alerts/index.md new file mode 100644 index 0000000000..056b8ee71d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/alerts/index.md @@ -0,0 +1,180 @@ +--- +title: alerts +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - alerts + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a alerts resource. + +## Overview + + + + +
Namealerts
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an alert. | +| | `SELECT` | | Gets a list of alerts accessible to the user, ordered by creation time. | +| | `INSERT` | | Creates an alert. | +| | `DELETE` | | Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days. | +| | `UPDATE` | | Updates an alert. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +condition, +create_time, +display_name, +lifecycle_state, +owner_user_name, +parent_path, +query_id, +seconds_to_retrigger, +state, +update_time +FROM databricks_workspace.dbsql.alerts +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +condition, +create_time, +display_name, +lifecycle_state, +owner_user_name, +parent_path, +query_id, +seconds_to_retrigger, +state, +update_time +FROM databricks_workspace.dbsql.alerts +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alerts resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.dbsql.alerts ( +deployment_name, +data__alert +) +SELECT +'{{ deployment_name }}', +'{{ alert }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: alert + value: + seconds_to_retrigger: 0 + display_name: Test alert + condition: + op: GREATER_THAN + operand: + column: + name: foo + threshold: + value: + double_value: 1 + query_id: dee5cca8-1c79-4b5e-a71m1-e7f9d241bdf6 + parent_path: /Workspace/Users/user.name@acme.com + +``` + + + + +## `UPDATE` example + +Updates a alerts resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.dbsql.alerts +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a alerts resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.dbsql.alerts +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/alerts_legacy/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/alerts_legacy/index.md new file mode 100644 index 0000000000..a394b63619 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/alerts_legacy/index.md @@ -0,0 +1,191 @@ +--- +title: alerts_legacy +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - alerts_legacy + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a alerts_legacy resource. + +## Overview + + + + +
Namealerts_legacy
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `integer` | +| | `string` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an alert. | +| | `SELECT` | | Gets a list of alerts. | +| | `INSERT` | | Creates an alert. An alert is a Databricks SQL object that periodically runs a query, evaluates a condition of its result, and notifies users or notification destinations if the condition was met. | +| | `DELETE` | | Deletes an alert. Deleted alerts are no longer accessible and cannot be restored. | +| | `UPDATE` | | Updates an alert. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +created_at, +last_triggered_at, +options, +parent, +query, +rearm, +state, +updated_at, +user +FROM databricks_workspace.dbsql.alerts_legacy +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +created_at, +last_triggered_at, +options, +parent, +query, +rearm, +state, +updated_at, +user +FROM databricks_workspace.dbsql.alerts_legacy +WHERE alert_id = '{{ alert_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new alerts_legacy resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.dbsql.alerts_legacy ( +deployment_name, +data__name, +data__options, +data__query_id, +data__rearm, +data__parent +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ options }}', +'{{ query_id }}', +'{{ rearm }}', +'{{ parent }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: Total Trips > 300 + - name: options + value: + column: total_trips + custom_body: Total trips exceeded + custom_subject: The total trips has exceeded 300. + muted: false + op: '>' + value: null + empty_result_state: unknown + - name: query_id + value: dee5cca8-1c79-4b5e-a711-e7f9d241bdf6 + - name: rearm + value: 0 + - name: parent + value: folders/2025532471912059 + +``` + + + + +## `UPDATE` example + +Updates a alerts_legacy resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.dbsql.alerts_legacy +SET { field = value } +WHERE alert_id = '{{ alert_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a alerts_legacy resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.dbsql.alerts_legacy +WHERE alert_id = '{{ alert_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/dashboards/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/dashboards/index.md new file mode 100644 index 0000000000..2868bc0f56 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/dashboards/index.md @@ -0,0 +1,208 @@ +--- +title: dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dashboards + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dashboards resource. + +## Overview + + + + +
Namedashboards
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `object` | +| | `integer` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns a JSON representation of a dashboard object, including its visualization and query objects. | +| | `SELECT` | | Fetch a paginated list of dashboard objects. | +| | `INSERT` | | | +| | `DELETE` | | Moves a dashboard to the trash. Trashed dashboards do not appear in list views or searches, and cannot be shared. | +| | `UPDATE` | | Modify this dashboard definition. This operation only affects attributes of the dashboard object. It does not add, modify, or remove widgets. | +| | `EXEC` | | A restored dashboard appears in list views and searches and can be shared. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +can_edit, +created_at, +dashboard_filters_enabled, +is_archived, +is_draft, +is_favorite, +options, +parent, +permission_tier, +slug, +tags, +updated_at, +user, +user_id, +widgets +FROM databricks_workspace.dbsql.dashboards +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +can_edit, +created_at, +dashboard_filters_enabled, +is_archived, +is_draft, +is_favorite, +options, +parent, +permission_tier, +slug, +tags, +updated_at, +user, +user_id, +widgets +FROM databricks_workspace.dbsql.dashboards +WHERE dashboard_id = '{{ dashboard_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dashboards resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.dbsql.dashboards ( +deployment_name, +data__name, +data__parent, +data__tags, +data__is_favorite, +data__run_as_role, +data__dashboard_filters_enabled +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ parent }}', +'{{ tags }}', +'{{ is_favorite }}', +'{{ run_as_role }}', +'{{ dashboard_filters_enabled }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: Sales Dashboard + - name: parent + value: folders/2025532471912059 + - name: tags + value: + - Payroll + - name: is_favorite + value: true + - name: run_as_role + value: viewer + - name: dashboard_filters_enabled + value: true + +``` + + + + +## `UPDATE` example + +Updates a dashboards resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.dbsql.dashboards +SET { field = value } +WHERE dashboard_id = '{{ dashboard_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a dashboards resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.dbsql.dashboards +WHERE dashboard_id = '{{ dashboard_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/index.md new file mode 100644 index 0000000000..9c533d0a6f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/index.md @@ -0,0 +1,49 @@ +--- +title: dbsql +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`dbsql`__ service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources +
+
+alerts
+alerts_legacy
+dashboards
+permissions
+queries
+queries_legacy
+query_history
+
+
+statement_execution
+statement_execution_results
+warehouse_config
+warehouse_permission_levels
+warehouse_permissions
+warehouses
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/permissions/index.md new file mode 100644 index 0000000000..5a7a1ef929 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/permissions/index.md @@ -0,0 +1,70 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - permissions + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a permissions resource. + +## Overview + + + + +
Namepermissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a JSON representation of the access control list (ACL) for a specified object. | +| | `REPLACE` | | Sets the access control list (ACL) for a specified object. This operation will complete rewrite the ACL. | +| | `EXEC` | | Transfer ownership of a single object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.dbsql.permissions +WHERE objectId = '{{ objectId }}' AND +objectType = '{{ objectType }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.dbsql.permissions +SET { field = value } +WHERE objectId = '{{ objectId }}' AND +objectType = '{{ objectType }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/queries/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/queries/index.md new file mode 100644 index 0000000000..da32b15797 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/queries/index.md @@ -0,0 +1,190 @@ +--- +title: queries +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - queries + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a queries resource. + +## Overview + + + + +
Namequeries
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a query. | +| | `SELECT` | | Gets a list of queries accessible to the user, ordered by creation time. | +| | `INSERT` | | Creates a query. | +| | `DELETE` | | Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is permanently deleted after 30 days. | +| | `UPDATE` | | Updates a query. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +description, +create_time, +display_name, +last_modifier_user_name, +lifecycle_state, +owner_user_name, +parameters, +parent_path, +query_text, +run_as_mode, +tags, +update_time, +warehouse_id +FROM databricks_workspace.dbsql.queries +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +description, +create_time, +display_name, +last_modifier_user_name, +lifecycle_state, +owner_user_name, +parameters, +parent_path, +query_text, +run_as_mode, +tags, +update_time, +warehouse_id +FROM databricks_workspace.dbsql.queries +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queries resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.dbsql.queries ( +deployment_name, +data__query +) +SELECT +'{{ deployment_name }}', +'{{ query }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: query + value: + description: Example description + tags: + - Tag 1 + display_name: Example query + parent_path: /Workspace/Users/user@acme.com + query_text: SELECT 1 + parameters: + - name: foo + text_value: + value: bar + title: foo + warehouse_id: a7066a8ef796be84 + run_as_mode: OWNER + +``` + + + + +## `UPDATE` example + +Updates a queries resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.dbsql.queries +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a queries resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.dbsql.queries +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/queries_legacy/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/queries_legacy/index.md new file mode 100644 index 0000000000..fa79740f0e --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/queries_legacy/index.md @@ -0,0 +1,242 @@ +--- +title: queries_legacy +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - queries_legacy + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a queries_legacy resource. + +## Overview + + + + +
Namequeries_legacy
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `boolean` | +| | `object` | +| | `integer` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `object` | +| | `integer` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve a query object definition along with contextual permissions information about the currently authenticated user. | +| | `SELECT` | | Gets a list of queries. Optionally, this list can be filtered by a search term. | +| | `INSERT` | | Creates a new query definition. Queries created with this endpoint belong to the authenticated user making the request. | +| | `DELETE` | | Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and they cannot be used for alerts. The trash is deleted after 30 days. | +| | `UPDATE` | | Modify this query definition. | +| | `EXEC` | | Restore a query that has been moved to the trash. A restored query appears in list views and searches. You can use restored queries for alerts. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +description, +can_edit, +created_at, +data_source_id, +is_archived, +is_draft, +is_favorite, +is_safe, +last_modified_by, +last_modified_by_id, +latest_query_data_id, +options, +parent, +permission_tier, +query, +query_hash, +run_as_role, +tags, +updated_at, +user, +user_id, +visualizations +FROM databricks_workspace.dbsql.queries_legacy +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +description, +can_edit, +created_at, +data_source_id, +is_archived, +is_draft, +is_favorite, +is_safe, +last_modified_by, +last_modified_by_id, +latest_query_data_id, +options, +parent, +permission_tier, +query, +query_hash, +run_as_role, +tags, +updated_at, +user, +user_id, +visualizations +FROM databricks_workspace.dbsql.queries_legacy +WHERE query_id = '{{ query_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new queries_legacy resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.dbsql.queries_legacy ( +deployment_name, +data__data_source_id, +data__query, +data__name, +data__parent, +data__description, +data__options, +data__run_as_role, +data__tags +) +SELECT +'{{ deployment_name }}', +'{{ data_source_id }}', +'{{ query }}', +'{{ name }}', +'{{ parent }}', +'{{ description }}', +'{{ options }}', +'{{ run_as_role }}', +'{{ tags }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: data_source_id + value: 0c205e24-5db2-4940-adb1-fb13c7ce960b + - name: query + value: SELECT field FROM table WHERE field = {{ param }} + - name: name + value: Orders by month by customer + - name: parent + value: folders/2025532471912059 + - name: description + value: Summarizes total order dollars for customers in the Europe/Asia region. + - name: options + value: + parameters: + - title: customer + name: param + type: text + value: acme + - name: run_as_role + value: viewer + - name: tags + value: + - Payroll + +``` + + + + +## `UPDATE` example + +Updates a queries_legacy resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.dbsql.queries_legacy +SET { field = value } +WHERE query_id = '{{ query_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a queries_legacy resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.dbsql.queries_legacy +WHERE query_id = '{{ query_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/query_history/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/query_history/index.md new file mode 100644 index 0000000000..558f6559d2 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/query_history/index.md @@ -0,0 +1,91 @@ +--- +title: query_history +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - query_history + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a query_history resource. + +## Overview + + + + +
Namequery_history
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `integer` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `boolean` | +| | `string` | +| | `object` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List the history of queries through SQL warehouses, and serverless compute. | + +## `SELECT` examples + +```sql +SELECT +channel_used, +duration, +endpoint_id, +error_message, +executed_as_user_id, +executed_as_user_name, +execution_end_time_ms, +is_final, +lookup_key, +metrics, +plans_state, +query_end_time_ms, +query_id, +query_start_time_ms, +query_text, +rows_produced, +spark_ui_url, +statement_type, +status, +user_id, +user_name, +warehouse_id +FROM databricks_workspace.dbsql.query_history +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/statement_execution/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/statement_execution/index.md new file mode 100644 index 0000000000..9e5a501b4a --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/statement_execution/index.md @@ -0,0 +1,58 @@ +--- +title: statement_execution +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - statement_execution + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a statement_execution resource. + +## Overview + + + + +
Namestatement_execution
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `object` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | This request can be used to poll for the statement's status. When the | +| | `EXEC` | | Requests that an executing statement be canceled. Callers must poll for status to see the terminal state. | +| | `EXEC` | | Execute a SQL statement and optionally await its results for a specified time. | + +## `SELECT` examples + +```sql +SELECT +manifest, +result, +statement_id, +status +FROM databricks_workspace.dbsql.statement_execution +WHERE statement_id = '{{ statement_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/statement_execution_results/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/statement_execution_results/index.md new file mode 100644 index 0000000000..5f4c2eed8b --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/statement_execution_results/index.md @@ -0,0 +1,61 @@ +--- +title: statement_execution_results +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - statement_execution_results + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a statement_execution_results resource. + +## Overview + + + + +
Namestatement_execution_results
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `array` | +| | `integer` | +| | `string` | +| | `integer` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | After the statement execution has | + +## `SELECT` examples + +```sql +SELECT +chunk_index, +data_array, +next_chunk_index, +next_chunk_internal_link, +row_count, +row_offset +FROM databricks_workspace.dbsql.statement_execution_results +WHERE chunk_index = '{{ chunk_index }}' AND +statement_id = '{{ statement_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_config/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_config/index.md new file mode 100644 index 0000000000..556c8d6fa9 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_config/index.md @@ -0,0 +1,77 @@ +--- +title: warehouse_config +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - warehouse_config + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a warehouse_config resource. + +## Overview + + + + +
Namewarehouse_config
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `object` | +| | `array` | +| | `array` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the workspace level configuration that is shared by all SQL warehouses in a workspace. | +| | `REPLACE` | | Sets the workspace level configuration that is shared by all SQL warehouses in a workspace. | + +## `SELECT` examples + +```sql +SELECT +channel, +config_param, +data_access_config, +enabled_warehouse_types, +global_param, +google_service_account, +instance_profile_arn, +security_policy, +sql_configuration_parameters +FROM databricks_workspace.dbsql.warehouse_config +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a warehouse_config resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.dbsql.warehouse_config +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_permission_levels/index.md new file mode 100644 index 0000000000..957dcf2043 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: warehouse_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - warehouse_permission_levels + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a warehouse_permission_levels resource. + +## Overview + + + + +
Namewarehouse_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.dbsql.warehouse_permission_levels +WHERE warehouse_id = '{{ warehouse_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_permissions/index.md new file mode 100644 index 0000000000..ce5550faa2 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouse_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: warehouse_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - warehouse_permissions + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a warehouse_permissions resource. + +## Overview + + + + +
Namewarehouse_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a SQL warehouse. SQL warehouses can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on a SQL warehouse. SQL warehouses can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.dbsql.warehouse_permissions +WHERE warehouse_id = '{{ warehouse_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a warehouse_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.dbsql.warehouse_permissions +SET { field = value } +WHERE warehouse_id = '{{ warehouse_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a warehouse_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.dbsql.warehouse_permissions +SET { field = value } +WHERE warehouse_id = '{{ warehouse_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouses/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouses/index.md new file mode 100644 index 0000000000..035521872e --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/dbsql/warehouses/index.md @@ -0,0 +1,250 @@ +--- +title: warehouses +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - warehouses + - dbsql + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a warehouses resource. + +## Overview + + + + +
Namewarehouses
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `boolean` | +| | `boolean` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `integer` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the information for a single SQL warehouse. | +| | `SELECT` | | Lists all SQL warehouses that a user has manager permissions on. | +| | `INSERT` | | Creates a new SQL warehouse. | +| | `DELETE` | | Deletes a SQL warehouse. | +| | `REPLACE` | | Updates the configuration for a SQL warehouse. | +| | `EXEC` | | Starts a SQL warehouse. | +| | `EXEC` | | Stops a SQL warehouse. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +auto_stop_mins, +channel, +cluster_size, +creator_name, +enable_photon, +enable_serverless_compute, +health, +instance_profile_arn, +jdbc_url, +max_num_clusters, +min_num_clusters, +num_active_sessions, +num_clusters, +odbc_params, +spot_instance_policy, +state, +tags, +warehouse_type +FROM databricks_workspace.dbsql.warehouses +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +auto_stop_mins, +channel, +cluster_size, +creator_name, +enable_photon, +enable_serverless_compute, +health, +instance_profile_arn, +jdbc_url, +max_num_clusters, +min_num_clusters, +num_active_sessions, +num_clusters, +odbc_params, +spot_instance_policy, +state, +tags, +warehouse_type +FROM databricks_workspace.dbsql.warehouses +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new warehouses resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.dbsql.warehouses ( +deployment_name, +data__name, +data__cluster_size, +data__min_num_clusters, +data__max_num_clusters, +data__auto_stop_mins, +data__creator_name, +data__instance_profile_arn, +data__tags, +data__spot_instance_policy, +data__enable_photon, +data__channel, +data__enable_serverless_compute, +data__warehouse_type +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ cluster_size }}', +'{{ min_num_clusters }}', +'{{ max_num_clusters }}', +'{{ auto_stop_mins }}', +'{{ creator_name }}', +'{{ instance_profile_arn }}', +'{{ tags }}', +'{{ spot_instance_policy }}', +'{{ enable_photon }}', +'{{ channel }}', +'{{ enable_serverless_compute }}', +'{{ warehouse_type }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: cluster_size + value: string + - name: min_num_clusters + value: '1' + - name: max_num_clusters + value: 0 + - name: auto_stop_mins + value: '120' + - name: creator_name + value: string + - name: instance_profile_arn + value: string + - name: tags + value: + custom_tags: + - key: string + value: string + - name: spot_instance_policy + value: POLICY_UNSPECIFIED + - name: enable_photon + value: true + - name: channel + value: + name: CHANNEL_NAME_PREVIEW + dbsql_version: string + - name: enable_serverless_compute + value: true + - name: warehouse_type + value: TYPE_UNSPECIFIED + +``` + + + + +## `REPLACE` example + +Replaces a warehouses resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.dbsql.warehouses +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a warehouses resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.dbsql.warehouses +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/index.md new file mode 100644 index 0000000000..4f32ba1836 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/index.md @@ -0,0 +1,41 @@ +--- +title: deltalivetables +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - deltalivetables + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`deltalivetables`__ service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources +
+
+pipeline_events
+pipeline_permission_levels
+pipeline_permissions
+
+
+pipeline_updates
+pipelines
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_events/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_events/index.md new file mode 100644 index 0000000000..8c3c3b83d3 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_events/index.md @@ -0,0 +1,66 @@ +--- +title: pipeline_events +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - pipeline_events + - deltalivetables + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a pipeline_events resource. + +## Overview + + + + +
Namepipeline_events
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves events for a pipeline. | + +## `SELECT` examples + +```sql +SELECT +id, +error, +event_type, +level, +maturity_level, +message, +origin, +sequence, +timestamp +FROM databricks_workspace.deltalivetables.pipeline_events +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_permission_levels/index.md new file mode 100644 index 0000000000..fefe311064 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: pipeline_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - pipeline_permission_levels + - deltalivetables + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a pipeline_permission_levels resource. + +## Overview + + + + +
Namepipeline_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.deltalivetables.pipeline_permission_levels +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_permissions/index.md new file mode 100644 index 0000000000..2559948de5 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: pipeline_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - pipeline_permissions + - deltalivetables + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a pipeline_permissions resource. + +## Overview + + + + +
Namepipeline_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a pipeline. Pipelines can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on a pipeline. Pipelines can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.deltalivetables.pipeline_permissions +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a pipeline_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.deltalivetables.pipeline_permissions +SET { field = value } +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a pipeline_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.deltalivetables.pipeline_permissions +SET { field = value } +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_updates/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_updates/index.md new file mode 100644 index 0000000000..fe34a07982 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipeline_updates/index.md @@ -0,0 +1,106 @@ +--- +title: pipeline_updates +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - pipeline_updates + - deltalivetables + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a pipeline_updates resource. + +## Overview + + + + +
Namepipeline_updates
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `integer` | +| | `boolean` | +| | `array` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `boolean` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an update from an active pipeline. | +| | `SELECT` | | List updates for an active pipeline. | +| | `EXEC` | | Starts a new update for the pipeline. If there is already an active update for the pipeline, the request will fail and the active update will remain running. | + +## `SELECT` examples + + + + +```sql +SELECT +cause, +cluster_id, +config, +creation_time, +full_refresh, +full_refresh_selection, +pipeline_id, +refresh_selection, +state, +update_id, +validate_only +FROM databricks_workspace.deltalivetables.pipeline_updates +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +cause, +cluster_id, +config, +creation_time, +full_refresh, +full_refresh_selection, +pipeline_id, +refresh_selection, +state, +update_id, +validate_only +FROM databricks_workspace.deltalivetables.pipeline_updates +WHERE pipeline_id = '{{ pipeline_id }}' AND +update_id = '{{ update_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipelines/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipelines/index.md new file mode 100644 index 0000000000..b2647f3ac2 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltalivetables/pipelines/index.md @@ -0,0 +1,183 @@ +--- +title: pipelines +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - pipelines + - deltalivetables + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a pipelines resource. + +## Overview + + + + +
Namepipelines
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | | +| | `SELECT` | | Lists pipelines defined in the Delta Live Tables system. | +| | `INSERT` | | Creates a new data processing pipeline based on the requested configuration. If successful, this method returns the ID of the new pipeline. | +| | `DELETE` | | Deletes a pipeline. | +| | `UPDATE` | | Updates a pipeline with the supplied configuration. | +| | `EXEC` | | Stops the pipeline by canceling the active update. If there is no active update for the pipeline, this request is a no-op. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +cluster_id, +creator_user_name, +latest_updates, +pipeline_id, +run_as_user_name, +spec, +state +FROM databricks_workspace.deltalivetables.pipelines +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +cluster_id, +creator_user_name, +latest_updates, +pipeline_id, +run_as_user_name, +spec, +state +FROM databricks_workspace.deltalivetables.pipelines +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new pipelines resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.deltalivetables.pipelines ( +deployment_name, +data__continuous, +data__name, +data__clusters, +data__libraries, +data__storage +) +SELECT +'{{ deployment_name }}', +'{{ continuous }}', +'{{ name }}', +'{{ clusters }}', +'{{ libraries }}', +'{{ storage }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: continuous + value: false + - name: name + value: Wikipedia pipeline (SQL) + - name: clusters + value: + - label: default + autoscale: + min_workers: 1 + max_workers: 5 + mode: ENHANCED + - name: libraries + value: + - notebook: + path: /Users/username/DLT Notebooks/Delta Live Tables quickstart (SQL) + - name: storage + value: /Users/username/data + +``` + + + + +## `UPDATE` example + +Updates a pipelines resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.deltalivetables.pipelines +SET { field = value } +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a pipelines resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.deltalivetables.pipelines +WHERE pipeline_id = '{{ pipeline_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/index.md new file mode 100644 index 0000000000..64e1c9eb05 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/index.md @@ -0,0 +1,44 @@ +--- +title: deltasharing +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`deltasharing`__ service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources +
+
+provider_shares
+providers
+recipient_activation_token
+recipient_activation_url
+
+
+recipient_share_permissions
+recipients
+share_permissions
+shares
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/provider_shares/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/provider_shares/index.md new file mode 100644 index 0000000000..f30b23f109 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/provider_shares/index.md @@ -0,0 +1,50 @@ +--- +title: provider_shares +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_shares + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_shares resource. + +## Overview + + + + +
Nameprovider_shares
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an array of a specified provider's shares within the metastore where: | + +## `SELECT` examples + +```sql +SELECT +name +FROM databricks_workspace.deltasharing.provider_shares +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/providers/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/providers/index.md new file mode 100644 index 0000000000..305468f919 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/providers/index.md @@ -0,0 +1,189 @@ +--- +title: providers +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - providers + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a providers resource. + +## Overview + + + + +
Nameproviders
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a specific authentication provider. The caller must supply the name of the provider, and must either be a metastore admin or the owner of the provider. | +| | `SELECT` | | Gets an array of available authentication providers. The caller must either be a metastore admin or the owner of the providers. Providers not owned by the caller are not included in the response. There is no guarantee of a specific ordering of the elements in the array. | +| | `INSERT` | | Creates a new authentication provider minimally based on a name and authentication type. The caller must be an admin on the metastore. | +| | `DELETE` | | Deletes an authentication provider, if the caller is a metastore admin or is the owner of the provider. | +| | `UPDATE` | | Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider. If the update changes the provider name, the caller must be both a metastore admin and the owner of the provider. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +authentication_type, +cloud, +comment, +created_at, +created_by, +data_provider_global_metastore_id, +metastore_id, +owner, +recipient_profile, +recipient_profile_str, +region, +updated_at, +updated_by +FROM databricks_workspace.deltasharing.providers +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +authentication_type, +cloud, +comment, +created_at, +created_by, +data_provider_global_metastore_id, +metastore_id, +owner, +recipient_profile, +recipient_profile_str, +region, +updated_at, +updated_by +FROM databricks_workspace.deltasharing.providers +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new providers resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.deltasharing.providers ( +deployment_name, +data__name, +data__authentication_type, +data__comment, +data__recipient_profile_str +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ authentication_type }}', +'{{ comment }}', +'{{ recipient_profile_str }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: authentication_type + value: TOKEN + - name: comment + value: string + - name: recipient_profile_str + value: string + +``` + + + + +## `UPDATE` example + +Updates a providers resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.deltasharing.providers +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a providers resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.deltasharing.providers +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_activation_token/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_activation_token/index.md new file mode 100644 index 0000000000..59beda2d02 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_activation_token/index.md @@ -0,0 +1,56 @@ +--- +title: recipient_activation_token +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - recipient_activation_token + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a recipient_activation_token resource. + +## Overview + + + + +
Namerecipient_activation_token
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve access token with an activation url. This is a public API without any authentication. | + +## `SELECT` examples + +```sql +SELECT +bearerToken, +endpoint, +expirationTime, +shareCredentialsVersion +FROM databricks_workspace.deltasharing.recipient_activation_token +WHERE activation_url = '{{ activation_url }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_activation_url/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_activation_url/index.md new file mode 100644 index 0000000000..6ea7556ffe --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_activation_url/index.md @@ -0,0 +1,37 @@ +--- +title: recipient_activation_url +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - recipient_activation_url + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a recipient_activation_url resource. + +## Overview + + + + +
Namerecipient_activation_url
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `EXEC` | | Gets an activation URL for a share. | diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_share_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_share_permissions/index.md new file mode 100644 index 0000000000..a061628167 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipient_share_permissions/index.md @@ -0,0 +1,52 @@ +--- +title: recipient_share_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - recipient_share_permissions + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a recipient_share_permissions resource. + +## Overview + + + + +
Namerecipient_share_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the share permissions for the specified Recipient. The caller must be a metastore admin or the owner of the Recipient. | + +## `SELECT` examples + +```sql +SELECT +privilege_assignments, +share_name +FROM databricks_workspace.deltasharing.recipient_share_permissions +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipients/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipients/index.md new file mode 100644 index 0000000000..460b66a05e --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/recipients/index.md @@ -0,0 +1,227 @@ +--- +title: recipients +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - recipients + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a recipients resource. + +## Overview + + + + +
Namerecipients
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `array` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a share recipient from the metastore if: | +| | `SELECT` | | Gets an array of all share recipients within the current metastore where: | +| | `INSERT` | | Creates a new recipient with the delta sharing authentication type in the metastore. The caller must be a metastore admin or has the | +| | `DELETE` | | Deletes the specified recipient from the metastore. The caller must be the owner of the recipient. | +| | `UPDATE` | | Updates an existing recipient in the metastore. The caller must be a metastore admin or the owner of the recipient. If the recipient name will be updated, the user must be both a metastore admin and the owner of the recipient. | +| | `EXEC` | | Refreshes the specified recipient's delta sharing authentication token with the provided token info. The caller must be the owner of the recipient. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +activated, +activation_url, +authentication_type, +cloud, +comment, +created_at, +created_by, +data_recipient_global_metastore_id, +ip_access_list, +metastore_id, +owner, +properties_kvpairs, +region, +sharing_code, +tokens, +updated_at, +updated_by +FROM databricks_workspace.deltasharing.recipients +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +activated, +activation_url, +authentication_type, +cloud, +comment, +created_at, +created_by, +data_recipient_global_metastore_id, +ip_access_list, +metastore_id, +owner, +properties_kvpairs, +region, +sharing_code, +tokens, +updated_at, +updated_by +FROM databricks_workspace.deltasharing.recipients +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new recipients resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.deltasharing.recipients ( +deployment_name, +data__name, +data__authentication_type, +data__owner, +data__comment, +data__ip_access_list, +data__properties_kvpairs, +data__data_recipient_global_metastore_id, +data__sharing_code, +data__expiration_time +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ authentication_type }}', +'{{ owner }}', +'{{ comment }}', +'{{ ip_access_list }}', +'{{ properties_kvpairs }}', +'{{ data_recipient_global_metastore_id }}', +'{{ sharing_code }}', +'{{ expiration_time }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: authentication_type + value: TOKEN + - name: owner + value: string + - name: comment + value: string + - name: ip_access_list + value: + allowed_ip_addresses: + - string + - name: properties_kvpairs + value: + properties: + property1: string + property2: string + - name: data_recipient_global_metastore_id + value: string + - name: sharing_code + value: string + - name: expiration_time + value: 0 + +``` + + + + +## `UPDATE` example + +Updates a recipients resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.deltasharing.recipients +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a recipients resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.deltasharing.recipients +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/share_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/share_permissions/index.md new file mode 100644 index 0000000000..60e6ff3d8c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/share_permissions/index.md @@ -0,0 +1,65 @@ +--- +title: share_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - share_permissions + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a share_permissions resource. + +## Overview + + + + +
Nameshare_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions for a data share from the metastore. The caller must be a metastore admin or the owner of the share. | +| | `UPDATE` | | Updates the permissions for a data share in the metastore. The caller must be a metastore admin or an owner of the share. | + +## `SELECT` examples + +```sql +SELECT +principal, +privileges +FROM databricks_workspace.deltasharing.share_permissions +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a share_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.deltasharing.share_permissions +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/shares/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/shares/index.md new file mode 100644 index 0000000000..3b1c003b42 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/deltasharing/shares/index.md @@ -0,0 +1,173 @@ +--- +title: shares +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - shares + - deltasharing + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a shares resource. + +## Overview + + + + +
Nameshares
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a data object share from the metastore. The caller must be a metastore admin or the owner of the share. | +| | `SELECT` | | Gets an array of data object shares from the metastore. The caller must be a metastore admin or the owner of the share. There is no guarantee of a specific ordering of the elements in the array. | +| | `INSERT` | | Creates a new share for data objects. Data objects can be added after creation with | +| | `DELETE` | | Deletes a data object share from the metastore. The caller must be an owner of the share. | +| | `UPDATE` | | Updates the share with the changes and data objects in the request. The caller must be the owner of the share or a metastore admin. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +comment, +created_at, +created_by, +objects, +owner, +storage_location, +storage_root, +updated_at, +updated_by +FROM databricks_workspace.deltasharing.shares +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +comment, +created_at, +created_by, +objects, +owner, +storage_location, +storage_root, +updated_at, +updated_by +FROM databricks_workspace.deltasharing.shares +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new shares resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.deltasharing.shares ( +deployment_name, +data__name, +data__comment, +data__storage_root +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ comment }}', +'{{ storage_root }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: comment + value: string + - name: storage_root + value: string + +``` + + + + +## `UPDATE` example + +Updates a shares resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.deltasharing.shares +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a shares resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.deltasharing.shares +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_directories/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_directories/index.md new file mode 100644 index 0000000000..1a54731f89 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_directories/index.md @@ -0,0 +1,96 @@ +--- +title: dbfs_directories +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dbfs_directories + - filemanagement + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dbfs_directories resource. + +## Overview + + + + +
Namedbfs_directories
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `boolean` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List the contents of a directory, or details of the file. If the file or directory does not exist, this call throws an exception with | +| | `INSERT` | | Creates the given directory and necessary parent directories if they do not exist. If a file (not a directory) exists at any prefix of the input path, this call throws an exception with | + +## `SELECT` examples + +```sql +SELECT +file_size, +is_dir, +modification_time, +path +FROM databricks_workspace.filemanagement.dbfs_directories +WHERE path = '{{ path }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dbfs_directories resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.filemanagement.dbfs_directories ( +deployment_name, +data__path +) +SELECT +'{{ deployment_name }}', +'{{ path }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: path + value: /mnt/foo + +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_files/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_files/index.md new file mode 100644 index 0000000000..0ff1ea452d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_files/index.md @@ -0,0 +1,54 @@ +--- +title: dbfs_files +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dbfs_files + - filemanagement + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dbfs_files resource. + +## Overview + + + + +
Namedbfs_files
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns the contents of a file. If the file does not exist, this call throws an exception with | +| | `EXEC` | | Moves a file from one location to another location within DBFS. If the source file does not exist, this call throws an exception with | +| | `EXEC` | | Uploads a file through the use of multipart form post. It is mainly used for streaming uploads, but can also be used as a convenient single call for data upload. | + +## `SELECT` examples + +```sql +SELECT +bytes_read, +data +FROM databricks_workspace.filemanagement.dbfs_files +WHERE path = '{{ path }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_objects/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_objects/index.md new file mode 100644 index 0000000000..8fcc3305f4 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_objects/index.md @@ -0,0 +1,67 @@ +--- +title: dbfs_objects +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dbfs_objects + - filemanagement + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dbfs_objects resource. + +## Overview + + + + +
Namedbfs_objects
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `boolean` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the file information for a file or directory. If the file or directory does not exist, this call throws an exception with | +| | `DELETE` | | Delete the file or directory (optionally recursively delete all files in the directory). This call throws an exception with | + +## `SELECT` examples + +```sql +SELECT +file_size, +is_dir, +modification_time, +path +FROM databricks_workspace.filemanagement.dbfs_objects +WHERE path = '{{ path }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a dbfs_objects resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.filemanagement.dbfs_objects +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_streams/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_streams/index.md new file mode 100644 index 0000000000..e463bbff67 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/dbfs_streams/index.md @@ -0,0 +1,92 @@ +--- +title: dbfs_streams +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dbfs_streams + - filemanagement + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dbfs_streams resource. + +## Overview + + + + +
Namedbfs_streams
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `INSERT` | | Opens a stream to write to a file and returns a handle to this stream. There is a 10 minute idle timeout on this handle. If a file or directory already exists on the given path and | +| | `DELETE` | | Closes the stream specified by the input handle. If the handle does not exist, this call throws an exception with | +| | `EXEC` | | Appends a block of data to the stream specified by the input handle. If the handle does not exist, this call will throw an exception with | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dbfs_streams resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.filemanagement.dbfs_streams ( +deployment_name, +data__path, +data__overwrite +) +SELECT +'{{ deployment_name }}', +'{{ path }}', +'{{ overwrite }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: path + value: /mnt/foo + - name: overwrite + value: false + +``` + + + + +## `DELETE` example + +Deletes a dbfs_streams resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.filemanagement.dbfs_streams +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/directories/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/directories/index.md new file mode 100644 index 0000000000..be16aa19a3 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/directories/index.md @@ -0,0 +1,85 @@ +--- +title: directories +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - directories + - filemanagement + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a directories resource. + +## Overview + + + + +
Namedirectories
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `INSERT` | | Creates an empty directory. If necessary, also creates any parent directories of the new, empty directory (like the shell command | +| | `DELETE` | | Deletes an empty directory. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new directories resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.filemanagement.directories ( +directory_path, +deployment_name +) +SELECT +'{{ directory_path }}', +'{{ deployment_name }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: [] # No request body parameters required +``` + + + + +## `DELETE` example + +Deletes a directories resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.filemanagement.directories +WHERE directory_path = '{{ directory_path }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/directory_contents/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/directory_contents/index.md new file mode 100644 index 0000000000..13de7106da --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/directory_contents/index.md @@ -0,0 +1,58 @@ +--- +title: directory_contents +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - directory_contents + - filemanagement + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a directory_contents resource. + +## Overview + + + + +
Namedirectory_contents
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `boolean` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns the contents of a directory. If there is no directory at the specified path, the API returns a HTTP 404 error. | + +## `SELECT` examples + +```sql +SELECT +name, +file_size, +is_directory, +last_modified, +path +FROM databricks_workspace.filemanagement.directory_contents +WHERE directory_path = '{{ directory_path }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/files/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/files/index.md new file mode 100644 index 0000000000..572f307257 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/files/index.md @@ -0,0 +1,50 @@ +--- +title: files +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - files + - filemanagement + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a files resource. + +## Overview + + + + +
Namefiles
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | Deletes a file. If the request is successful, there is no response body. | +| | `EXEC` | | Downloads a file. The file contents are the response body. This is a standard HTTP file download, not a JSON RPC. It supports the Range and If-Unmodified-Since HTTP headers. | +| | `EXEC` | | Uploads a file of up to 5 GiB. The file contents should be sent as the request body as raw bytes (an octet stream); do not encode or otherwise modify the bytes before sending. The contents of the resulting file will be exactly the bytes sent in the request body. If the request is successful, there is no response body. | + +## `DELETE` example + +Deletes a files resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.filemanagement.files +WHERE file_path = '{{ file_path }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/index.md new file mode 100644 index 0000000000..ed01fdd06d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/filemanagement/index.md @@ -0,0 +1,43 @@ +--- +title: filemanagement +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - filemanagement + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`filemanagement`__ service documentation. + +:::info Service Summary + +
+
+total resources: 7
+
+
+ +::: + +## Resources +
+
+dbfs_directories
+dbfs_files
+dbfs_objects
+dbfs_streams
+
+
+directories
+directory_contents
+files
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/assignable_roles/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/assignable_roles/index.md new file mode 100644 index 0000000000..d9d3415577 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/assignable_roles/index.md @@ -0,0 +1,50 @@ +--- +title: assignable_roles +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - assignable_roles + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a assignable_roles resource. + +## Overview + + + + +
Nameassignable_roles
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets all the roles that can be granted on an account-level resource. A role is grantable if the rule set on the resource can contain an access rule of the role. | + +## `SELECT` examples + +```sql +SELECT +name +FROM databricks_workspace.iam.assignable_roles +WHERE resource = '{{ resource }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/currentuser/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/currentuser/index.md new file mode 100644 index 0000000000..b16f2afe88 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/currentuser/index.md @@ -0,0 +1,69 @@ +--- +title: currentuser +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - currentuser + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a currentuser resource. + +## Overview + + + + +
Namecurrentuser
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `boolean` | +| | `string` | +| | `array` | +| | `array` | +| | `string` | +| | `array` | +| | `array` | +| | `array` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get details about the current method caller's identity. | + +## `SELECT` examples + +```sql +SELECT +id, +name, +active, +displayName, +emails, +entitlements, +externalId, +groups, +roles, +schemas, +userName +FROM databricks_workspace.iam.currentuser +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/groups/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/groups/index.md new file mode 100644 index 0000000000..53b81cf02c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/groups/index.md @@ -0,0 +1,224 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - groups + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a groups resource. + +## Overview + + + + +
Namegroups
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `array` | +| | `array` | +| | `array` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the information for a specific group in the Databricks workspace. | +| | `SELECT` | | Gets all details of the groups associated with the Databricks workspace. | +| | `INSERT` | | Creates a group in the Databricks workspace with a unique name, using the supplied group details. | +| | `DELETE` | | Deletes a group from the Databricks workspace. | +| | `UPDATE` | | Partially updates the details of a group. | +| | `UPDATE` | | Updates the details of a group by replacing the entire group entity. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +displayName, +entitlements, +externalId, +groups, +members, +roles, +schemas +FROM databricks_workspace.iam.groups +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +displayName, +entitlements, +externalId, +groups, +members, +roles, +schemas +FROM databricks_workspace.iam.groups +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new groups resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.iam.groups ( +deployment_name, +data__schemas, +data__displayName, +data__members, +data__groups, +data__roles, +data__entitlements, +data__externalId +) +SELECT +'{{ deployment_name }}', +'{{ schemas }}', +'{{ displayName }}', +'{{ members }}', +'{{ groups }}', +'{{ roles }}', +'{{ entitlements }}', +'{{ externalId }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: schemas + value: + - urn:ietf:params:scim:schemas:core:2.0:Group + - name: displayName + value: string + - name: members + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: groups + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: roles + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: entitlements + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: externalId + value: string + +``` + + + + +## `UPDATE` example + +Updates a groups resource. + + + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.groups +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.groups +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + +## `DELETE` example + +Deletes a groups resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.iam.groups +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/index.md new file mode 100644 index 0000000000..f8f2a489a5 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/index.md @@ -0,0 +1,46 @@ +--- +title: iam +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`iam`__ service documentation. + +:::info Service Summary + +
+
+total resources: 10
+
+
+ +::: + +## Resources +
+
+assignable_roles
+currentuser
+groups
+permission_levels
+permissions
+
+
+rule_sets
+service_principals
+user_permission_levels
+user_permissions
+users
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/permission_levels/index.md new file mode 100644 index 0000000000..9e07a93b8b --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/permission_levels/index.md @@ -0,0 +1,53 @@ +--- +title: permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - permission_levels + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a permission_levels resource. + +## Overview + + + + +
Namepermission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.iam.permission_levels +WHERE request_object_id = '{{ request_object_id }}' AND +request_object_type = '{{ request_object_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/permissions/index.md new file mode 100644 index 0000000000..ee5fb8ec63 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/permissions/index.md @@ -0,0 +1,83 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - permissions + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a permissions resource. + +## Overview + + + + +
Namepermissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of an object. Objects can inherit permissions from their parent objects or root object. | +| | `UPDATE` | | Updates the permissions on an object. Objects can inherit permissions from their parent objects or root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.iam.permissions +WHERE request_object_id = '{{ request_object_id }}' AND +request_object_type = '{{ request_object_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.permissions +SET { field = value } +WHERE request_object_id = '{{ request_object_id }}' AND +request_object_type = '{{ request_object_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.iam.permissions +SET { field = value } +WHERE request_object_id = '{{ request_object_id }}' AND +request_object_type = '{{ request_object_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/rule_sets/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/rule_sets/index.md new file mode 100644 index 0000000000..e2ebe31f99 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/rule_sets/index.md @@ -0,0 +1,67 @@ +--- +title: rule_sets +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - rule_sets + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a rule_sets resource. + +## Overview + + + + +
Namerule_sets
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported. | +| | `UPDATE` | | Replace the rules of a rule set. First, use a GET rule set request to read the current version of the rule set before modifying it. This pattern helps prevent conflicts between concurrent updates. | + +## `SELECT` examples + +```sql +SELECT +name, +etag, +grant_rules +FROM databricks_workspace.iam.rule_sets +WHERE etag = '{{ etag }}' AND +name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a rule_sets resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.rule_sets +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/service_principals/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/service_principals/index.md new file mode 100644 index 0000000000..41fcd8b48f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/service_principals/index.md @@ -0,0 +1,226 @@ +--- +title: service_principals +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - service_principals + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a service_principals resource. + +## Overview + + + + +
Nameservice_principals
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `array` | +| | `array` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the details for a single service principal define in the Databricks workspace. | +| | `SELECT` | | Gets the set of service principals associated with a Databricks workspace. | +| | `INSERT` | | Creates a new service principal in the Databricks workspace. | +| | `DELETE` | | Delete a single service principal in the Databricks workspace. | +| | `UPDATE` | | Partially updates the details of a single service principal in the Databricks workspace. | +| | `UPDATE` | | Updates the details of a single service principal. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +active, +applicationId, +displayName, +entitlements, +externalId, +groups, +roles, +schemas +FROM databricks_workspace.iam.service_principals +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +active, +applicationId, +displayName, +entitlements, +externalId, +groups, +roles, +schemas +FROM databricks_workspace.iam.service_principals +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_principals resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.iam.service_principals ( +deployment_name, +data__schemas, +data__applicationId, +data__displayName, +data__groups, +data__roles, +data__entitlements, +data__externalId, +data__active +) +SELECT +'{{ deployment_name }}', +'{{ schemas }}', +'{{ applicationId }}', +'{{ displayName }}', +'{{ groups }}', +'{{ roles }}', +'{{ entitlements }}', +'{{ externalId }}', +'{{ active }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: schemas + value: + - urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal + - name: applicationId + value: 97ab27fa-30e2-43e3-92a3-160e80f4c0d5 + - name: displayName + value: etl-service + - name: groups + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: roles + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: entitlements + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: externalId + value: string + - name: active + value: true + +``` + + + + +## `UPDATE` example + +Updates a service_principals resource. + + + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.service_principals +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.service_principals +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + +## `DELETE` example + +Deletes a service_principals resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.iam.service_principals +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/user_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/user_permission_levels/index.md new file mode 100644 index 0000000000..ae7b50f671 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/user_permission_levels/index.md @@ -0,0 +1,51 @@ +--- +title: user_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - user_permission_levels + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a user_permission_levels resource. + +## Overview + + + + +
Nameuser_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.iam.user_permission_levels +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/user_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/user_permissions/index.md new file mode 100644 index 0000000000..029c5c3830 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/user_permissions/index.md @@ -0,0 +1,77 @@ +--- +title: user_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - user_permissions + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a user_permissions resource. + +## Overview + + + + +
Nameuser_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of all passwords. Passwords can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on all passwords. Passwords can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.iam.user_permissions +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a user_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.user_permissions +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a user_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.iam.user_permissions +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/iam/users/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/users/index.md new file mode 100644 index 0000000000..f564fc0c80 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/iam/users/index.md @@ -0,0 +1,247 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - users + - iam + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a users resource. + +## Overview + + + + +
Nameusers
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `boolean` | +| | `string` | +| | `array` | +| | `array` | +| | `string` | +| | `array` | +| | `array` | +| | `array` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets information for a specific user in Databricks workspace. | +| | `SELECT` | | Gets details for all the users associated with a Databricks workspace. | +| | `INSERT` | | Creates a new user in the Databricks workspace. This new user will also be added to the Databricks account. | +| | `DELETE` | | Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the user. | +| | `UPDATE` | | Partially updates a user resource by applying the supplied operations on specific user attributes. | +| | `UPDATE` | | Replaces a user's information with the data supplied in request. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +active, +displayName, +emails, +entitlements, +externalId, +groups, +roles, +schemas, +userName +FROM databricks_workspace.iam.users +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +active, +displayName, +emails, +entitlements, +externalId, +groups, +roles, +schemas, +userName +FROM databricks_workspace.iam.users +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new users resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.iam.users ( +deployment_name, +data__schemas, +data__userName, +data__emails, +data__name, +data__displayName, +data__groups, +data__roles, +data__entitlements, +data__externalId, +data__active +) +SELECT +'{{ deployment_name }}', +'{{ schemas }}', +'{{ userName }}', +'{{ emails }}', +'{{ name }}', +'{{ displayName }}', +'{{ groups }}', +'{{ roles }}', +'{{ entitlements }}', +'{{ externalId }}', +'{{ active }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: schemas + value: + - urn:ietf:params:scim:schemas:core:2.0:User + - name: userName + value: user@example.com + - name: emails + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: name + value: + givenName: string + familyName: string + - name: displayName + value: string + - name: groups + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: roles + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: entitlements + value: + - $ref: string + value: string + display: string + primary: true + type: string + - name: externalId + value: string + - name: active + value: true + +``` + + + + +## `UPDATE` example + +Updates a users resource. + + + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.users +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + +```sql +/*+ update */ +UPDATE databricks_workspace.iam.users +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + +## `DELETE` example + +Deletes a users resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.iam.users +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboard_schedules/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboard_schedules/index.md new file mode 100644 index 0000000000..a455f5999c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboard_schedules/index.md @@ -0,0 +1,182 @@ +--- +title: dashboard_schedules +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dashboard_schedules + - lakeview + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dashboard_schedules resource. + +## Overview + + + + +
Namedashboard_schedules
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | | +| | `SELECT` | | | +| | `INSERT` | | | +| | `DELETE` | | | +| | `UPDATE` | | | + +## `SELECT` examples + + + + +```sql +SELECT +create_time, +cron_schedule, +dashboard_id, +display_name, +etag, +pause_status, +schedule_id, +update_time, +warehouse_id +FROM databricks_workspace.lakeview.dashboard_schedules +WHERE dashboard_id = '{{ dashboard_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +create_time, +cron_schedule, +dashboard_id, +display_name, +etag, +pause_status, +schedule_id, +update_time, +warehouse_id +FROM databricks_workspace.lakeview.dashboard_schedules +WHERE dashboard_id = '{{ dashboard_id }}' AND +schedule_id = '{{ schedule_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dashboard_schedules resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.lakeview.dashboard_schedules ( +deployment_name, +data__cron_schedule, +data__pause_status, +data__display_name, +data__etag, +data__warehouse_id +) +SELECT +'{{ deployment_name }}', +'{{ cron_schedule }}', +'{{ pause_status }}', +'{{ display_name }}', +'{{ etag }}', +'{{ warehouse_id }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: cron_schedule + value: + quartz_cron_expression: 0 0 8 * * ? + timezone_id: Europe/London + - name: pause_status + value: UNPAUSED + - name: display_name + value: Monthly Traffic Report Snapshot + - name: etag + value: '80611980' + - name: warehouse_id + value: 47bb1c472649e711 + +``` + + + + +## `UPDATE` example + +Updates a dashboard_schedules resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.lakeview.dashboard_schedules +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a dashboard_schedules resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.lakeview.dashboard_schedules +WHERE dashboard_id = '{{ dashboard_id }}' AND +schedule_id = '{{ schedule_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboard_subscriptions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboard_subscriptions/index.md new file mode 100644 index 0000000000..ddf8e58da6 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboard_subscriptions/index.md @@ -0,0 +1,158 @@ +--- +title: dashboard_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dashboard_subscriptions + - lakeview + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dashboard_subscriptions resource. + +## Overview + + + + +
Namedashboard_subscriptions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | | +| | `SELECT` | | | +| | `INSERT` | | | +| | `DELETE` | | | + +## `SELECT` examples + + + + +```sql +SELECT +create_time, +created_by_user_id, +dashboard_id, +etag, +schedule_id, +subscriber, +subscription_id, +update_time +FROM databricks_workspace.lakeview.dashboard_subscriptions +WHERE dashboard_id = '{{ dashboard_id }}' AND +schedule_id = '{{ schedule_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +create_time, +created_by_user_id, +dashboard_id, +etag, +schedule_id, +subscriber, +subscription_id, +update_time +FROM databricks_workspace.lakeview.dashboard_subscriptions +WHERE dashboard_id = '{{ dashboard_id }}' AND +schedule_id = '{{ schedule_id }}' AND +subscription_id = '{{ subscription_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dashboard_subscriptions resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.lakeview.dashboard_subscriptions ( +deployment_name, +data__subscriber, +data__etag +) +SELECT +'{{ deployment_name }}', +'{{ subscriber }}', +'{{ etag }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: subscriber + value: + user_subscriber: + user_id: '3294322584244938' + - name: etag + value: '80611980' + +``` + + + + +## `DELETE` example + +Deletes a dashboard_subscriptions resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.lakeview.dashboard_subscriptions +WHERE dashboard_id = '{{ dashboard_id }}' AND +schedule_id = '{{ schedule_id }}' AND +subscription_id = '{{ subscription_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboards/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboards/index.md new file mode 100644 index 0000000000..cb5dfe3b0a --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboards/index.md @@ -0,0 +1,183 @@ +--- +title: dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dashboards + - lakeview + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dashboards resource. + +## Overview + + + + +
Namedashboards
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a draft dashboard. | +| | `SELECT` | | | +| | `INSERT` | | Create a draft dashboard. | +| | `DELETE` | | Trash a dashboard. | +| | `UPDATE` | | Update a draft dashboard. | +| | `EXEC` | | Migrates a classic SQL dashboard to Lakeview. | +| | `EXEC` | | Publish the current draft dashboard. | +| | `EXEC` | | Unpublish the dashboard. | + +## `SELECT` examples + + + + +```sql +SELECT +create_time, +dashboard_id, +display_name, +etag, +lifecycle_state, +parent_path, +path, +serialized_dashboard, +update_time, +warehouse_id +FROM databricks_workspace.lakeview.dashboards +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +create_time, +dashboard_id, +display_name, +etag, +lifecycle_state, +parent_path, +path, +serialized_dashboard, +update_time, +warehouse_id +FROM databricks_workspace.lakeview.dashboards +WHERE dashboard_id = '{{ dashboard_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new dashboards resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.lakeview.dashboards ( +deployment_name, +data__display_name, +data__warehouse_id, +data__etag, +data__serialized_dashboard, +data__parent_path +) +SELECT +'{{ deployment_name }}', +'{{ display_name }}', +'{{ warehouse_id }}', +'{{ etag }}', +'{{ serialized_dashboard }}', +'{{ parent_path }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: display_name + value: Monthly Traffic Report + - name: warehouse_id + value: 47bb1c472649e711 + - name: etag + value: '80611980' + - name: serialized_dashboard + value: '{"pages":[{"name":"b532570b","displayName":"New Page"}]}' + - name: parent_path + value: /path/to/dir + +``` + + + + +## `UPDATE` example + +Updates a dashboards resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.lakeview.dashboards +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a dashboards resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.lakeview.dashboards +WHERE dashboard_id = '{{ dashboard_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboards_published/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboards_published/index.md new file mode 100644 index 0000000000..c7b0536de3 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/dashboards_published/index.md @@ -0,0 +1,56 @@ +--- +title: dashboards_published +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dashboards_published + - lakeview + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dashboards_published resource. + +## Overview + + + + +
Namedashboards_published
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get the current published dashboard. | + +## `SELECT` examples + +```sql +SELECT +display_name, +embed_credentials, +revision_create_time, +warehouse_id +FROM databricks_workspace.lakeview.dashboards_published +WHERE dashboard_id = '{{ dashboard_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/index.md new file mode 100644 index 0000000000..e88fbe409f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/lakeview/index.md @@ -0,0 +1,40 @@ +--- +title: lakeview +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - lakeview + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`lakeview`__ service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+
+dashboard_schedules
+dashboard_subscriptions
+
+
+dashboards
+dashboards_published
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_artifacts/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_artifacts/index.md new file mode 100644 index 0000000000..96a0c2d47b --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_artifacts/index.md @@ -0,0 +1,53 @@ +--- +title: experiment_artifacts +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - experiment_artifacts + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a experiment_artifacts resource. + +## Overview + + + + +
Nameexperiment_artifacts
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List artifacts for a run. Takes an optional | + +## `SELECT` examples + +```sql +SELECT +files, +next_page_token, +root_uri +FROM databricks_workspace.machinelearning.experiment_artifacts +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_permission_levels/index.md new file mode 100644 index 0000000000..9d87d4c97f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: experiment_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - experiment_permission_levels + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a experiment_permission_levels resource. + +## Overview + + + + +
Nameexperiment_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.machinelearning.experiment_permission_levels +WHERE experiment_id = '{{ experiment_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_permissions/index.md new file mode 100644 index 0000000000..4e92d70cc0 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: experiment_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - experiment_permissions + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a experiment_permissions resource. + +## Overview + + + + +
Nameexperiment_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of an experiment. Experiments can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on an experiment. Experiments can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.machinelearning.experiment_permissions +WHERE experiment_id = '{{ experiment_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a experiment_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.machinelearning.experiment_permissions +SET { field = value } +WHERE experiment_id = '{{ experiment_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a experiment_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.machinelearning.experiment_permissions +SET { field = value } +WHERE experiment_id = '{{ experiment_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_run_tags/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_run_tags/index.md new file mode 100644 index 0000000000..aefa2809ee --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_run_tags/index.md @@ -0,0 +1,48 @@ +--- +title: experiment_run_tags +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - experiment_run_tags + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a experiment_run_tags resource. + +## Overview + + + + +
Nameexperiment_run_tags
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `REPLACE` | | Sets a tag on a run. Tags are run metadata that can be updated during a run and after a run completes. | + +## `REPLACE` example + +Replaces a experiment_run_tags resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.machinelearning.experiment_run_tags +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_runs/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_runs/index.md new file mode 100644 index 0000000000..e2215079f4 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_runs/index.md @@ -0,0 +1,185 @@ +--- +title: experiment_runs +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - experiment_runs + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a experiment_runs resource. + +## Overview + + + + +
Nameexperiment_runs
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `object` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the metadata, metrics, params, and tags for a run. In the case where multiple metrics with the same key are logged for a run, return only the value with the latest timestamp. | +| | `SELECT` | | Searches for runs that satisfy expressions. | +| | `INSERT` | | Creates a new run within an experiment. A run is usually a single execution of a machine learning or data ETL pipeline. MLflow uses runs to track the | +| | `DELETE` | | Marks a run for deletion. | +| | `DELETE` | | Bulk delete runs in an experiment that were created prior to or at the specified timestamp. Deletes at most max_runs per request. To call this API from a Databricks Notebook in Python, you can use the client code snippet on | +| | `UPDATE` | | Updates run metadata. | +| | `EXEC` | | Logs a batch of metrics, params, and tags for a run. If any data failed to be persisted, the server will respond with an error (non-200 status code). | +| | `EXEC` | | Experimental: This API may change or be removed in a future release without warning. | +| | `EXEC` | | Logs a metric for a run. A metric is a key-value pair (string key, float value) with an associated timestamp. Examples include the various metrics that represent ML model accuracy. A metric can be logged multiple times. | +| | `EXEC` | | Experimental: This API may change or be removed in a future release without warning. | +| | `EXEC` | | Logs a param used for a run. A param is a key-value pair (string key, string value). Examples include hyperparameters used for ML model training and constant dates and values used in an ETL pipeline. A param can be logged only once for a run. | +| | `EXEC` | | Restores a deleted run. | +| | `EXEC` | | Bulk restore runs in an experiment that were deleted no earlier than the specified timestamp. Restores at most max_runs per request. To call this API from a Databricks Notebook in Python, you can use the client code snippet on | + +## `SELECT` examples + + + + +```sql +SELECT +data, +info, +inputs +FROM databricks_workspace.machinelearning.experiment_runs +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +data, +info, +inputs +FROM databricks_workspace.machinelearning.experiment_runs +WHERE run_id = '{{ run_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new experiment_runs resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.machinelearning.experiment_runs ( +deployment_name, +data__experiment_id, +data__user_id, +data__start_time, +data__tags +) +SELECT +'{{ deployment_name }}', +'{{ experiment_id }}', +'{{ user_id }}', +'{{ start_time }}', +'{{ tags }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: experiment_id + value: string + - name: user_id + value: string + - name: start_time + value: 0 + - name: tags + value: + - key: string + value: string + +``` + + + + +## `UPDATE` example + +Updates a experiment_runs resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.machinelearning.experiment_runs +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a experiment_runs resource. + + + + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.experiment_runs +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.experiment_runs +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_tags/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_tags/index.md new file mode 100644 index 0000000000..cc36b76aa9 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiment_tags/index.md @@ -0,0 +1,59 @@ +--- +title: experiment_tags +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - experiment_tags + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a experiment_tags resource. + +## Overview + + + + +
Nameexperiment_tags
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | Deletes a tag on a run. Tags are run metadata that can be updated during a run and after a run completes. | +| | `REPLACE` | | Sets a tag on an experiment. Experiment tags are metadata that can be updated. | + +## `REPLACE` example + +Replaces a experiment_tags resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.machinelearning.experiment_tags +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a experiment_tags resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.experiment_tags +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiments/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiments/index.md new file mode 100644 index 0000000000..ebbb2e9c89 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiments/index.md @@ -0,0 +1,202 @@ +--- +title: experiments +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - experiments + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a experiments resource. + +## Overview + + + + +
Nameexperiments
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets metadata for an experiment. | +| | `SELECT` | | Gets metadata for an experiment. This method works on deleted experiments. | +| | `SELECT` | | Gets a list of all experiments. | +| | `SELECT` | | Searches for experiments that satisfy specified search criteria. | +| | `INSERT` | | Creates an experiment with a name. Returns the ID of the newly created experiment. Validates that another experiment with the same name does not already exist and fails if another experiment with the same name already exists. | +| | `DELETE` | | Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion. If the experiment uses FileStore, artifacts associated with experiment are also deleted. | +| | `UPDATE` | | Updates experiment metadata. | +| | `EXEC` | | Restore an experiment marked for deletion. This also restores associated metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying artifacts associated with experiment are also restored. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +artifact_location, +creation_time, +experiment_id, +last_update_time, +lifecycle_stage, +tags +FROM databricks_workspace.machinelearning.experiments +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +artifact_location, +creation_time, +experiment_id, +last_update_time, +lifecycle_stage, +tags +FROM databricks_workspace.machinelearning.experiments +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +artifact_location, +creation_time, +experiment_id, +last_update_time, +lifecycle_stage, +tags +FROM databricks_workspace.machinelearning.experiments +WHERE experiment_id = '{{ experiment_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +artifact_location, +creation_time, +experiment_id, +last_update_time, +lifecycle_stage, +tags +FROM databricks_workspace.machinelearning.experiments +WHERE experiment_name = '{{ experiment_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new experiments resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.machinelearning.experiments ( +deployment_name, +data__name, +data__artifact_location, +data__tags +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ artifact_location }}', +'{{ tags }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: artifact_location + value: string + - name: tags + value: + - key: string + value: string + +``` + + + + +## `UPDATE` example + +Updates a experiments resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.machinelearning.experiments +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a experiments resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.experiments +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiments_history/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiments_history/index.md new file mode 100644 index 0000000000..78d16a12e0 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/experiments_history/index.md @@ -0,0 +1,56 @@ +--- +title: experiments_history +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - experiments_history + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a experiments_history resource. + +## Overview + + + + +
Nameexperiments_history
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `number` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a list of all values for the specified metric for a given run. | + +## `SELECT` examples + +```sql +SELECT +key, +step, +timestamp, +value +FROM databricks_workspace.machinelearning.experiments_history +WHERE metric_key = '{{ metric_key }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/index.md new file mode 100644 index 0000000000..ba0af45349 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/index.md @@ -0,0 +1,55 @@ +--- +title: machinelearning +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`machinelearning`__ service documentation. + +:::info Service Summary + +
+
+total resources: 19
+
+
+ +::: + +## Resources +
+
+experiment_artifacts
+experiment_permission_levels
+experiment_permissions
+experiment_run_tags
+experiment_runs
+experiment_tags
+experiments
+experiments_history
+model_latest_versions
+model_permission_levels
+
+
+model_permissions
+model_tags
+model_transition_requests
+model_version_comments
+model_version_download_urls
+model_version_tags
+model_versions
+model_web_hooks
+models
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_latest_versions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_latest_versions/index.md new file mode 100644 index 0000000000..5c32e38184 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_latest_versions/index.md @@ -0,0 +1,73 @@ +--- +title: model_latest_versions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_latest_versions + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_latest_versions resource. + +## Overview + + + + +
Namemodel_latest_versions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the latest version of a registered model. | + +## `SELECT` examples + +```sql +SELECT +name, +description, +creation_timestamp, +current_stage, +last_updated_timestamp, +run_id, +run_link, +source, +status, +status_message, +tags, +user_id, +version +FROM databricks_workspace.machinelearning.model_latest_versions +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_permission_levels/index.md new file mode 100644 index 0000000000..29f7c6e6bc --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: model_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_permission_levels + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_permission_levels resource. + +## Overview + + + + +
Namemodel_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.machinelearning.model_permission_levels +WHERE registered_model_id = '{{ registered_model_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_permissions/index.md new file mode 100644 index 0000000000..314926c79c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: model_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_permissions + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_permissions resource. + +## Overview + + + + +
Namemodel_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a registered model. Registered models can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on a registered model. Registered models can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.machinelearning.model_permissions +WHERE registered_model_id = '{{ registered_model_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a model_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.machinelearning.model_permissions +SET { field = value } +WHERE registered_model_id = '{{ registered_model_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a model_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.machinelearning.model_permissions +SET { field = value } +WHERE registered_model_id = '{{ registered_model_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_tags/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_tags/index.md new file mode 100644 index 0000000000..68b19b0565 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_tags/index.md @@ -0,0 +1,61 @@ +--- +title: model_tags +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_tags + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_tags resource. + +## Overview + + + + +
Namemodel_tags
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | Deletes the tag for a registered model. | +| | `REPLACE` | | Sets a tag on a registered model. | + +## `REPLACE` example + +Replaces a model_tags resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.machinelearning.model_tags +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a model_tags resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.model_tags +WHERE key = '{{ key }}' AND +name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_transition_requests/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_transition_requests/index.md new file mode 100644 index 0000000000..47576c7660 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_transition_requests/index.md @@ -0,0 +1,137 @@ +--- +title: model_transition_requests +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_transition_requests + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_transition_requests resource. + +## Overview + + + + +
Namemodel_transition_requests
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a list of all open stage transition requests for the model version. | +| | `INSERT` | | Creates a model version stage transition request. | +| | `DELETE` | | Cancels a model version stage transition request. | +| | `EXEC` | | Approves a model version stage transition request. | +| | `EXEC` | | Rejects a model version stage transition request. | +| | `EXEC` | | Transition a model version's stage. This is a Databricks workspace version of the | + +## `SELECT` examples + +```sql +SELECT +id, +activity_type, +comment, +creation_timestamp, +from_stage, +last_updated_timestamp, +system_comment, +to_stage, +user_id +FROM databricks_workspace.machinelearning.model_transition_requests +WHERE name = '{{ name }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_transition_requests resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.machinelearning.model_transition_requests ( +deployment_name, +data__name, +data__version, +data__stage, +data__comment +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ version }}', +'{{ stage }}', +'{{ comment }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: search_ads_model + - name: version + value: '1' + - name: stage + value: Staging + - name: comment + value: This version is great! + +``` + + + + +## `DELETE` example + +Deletes a model_transition_requests resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.model_transition_requests +WHERE creator = '{{ creator }}' AND +name = '{{ name }}' AND +stage = '{{ stage }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_comments/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_comments/index.md new file mode 100644 index 0000000000..ed8ea085b7 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_comments/index.md @@ -0,0 +1,108 @@ +--- +title: model_version_comments +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_version_comments + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_version_comments resource. + +## Overview + + + + +
Namemodel_version_comments
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `INSERT` | | Posts a comment on a model version. A comment can be submitted either by a user or programmatically to display relevant information about the model. For example, test results or deployment errors. | +| | `DELETE` | | Deletes a comment on a model version. | +| | `UPDATE` | | Post an edit to a comment on a model version. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_version_comments resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.machinelearning.model_version_comments ( +deployment_name, +data__name, +data__version, +data__comment +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ version }}', +'{{ comment }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: search_ads_model + - name: version + value: '1' + - name: comment + value: This version is great! + +``` + + + + +## `UPDATE` example + +Updates a model_version_comments resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.machinelearning.model_version_comments +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a model_version_comments resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.model_version_comments +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_download_urls/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_download_urls/index.md new file mode 100644 index 0000000000..ead3620a39 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_download_urls/index.md @@ -0,0 +1,51 @@ +--- +title: model_version_download_urls +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_version_download_urls + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_version_download_urls resource. + +## Overview + + + + +
Namemodel_version_download_urls
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a URI to download the model version. | + +## `SELECT` examples + +```sql +SELECT +artifact_uri +FROM databricks_workspace.machinelearning.model_version_download_urls +WHERE name = '{{ name }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_tags/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_tags/index.md new file mode 100644 index 0000000000..b790701e62 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_version_tags/index.md @@ -0,0 +1,62 @@ +--- +title: model_version_tags +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_version_tags + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_version_tags resource. + +## Overview + + + + +
Namemodel_version_tags
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | Deletes a model version tag. | +| | `REPLACE` | | Sets a model version tag. | + +## `REPLACE` example + +Replaces a model_version_tags resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.machinelearning.model_version_tags +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a model_version_tags resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.model_version_tags +WHERE key = '{{ key }}' AND +name = '{{ name }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_versions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_versions/index.md new file mode 100644 index 0000000000..ba112e089d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_versions/index.md @@ -0,0 +1,197 @@ +--- +title: model_versions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_versions + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_versions resource. + +## Overview + + + + +
Namemodel_versions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a model version. | +| | `SELECT` | | Searches for specific model versions based on the supplied | +| | `INSERT` | | Creates a model version. | +| | `DELETE` | | Deletes a model version. | +| | `UPDATE` | | Updates the model version. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +description, +creation_timestamp, +current_stage, +last_updated_timestamp, +run_id, +run_link, +source, +status, +status_message, +tags, +user_id, +version +FROM databricks_workspace.machinelearning.model_versions +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +description, +creation_timestamp, +current_stage, +last_updated_timestamp, +run_id, +run_link, +source, +status, +status_message, +tags, +user_id, +version +FROM databricks_workspace.machinelearning.model_versions +WHERE name = '{{ name }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_versions resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.machinelearning.model_versions ( +deployment_name, +data__name, +data__source, +data__run_id, +data__tags, +data__run_link, +data__description +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ source }}', +'{{ run_id }}', +'{{ tags }}', +'{{ run_link }}', +'{{ description }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: source + value: string + - name: run_id + value: string + - name: tags + value: + - key: string + value: string + - name: run_link + value: string + - name: description + value: string + +``` + + + + +## `UPDATE` example + +Updates a model_versions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.machinelearning.model_versions +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a model_versions resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.model_versions +WHERE name = '{{ name }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_web_hooks/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_web_hooks/index.md new file mode 100644 index 0000000000..e6027a4952 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/model_web_hooks/index.md @@ -0,0 +1,157 @@ +--- +title: model_web_hooks +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_web_hooks + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_web_hooks resource. + +## Overview + + + + +
Namemodel_web_hooks
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `array` | +| | `object` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | This endpoint is in Public Preview. | +| | `INSERT` | | : This endpoint is in Public Preview. | +| | `DELETE` | | This endpoint is in Public Preview. | +| | `UPDATE` | | This endpoint is in Public Preview. | +| | `EXEC` | | This endpoint is in Public Preview. | + +## `SELECT` examples + +```sql +SELECT +id, +description, +creation_timestamp, +events, +http_url_spec, +last_updated_timestamp, +model_name, +status +FROM databricks_workspace.machinelearning.model_web_hooks +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new model_web_hooks resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.machinelearning.model_web_hooks ( +deployment_name, +data__job_spec, +data__http_url_spec, +data__events, +data__model_name, +data__description, +data__status +) +SELECT +'{{ deployment_name }}', +'{{ job_spec }}', +'{{ http_url_spec }}', +'{{ events }}', +'{{ model_name }}', +'{{ description }}', +'{{ status }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: job_spec + value: + job_id: '1' + access_token: dapi12345678935845824 + workspace_url: string + - name: http_url_spec + value: + url: https://hooks.slack.com/services/... + secret: anyRandomString + enable_ssl_verification: true + authorization: Bearer + - name: events + value: + - MODEL_VERSION_CREATED + - MODEL_VERSION_TRANSITIONED_TO_STAGING + - COMMENT_CREATED + - name: model_name + value: registered-model-1 + - name: description + value: Webhook for comment creation + - name: status + value: ACTIVE + +``` + + + + +## `UPDATE` example + +Updates a model_web_hooks resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.machinelearning.model_web_hooks +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a model_web_hooks resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.model_web_hooks +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/models/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/models/index.md new file mode 100644 index 0000000000..dfd2506eaf --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/machinelearning/models/index.md @@ -0,0 +1,184 @@ +--- +title: models +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - models + - machinelearning + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a models resource. + +## Overview + + + + +
Namemodels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `integer` | +| | `array` | +| | `array` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get the details of a model. This is a Databricks workspace version of the | +| | `SELECT` | | Lists all available registered models, up to the limit specified in | +| | `SELECT` | | Search for registered models based on the specified | +| | `INSERT` | | Creates a new registered model with the name specified in the request body. | +| | `DELETE` | | Deletes a registered model. | +| | `UPDATE` | | Updates a registered model. | +| | `EXEC` | | Renames a registered model. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +description, +creation_timestamp, +last_updated_timestamp, +latest_versions, +tags, +user_id +FROM databricks_workspace.machinelearning.models +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +description, +creation_timestamp, +last_updated_timestamp, +latest_versions, +tags, +user_id +FROM databricks_workspace.machinelearning.models +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +description, +creation_timestamp, +last_updated_timestamp, +latest_versions, +tags, +user_id +FROM databricks_workspace.machinelearning.models +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new models resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.machinelearning.models ( +deployment_name, +data__name, +data__tags, +data__description +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ tags }}', +'{{ description }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: tags + value: + - key: string + value: string + - name: description + value: string + +``` + + + + +## `UPDATE` example + +Updates a models resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.machinelearning.models +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a models resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.machinelearning.models +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_fulfillments/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_fulfillments/index.md new file mode 100644 index 0000000000..3b72152bbd --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_fulfillments/index.md @@ -0,0 +1,58 @@ +--- +title: consumer_fulfillments +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - consumer_fulfillments + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a consumer_fulfillments resource. + +## Overview + + + + +
Nameconsumer_fulfillments
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get all listings fulfillments associated with a listing. A | + +## `SELECT` examples + +```sql +SELECT +fulfillment_type, +listing_id, +recipient_type, +repo_info, +share_info +FROM databricks_workspace.marketplace.consumer_fulfillments +WHERE listing_id = '{{ listing_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_installations/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_installations/index.md new file mode 100644 index 0000000000..6646263fba --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_installations/index.md @@ -0,0 +1,161 @@ +--- +title: consumer_installations +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - consumer_installations + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a consumer_installations resource. + +## Overview + + + + +
Nameconsumer_installations
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all installations across all listings. | +| | `INSERT` | | Install payload associated with a Databricks Marketplace listing. | +| | `DELETE` | | Uninstall an installation associated with a Databricks Marketplace listing. | +| | `UPDATE` | | This is a update API that will update the part of the fields defined in the installation table as well as interact with external services according to the fields not included in the installation table | + +## `SELECT` examples + +```sql +SELECT +id, +catalog_name, +error_message, +installed_on, +listing_id, +listing_name, +recipient_type, +repo_name, +repo_path, +share_name, +status, +token_detail, +tokens +FROM databricks_workspace.marketplace.consumer_installations +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new consumer_installations resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.consumer_installations ( +listing_id, +deployment_name, +data__share_name, +data__catalog_name, +data__repo_detail, +data__recipient_type, +data__accepted_consumer_terms +) +SELECT +'{{ listing_id }}', +'{{ deployment_name }}', +'{{ share_name }}', +'{{ catalog_name }}', +'{{ repo_detail }}', +'{{ recipient_type }}', +'{{ accepted_consumer_terms }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: share_name + value: string + - name: catalog_name + value: string + - name: repo_detail + value: + repo_name: string + repo_path: string + - name: recipient_type + value: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS + - name: accepted_consumer_terms + value: + version: string + +``` + + + + +## `UPDATE` example + +Updates a consumer_installations resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.marketplace.consumer_installations +SET { field = value } +WHERE installation_id = '{{ installation_id }}' AND +listing_id = '{{ listing_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a consumer_installations resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.marketplace.consumer_installations +WHERE installation_id = '{{ installation_id }}' AND +listing_id = '{{ listing_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_listing_content/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_listing_content/index.md new file mode 100644 index 0000000000..abb142155f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_listing_content/index.md @@ -0,0 +1,52 @@ +--- +title: consumer_listing_content +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - consumer_listing_content + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a consumer_listing_content resource. + +## Overview + + + + +
Nameconsumer_listing_content
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a high level preview of the metadata of listing installable content. | + +## `SELECT` examples + +```sql +SELECT +name, +data_object_type +FROM databricks_workspace.marketplace.consumer_listing_content +WHERE listing_id = '{{ listing_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_listings/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_listings/index.md new file mode 100644 index 0000000000..0b16f122e6 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_listings/index.md @@ -0,0 +1,95 @@ +--- +title: consumer_listings +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - consumer_listings + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a consumer_listings resource. + +## Overview + + + + +
Nameconsumer_listings
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a published listing in the Databricks Marketplace that the consumer has access to. | +| | `SELECT` | | List all published listings in the Databricks Marketplace that the consumer has access to. | +| | `SELECT` | | Search published listings in the Databricks Marketplace that the consumer has access to. This query supports a variety of different search parameters and performs fuzzy matching. | +| | `EXEC` | | Batch get a published listing in the Databricks Marketplace that the consumer has access to. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +detail, +summary +FROM databricks_workspace.marketplace.consumer_listings +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +detail, +summary +FROM databricks_workspace.marketplace.consumer_listings +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +detail, +summary +FROM databricks_workspace.marketplace.consumer_listings +WHERE query = '{{ query }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_personalization_requests/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_personalization_requests/index.md new file mode 100644 index 0000000000..4d62912db1 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_personalization_requests/index.md @@ -0,0 +1,189 @@ +--- +title: consumer_personalization_requests +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - consumer_personalization_requests + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a consumer_personalization_requests resource. + +## Overview + + + + +
Nameconsumer_personalization_requests
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get the personalization request for a listing. Each consumer can make at | +| | `SELECT` | | List personalization requests for a consumer across all listings. | +| | `INSERT` | | Create a personalization request for a listing. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +comment, +consumer_region, +contact_info, +created_at, +intended_use, +is_from_lighthouse, +listing_id, +listing_name, +metastore_id, +provider_id, +recipient_type, +share, +status, +status_message, +updated_at +FROM databricks_workspace.marketplace.consumer_personalization_requests +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +comment, +consumer_region, +contact_info, +created_at, +intended_use, +is_from_lighthouse, +listing_id, +listing_name, +metastore_id, +provider_id, +recipient_type, +share, +status, +status_message, +updated_at +FROM databricks_workspace.marketplace.consumer_personalization_requests +WHERE listing_id = '{{ listing_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new consumer_personalization_requests resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.consumer_personalization_requests ( +listing_id, +deployment_name, +data__comment, +data__intended_use, +data__first_name, +data__last_name, +data__company, +data__is_from_lighthouse, +data__recipient_type, +data__accepted_consumer_terms +) +SELECT +'{{ listing_id }}', +'{{ deployment_name }}', +'{{ comment }}', +'{{ intended_use }}', +'{{ first_name }}', +'{{ last_name }}', +'{{ company }}', +'{{ is_from_lighthouse }}', +'{{ recipient_type }}', +'{{ accepted_consumer_terms }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: comment + value: string + - name: intended_use + value: string + - name: first_name + value: string + - name: last_name + value: string + - name: company + value: string + - name: is_from_lighthouse + value: true + - name: recipient_type + value: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS + - name: accepted_consumer_terms + value: + version: string + +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_providers/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_providers/index.md new file mode 100644 index 0000000000..0502530a31 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/consumer_providers/index.md @@ -0,0 +1,113 @@ +--- +title: consumer_providers +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - consumer_providers + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a consumer_providers resource. + +## Overview + + + + +
Nameconsumer_providers
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a provider in the Databricks Marketplace with at least one visible listing. | +| | `SELECT` | | List all providers in the Databricks Marketplace with at least one visible listing. | +| | `EXEC` | | Batch get a provider in the Databricks Marketplace with at least one visible listing. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +description, +business_contact_email, +company_website_link, +dark_mode_icon_file_id, +dark_mode_icon_file_path, +icon_file_id, +icon_file_path, +is_featured, +privacy_policy_link, +published_by, +support_contact_email, +term_of_service_link +FROM databricks_workspace.marketplace.consumer_providers +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +description, +business_contact_email, +company_website_link, +dark_mode_icon_file_id, +dark_mode_icon_file_path, +icon_file_id, +icon_file_path, +is_featured, +privacy_policy_link, +published_by, +support_contact_email, +term_of_service_link +FROM databricks_workspace.marketplace.consumer_providers +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/index.md new file mode 100644 index 0000000000..0b8dd7817c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/index.md @@ -0,0 +1,52 @@ +--- +title: marketplace +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`marketplace`__ service documentation. + +:::info Service Summary + +
+
+total resources: 16
+
+
+ +::: + +## Resources +
+
+consumer_fulfillments
+consumer_installations
+consumer_listing_content
+consumer_listings
+consumer_personalization_requests
+consumer_providers
+listing_installations
+provider_analytics_dashboards
+
+
+provider_analytics_dashboards_latest
+provider_exchange_filters
+provider_exchange_listings
+provider_exchanges
+provider_files
+provider_listings
+provider_personalization_requests
+providers
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/listing_installations/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/listing_installations/index.md new file mode 100644 index 0000000000..bf06ecc1ca --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/listing_installations/index.md @@ -0,0 +1,74 @@ +--- +title: listing_installations +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - listing_installations + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a listing_installations resource. + +## Overview + + + + +
Namelisting_installations
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List all installations for a particular listing. | + +## `SELECT` examples + +```sql +SELECT +id, +catalog_name, +error_message, +installed_on, +listing_id, +listing_name, +recipient_type, +repo_name, +repo_path, +share_name, +status, +token_detail, +tokens +FROM databricks_workspace.marketplace.listing_installations +WHERE listing_id = '{{ listing_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_analytics_dashboards/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_analytics_dashboards/index.md new file mode 100644 index 0000000000..706b07607d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_analytics_dashboards/index.md @@ -0,0 +1,101 @@ +--- +title: provider_analytics_dashboards +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_analytics_dashboards + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_analytics_dashboards resource. + +## Overview + + + + +
Nameprovider_analytics_dashboards
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get provider analytics dashboard. | +| | `INSERT` | | Create provider analytics dashboard. Returns Marketplace specific | +| | `UPDATE` | | Update provider analytics dashboard. | + +## `SELECT` examples + +```sql +SELECT +id, +dashboard_id, +version +FROM databricks_workspace.marketplace.provider_analytics_dashboards +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new provider_analytics_dashboards resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.provider_analytics_dashboards ( +deployment_name +) +SELECT +'{{ deployment_name }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: [] # No request body parameters required +``` + + + + +## `UPDATE` example + +Updates a provider_analytics_dashboards resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.marketplace.provider_analytics_dashboards +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_analytics_dashboards_latest/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_analytics_dashboards_latest/index.md new file mode 100644 index 0000000000..9a096acc4e --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_analytics_dashboards_latest/index.md @@ -0,0 +1,49 @@ +--- +title: provider_analytics_dashboards_latest +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_analytics_dashboards_latest + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_analytics_dashboards_latest resource. + +## Overview + + + + +
Nameprovider_analytics_dashboards_latest
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get latest version of provider analytics dashboard. | + +## `SELECT` examples + +```sql +SELECT +version +FROM databricks_workspace.marketplace.provider_analytics_dashboards_latest +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchange_filters/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchange_filters/index.md new file mode 100644 index 0000000000..e7b9a2ee38 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchange_filters/index.md @@ -0,0 +1,140 @@ +--- +title: provider_exchange_filters +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_exchange_filters + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_exchange_filters resource. + +## Overview + + + + +
Nameprovider_exchange_filters
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List exchange filter | +| | `INSERT` | | Add an exchange filter. | +| | `DELETE` | | Delete an exchange filter | +| | `UPDATE` | | Update an exchange filter. | + +## `SELECT` examples + +```sql +SELECT +id, +name, +created_at, +created_by, +exchange_id, +filter_type, +filter_value, +updated_at, +updated_by +FROM databricks_workspace.marketplace.provider_exchange_filters +WHERE exchange_id = '{{ exchange_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new provider_exchange_filters resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.provider_exchange_filters ( +deployment_name, +data__filter +) +SELECT +'{{ deployment_name }}', +'{{ filter }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: filter + value: + id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + +``` + + + + +## `UPDATE` example + +Updates a provider_exchange_filters resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.marketplace.provider_exchange_filters +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a provider_exchange_filters resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.marketplace.provider_exchange_filters +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchange_listings/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchange_listings/index.md new file mode 100644 index 0000000000..661d52ecd3 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchange_listings/index.md @@ -0,0 +1,148 @@ +--- +title: provider_exchange_listings +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_exchange_listings + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_exchange_listings resource. + +## Overview + + + + +
Nameprovider_exchange_listings
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List exchanges associated with a listing | +| | `SELECT` | | List listings associated with an exchange | +| | `INSERT` | | Associate an exchange with a listing | +| | `DELETE` | | Disassociate an exchange with a listing | + +## `SELECT` examples + + + + +```sql +SELECT +id, +created_at, +created_by, +exchange_id, +exchange_name, +listing_id, +listing_name +FROM databricks_workspace.marketplace.provider_exchange_listings +WHERE listing_id = '{{ listing_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +created_at, +created_by, +exchange_id, +exchange_name, +listing_id, +listing_name +FROM databricks_workspace.marketplace.provider_exchange_listings +WHERE exchange_id = '{{ exchange_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new provider_exchange_listings resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.provider_exchange_listings ( +deployment_name, +data__listing_id, +data__exchange_id +) +SELECT +'{{ deployment_name }}', +'{{ listing_id }}', +'{{ exchange_id }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: listing_id + value: string + - name: exchange_id + value: string + +``` + + + + +## `DELETE` example + +Deletes a provider_exchange_listings resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.marketplace.provider_exchange_listings +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchanges/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchanges/index.md new file mode 100644 index 0000000000..974fd11079 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_exchanges/index.md @@ -0,0 +1,187 @@ +--- +title: provider_exchanges +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_exchanges + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_exchanges resource. + +## Overview + + + + +
Nameprovider_exchanges
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `array` | +| | `array` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get an exchange. | +| | `SELECT` | | List exchanges visible to provider | +| | `INSERT` | | Create an exchange | +| | `DELETE` | | This removes a listing from marketplace. | +| | `UPDATE` | | Update an exchange | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +comment, +created_at, +created_by, +filters, +linked_listings, +updated_at, +updated_by +FROM databricks_workspace.marketplace.provider_exchanges +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +comment, +created_at, +created_by, +filters, +linked_listings, +updated_at, +updated_by +FROM databricks_workspace.marketplace.provider_exchanges +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new provider_exchanges resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.provider_exchanges ( +deployment_name, +data__exchange +) +SELECT +'{{ deployment_name }}', +'{{ exchange }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: exchange + value: + id: string + name: string + comment: string + filters: + - id: string + exchange_id: string + filter_value: string + name: string + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + filter_type: GLOBAL_METASTORE_ID + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + linked_listings: + - id: string + exchange_id: string + exchange_name: string + listing_id: string + listing_name: string + created_at: 0 + created_by: string + +``` + + + + +## `UPDATE` example + +Updates a provider_exchanges resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.marketplace.provider_exchanges +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a provider_exchanges resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.marketplace.provider_exchanges +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_files/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_files/index.md new file mode 100644 index 0000000000..acece5f393 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_files/index.md @@ -0,0 +1,166 @@ +--- +title: provider_files +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_files + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_files resource. + +## Overview + + + + +
Nameprovider_files
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a file | +| | `SELECT` | | List files attached to a parent entity. | +| | `INSERT` | | Create a file. Currently, only provider icons and attached notebooks are supported. | +| | `DELETE` | | Delete a file | + +## `SELECT` examples + + + + +```sql +SELECT +id, +created_at, +display_name, +download_link, +file_parent, +marketplace_file_type, +mime_type, +status, +status_message, +updated_at +FROM databricks_workspace.marketplace.provider_files +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +created_at, +display_name, +download_link, +file_parent, +marketplace_file_type, +mime_type, +status, +status_message, +updated_at +FROM databricks_workspace.marketplace.provider_files +WHERE file_id = '{{ file_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new provider_files resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.provider_files ( +deployment_name, +data__file_parent, +data__marketplace_file_type, +data__mime_type, +data__display_name +) +SELECT +'{{ deployment_name }}', +'{{ file_parent }}', +'{{ marketplace_file_type }}', +'{{ mime_type }}', +'{{ display_name }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: file_parent + value: + parent_id: string + file_parent_type: PROVIDER + - name: marketplace_file_type + value: PROVIDER_ICON + - name: mime_type + value: string + - name: display_name + value: string + +``` + + + + +## `DELETE` example + +Deletes a provider_files resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.marketplace.provider_files +WHERE file_id = '{{ file_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_listings/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_listings/index.md new file mode 100644 index 0000000000..eb03a3c854 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_listings/index.md @@ -0,0 +1,214 @@ +--- +title: provider_listings +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_listings + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_listings resource. + +## Overview + + + + +
Nameprovider_listings
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a listing | +| | `SELECT` | | List listings owned by this provider | +| | `INSERT` | | Create a new listing | +| | `DELETE` | | Delete a listing | +| | `UPDATE` | | Update a listing | + +## `SELECT` examples + + + + +```sql +SELECT +id, +detail, +summary +FROM databricks_workspace.marketplace.provider_listings +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +detail, +summary +FROM databricks_workspace.marketplace.provider_listings +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new provider_listings resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.provider_listings ( +deployment_name, +data__listing +) +SELECT +'{{ deployment_name }}', +'{{ listing }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: listing + value: + id: string + summary: + name: string + subtitle: string + status: DRAFT + share: + name: string + type: SAMPLE + provider_region: + cloud: string + region: string + setting: + visibility: PUBLIC + created_at: 0 + created_by: string + updated_at: 0 + updated_by: string + published_at: 0 + published_by: string + categories: + - ADVERTISING_AND_MARKETING + listingType: STANDARD + created_by_id: 0 + updated_by_id: 0 + provider_id: string + exchange_ids: + - string + git_repo: + git_repo_url: string + detail: + description: string + terms_of_service: string + documentation_link: string + support_link: string + file_ids: + - string + privacy_policy_link: string + embedded_notebook_file_infos: + - id: string + marketplace_file_type: PROVIDER_ICON + file_parent: + parent_id: string + file_parent_type: PROVIDER + mime_type: string + download_link: string + created_at: 0 + updated_at: 0 + display_name: string + status: FILE_STATUS_PUBLISHED + status_message: string + geographical_coverage: string + cost: FREE + pricing_model: string + update_frequency: + interval: 0 + unit: NONE + collection_granularity: + interval: 0 + unit: NONE + collection_date_start: 0 + collection_date_end: 0 + data_source: string + size: 0.1 + assets: + - ASSET_TYPE_GIT_REPO + license: string + tags: + - tag_name: LISTING_TAG_TYPE_LANGUAGE + tag_values: + - string + +``` + + + + +## `UPDATE` example + +Updates a provider_listings resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.marketplace.provider_listings +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a provider_listings resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.marketplace.provider_listings +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_personalization_requests/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_personalization_requests/index.md new file mode 100644 index 0000000000..54148819f1 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/provider_personalization_requests/index.md @@ -0,0 +1,93 @@ +--- +title: provider_personalization_requests +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - provider_personalization_requests + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a provider_personalization_requests resource. + +## Overview + + + + +
Nameprovider_personalization_requests
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | List personalization requests to this provider. This will return all personalization requests, regardless of which listing they are for. | +| | `UPDATE` | | Update personalization request. This method only permits updating the status of the request. | + +## `SELECT` examples + +```sql +SELECT +id, +comment, +consumer_region, +contact_info, +created_at, +intended_use, +is_from_lighthouse, +listing_id, +listing_name, +metastore_id, +provider_id, +recipient_type, +share, +status, +status_message, +updated_at +FROM databricks_workspace.marketplace.provider_personalization_requests +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a provider_personalization_requests resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.marketplace.provider_personalization_requests +SET { field = value } +WHERE listing_id = '{{ listing_id }}' AND +request_id = '{{ request_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/providers/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/providers/index.md new file mode 100644 index 0000000000..a5ed04daa4 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/marketplace/providers/index.md @@ -0,0 +1,191 @@ +--- +title: providers +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - providers + - marketplace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a providers resource. + +## Overview + + + + +
Nameproviders
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get provider profile | +| | `SELECT` | | List provider profiles for account. | +| | `INSERT` | | Create a provider | +| | `DELETE` | | Delete provider | +| | `UPDATE` | | Update provider profile | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +description, +business_contact_email, +company_website_link, +dark_mode_icon_file_id, +dark_mode_icon_file_path, +icon_file_id, +icon_file_path, +is_featured, +privacy_policy_link, +published_by, +support_contact_email, +term_of_service_link +FROM databricks_workspace.marketplace.providers +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +description, +business_contact_email, +company_website_link, +dark_mode_icon_file_id, +dark_mode_icon_file_path, +icon_file_id, +icon_file_path, +is_featured, +privacy_policy_link, +published_by, +support_contact_email, +term_of_service_link +FROM databricks_workspace.marketplace.providers +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new providers resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.marketplace.providers ( +deployment_name, +data__provider +) +SELECT +'{{ deployment_name }}', +'{{ provider }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: provider + value: + id: string + name: string + description: string + icon_file_path: string + business_contact_email: string + support_contact_email: string + is_featured: true + published_by: string + company_website_link: string + icon_file_id: string + term_of_service_link: string + privacy_policy_link: string + dark_mode_icon_file_id: string + dark_mode_icon_file_path: string + +``` + + + + +## `UPDATE` example + +Updates a providers resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.marketplace.providers +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a providers resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.marketplace.providers +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/ai_gateways/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/ai_gateways/index.md new file mode 100644 index 0000000000..e8e3462f6b --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/ai_gateways/index.md @@ -0,0 +1,37 @@ +--- +title: ai_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - ai_gateways + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a ai_gateways resource. + +## Overview + + + + +
Nameai_gateways
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `EXEC` | | Used to update the AI Gateway of a serving endpoint. NOTE: Only external model endpoints are currently supported. | diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/build_logs/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/build_logs/index.md new file mode 100644 index 0000000000..f6edef033f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/build_logs/index.md @@ -0,0 +1,51 @@ +--- +title: build_logs +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - build_logs + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a build_logs resource. + +## Overview + + + + +
Namebuild_logs
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves the build logs associated with the provided served model. | + +## `SELECT` examples + +```sql +SELECT +logs +FROM databricks_workspace.realtimeserving.build_logs +WHERE name = '{{ name }}' AND +served_model_name = '{{ served_model_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/index.md new file mode 100644 index 0000000000..a1ebe8b80a --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/index.md @@ -0,0 +1,44 @@ +--- +title: realtimeserving +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`realtimeserving`__ service documentation. + +:::info Service Summary + +
+
+total resources: 8
+
+
+ +::: + +## Resources +
+
+ai_gateways
+build_logs
+logs
+metrics
+
+
+schemas
+serving_endpoints
+serving_endpoints_permission_levels
+serving_endpoints_permissions
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/logs/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/logs/index.md new file mode 100644 index 0000000000..02d0a2e4c4 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/logs/index.md @@ -0,0 +1,51 @@ +--- +title: logs +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - logs + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a logs resource. + +## Overview + + + + +
Namelogs
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves the service logs associated with the provided served model. | + +## `SELECT` examples + +```sql +SELECT +logs +FROM databricks_workspace.realtimeserving.logs +WHERE name = '{{ name }}' AND +served_model_name = '{{ served_model_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/metrics/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/metrics/index.md new file mode 100644 index 0000000000..a5ae88dd0d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/metrics/index.md @@ -0,0 +1,37 @@ +--- +title: metrics +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - metrics + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a metrics resource. + +## Overview + + + + +
Namemetrics
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `EXEC` | | Retrieves the metrics associated with the provided serving endpoint in either Prometheus or OpenMetrics exposition format. | diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/schemas/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/schemas/index.md new file mode 100644 index 0000000000..31d864fd51 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/schemas/index.md @@ -0,0 +1,56 @@ +--- +title: schemas +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - schemas + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a schemas resource. + +## Overview + + + + +
Nameschemas
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `object` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for the supported paths, input and output format and datatypes. | + +## `SELECT` examples + +```sql +SELECT +info, +openapi, +paths, +servers +FROM databricks_workspace.realtimeserving.schemas +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints/index.md new file mode 100644 index 0000000000..31a323d9e8 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints/index.md @@ -0,0 +1,253 @@ +--- +title: serving_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - serving_endpoints + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a serving_endpoints resource. + +## Overview + + + + +
Nameserving_endpoints
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `integer` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `object` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves the details for a single serving endpoint. | +| | `SELECT` | | | +| | `INSERT` | | | +| | `DELETE` | | | +| | `UPDATE` | | Used to batch add and delete tags from a serving endpoint with a single API call. | +| | `UPDATE` | | Updates any combination of the serving endpoint's served entities, the compute configuration of those served entities, and the endpoint's traffic config. An endpoint that already has an update in progress can not be updated until the current update completes or fails. | +| | `REPLACE` | | Used to update the rate limits of a serving endpoint. NOTE: Only foundation model endpoints are currently supported. For external models, use AI Gateway to manage rate limits. | +| | `EXEC` | | | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +config, +creation_timestamp, +creator, +last_updated_timestamp, +permission_level, +route_optimized, +state, +tags +FROM databricks_workspace.realtimeserving.serving_endpoints +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +config, +creation_timestamp, +creator, +last_updated_timestamp, +permission_level, +route_optimized, +state, +tags +FROM databricks_workspace.realtimeserving.serving_endpoints +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new serving_endpoints resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.realtimeserving.serving_endpoints ( +deployment_name, +data__name, +data__config, +data__ai_gateway, +data__tags +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ config }}', +'{{ ai_gateway }}', +'{{ tags }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: openai_endpoint + - name: config + value: + served_entities: + - name: openai_embeddings + external_model: + name: text-embedding-ada-002 + provider: openai + task: llm/v1/embeddings + openai_config: + openai_api_key: '{{secrets/my_scope/my_openai_api_key}}' + - name: ai_gateway + value: + usage_tracking_config: + enabled: true + inference_table_config: + catalog_name: my-catalog + schema_name: my-schema + table_name_prefix: my-prefix + enabled: true + rate_limits: + - calls: 100 + key: user + renewal_period: minute + guardrails: + input: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + - topic2 + invalid_keywords: + - keyword1 + - keyword2 + output: + safety: true + pii: + behavior: BLOCK + valid_topics: + - topic1 + - topic2 + invalid_keywords: + - keyword1 + - keyword2 + - name: tags + value: + - key: team + value: gen-ai + +``` + + + + +## `UPDATE` example + +Updates a serving_endpoints resource. + + + +```sql +/*+ update */ +UPDATE databricks_workspace.realtimeserving.serving_endpoints +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + +```sql +/*+ update */ +UPDATE databricks_workspace.realtimeserving.serving_endpoints +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + +## `REPLACE` example + +Replaces a serving_endpoints resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.realtimeserving.serving_endpoints +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a serving_endpoints resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.realtimeserving.serving_endpoints +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints_permission_levels/index.md new file mode 100644 index 0000000000..e511082847 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: serving_endpoints_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - serving_endpoints_permission_levels + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a serving_endpoints_permission_levels resource. + +## Overview + + + + +
Nameserving_endpoints_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.realtimeserving.serving_endpoints_permission_levels +WHERE serving_endpoint_id = '{{ serving_endpoint_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints_permissions/index.md new file mode 100644 index 0000000000..c4cc81c281 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/realtimeserving/serving_endpoints_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: serving_endpoints_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - serving_endpoints_permissions + - realtimeserving + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a serving_endpoints_permissions resource. + +## Overview + + + + +
Nameserving_endpoints_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a serving endpoint. Serving endpoints can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on a serving endpoint. Serving endpoints can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.realtimeserving.serving_endpoints_permissions +WHERE serving_endpoint_id = '{{ serving_endpoint_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a serving_endpoints_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.realtimeserving.serving_endpoints_permissions +SET { field = value } +WHERE serving_endpoint_id = '{{ serving_endpoint_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a serving_endpoints_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.realtimeserving.serving_endpoints_permissions +SET { field = value } +WHERE serving_endpoint_id = '{{ serving_endpoint_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/repos/git_credentials/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/git_credentials/index.md new file mode 100644 index 0000000000..f43eda7d11 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/git_credentials/index.md @@ -0,0 +1,152 @@ +--- +title: git_credentials +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - git_credentials + - repos + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a git_credentials resource. + +## Overview + + + + +
Namegit_credentials
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the Git credential with the specified credential ID. | +| | `SELECT` | | Lists the calling user's Git credentials. One credential per user is supported. | +| | `INSERT` | | Creates a Git credential entry for the user. Only one Git credential per user is supported, so any attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update existing credentials, or the DELETE endpoint to delete existing credentials. | +| | `DELETE` | | Deletes the specified Git credential. | +| | `UPDATE` | | Updates the specified Git credential. | + +## `SELECT` examples + + + + +```sql +SELECT +credential_id, +git_provider, +git_username +FROM databricks_workspace.repos.git_credentials +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +credential_id, +git_provider, +git_username +FROM databricks_workspace.repos.git_credentials +WHERE credential_id = '{{ credential_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new git_credentials resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.repos.git_credentials ( +deployment_name, +data__git_provider, +data__git_username, +data__personal_access_token +) +SELECT +'{{ deployment_name }}', +'{{ git_provider }}', +'{{ git_username }}', +'{{ personal_access_token }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: git_provider + value: gitHub + - name: git_username + value: testuser + - name: personal_access_token + value: something + +``` + + + + +## `UPDATE` example + +Updates a git_credentials resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.repos.git_credentials +SET { field = value } +WHERE credential_id = '{{ credential_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a git_credentials resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.repos.git_credentials +WHERE credential_id = '{{ credential_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/repos/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/index.md new file mode 100644 index 0000000000..63d9c85fbb --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/index.md @@ -0,0 +1,40 @@ +--- +title: repos +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - repos + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`repos`__ service documentation. + +:::info Service Summary + +
+
+total resources: 4
+
+
+ +::: + +## Resources +
+
+git_credentials
+permission_levels
+
+
+permissions
+repos
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/repos/permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/permission_levels/index.md new file mode 100644 index 0000000000..caee2a3772 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - permission_levels + - repos + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a permission_levels resource. + +## Overview + + + + +
Namepermission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.repos.permission_levels +WHERE repo_id = '{{ repo_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/repos/permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/permissions/index.md new file mode 100644 index 0000000000..47271bfd06 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/permissions/index.md @@ -0,0 +1,80 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - permissions + - repos + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a permissions resource. + +## Overview + + + + +
Namepermissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a repo. Repos can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on a repo. Repos can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.repos.permissions +WHERE repo_id = '{{ repo_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.repos.permissions +SET { field = value } +WHERE repo_id = '{{ repo_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.repos.permissions +SET { field = value } +WHERE repo_id = '{{ repo_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/repos/repos/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/repos/index.md new file mode 100644 index 0000000000..7cf38dd3a1 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/repos/repos/index.md @@ -0,0 +1,173 @@ +--- +title: repos +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - repos + - repos + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a repos resource. + +## Overview + + + + +
Namerepos
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns the repo with the given repo ID. | +| | `SELECT` | | Returns repos that the calling user has Manage permissions on. Use | +| | `INSERT` | | Creates a repo in the workspace and links it to the remote Git repo specified. Note that repos created programmatically must be linked to a remote Git repo, unlike repos created in the browser. | +| | `DELETE` | | Deletes the specified repo. | +| | `UPDATE` | | Updates the repo to a different branch or tag, or updates the repo to the latest commit on the same branch. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +branch, +head_commit_id, +path, +provider, +url +FROM databricks_workspace.repos.repos +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +branch, +head_commit_id, +path, +provider, +url +FROM databricks_workspace.repos.repos +WHERE repo_id = '{{ repo_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new repos resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.repos.repos ( +deployment_name, +data__branch, +data__path, +data__provider, +data__sparse_checkout, +data__url +) +SELECT +'{{ deployment_name }}', +'{{ branch }}', +'{{ path }}', +'{{ provider }}', +'{{ sparse_checkout }}', +'{{ url }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: branch + value: main + - name: path + value: /Users/user@company.com/clitest + - name: provider + value: gitHub + - name: sparse_checkout + value: + patterns: + - parent-folder/child-folder + - src + - test + - name: url + value: https://github.com/databricks/cli.git + +``` + + + + +## `UPDATE` example + +Updates a repos resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.repos.repos +SET { field = value } +WHERE repo_id = '{{ repo_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a repos resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.repos.repos +WHERE repo_id = '{{ repo_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/acls/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/acls/index.md new file mode 100644 index 0000000000..15254ce8e9 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/acls/index.md @@ -0,0 +1,101 @@ +--- +title: acls +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - acls + - secrets + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a acls resource. + +## Overview + + + + +
Nameacls
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the details about the given ACL, such as the group and permission. Users must have the | +| | `SELECT` | | List the ACLs for a given secret scope. Users must have the | +| | `DELETE` | | Deletes the given ACL on the given scope. | +| | `REPLACE` | | Creates or overwrites the Access Control List (ACL) associated with the given principal (user or group) on the specified scope point. | + +## `SELECT` examples + + + + +```sql +SELECT +permission, +principal +FROM databricks_workspace.secrets.acls +WHERE scope = '{{ scope }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +permission, +principal +FROM databricks_workspace.secrets.acls +WHERE principal = '{{ principal }}' AND +scope = '{{ scope }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `REPLACE` example + +Replaces a acls resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.secrets.acls +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a acls resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.secrets.acls +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/index.md new file mode 100644 index 0000000000..12ac270984 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/index.md @@ -0,0 +1,39 @@ +--- +title: secrets +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - secrets + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`secrets`__ service documentation. + +:::info Service Summary + +
+
+total resources: 3
+
+
+ +::: + +## Resources +
+
+acls
+scopes
+
+
+secrets
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/scopes/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/scopes/index.md new file mode 100644 index 0000000000..0bc9c4dbb2 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/scopes/index.md @@ -0,0 +1,110 @@ +--- +title: scopes +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - scopes + - secrets + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a scopes resource. + +## Overview + + + + +
Namescopes
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists all secret scopes available in the workspace. | +| | `INSERT` | | The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters. | +| | `DELETE` | | Deletes a secret scope. | + +## `SELECT` examples + +```sql +SELECT +name, +backend_type +FROM databricks_workspace.secrets.scopes +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new scopes resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.secrets.scopes ( +deployment_name, +data__scope, +data__initial_manage_principal, +data__scope_backend_type +) +SELECT +'{{ deployment_name }}', +'{{ scope }}', +'{{ initial_manage_principal }}', +'{{ scope_backend_type }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: scope + value: string + - name: initial_manage_principal + value: string + - name: scope_backend_type + value: DATABRICKS + +``` + + + + +## `DELETE` example + +Deletes a scopes resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.secrets.scopes +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/secrets/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/secrets/index.md new file mode 100644 index 0000000000..84a5e9d3cf --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/secrets/secrets/index.md @@ -0,0 +1,101 @@ +--- +title: secrets +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - secrets + - secrets + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a secrets resource. + +## Overview + + + + +
Namesecrets
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the bytes representation of a secret value for the specified scope and key. | +| | `SELECT` | | Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret data cannot be retrieved using this API. Users need the READ permission to make this call. | +| | `DELETE` | | Deletes the secret stored in this secret scope. You must have | +| | `REPLACE` | | Inserts a secret under the provided scope with the given name. If a secret already exists with the same name, this command overwrites the existing secret's value. The server encrypts the secret using the secret scope's encryption settings before storing it. | + +## `SELECT` examples + + + + +```sql +SELECT +key, +last_updated_timestamp +FROM databricks_workspace.secrets.secrets +WHERE scope = '{{ scope }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +key, +last_updated_timestamp +FROM databricks_workspace.secrets.secrets +WHERE key = '{{ key }}' AND +scope = '{{ scope }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `REPLACE` example + +Replaces a secrets resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.secrets.secrets +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a secrets resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.secrets.secrets +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/artifact_allow_lists/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/artifact_allow_lists/index.md new file mode 100644 index 0000000000..fac742d02c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/artifact_allow_lists/index.md @@ -0,0 +1,69 @@ +--- +title: artifact_allow_lists +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - artifact_allow_lists + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a artifact_allow_lists resource. + +## Overview + + + + +
Nameartifact_allow_lists
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get the artifact allowlist of a certain artifact type. The caller must be a metastore admin or have the | +| | `UPDATE` | | Set the artifact allowlist of a certain artifact type. The whole artifact allowlist is replaced with the new allowlist. The caller must be a metastore admin or have the | + +## `SELECT` examples + +```sql +SELECT +artifact_matchers, +created_at, +created_by, +metastore_id +FROM databricks_workspace.unitycatalog.artifact_allow_lists +WHERE artifact_type = '{{ artifact_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a artifact_allow_lists resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.artifact_allow_lists +SET { field = value } +WHERE artifact_type = '{{ artifact_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/catalogs/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/catalogs/index.md new file mode 100644 index 0000000000..84956b5124 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/catalogs/index.md @@ -0,0 +1,239 @@ +--- +title: catalogs +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - catalogs + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a catalogs resource. + +## Overview + + + + +
Namecatalogs
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of the catalog, or a user that has the | +| | `SELECT` | | Gets an array of catalogs in the metastore. If the caller is the metastore admin, all catalogs will be retrieved. Otherwise, only catalogs owned by the caller (or for which the caller has the | +| | `INSERT` | | Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the | +| | `DELETE` | | Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner of the catalog. | +| | `UPDATE` | | Updates the catalog that matches the supplied name. The caller must be either the owner of the catalog, or a metastore admin (when changing the owner field of the catalog). | + +## `SELECT` examples + + + + +```sql +SELECT +name, +browse_only, +catalog_type, +comment, +connection_name, +created_at, +created_by, +effective_predictive_optimization_flag, +enable_predictive_optimization, +full_name, +isolation_mode, +metastore_id, +options, +owner, +properties, +provider_name, +provisioning_info, +securable_kind, +securable_type, +share_name, +storage_location, +storage_root, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.catalogs +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +browse_only, +catalog_type, +comment, +connection_name, +created_at, +created_by, +effective_predictive_optimization_flag, +enable_predictive_optimization, +full_name, +isolation_mode, +metastore_id, +options, +owner, +properties, +provider_name, +provisioning_info, +securable_kind, +securable_type, +share_name, +storage_location, +storage_root, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.catalogs +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new catalogs resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.catalogs ( +deployment_name, +data__name, +data__comment, +data__properties, +data__storage_root, +data__provider_name, +data__share_name, +data__connection_name, +data__options +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ comment }}', +'{{ properties }}', +'{{ storage_root }}', +'{{ provider_name }}', +'{{ share_name }}', +'{{ connection_name }}', +'{{ options }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: comment + value: string + - name: properties + value: + property1: string + property2: string + - name: storage_root + value: string + - name: provider_name + value: string + - name: share_name + value: string + - name: connection_name + value: string + - name: options + value: + property1: string + property2: string + +``` + + + + +## `UPDATE` example + +Updates a catalogs resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.catalogs +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a catalogs resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.catalogs +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/connections/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/connections/index.md new file mode 100644 index 0000000000..3091838971 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/connections/index.md @@ -0,0 +1,216 @@ +--- +title: connections +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - connections + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a connections resource. + +## Overview + + + + +
Nameconnections
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `object` | +| | `object` | +| | `boolean` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a connection from it's name. | +| | `SELECT` | | List all connections. | +| | `INSERT` | | Creates a new connection | +| | `DELETE` | | Deletes the connection that matches the supplied name. | +| | `UPDATE` | | Updates the connection that matches the supplied name. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +comment, +connection_id, +connection_type, +created_at, +created_by, +credential_type, +full_name, +metastore_id, +options, +owner, +properties, +provisioning_info, +read_only, +securable_kind, +securable_type, +updated_at, +updated_by, +url +FROM databricks_workspace.unitycatalog.connections +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +comment, +connection_id, +connection_type, +created_at, +created_by, +credential_type, +full_name, +metastore_id, +options, +owner, +properties, +provisioning_info, +read_only, +securable_kind, +securable_type, +updated_at, +updated_by, +url +FROM databricks_workspace.unitycatalog.connections +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new connections resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.connections ( +deployment_name, +data__name, +data__connection_type, +data__options, +data__read_only, +data__comment, +data__properties +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ connection_type }}', +'{{ options }}', +'{{ read_only }}', +'{{ comment }}', +'{{ properties }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: connection_type + value: MYSQL + - name: options + value: + property1: string + property2: string + - name: read_only + value: true + - name: comment + value: string + - name: properties + value: + property1: string + property2: string + +``` + + + + +## `UPDATE` example + +Updates a connections resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.connections +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a connections resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.connections +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/credential_validation/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/credential_validation/index.md new file mode 100644 index 0000000000..2c30ca24fa --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/credential_validation/index.md @@ -0,0 +1,51 @@ +--- +title: credential_validation +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - credential_validation + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a credential_validation resource. + +## Overview + + + + +
Namecredential_validation
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `boolean` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Validates a credential. | + +## `SELECT` examples + +```sql +SELECT +isDir, +results +FROM databricks_workspace.unitycatalog.credential_validation +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/credentials/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/credentials/index.md new file mode 100644 index 0000000000..5448a17a56 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/credentials/index.md @@ -0,0 +1,177 @@ +--- +title: credentials +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - credentials + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a credentials resource. + +## Overview + + + + +
Namecredentials
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns a set of temporary credentials generated using the specified service credential. The caller must be a metastore admin or have the metastore privilege | +| | `SELECT` | | Gets a service or storage credential from the metastore. The caller must be a metastore admin, the owner of the credential, or have any permission on the credential. | +| | `SELECT` | | Gets an array of credentials (as | +| | `INSERT` | | Creates a new credential. The type of credential to be created is determined by the | +| | `DELETE` | | Deletes a service or storage credential from the metastore. The caller must be an owner of the credential. | +| | `UPDATE` | | Updates a service or storage credential on the metastore. | + +## `SELECT` examples + + + + +```sql +SELECT +aws_temp_credentials, +expiration_time +FROM databricks_workspace.unitycatalog.credentials +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +aws_temp_credentials, +expiration_time +FROM databricks_workspace.unitycatalog.credentials +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +aws_temp_credentials, +expiration_time +FROM databricks_workspace.unitycatalog.credentials +WHERE name_arg = '{{ name_arg }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new credentials resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.credentials ( +deployment_name, +data__name, +data__aws_iam_role, +data__comment, +data__read_only, +data__purpose, +data__skip_validation +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ aws_iam_role }}', +'{{ comment }}', +'{{ read_only }}', +'{{ purpose }}', +'{{ skip_validation }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: aws_iam_role + value: + role_arn: string + unity_catalog_iam_arn: string + external_id: string + - name: comment + value: string + - name: read_only + value: true + - name: purpose + value: STORAGE + - name: skip_validation + value: false + +``` + + + + +## `UPDATE` example + +Updates a credentials resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.credentials +SET { field = value } +WHERE name_arg = '{{ name_arg }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a credentials resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.credentials +WHERE name_arg = '{{ name_arg }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/effective_grants/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/effective_grants/index.md new file mode 100644 index 0000000000..5a113e4d5c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/effective_grants/index.md @@ -0,0 +1,53 @@ +--- +title: effective_grants +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - effective_grants + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a effective_grants resource. + +## Overview + + + + +
Nameeffective_grants
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the effective permissions for a securable. | + +## `SELECT` examples + +```sql +SELECT +principal, +privileges +FROM databricks_workspace.unitycatalog.effective_grants +WHERE full_name = '{{ full_name }}' AND +securable_type = '{{ securable_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/external_locations/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/external_locations/index.md new file mode 100644 index 0000000000..586da733fb --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/external_locations/index.md @@ -0,0 +1,204 @@ +--- +title: external_locations +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - external_locations + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a external_locations resource. + +## Overview + + + + +
Nameexternal_locations
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an external location from the metastore. The caller must be either a metastore admin, the owner of the external location, or a user that has some privilege on the external location. | +| | `SELECT` | | Gets an array of external locations ( | +| | `INSERT` | | Creates a new external location entry in the metastore. The caller must be a metastore admin or have the | +| | `DELETE` | | Deletes the specified external location from the metastore. The caller must be the owner of the external location. | +| | `UPDATE` | | Updates an external location in the metastore. The caller must be the owner of the external location, or be a metastore admin. In the second case, the admin can only update the name of the external location. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +access_point, +browse_only, +comment, +created_at, +created_by, +credential_id, +credential_name, +isolation_mode, +metastore_id, +owner, +read_only, +updated_at, +updated_by, +url +FROM databricks_workspace.unitycatalog.external_locations +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +access_point, +browse_only, +comment, +created_at, +created_by, +credential_id, +credential_name, +isolation_mode, +metastore_id, +owner, +read_only, +updated_at, +updated_by, +url +FROM databricks_workspace.unitycatalog.external_locations +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new external_locations resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.external_locations ( +deployment_name, +data__name, +data__url, +data__credential_name, +data__read_only, +data__comment, +data__access_point, +data__skip_validation +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ url }}', +'{{ credential_name }}', +'{{ read_only }}', +'{{ comment }}', +'{{ access_point }}', +'{{ skip_validation }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: url + value: string + - name: credential_name + value: string + - name: read_only + value: true + - name: comment + value: string + - name: access_point + value: string + - name: skip_validation + value: true + +``` + + + + +## `UPDATE` example + +Updates a external_locations resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.external_locations +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a external_locations resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.external_locations +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/functions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/functions/index.md new file mode 100644 index 0000000000..543f4acbef --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/functions/index.md @@ -0,0 +1,279 @@ +--- +title: functions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - functions + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a functions resource. + +## Overview + + + + +
Namefunctions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `boolean` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a function from within a parent catalog and schema. For the fetch to succeed, the user must satisfy one of the following requirements: | +| | `SELECT` | | List functions within the specified parent catalog and schema. If the user is a metastore admin, all functions are returned in the output list. Otherwise, the user must have the | +| | `INSERT` | | | +| | `DELETE` | | Deletes the function that matches the supplied name. For the deletion to succeed, the user must satisfy one of the following conditions: | +| | `UPDATE` | | Updates the function that matches the supplied name. Only the owner of the function can be updated. If the user is not a metastore admin, the user must be a member of the group that is the new function owner. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +browse_only, +catalog_name, +comment, +created_at, +created_by, +data_type, +external_language, +external_name, +full_data_type, +full_name, +function_id, +input_params, +is_deterministic, +is_null_call, +metastore_id, +owner, +parameter_style, +properties, +return_params, +routine_body, +routine_definition, +routine_dependencies, +schema_name, +security_type, +specific_name, +sql_data_access, +sql_path, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.functions +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +browse_only, +catalog_name, +comment, +created_at, +created_by, +data_type, +external_language, +external_name, +full_data_type, +full_name, +function_id, +input_params, +is_deterministic, +is_null_call, +metastore_id, +owner, +parameter_style, +properties, +return_params, +routine_body, +routine_definition, +routine_dependencies, +schema_name, +security_type, +specific_name, +sql_data_access, +sql_path, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.functions +WHERE catalog_name = '{{ catalog_name }}' AND +schema_name = '{{ schema_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new functions resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.functions ( +deployment_name, +data__function_info +) +SELECT +'{{ deployment_name }}', +'{{ function_info }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: function_info + value: + name: string + catalog_name: string + schema_name: string + input_params: + parameters: + - name: string + type_text: string + type_json: string + type_name: BOOLEAN + type_precision: 0 + type_scale: 0 + type_interval_type: string + position: 0 + parameter_mode: IN + parameter_type: PARAM + parameter_default: string + comment: string + data_type: BOOLEAN + full_data_type: string + return_params: + parameters: + - name: string + type_text: string + type_json: string + type_name: BOOLEAN + type_precision: 0 + type_scale: 0 + type_interval_type: string + position: 0 + parameter_mode: IN + parameter_type: PARAM + parameter_default: string + comment: string + routine_definition: string + routine_dependencies: + dependencies: + - table: + table_full_name: string + function: + function_full_name: string + is_deterministic: true + is_null_call: true + specific_name: string + external_name: string + external_language: string + sql_path: string + comment: string + properties: string + routine_body: SQL + security_type: DEFINER + sql_data_access: CONTAINS_SQL + parameter_style: S + +``` + + + + +## `UPDATE` example + +Updates a functions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.functions +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a functions resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.functions +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/grants/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/grants/index.md new file mode 100644 index 0000000000..79dab0504b --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/grants/index.md @@ -0,0 +1,67 @@ +--- +title: grants +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - grants + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a grants resource. + +## Overview + + + + +
Namegrants
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions for a securable. | +| | `UPDATE` | | Updates the permissions for a securable. | + +## `SELECT` examples + +```sql +SELECT +principal, +privileges +FROM databricks_workspace.unitycatalog.grants +WHERE full_name = '{{ full_name }}' AND +securable_type = '{{ securable_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a grants resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.grants +SET { field = value } +WHERE full_name = '{{ full_name }}' AND +securable_type = '{{ securable_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/index.md new file mode 100644 index 0000000000..7d4e90c10f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/index.md @@ -0,0 +1,66 @@ +--- +title: unitycatalog +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`unitycatalog`__ service documentation. + +:::info Service Summary + +
+
+total resources: 30
+
+
+ +::: + +## Resources +
+
+artifact_allow_lists
+catalogs
+connections
+credential_validation
+credentials
+effective_grants
+external_locations
+functions
+grants
+metastore_assignments
+metastore_summary
+metastores
+model_versions
+online_tables
+quality_monitor_refreshes
+
+
+quality_monitors
+registered_model_aliases
+registered_models
+resource_quotas
+schemas
+storage_credential_validation
+storage_credentials
+system_schemas
+table_constraints
+table_exists
+table_summaries
+tables
+temporary_table_credentials
+volumes
+workspace_bindings
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastore_assignments/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastore_assignments/index.md new file mode 100644 index 0000000000..088975e14e --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastore_assignments/index.md @@ -0,0 +1,125 @@ +--- +title: metastore_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - metastore_assignments + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a metastore_assignments resource. + +## Overview + + + + +
Namemetastore_assignments
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the metastore assignment for the workspace being accessed. | +| | `INSERT` | | Creates a new metastore assignment. If an assignment for the same | +| | `DELETE` | | Deletes a metastore assignment. The caller must be an account administrator. | +| | `UPDATE` | | Updates a metastore assignment. This operation can be used to update | + +## `SELECT` examples + +```sql +SELECT +default_catalog_name, +metastore_id, +workspace_id +FROM databricks_workspace.unitycatalog.metastore_assignments +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new metastore_assignments resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.metastore_assignments ( +workspace_id, +deployment_name, +data__metastore_id, +data__default_catalog_name +) +SELECT +'{{ workspace_id }}', +'{{ deployment_name }}', +'{{ metastore_id }}', +'{{ default_catalog_name }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: metastore_id + value: string + - name: default_catalog_name + value: string + +``` + + + + +## `UPDATE` example + +Updates a metastore_assignments resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.metastore_assignments +SET { field = value } +WHERE workspace_id = '{{ workspace_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a metastore_assignments resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.metastore_assignments +WHERE metastore_id = '{{ metastore_id }}' AND +workspace_id = '{{ workspace_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastore_summary/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastore_summary/index.md new file mode 100644 index 0000000000..cf8487c7ef --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastore_summary/index.md @@ -0,0 +1,85 @@ +--- +title: metastore_summary +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - metastore_summary + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a metastore_summary resource. + +## Overview + + + + +
Namemetastore_summary
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets information about a metastore. This summary includes the storage credential, the cloud vendor, the cloud region, and the global metastore ID. | + +## `SELECT` examples + +```sql +SELECT +name, +cloud, +created_at, +created_by, +default_data_access_config_id, +delta_sharing_organization_name, +delta_sharing_recipient_token_lifetime_in_seconds, +delta_sharing_scope, +external_access_enabled, +global_metastore_id, +metastore_id, +owner, +privilege_model_version, +region, +storage_root, +storage_root_credential_id, +storage_root_credential_name, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.metastore_summary +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastores/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastores/index.md new file mode 100644 index 0000000000..69a2605446 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/metastores/index.md @@ -0,0 +1,200 @@ +--- +title: metastores +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - metastores + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a metastores resource. + +## Overview + + + + +
Namemetastores
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this info. | +| | `SELECT` | | Gets an array of the available metastores (as | +| | `INSERT` | | Creates a new metastore based on a provided name and optional storage root path. By default (if the | +| | `DELETE` | | Deletes a metastore. The caller must be a metastore admin. | +| | `UPDATE` | | Updates information for a specific metastore. The caller must be a metastore admin. If the | + +## `SELECT` examples + + + + +```sql +SELECT +name, +cloud, +created_at, +created_by, +default_data_access_config_id, +delta_sharing_organization_name, +delta_sharing_recipient_token_lifetime_in_seconds, +delta_sharing_scope, +external_access_enabled, +global_metastore_id, +metastore_id, +owner, +privilege_model_version, +region, +storage_root, +storage_root_credential_id, +storage_root_credential_name, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.metastores +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +cloud, +created_at, +created_by, +default_data_access_config_id, +delta_sharing_organization_name, +delta_sharing_recipient_token_lifetime_in_seconds, +delta_sharing_scope, +external_access_enabled, +global_metastore_id, +metastore_id, +owner, +privilege_model_version, +region, +storage_root, +storage_root_credential_id, +storage_root_credential_name, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.metastores +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new metastores resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.metastores ( +deployment_name, +data__name, +data__storage_root, +data__region +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ storage_root }}', +'{{ region }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: storage_root + value: string + - name: region + value: string + +``` + + + + +## `UPDATE` example + +Updates a metastores resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.metastores +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a metastores resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.metastores +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/model_versions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/model_versions/index.md new file mode 100644 index 0000000000..563851d3ee --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/model_versions/index.md @@ -0,0 +1,176 @@ +--- +title: model_versions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - model_versions + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a model_versions resource. + +## Overview + + + + +
Namemodel_versions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a model version. | +| | `SELECT` | | Get a model version by alias. | +| | `SELECT` | | List model versions. You can list model versions under a particular schema, or list all model versions in the current metastore. | +| | `DELETE` | | Deletes a model version from the specified registered model. Any aliases assigned to the model version will also be deleted. | +| | `UPDATE` | | Updates the specified model version. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +catalog_name, +comment, +created_at, +created_by, +metastore_id, +model_name, +run_id, +run_workspace_id, +schema_name, +source, +status, +storage_location, +updated_at, +updated_by, +version +FROM databricks_workspace.unitycatalog.model_versions +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +catalog_name, +comment, +created_at, +created_by, +metastore_id, +model_name, +run_id, +run_workspace_id, +schema_name, +source, +status, +storage_location, +updated_at, +updated_by, +version +FROM databricks_workspace.unitycatalog.model_versions +WHERE full_name = '{{ full_name }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +catalog_name, +comment, +created_at, +created_by, +metastore_id, +model_name, +run_id, +run_workspace_id, +schema_name, +source, +status, +storage_location, +updated_at, +updated_by, +version +FROM databricks_workspace.unitycatalog.model_versions +WHERE alias = '{{ alias }}' AND +full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `UPDATE` example + +Updates a model_versions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.model_versions +SET { field = value } +WHERE full_name = '{{ full_name }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a model_versions resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.model_versions +WHERE full_name = '{{ full_name }}' AND +version = '{{ version }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/online_tables/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/online_tables/index.md new file mode 100644 index 0000000000..610ec0e06f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/online_tables/index.md @@ -0,0 +1,122 @@ +--- +title: online_tables +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - online_tables + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a online_tables resource. + +## Overview + + + + +
Nameonline_tables
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get information about an existing online table and its status. | +| | `INSERT` | | Create a new Online Table. | +| | `DELETE` | | Delete an online table. Warning: This will delete all the data in the online table. If the source Delta table was deleted or modified since this Online Table was created, this will lose the data forever! | + +## `SELECT` examples + +```sql +SELECT +name, +spec, +status, +table_serving_url, +unity_catalog_provisioning_state +FROM databricks_workspace.unitycatalog.online_tables +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new online_tables resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.online_tables ( +deployment_name, +data__name, +data__spec +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ spec }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: spec + value: + run_continuously: {} + run_triggered: {} + source_table_full_name: string + primary_key_columns: + - string + timeseries_key: string + perform_full_copy: false + pipeline_id: string + +``` + + + + +## `DELETE` example + +Deletes a online_tables resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.online_tables +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/quality_monitor_refreshes/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/quality_monitor_refreshes/index.md new file mode 100644 index 0000000000..207622bf97 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/quality_monitor_refreshes/index.md @@ -0,0 +1,91 @@ +--- +title: quality_monitor_refreshes +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - quality_monitor_refreshes + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a quality_monitor_refreshes resource. + +## Overview + + + + +
Namequality_monitor_refreshes
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `string` | +| | `integer` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets info about a specific monitor refresh using the given refresh ID. | +| | `SELECT` | | Gets an array containing the history of the most recent refreshes (up to 25) for this table. | +| | `EXEC` | | Queues a metric refresh on the monitor for the specified table. The refresh will execute in the background. | + +## `SELECT` examples + + + + +```sql +SELECT +end_time_ms, +message, +refresh_id, +start_time_ms, +state, +trigger +FROM databricks_workspace.unitycatalog.quality_monitor_refreshes +WHERE table_name = '{{ table_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +end_time_ms, +message, +refresh_id, +start_time_ms, +state, +trigger +FROM databricks_workspace.unitycatalog.quality_monitor_refreshes +WHERE refresh_id = '{{ refresh_id }}' AND +table_name = '{{ table_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/quality_monitors/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/quality_monitors/index.md new file mode 100644 index 0000000000..0dece57fc8 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/quality_monitors/index.md @@ -0,0 +1,217 @@ +--- +title: quality_monitors +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - quality_monitors + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a quality_monitors resource. + +## Overview + + + + +
Namequality_monitors
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | +| | `array` | +| | `object` | +| | `string` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a monitor for the specified table. | +| | `INSERT` | | Creates a new monitor for the specified table. | +| | `DELETE` | | Deletes a monitor for the specified table. | +| | `UPDATE` | | Updates a monitor for the specified table. | + +## `SELECT` examples + +```sql +SELECT +assets_dir, +baseline_table_name, +custom_metrics, +dashboard_id, +drift_metrics_table_name, +inference_log, +latest_monitor_failure_msg, +monitor_version, +notifications, +output_schema_name, +profile_metrics_table_name, +schedule, +slicing_exprs, +snapshot, +status, +table_name, +time_series +FROM databricks_workspace.unitycatalog.quality_monitors +WHERE table_name = '{{ table_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new quality_monitors resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.quality_monitors ( +table_name, +deployment_name, +data__skip_builtin_dashboard, +data__warehouse_id, +data__assets_dir, +data__output_schema_name, +data__inference_log, +data__time_series, +data__snapshot, +data__slicing_exprs, +data__custom_metrics, +data__baseline_table_name, +data__schedule, +data__notifications +) +SELECT +'{{ table_name }}', +'{{ deployment_name }}', +'{{ skip_builtin_dashboard }}', +'{{ warehouse_id }}', +'{{ assets_dir }}', +'{{ output_schema_name }}', +'{{ inference_log }}', +'{{ time_series }}', +'{{ snapshot }}', +'{{ slicing_exprs }}', +'{{ custom_metrics }}', +'{{ baseline_table_name }}', +'{{ schedule }}', +'{{ notifications }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: skip_builtin_dashboard + value: true + - name: warehouse_id + value: string + - name: assets_dir + value: string + - name: output_schema_name + value: string + - name: inference_log + value: + problem_type: PROBLEM_TYPE_CLASSIFICATION + timestamp_col: string + granularities: + - string + prediction_col: string + label_col: string + model_id_col: string + prediction_proba_col: string + - name: time_series + value: + timestamp_col: string + granularities: + - string + - name: snapshot + value: {} + - name: slicing_exprs + value: + - string + - name: custom_metrics + value: + - name: string + definition: string + input_columns: + - string + output_data_type: string + type: CUSTOM_METRIC_TYPE_AGGREGATE + - name: baseline_table_name + value: string + - name: schedule + value: + quartz_cron_expression: string + timezone_id: string + pause_status: UNPAUSED + - name: notifications + value: + on_failure: + email_addresses: + - string + +``` + + + + +## `UPDATE` example + +Updates a quality_monitors resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.quality_monitors +SET { field = value } +WHERE table_name = '{{ table_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a quality_monitors resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.quality_monitors +WHERE table_name = '{{ table_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/registered_model_aliases/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/registered_model_aliases/index.md new file mode 100644 index 0000000000..8337aafd46 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/registered_model_aliases/index.md @@ -0,0 +1,63 @@ +--- +title: registered_model_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - registered_model_aliases + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a registered_model_aliases resource. + +## Overview + + + + +
Nameregistered_model_aliases
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | Deletes a registered model alias. | +| | `REPLACE` | | Set an alias on the specified registered model. | + +## `REPLACE` example + +Replaces a registered_model_aliases resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.unitycatalog.registered_model_aliases +SET { field = value } +WHERE alias = '{{ alias }}' AND +full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a registered_model_aliases resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.registered_model_aliases +WHERE alias = '{{ alias }}' AND +full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/registered_models/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/registered_models/index.md new file mode 100644 index 0000000000..d77e06481f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/registered_models/index.md @@ -0,0 +1,193 @@ +--- +title: registered_models +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - registered_models + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a registered_models resource. + +## Overview + + + + +
Nameregistered_models
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a registered model. | +| | `SELECT` | | List registered models. You can list registered models under a particular schema, or list all registered models in the current metastore. | +| | `INSERT` | | Creates a new registered model in Unity Catalog. | +| | `DELETE` | | Deletes a registered model and all its model versions from the specified parent catalog and schema. | +| | `UPDATE` | | Updates the specified registered model. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +catalog_name, +comment, +created_at, +created_by, +full_name, +metastore_id, +owner, +schema_name, +securable_kind, +securable_type, +storage_location, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.registered_models +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +catalog_name, +comment, +created_at, +created_by, +full_name, +metastore_id, +owner, +schema_name, +securable_kind, +securable_type, +storage_location, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.registered_models +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new registered_models resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.registered_models ( +deployment_name, +data__name, +data__catalog_name, +data__schema_name, +data__comment +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ catalog_name }}', +'{{ schema_name }}', +'{{ comment }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: revenue_forecasting_model + - name: catalog_name + value: main + - name: schema_name + value: default + - name: comment + value: This model contains model versions that forecast future revenue, given + historical data + +``` + + + + +## `UPDATE` example + +Updates a registered_models resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.registered_models +SET { field = value } +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a registered_models resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.registered_models +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/resource_quotas/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/resource_quotas/index.md new file mode 100644 index 0000000000..4b542c37fb --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/resource_quotas/index.md @@ -0,0 +1,90 @@ +--- +title: resource_quotas +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - resource_quotas + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a resource_quotas resource. + +## Overview + + + + +
Nameresource_quotas
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `string` | +| | `string` | +| | `integer` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | The GetQuota API returns usage information for a single resource quota, defined as a child-parent pair. This API also refreshes the quota count if it is out of date. Refreshes are triggered asynchronously. The updated count might not be returned in the first call. | +| | `SELECT` | | ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the counts returned. This API does not trigger a refresh of quota counts. | + +## `SELECT` examples + + + + +```sql +SELECT +last_refreshed_at, +parent_full_name, +parent_securable_type, +quota_count, +quota_limit, +quota_name +FROM databricks_workspace.unitycatalog.resource_quotas +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +last_refreshed_at, +parent_full_name, +parent_securable_type, +quota_count, +quota_limit, +quota_name +FROM databricks_workspace.unitycatalog.resource_quotas +WHERE parent_full_name = '{{ parent_full_name }}' AND +parent_securable_type = '{{ parent_securable_type }}' AND +quota_name = '{{ quota_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/schemas/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/schemas/index.md new file mode 100644 index 0000000000..df21eb4c8b --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/schemas/index.md @@ -0,0 +1,208 @@ +--- +title: schemas +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - schemas + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a schemas resource. + +## Overview + + + + +
Nameschemas
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `boolean` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the specified schema within the metastore. The caller must be a metastore admin, the owner of the schema, or a user that has the | +| | `SELECT` | | Gets an array of schemas for a catalog in the metastore. If the caller is the metastore admin or the owner of the parent catalog, all schemas for the catalog will be retrieved. Otherwise, only schemas owned by the caller (or for which the caller has the | +| | `INSERT` | | Creates a new schema for catalog in the Metatastore. The caller must be a metastore admin, or have the | +| | `DELETE` | | Deletes the specified schema from the parent catalog. The caller must be the owner of the schema or an owner of the parent catalog. | +| | `UPDATE` | | Updates a schema for a catalog. The caller must be the owner of the schema or a metastore admin. If the caller is a metastore admin, only the | + +## `SELECT` examples + + + + +```sql +SELECT +name, +browse_only, +catalog_name, +catalog_type, +comment, +created_at, +created_by, +effective_predictive_optimization_flag, +enable_predictive_optimization, +full_name, +metastore_id, +owner, +properties, +schema_id, +storage_location, +storage_root, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.schemas +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +browse_only, +catalog_name, +catalog_type, +comment, +created_at, +created_by, +effective_predictive_optimization_flag, +enable_predictive_optimization, +full_name, +metastore_id, +owner, +properties, +schema_id, +storage_location, +storage_root, +updated_at, +updated_by +FROM databricks_workspace.unitycatalog.schemas +WHERE catalog_name = '{{ catalog_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new schemas resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.schemas ( +deployment_name, +data__name, +data__catalog_name, +data__comment, +data__properties, +data__storage_root +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ catalog_name }}', +'{{ comment }}', +'{{ properties }}', +'{{ storage_root }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: catalog_name + value: string + - name: comment + value: string + - name: properties + value: + property1: string + property2: string + - name: storage_root + value: string + +``` + + + + +## `UPDATE` example + +Updates a schemas resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.schemas +SET { field = value } +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a schemas resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.schemas +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/storage_credential_validation/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/storage_credential_validation/index.md new file mode 100644 index 0000000000..2b1cab6b4c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/storage_credential_validation/index.md @@ -0,0 +1,51 @@ +--- +title: storage_credential_validation +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - storage_credential_validation + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a storage_credential_validation resource. + +## Overview + + + + +
Namestorage_credential_validation
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `boolean` | +| | `array` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Validates a storage credential. At least one of | + +## `SELECT` examples + +```sql +SELECT +isDir, +results +FROM databricks_workspace.unitycatalog.storage_credential_validation +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/storage_credentials/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/storage_credentials/index.md new file mode 100644 index 0000000000..4cf907878d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/storage_credentials/index.md @@ -0,0 +1,194 @@ +--- +title: storage_credentials +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - storage_credentials + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a storage_credentials resource. + +## Overview + + + + +
Namestorage_credentials
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `integer` | +| | `string` | +| | `boolean` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have some permission on the storage credential. | +| | `SELECT` | | Gets an array of storage credentials (as | +| | `INSERT` | | Creates a new storage credential. | +| | `DELETE` | | Deletes a storage credential from the metastore. The caller must be an owner of the storage credential. | +| | `UPDATE` | | Updates a storage credential on the metastore. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +aws_iam_role, +comment, +created_at, +created_by, +full_name, +isolation_mode, +metastore_id, +owner, +read_only, +updated_at, +updated_by, +used_for_managed_storage +FROM databricks_workspace.unitycatalog.storage_credentials +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +aws_iam_role, +comment, +created_at, +created_by, +full_name, +isolation_mode, +metastore_id, +owner, +read_only, +updated_at, +updated_by, +used_for_managed_storage +FROM databricks_workspace.unitycatalog.storage_credentials +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new storage_credentials resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.storage_credentials ( +deployment_name, +data__name, +data__comment, +data__read_only, +data__aws_iam_role, +data__skip_validation +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ comment }}', +'{{ read_only }}', +'{{ aws_iam_role }}', +'{{ skip_validation }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: string + - name: comment + value: string + - name: read_only + value: true + - name: aws_iam_role + value: + role_arn: string + - name: skip_validation + value: false + +``` + + + + +## `UPDATE` example + +Updates a storage_credentials resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.storage_credentials +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a storage_credentials resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.storage_credentials +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/system_schemas/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/system_schemas/index.md new file mode 100644 index 0000000000..b47e1bc596 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/system_schemas/index.md @@ -0,0 +1,54 @@ +--- +title: system_schemas +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - system_schemas + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a system_schemas resource. + +## Overview + + + + +
Namesystem_schemas
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore admin. | +| | `EXEC` | | Disables the system schema and removes it from the system catalog. The caller must be an account admin or a metastore admin. | +| | `EXEC` | | Enables the system schema and adds it to the system catalog. The caller must be an account admin or a metastore admin. | + +## `SELECT` examples + +```sql +SELECT +schema, +state +FROM databricks_workspace.unitycatalog.system_schemas +WHERE metastore_id = '{{ metastore_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_constraints/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_constraints/index.md new file mode 100644 index 0000000000..531556fc90 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_constraints/index.md @@ -0,0 +1,107 @@ +--- +title: table_constraints +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - table_constraints + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a table_constraints resource. + +## Overview + + + + +
Nametable_constraints
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `INSERT` | | Creates a new table constraint. | +| | `DELETE` | | Deletes a table constraint. | + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new table_constraints resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.table_constraints ( +deployment_name, +data__full_name_arg, +data__constraint +) +SELECT +'{{ deployment_name }}', +'{{ full_name_arg }}', +'{{ constraint }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: full_name_arg + value: string + - name: constraint + value: + primary_key_constraint: + name: string + child_columns: + - string + foreign_key_constraint: + name: string + child_columns: + - string + parent_table: string + parent_columns: + - string + named_table_constraint: + name: string + +``` + + + + +## `DELETE` example + +Deletes a table_constraints resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.table_constraints +WHERE cascade = '{{ cascade }}' AND +constraint_name = '{{ constraint_name }}' AND +full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_exists/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_exists/index.md new file mode 100644 index 0000000000..6c4750fa3f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_exists/index.md @@ -0,0 +1,50 @@ +--- +title: table_exists +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - table_exists + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a table_exists resource. + +## Overview + + + + +
Nametable_exists
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `boolean` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets if a table exists in the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements: | + +## `SELECT` examples + +```sql +SELECT +table_exists +FROM databricks_workspace.unitycatalog.table_exists +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_summaries/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_summaries/index.md new file mode 100644 index 0000000000..f2c51672e6 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/table_summaries/index.md @@ -0,0 +1,52 @@ +--- +title: table_summaries +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - table_summaries + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a table_summaries resource. + +## Overview + + + + +
Nametable_summaries
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an array of summaries for tables for a schema and catalog within the metastore. The table summaries returned are either: | + +## `SELECT` examples + +```sql +SELECT +full_name, +table_type +FROM databricks_workspace.unitycatalog.table_summaries +WHERE catalog_name = '{{ catalog_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/tables/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/tables/index.md new file mode 100644 index 0000000000..217233cf00 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/tables/index.md @@ -0,0 +1,177 @@ +--- +title: tables +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - tables + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a tables resource. + +## Overview + + + + +
Nametables
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `boolean` | +| | `string` | +| | `array` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `array` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements: | +| | `SELECT` | | Gets an array of all tables for the current metastore under the parent catalog and schema. The caller must be a metastore admin or an owner of (or have the | +| | `DELETE` | | Deletes a table from the specified parent catalog and schema. The caller must be the owner of the parent catalog, have the | + +## `SELECT` examples + + + + +```sql +SELECT +name, +access_point, +browse_only, +catalog_name, +columns, +comment, +created_at, +created_by, +data_access_configuration_id, +data_source_format, +deleted_at, +delta_runtime_properties_kvpairs, +effective_predictive_optimization_flag, +enable_predictive_optimization, +full_name, +metastore_id, +owner, +pipeline_id, +properties, +row_filter, +schema_name, +sql_path, +storage_credential_name, +storage_location, +table_constraints, +table_id, +table_type, +updated_at, +updated_by, +view_definition, +view_dependencies +FROM databricks_workspace.unitycatalog.tables +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +access_point, +browse_only, +catalog_name, +columns, +comment, +created_at, +created_by, +data_access_configuration_id, +data_source_format, +deleted_at, +delta_runtime_properties_kvpairs, +effective_predictive_optimization_flag, +enable_predictive_optimization, +full_name, +metastore_id, +owner, +pipeline_id, +properties, +row_filter, +schema_name, +sql_path, +storage_credential_name, +storage_location, +table_constraints, +table_id, +table_type, +updated_at, +updated_by, +view_definition, +view_dependencies +FROM databricks_workspace.unitycatalog.tables +WHERE catalog_name = '{{ catalog_name }}' AND +schema_name = '{{ schema_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `DELETE` example + +Deletes a tables resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.tables +WHERE full_name = '{{ full_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/temporary_table_credentials/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/temporary_table_credentials/index.md new file mode 100644 index 0000000000..52aeea0675 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/temporary_table_credentials/index.md @@ -0,0 +1,59 @@ +--- +title: temporary_table_credentials +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - temporary_table_credentials + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a temporary_table_credentials resource. + +## Overview + + + + +
Nametemporary_table_credentials
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `object` | +| | `integer` | +| | `object` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get a short-lived credential for directly accessing the table data on cloud storage. The metastore must have external_access_enabled flag set to true (default false). The caller must have EXTERNAL_USE_SCHEMA privilege on the parent schema and this privilege can only be granted by catalog owners. | + +## `SELECT` examples + +```sql +SELECT +aws_temp_credentials, +azure_user_delegation_sas, +expiration_time, +gcp_oauth_token, +r2_temp_credentials, +url +FROM databricks_workspace.unitycatalog.temporary_table_credentials +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/volumes/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/volumes/index.md new file mode 100644 index 0000000000..994c5d3f2e --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/volumes/index.md @@ -0,0 +1,199 @@ +--- +title: volumes +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - volumes + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a volumes resource. + +## Overview + + + + +
Namevolumes
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an array of volumes for the current metastore under the parent catalog and schema. | +| | `SELECT` | | Gets a volume from the metastore for a specific catalog and schema. | +| | `INSERT` | | Creates a new volume. | +| | `DELETE` | | Deletes a volume from the specified parent catalog and schema. | +| | `UPDATE` | | Updates the specified volume under the specified parent catalog and schema. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +catalog_name, +comment, +created_at, +created_by, +full_name, +metastore_id, +owner, +schema_name, +storage_location, +updated_at, +updated_by, +volume_id, +volume_type +FROM databricks_workspace.unitycatalog.volumes +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +catalog_name, +comment, +created_at, +created_by, +full_name, +metastore_id, +owner, +schema_name, +storage_location, +updated_at, +updated_by, +volume_id, +volume_type +FROM databricks_workspace.unitycatalog.volumes +WHERE catalog_name = '{{ catalog_name }}' AND +schema_name = '{{ schema_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new volumes resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.unitycatalog.volumes ( +deployment_name, +data__catalog_name, +data__schema_name, +data__name, +data__volume_type, +data__storage_location, +data__comment +) +SELECT +'{{ deployment_name }}', +'{{ catalog_name }}', +'{{ schema_name }}', +'{{ name }}', +'{{ volume_type }}', +'{{ storage_location }}', +'{{ comment }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: catalog_name + value: main + - name: schema_name + value: default + - name: name + value: my_volume + - name: volume_type + value: EXTERNAL + - name: storage_location + value: s3://my-bucket/hello/world/my-volume + - name: comment + value: This is my first volume + +``` + + + + +## `UPDATE` example + +Updates a volumes resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.volumes +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a volumes resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.unitycatalog.volumes +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/workspace_bindings/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/workspace_bindings/index.md new file mode 100644 index 0000000000..8589d71e1d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/unitycatalog/workspace_bindings/index.md @@ -0,0 +1,87 @@ +--- +title: workspace_bindings +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - workspace_bindings + - unitycatalog + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a workspace_bindings resource. + +## Overview + + + + +
Nameworkspace_bindings
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable. | +| | `UPDATE` | | Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog. | +| | `UPDATE` | | Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable. | + +## `SELECT` examples + +```sql +SELECT +binding_type, +workspace_id +FROM databricks_workspace.unitycatalog.workspace_bindings +WHERE securable_name = '{{ securable_name }}' AND +securable_type = '{{ securable_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a workspace_bindings resource. + + + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.workspace_bindings +SET { field = value } +WHERE name = '{{ name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + +```sql +/*+ update */ +UPDATE databricks_workspace.unitycatalog.workspace_bindings +SET { field = value } +WHERE securable_name = '{{ securable_name }}' AND +securable_type = '{{ securable_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/data_vector_indexes/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/data_vector_indexes/index.md new file mode 100644 index 0000000000..eb1a0ec5a8 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/data_vector_indexes/index.md @@ -0,0 +1,61 @@ +--- +title: data_vector_indexes +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - data_vector_indexes + - vectorsearch + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a data_vector_indexes resource. + +## Overview + + + + +
Namedata_vector_indexes
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | Handles the deletion of data from a specified vector index. | +| | `REPLACE` | | Handles the upserting of data into a specified vector index. | + +## `REPLACE` example + +Replaces a data_vector_indexes resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.vectorsearch.data_vector_indexes +SET { field = value } +WHERE index_name = '{{ index_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a data_vector_indexes resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.vectorsearch.data_vector_indexes +WHERE index_name = '{{ index_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/endpoints/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/endpoints/index.md new file mode 100644 index 0000000000..c41ea743d7 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/endpoints/index.md @@ -0,0 +1,153 @@ +--- +title: endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - endpoints + - vectorsearch + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a endpoints resource. + +## Overview + + + + +
Nameendpoints
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `integer` | +| | `string` | +| | `object` | +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | | +| | `SELECT` | | | +| | `INSERT` | | Create a new endpoint. | +| | `DELETE` | | | + +## `SELECT` examples + + + + +```sql +SELECT +id, +name, +creation_timestamp, +creator, +endpoint_status, +endpoint_type, +last_updated_timestamp, +last_updated_user, +num_indexes +FROM databricks_workspace.vectorsearch.endpoints +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +name, +creation_timestamp, +creator, +endpoint_status, +endpoint_type, +last_updated_timestamp, +last_updated_user, +num_indexes +FROM databricks_workspace.vectorsearch.endpoints +WHERE endpoint_name = '{{ endpoint_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new endpoints resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.vectorsearch.endpoints ( +deployment_name, +data__name, +data__endpoint_type +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ endpoint_type }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: docs-endpoint + - name: endpoint_type + value: STANDARD + +``` + + + + +## `DELETE` example + +Deletes a endpoints resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.vectorsearch.endpoints +WHERE endpoint_name = '{{ endpoint_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index.md new file mode 100644 index 0000000000..6ed43a3770 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index.md @@ -0,0 +1,41 @@ +--- +title: vectorsearch +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - vectorsearch + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`vectorsearch`__ service documentation. + +:::info Service Summary + +
+
+total resources: 5
+
+
+ +::: + +## Resources +
+
+data_vector_indexes
+endpoints
+index_query
+
+
+index_scan
+indexes
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index_query/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index_query/index.md new file mode 100644 index 0000000000..37a8152361 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index_query/index.md @@ -0,0 +1,54 @@ +--- +title: index_query +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - index_query + - vectorsearch + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a index_query resource. + +## Overview + + + + +
Nameindex_query
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Query the specified vector index. | + +## `SELECT` examples + +```sql +SELECT +manifest, +next_page_token, +result +FROM databricks_workspace.vectorsearch.index_query +WHERE index_name = '{{ index_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index_scan/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index_scan/index.md new file mode 100644 index 0000000000..e4cda39e5f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/index_scan/index.md @@ -0,0 +1,52 @@ +--- +title: index_scan +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - index_scan + - vectorsearch + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a index_scan resource. + +## Overview + + + + +
Nameindex_scan
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Scan the specified vector index and return the first | + +## `SELECT` examples + +```sql +SELECT +data, +last_primary_key +FROM databricks_workspace.vectorsearch.index_scan +WHERE index_name = '{{ index_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/indexes/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/indexes/index.md new file mode 100644 index 0000000000..b83159e935 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/vectorsearch/indexes/index.md @@ -0,0 +1,166 @@ +--- +title: indexes +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - indexes + - vectorsearch + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a indexes resource. + +## Overview + + + + +
Nameindexes
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Get an index. | +| | `SELECT` | | List all indexes in the given endpoint. | +| | `INSERT` | | Create a new index. | +| | `DELETE` | | Delete an index. | +| | `EXEC` | | Use | +| | `EXEC` | | Triggers a synchronization process for a specified vector index. | + +## `SELECT` examples + + + + +```sql +SELECT +name, +creator, +delta_sync_index_spec, +endpoint_name, +index_type, +primary_key, +status +FROM databricks_workspace.vectorsearch.indexes +WHERE index_name = '{{ index_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +name, +creator, +delta_sync_index_spec, +endpoint_name, +index_type, +primary_key, +status +FROM databricks_workspace.vectorsearch.indexes +WHERE endpoint_name = '{{ endpoint_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new indexes resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.vectorsearch.indexes ( +deployment_name, +data__name, +data__primary_key, +data__index_type, +data__delta_sync_index_spec +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ primary_key }}', +'{{ index_type }}', +'{{ delta_sync_index_spec }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: main_catalog.docs.en_wiki_index + - name: primary_key + value: id + - name: index_type + value: DELTA_SYNC + - name: delta_sync_index_spec + value: + source_table: main_catalog.docs.en_wiki + pipeline_type: TRIGGERED + embedding_source_columns: + - name: text + embedding_model_endpoint_name: e5-small-v2 + columns_to_sync: + - id + - text + +``` + + + + +## `DELETE` example + +Deletes a indexes resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.vectorsearch.indexes +WHERE index_name = '{{ index_name }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/index.md new file mode 100644 index 0000000000..72855b4962 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/index.md @@ -0,0 +1,42 @@ +--- +title: workflows +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - workflows + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`workflows`__ service documentation. + +:::info Service Summary + +
+
+total resources: 6
+
+
+ +::: + +## Resources +
+
+job_compliance
+job_permission_levels
+job_permissions
+
+
+job_run_output
+job_runs
+jobs
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_compliance/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_compliance/index.md new file mode 100644 index 0000000000..be7f0d4bbe --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_compliance/index.md @@ -0,0 +1,92 @@ +--- +title: job_compliance +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - job_compliance + - workflows + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a job_compliance resource. + +## Overview + + + + +
Namejob_compliance
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `boolean` | +| | `integer` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns the policy compliance status of a job. Jobs could be out of compliance if a cluster policy they use was updated after the job was last edited and some of its job clusters no longer comply with their updated policies. | +| | `SELECT` | | Returns the policy compliance status of all jobs that use a given policy. Jobs could be out of compliance if a cluster policy they use was updated after the job was last edited and its job clusters no longer comply with the updated policy. | +| | `REPLACE` | | Updates a job so the job clusters that are created when running the job (specified in | + +## `SELECT` examples + + + + +```sql +SELECT +is_compliant, +job_id, +violations +FROM databricks_workspace.workflows.job_compliance +WHERE job_id = '{{ job_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +is_compliant, +job_id, +violations +FROM databricks_workspace.workflows.job_compliance +WHERE policy_id = '{{ policy_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `REPLACE` example + +Replaces a job_compliance resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.workflows.job_compliance +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_permission_levels/index.md new file mode 100644 index 0000000000..349c30574f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_permission_levels/index.md @@ -0,0 +1,52 @@ +--- +title: job_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - job_permission_levels + - workflows + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a job_permission_levels resource. + +## Overview + + + + +
Namejob_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.workflows.job_permission_levels +WHERE job_id = '{{ job_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_permissions/index.md new file mode 100644 index 0000000000..5d3afcbd7e --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_permissions/index.md @@ -0,0 +1,80 @@ +--- +title: job_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - job_permissions + - workflows + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a job_permissions resource. + +## Overview + + + + +
Namejob_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a job. Jobs can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on a job. Jobs can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.workflows.job_permissions +WHERE job_id = '{{ job_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a job_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workflows.job_permissions +SET { field = value } +WHERE job_id = '{{ job_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a job_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.workflows.job_permissions +SET { field = value } +WHERE job_id = '{{ job_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_run_output/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_run_output/index.md new file mode 100644 index 0000000000..edeb65d85a --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_run_output/index.md @@ -0,0 +1,68 @@ +--- +title: job_run_output +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - job_run_output + - workflows + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a job_run_output resource. + +## Overview + + + + +
Namejob_run_output
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `string` | +| | `string` | +| | `string` | +| | `boolean` | +| | `object` | +| | `object` | +| | `object` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve the output and metadata of a single task run. When a notebook task returns a value through the | + +## `SELECT` examples + +```sql +SELECT +dbt_output, +error, +error_trace, +info, +logs, +logs_truncated, +metadata, +notebook_output, +run_job_output, +sql_output +FROM databricks_workspace.workflows.job_run_output +WHERE run_id = '{{ run_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_runs/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_runs/index.md new file mode 100644 index 0000000000..5d5c11f4ce --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/job_runs/index.md @@ -0,0 +1,181 @@ +--- +title: job_runs +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - job_runs + - workflows + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a job_runs resource. + +## Overview + + + + +
Namejob_runs
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `integer` | +| | `object` | +| | `object` | +| | `string` | +| | `integer` | +| | `integer` | +| | `object` | +| | `boolean` | +| | `array` | +| | `integer` | +| | `array` | +| | `integer` | +| | `integer` | +| | `integer` | +| | `object` | +| | `integer` | +| | `array` | +| | `integer` | +| | `integer` | +| | `string` | +| | `string` | +| | `string` | +| | `object` | +| | `integer` | +| | `integer` | +| | `object` | +| | `object` | +| | `array` | +| | `string` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves the metadata of a run. | +| | `SELECT` | | List runs in descending order by start time. | +| | `DELETE` | | Deletes a non-active run. Returns an error if the run is active. | +| | `EXEC` | | Cancels all active runs of a job. The runs are canceled asynchronously, so it doesn't prevent new runs from being started. | +| | `EXEC` | | Cancels a job run or a task run. The run is canceled asynchronously, so it may still be running when this request completes. | +| | `EXEC` | | Export and retrieve the job run task. | +| | `EXEC` | | Re-run one or more tasks. Tasks are re-run as part of the original job run. They use the current job and task settings, and can be viewed in the history for the original job run. | + +## `SELECT` examples + + + + +```sql +SELECT +description, +attempt_number, +cleanup_duration, +cluster_instance, +cluster_spec, +creator_user_name, +end_time, +execution_duration, +git_source, +has_more, +job_clusters, +job_id, +job_parameters, +job_run_id, +number_in_job, +original_attempt_run_id, +overriding_parameters, +queue_duration, +repair_history, +run_duration, +run_id, +run_name, +run_page_url, +run_type, +schedule, +setup_duration, +start_time, +state, +status, +tasks, +trigger, +trigger_info +FROM databricks_workspace.workflows.job_runs +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +description, +attempt_number, +cleanup_duration, +cluster_instance, +cluster_spec, +creator_user_name, +end_time, +execution_duration, +git_source, +has_more, +job_clusters, +job_id, +job_parameters, +job_run_id, +number_in_job, +original_attempt_run_id, +overriding_parameters, +queue_duration, +repair_history, +run_duration, +run_id, +run_name, +run_page_url, +run_type, +schedule, +setup_duration, +start_time, +state, +status, +tasks, +trigger, +trigger_info +FROM databricks_workspace.workflows.job_runs +WHERE run_id = '{{ run_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `DELETE` example + +Deletes a job_runs resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workflows.job_runs +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/jobs/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/jobs/index.md new file mode 100644 index 0000000000..6d8972c452 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workflows/jobs/index.md @@ -0,0 +1,373 @@ +--- +title: jobs +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - jobs + - workflows + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a jobs resource. + +## Overview + + + + +
Namejobs
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `string` | +| | `boolean` | +| | `integer` | +| | `object` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves the details for a single job. | +| | `SELECT` | | Retrieves a list of jobs. | +| | `INSERT` | | Create a new job. | +| | `DELETE` | | Deletes a job. | +| | `UPDATE` | | Add, update, or remove specific settings of an existing job. Use the | +| | `REPLACE` | | Overwrite all settings for the given job. Use the | +| | `EXEC` | | Run a job and return the | +| | `EXEC` | | Submit a one-time run. This endpoint allows you to submit a workload directly without creating a job. Runs submitted using this endpoint don’t display in the UI. Use the | + +## `SELECT` examples + + + + +```sql +SELECT +created_time, +creator_user_name, +has_more, +job_id, +settings +FROM databricks_workspace.workflows.jobs +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +created_time, +creator_user_name, +has_more, +job_id, +settings +FROM databricks_workspace.workflows.jobs +WHERE job_id = '{{ job_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new jobs resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.workflows.jobs ( +deployment_name, +data__name, +data__description, +data__email_notifications, +data__webhook_notifications, +data__notification_settings, +data__timeout_seconds, +data__health, +data__schedule, +data__trigger, +data__continuous, +data__max_concurrent_runs, +data__tasks, +data__job_clusters, +data__git_source, +data__tags, +data__format, +data__queue, +data__parameters, +data__run_as, +data__edit_mode, +data__deployment, +data__environments, +data__access_control_list +) +SELECT +'{{ deployment_name }}', +'{{ name }}', +'{{ description }}', +'{{ email_notifications }}', +'{{ webhook_notifications }}', +'{{ notification_settings }}', +'{{ timeout_seconds }}', +'{{ health }}', +'{{ schedule }}', +'{{ trigger }}', +'{{ continuous }}', +'{{ max_concurrent_runs }}', +'{{ tasks }}', +'{{ job_clusters }}', +'{{ git_source }}', +'{{ tags }}', +'{{ format }}', +'{{ queue }}', +'{{ parameters }}', +'{{ run_as }}', +'{{ edit_mode }}', +'{{ deployment }}', +'{{ environments }}', +'{{ access_control_list }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: name + value: A multitask job + - name: description + value: This job contain multiple tasks that are required to produce the weekly + shark sightings report. + - name: email_notifications + value: + on_start: + - user.name@databricks.com + on_success: + - user.name@databricks.com + on_failure: + - user.name@databricks.com + on_duration_warning_threshold_exceeded: + - user.name@databricks.com + on_streaming_backlog_exceeded: + - user.name@databricks.com + no_alert_for_skipped_runs: false + - name: webhook_notifications + value: + on_start: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_success: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_failure: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_duration_warning_threshold_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + on_streaming_backlog_exceeded: + - - id: 0481e838-0a59-4eff-9541-a4ca6f149574 + - name: notification_settings + value: + no_alert_for_skipped_runs: false + no_alert_for_canceled_runs: false + - name: timeout_seconds + value: 86400 + - name: health + value: + rules: + - metric: RUN_DURATION_SECONDS + op: GREATER_THAN + value: 10 + - name: schedule + value: + quartz_cron_expression: 20 30 * * * ? + timezone_id: Europe/London + pause_status: UNPAUSED + - name: trigger + value: + pause_status: UNPAUSED + file_arrival: + url: string + min_time_between_triggers_seconds: 0 + wait_after_last_change_seconds: 0 + periodic: + interval: 0 + unit: HOURS + - name: continuous + value: + pause_status: UNPAUSED + - name: max_concurrent_runs + value: 10 + - name: tasks + value: + - max_retries: 3 + task_key: Sessionize + description: Extracts session data from events + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.Sessionize + parameters: + - --data + - dbfs:/path/to/data.json + libraries: + - jar: dbfs:/mnt/databricks/Sessionize.jar + retry_on_timeout: false + existing_cluster_id: 0923-164208-meows279 + - max_retries: 3 + task_key: Orders_Ingest + description: Ingests order data + job_cluster_key: auto_scaling_cluster + min_retry_interval_millis: 2000 + depends_on: [] + timeout_seconds: 86400 + spark_jar_task: + main_class_name: com.databricks.OrdersIngest + parameters: + - --data + - dbfs:/path/to/order-data.json + libraries: + - jar: dbfs:/mnt/databricks/OrderIngest.jar + retry_on_timeout: false + - max_retries: 3 + task_key: Match + description: Matches orders with user sessions + notebook_task: + base_parameters: + age: '35' + name: John Doe + notebook_path: /Users/user.name@databricks.com/Match + min_retry_interval_millis: 2000 + depends_on: + - task_key: Orders_Ingest + - task_key: Sessionize + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + timeout_seconds: 86400 + retry_on_timeout: false + run_if: ALL_SUCCESS + - name: job_clusters + value: + - job_cluster_key: auto_scaling_cluster + new_cluster: + autoscale: + max_workers: 16 + min_workers: 2 + node_type_id: null + spark_conf: + spark.speculation: true + spark_version: 7.3.x-scala2.12 + - name: git_source + value: + git_branch: main + git_provider: gitHub + git_url: https://github.com/databricks/databricks-cli + - name: tags + value: + cost-center: engineering + team: jobs + - name: format + value: SINGLE_TASK + - name: queue + value: + enabled: true + - name: parameters + value: + - default: users + name: table + - name: run_as + value: + user_name: user@databricks.com + service_principal_name: 692bc6d0-ffa3-11ed-be56-0242ac120002 + - name: edit_mode + value: UI_LOCKED + - name: deployment + value: + kind: BUNDLE + metadata_file_path: string + - name: environments + value: + - environment_key: string + spec: + client: '1' + dependencies: + - string + - name: access_control_list + value: + - user_name: string + group_name: string + service_principal_name: string + permission_level: CAN_MANAGE + +``` + + + + +## `UPDATE` example + +Updates a jobs resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workflows.jobs +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a jobs resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.workflows.jobs +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a jobs resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workflows.jobs +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/automatic_cluster_update/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/automatic_cluster_update/index.md new file mode 100644 index 0000000000..6d37c8cc8a --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/automatic_cluster_update/index.md @@ -0,0 +1,65 @@ +--- +title: automatic_cluster_update +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - automatic_cluster_update + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a automatic_cluster_update resource. + +## Overview + + + + +
Nameautomatic_cluster_update
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the automatic cluster update setting. | +| | `UPDATE` | | Updates the automatic cluster update setting for the workspace. A fresh etag needs to be provided in | + +## `SELECT` examples + +```sql +SELECT +automatic_cluster_update_workspace, +etag, +setting_name +FROM databricks_workspace.workspace.automatic_cluster_update +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a automatic_cluster_update resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.automatic_cluster_update +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/compliance_security_profile/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/compliance_security_profile/index.md new file mode 100644 index 0000000000..e421eb141f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/compliance_security_profile/index.md @@ -0,0 +1,65 @@ +--- +title: compliance_security_profile +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - compliance_security_profile + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a compliance_security_profile resource. + +## Overview + + + + +
Namecompliance_security_profile
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the compliance security profile setting. | +| | `UPDATE` | | Updates the compliance security profile setting for the workspace. A fresh etag needs to be provided in | + +## `SELECT` examples + +```sql +SELECT +compliance_security_profile_workspace, +etag, +setting_name +FROM databricks_workspace.workspace.compliance_security_profile +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a compliance_security_profile resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.compliance_security_profile +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/dashboard_embedding_access_policy/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/dashboard_embedding_access_policy/index.md new file mode 100644 index 0000000000..d9d17f874c --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/dashboard_embedding_access_policy/index.md @@ -0,0 +1,76 @@ +--- +title: dashboard_embedding_access_policy +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dashboard_embedding_access_policy + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dashboard_embedding_access_policy resource. + +## Overview + + + + +
Namedashboard_embedding_access_policy
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded on approved domains. | +| | `DELETE` | | Delete the AI/BI dashboard embedding access policy, reverting back to the default. | +| | `UPDATE` | | Updates the AI/BI dashboard embedding access policy at the workspace level. | + +## `SELECT` examples + +```sql +SELECT +aibi_dashboard_embedding_access_policy, +etag, +setting_name +FROM databricks_workspace.workspace.dashboard_embedding_access_policy +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a dashboard_embedding_access_policy resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.dashboard_embedding_access_policy +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a dashboard_embedding_access_policy resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workspace.dashboard_embedding_access_policy +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/dashboard_embedding_approved_domains/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/dashboard_embedding_approved_domains/index.md new file mode 100644 index 0000000000..e774d16c9f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/dashboard_embedding_approved_domains/index.md @@ -0,0 +1,76 @@ +--- +title: dashboard_embedding_approved_domains +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - dashboard_embedding_approved_domains + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a dashboard_embedding_approved_domains resource. + +## Overview + + + + +
Namedashboard_embedding_approved_domains
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieves the list of domains approved to host embedded AI/BI dashboards. | +| | `DELETE` | | Delete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default empty list. | +| | `UPDATE` | | Updates the list of domains approved to host embedded AI/BI dashboards. This update will fail if the current workspace access policy is not ALLOW_APPROVED_DOMAINS. | + +## `SELECT` examples + +```sql +SELECT +aibi_dashboard_embedding_approved_domains, +etag, +setting_name +FROM databricks_workspace.workspace.dashboard_embedding_approved_domains +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a dashboard_embedding_approved_domains resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.dashboard_embedding_approved_domains +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a dashboard_embedding_approved_domains resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workspace.dashboard_embedding_approved_domains +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/directories/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/directories/index.md new file mode 100644 index 0000000000..b960c82de8 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/directories/index.md @@ -0,0 +1,94 @@ +--- +title: directories +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - directories + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a directories resource. + +## Overview + + + + +
Namedirectories
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists the contents of a directory, or the object if it is not a directory. If the input path does not exist, this call returns an error | +| | `INSERT` | | Creates the specified directory (and necessary parent directories if they do not exist). If there is an object (not a directory) at any prefix of the input path, this call returns an error | + +## `SELECT` examples + +```sql +SELECT +object_id, +object_type, +path +FROM databricks_workspace.workspace.directories +WHERE path = '{{ path }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new directories resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.workspace.directories ( +deployment_name, +data__path +) +SELECT +'{{ deployment_name }}', +'{{ path }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: path + value: /Users/user@example.com/project + +``` + + + diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/enhanced_security_monitoring/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/enhanced_security_monitoring/index.md new file mode 100644 index 0000000000..cf82f1db2d --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/enhanced_security_monitoring/index.md @@ -0,0 +1,65 @@ +--- +title: enhanced_security_monitoring +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - enhanced_security_monitoring + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a enhanced_security_monitoring resource. + +## Overview + + + + +
Nameenhanced_security_monitoring
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `object` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the enhanced security monitoring setting. | +| | `UPDATE` | | Updates the enhanced security monitoring setting for the workspace. A fresh etag needs to be provided in | + +## `SELECT` examples + +```sql +SELECT +enhanced_security_monitoring_workspace, +etag, +setting_name +FROM databricks_workspace.workspace.enhanced_security_monitoring +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a enhanced_security_monitoring resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.enhanced_security_monitoring +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/feature_status/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/feature_status/index.md new file mode 100644 index 0000000000..d23005659a --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/feature_status/index.md @@ -0,0 +1,64 @@ +--- +title: feature_status +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - feature_status + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a feature_status resource. + +## Overview + + + + +
Namefeature_status
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Enables or disables a specified feature for a workspace. | +| | `REPLACE` | | Enables or disables a specified feature for a workspace. | + +## `SELECT` examples + +```sql +SELECT +property1, +property2 +FROM databricks_workspace.workspace.feature_status +WHERE keys = '{{ keys }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a feature_status resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.workspace.feature_status +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/index.md new file mode 100644 index 0000000000..ce19c45471 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/index.md @@ -0,0 +1,55 @@ +--- +title: workspace +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +__`workspace`__ service documentation. + +:::info Service Summary + +
+
+total resources: 19
+
+
+ +::: + +## Resources +
+
+automatic_cluster_update
+compliance_security_profile
+dashboard_embedding_access_policy
+dashboard_embedding_approved_domains
+directories
+enhanced_security_monitoring
+feature_status
+ip_access_lists
+notification_destinations
+object_permission_levels
+
+
+object_permissions
+object_status
+objects
+permissions
+restrict_admins
+token_permission_levels
+token_permissions
+tokens
+user_tokens
+
+
\ No newline at end of file diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/ip_access_lists/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/ip_access_lists/index.md new file mode 100644 index 0000000000..b16084659b --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/ip_access_lists/index.md @@ -0,0 +1,187 @@ +--- +title: ip_access_lists +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - ip_access_lists + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a ip_access_lists resource. + +## Overview + + + + +
Nameip_access_lists
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `integer` | +| | `integer` | +| | `integer` | +| | `boolean` | +| | `array` | +| | `string` | +| | `string` | +| | `string` | +| | `integer` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an IP access list, specified by its list ID. | +| | `SELECT` | | Gets all IP access lists for the specified workspace. | +| | `INSERT` | | Creates an IP access list for this workspace. | +| | `DELETE` | | Deletes an IP access list, specified by its list ID. | +| | `UPDATE` | | Updates an existing IP access list, specified by its ID. | +| | `REPLACE` | | Replaces an IP access list, specified by its ID. | + +## `SELECT` examples + + + + +```sql +SELECT +address_count, +created_at, +created_by, +enabled, +ip_addresses, +label, +list_id, +list_type, +updated_at, +updated_by +FROM databricks_workspace.workspace.ip_access_lists +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +address_count, +created_at, +created_by, +enabled, +ip_addresses, +label, +list_id, +list_type, +updated_at, +updated_by +FROM databricks_workspace.workspace.ip_access_lists +WHERE ip_access_list_id = '{{ ip_access_list_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new ip_access_lists resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.workspace.ip_access_lists ( +deployment_name, +data__label, +data__list_type, +data__ip_addresses +) +SELECT +'{{ deployment_name }}', +'{{ label }}', +'{{ list_type }}', +'{{ ip_addresses }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: label + value: Office VPN + - name: list_type + value: ALLOW + - name: ip_addresses + value: + - 192.168.100.0/22 + +``` + + + + +## `UPDATE` example + +Updates a ip_access_lists resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.ip_access_lists +SET { field = value } +WHERE ip_access_list_id = '{{ ip_access_list_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a ip_access_lists resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.workspace.ip_access_lists +SET { field = value } +WHERE ip_access_list_id = '{{ ip_access_list_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a ip_access_lists resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workspace.ip_access_lists +WHERE ip_access_list_id = '{{ ip_access_list_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/notification_destinations/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/notification_destinations/index.md new file mode 100644 index 0000000000..a5e4035bd6 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/notification_destinations/index.md @@ -0,0 +1,152 @@ +--- +title: notification_destinations +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - notification_destinations + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a notification_destinations resource. + +## Overview + + + + +
Namenotification_destinations
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a notification destination. | +| | `SELECT` | | Lists notification destinations. | +| | `INSERT` | | Creates a notification destination. Requires workspace admin permissions. | +| | `DELETE` | | Deletes a notification destination. Requires workspace admin permissions. | +| | `UPDATE` | | Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body. | + +## `SELECT` examples + + + + +```sql +SELECT +id, +destination_type, +display_name +FROM databricks_workspace.workspace.notification_destinations +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +id, +destination_type, +display_name +FROM databricks_workspace.workspace.notification_destinations +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new notification_destinations resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.workspace.notification_destinations ( +deployment_name, +data__config, +data__display_name +) +SELECT +'{{ deployment_name }}', +'{{ config }}', +'{{ display_name }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: config + value: + generic_webhook: + password: my-password + url: https://my-webhook.com + username: my-username + - name: display_name + value: My webhook destination + +``` + + + + +## `UPDATE` example + +Updates a notification_destinations resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.notification_destinations +SET { field = value } +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a notification_destinations resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workspace.notification_destinations +WHERE id = '{{ id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_permission_levels/index.md new file mode 100644 index 0000000000..a5475dd117 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_permission_levels/index.md @@ -0,0 +1,53 @@ +--- +title: object_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - object_permission_levels + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a object_permission_levels resource. + +## Overview + + + + +
Nameobject_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.workspace.object_permission_levels +WHERE workspace_object_id = '{{ workspace_object_id }}' AND +workspace_object_type = '{{ workspace_object_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_permissions/index.md new file mode 100644 index 0000000000..1ab7d8d80a --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_permissions/index.md @@ -0,0 +1,83 @@ +--- +title: object_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - object_permissions + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a object_permissions resource. + +## Overview + + + + +
Nameobject_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of a workspace object. Workspace objects can inherit permissions from their parent objects or root object. | +| | `UPDATE` | | Updates the permissions on a workspace object. Workspace objects can inherit permissions from their parent objects or root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.workspace.object_permissions +WHERE workspace_object_id = '{{ workspace_object_id }}' AND +workspace_object_type = '{{ workspace_object_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a object_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.object_permissions +SET { field = value } +WHERE workspace_object_id = '{{ workspace_object_id }}' AND +workspace_object_type = '{{ workspace_object_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a object_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.workspace.object_permissions +SET { field = value } +WHERE workspace_object_id = '{{ workspace_object_id }}' AND +workspace_object_type = '{{ workspace_object_type }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_status/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_status/index.md new file mode 100644 index 0000000000..9151a0ecfc --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/object_status/index.md @@ -0,0 +1,56 @@ +--- +title: object_status +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - object_status + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a object_status resource. + +## Overview + + + + +
Nameobject_status
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the status of an object or a directory. If | + +## `SELECT` examples + +```sql +SELECT +language, +object_id, +object_type, +path +FROM databricks_workspace.workspace.object_status +WHERE path = '{{ path }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/objects/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/objects/index.md new file mode 100644 index 0000000000..e767f723be --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/objects/index.md @@ -0,0 +1,49 @@ +--- +title: objects +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - objects + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a objects resource. + +## Overview + + + + +
Nameobjects
TypeResource
Id
+ + +`SELECT` not supported for this resource, see the methods section for supported operations. +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `DELETE` | | Deletes an object or a directory (and optionally recursively deletes all objects in the directory). | +| | `EXEC` | | Exports an object or the contents of an entire directory. | +| | `EXEC` | | Imports a workspace object (for example, a notebook or file) or the contents of an entire directory. If | + +## `DELETE` example + +Deletes a objects resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workspace.objects +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/permissions/index.md new file mode 100644 index 0000000000..3679220036 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/permissions/index.md @@ -0,0 +1,76 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - permissions + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a permissions resource. + +## Overview + + + + +
Namepermissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the default namespace setting. | +| | `DELETE` | | Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in | +| | `UPDATE` | | Updates the default namespace setting for the workspace. A fresh etag needs to be provided in | + +## `SELECT` examples + +```sql +SELECT +etag, +namespace, +setting_name +FROM databricks_workspace.workspace.permissions +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.permissions +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a permissions resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workspace.permissions +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/restrict_admins/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/restrict_admins/index.md new file mode 100644 index 0000000000..b4c30ccc2f --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/restrict_admins/index.md @@ -0,0 +1,76 @@ +--- +title: restrict_admins +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - restrict_admins + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a restrict_admins resource. + +## Overview + + + + +
Namerestrict_admins
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `object` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the restrict workspace admins setting. | +| | `DELETE` | | Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be provided in | +| | `UPDATE` | | Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in | + +## `SELECT` examples + +```sql +SELECT +etag, +restrict_workspace_admins, +setting_name +FROM databricks_workspace.workspace.restrict_admins +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a restrict_admins resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.restrict_admins +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `DELETE` example + +Deletes a restrict_admins resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workspace.restrict_admins +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/token_permission_levels/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/token_permission_levels/index.md new file mode 100644 index 0000000000..1c93fc3abb --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/token_permission_levels/index.md @@ -0,0 +1,51 @@ +--- +title: token_permission_levels +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - token_permission_levels + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a token_permission_levels resource. + +## Overview + + + + +
Nametoken_permission_levels
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permission levels that a user can have on an object. | + +## `SELECT` examples + +```sql +SELECT +description, +permission_level +FROM databricks_workspace.workspace.token_permission_levels +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/token_permissions/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/token_permissions/index.md new file mode 100644 index 0000000000..25d6080001 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/token_permissions/index.md @@ -0,0 +1,77 @@ +--- +title: token_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - token_permissions + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a token_permissions resource. + +## Overview + + + + +
Nametoken_permissions
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `array` | +| | `string` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the permissions of all tokens. Tokens can inherit permissions from their root object. | +| | `UPDATE` | | Updates the permissions on all tokens. Tokens can inherit permissions from their root object. | +| | `REPLACE` | | Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. | + +## `SELECT` examples + +```sql +SELECT +access_control_list, +object_id, +object_type +FROM databricks_workspace.workspace.token_permissions +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `UPDATE` example + +Updates a token_permissions resource. + +```sql +/*+ update */ +UPDATE databricks_workspace.workspace.token_permissions +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `REPLACE` example + +Replaces a token_permissions resource. + +```sql +/*+ update */ +REPLACE databricks_workspace.workspace.token_permissions +SET { field = value } +WHERE deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/tokens/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/tokens/index.md new file mode 100644 index 0000000000..6ff37914d7 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/tokens/index.md @@ -0,0 +1,157 @@ +--- +title: tokens +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - tokens + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a tokens resource. + +## Overview + + + + +
Nametokens
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `string` | +| | `integer` | +| | `integer` | +| | `integer` | +| | `integer` | +| | `string` | +| | `integer` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets information about a token, specified by its ID. | +| | `SELECT` | | Lists all tokens associated with the specified workspace or user. | +| | `INSERT` | | Creates a token on behalf of a service principal. | +| | `DELETE` | | Deletes a token, specified by its ID. | + +## `SELECT` examples + + + + +```sql +SELECT +comment, +created_by_id, +created_by_username, +creation_time, +expiry_time, +last_used_day, +owner_id, +token_id, +workspace_id +FROM databricks_workspace.workspace.tokens +WHERE deployment_name = '{{ deployment_name }}'; +``` + + + + +```sql +SELECT +comment, +created_by_id, +created_by_username, +creation_time, +expiry_time, +last_used_day, +owner_id, +token_id, +workspace_id +FROM databricks_workspace.workspace.tokens +WHERE token_id = '{{ token_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` + + + + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tokens resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.workspace.tokens ( +deployment_name, +data__application_id, +data__lifetime_seconds, +data__comment +) +SELECT +'{{ deployment_name }}', +'{{ application_id }}', +'{{ lifetime_seconds }}', +'{{ comment }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: application_id + value: 6f5ccf28-d83a-4957-9bfb-5bbfac551410 + - name: lifetime_seconds + value: 3600 + - name: comment + value: This is for the ABC department automation scripts. + +``` + + + + +## `DELETE` example + +Deletes a tokens resource. + +```sql +/*+ delete */ +DELETE FROM databricks_workspace.workspace.tokens +WHERE token_id = '{{ token_id }}' AND +deployment_name = '{{ deployment_name }}'; +``` diff --git a/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/user_tokens/index.md b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/user_tokens/index.md new file mode 100644 index 0000000000..67152ac3f3 --- /dev/null +++ b/docs/databricks_workspace-docs/providers/databricks_workspace/workspace/user_tokens/index.md @@ -0,0 +1,100 @@ +--- +title: user_tokens +hide_title: false +hide_table_of_contents: false +keywords: + - Databricks + - user_tokens + - workspace + - databricks_workspace + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Databricks resources using SQL +custom_edit_url: null +image: /img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Operations on a user_tokens resource. + +## Overview + + + + +
Nameuser_tokens
TypeResource
Id
+ +## Fields +| Name | Datatype | +|:-----|:---------| +| | `string` | +| | `integer` | +| | `integer` | +| | `string` | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists all the valid tokens for a user-workspace pair. | +| | `INSERT` | | Creates and returns a token for a user. If this call is made through token authentication, it creates a token with the same client ID as the authenticated token. If the user's token quota is exceeded, this call returns an error | +| | `EXEC` | | Revokes an access token. | + +## `SELECT` examples + +```sql +SELECT +comment, +creation_time, +expiry_time, +token_id +FROM databricks_workspace.workspace.user_tokens +WHERE deployment_name = '{{ deployment_name }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new user_tokens resource. + + + + +```sql +/*+ create */ +INSERT INTO databricks_workspace.workspace.user_tokens ( +deployment_name, +data__lifetime_seconds, +data__comment +) +SELECT +'{{ deployment_name }}', +'{{ lifetime_seconds }}', +'{{ comment }}' +; +``` + + + + +```yaml +- name: your_resource_model_name + props: + - name: lifetime_seconds + value: 0 + - name: comment + value: string + +``` + + + diff --git a/docs/databricks_workspace-docs/stackql-provider-registry.mdx b/docs/databricks_workspace-docs/stackql-provider-registry.mdx new file mode 100644 index 0000000000..6d14f7de8f --- /dev/null +++ b/docs/databricks_workspace-docs/stackql-provider-registry.mdx @@ -0,0 +1,19 @@ +--- +title: StackQL Provider Registry +hide_title: true +hide_table_of_contents: true +keywords: + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query and Deploy Cloud Infrastructure and Resources using SQL +custom_edit_url: null +image: https://storage.googleapis.com/stackql-web-assets/blog/stackql-blog-post-featured-image.png +slug: / +--- +import RegistryPage from '@site/src/shared/shared-stackql-provider-registry.mdx'; + + + +--- diff --git a/package.json b/package.json index 7ceb7dc4b4..71686be7d7 100644 --- a/package.json +++ b/package.json @@ -28,6 +28,10 @@ "start:pagerduty": "export REGISTRY=pagerduty && docusaurus start", "start:datadog": "export REGISTRY=datadog && docusaurus start", "start:homebrew": "export REGISTRY=homebrew && docusaurus start", + "start:databricks_account": "export REGISTRY=databricks_account && docusaurus start", + "start:databricks_workspace": "export REGISTRY=databricks_workspace && docusaurus start", + "build:databricks_account": "export REGISTRY=databricks_account && docusaurus build", + "build:databricks_workspace": "export REGISTRY=databricks_workspace && docusaurus build", "build:root": "docusaurus build", "build:aws": "export REGISTRY=aws && docusaurus build", "build:azure": "export REGISTRY=azure && docusaurus build", diff --git a/sidebars.js b/sidebars.js index 2836b86979..ee347bdb99 100644 --- a/sidebars.js +++ b/sidebars.js @@ -18,9 +18,11 @@ const providers = [ {name: 'azure'}, {name: 'google'}, {name: 'googleadmin'}, - {name: 'digitalocean'}, - {name: 'github'}, + {name: 'digitalocean'}, + {name: 'databricks_account'}, + {name: 'databricks_workspace'}, {name: 'confluent'}, + {name: 'github'}, {name: 'openai'}, {name: 'anthropic'}, {name: 'linode'}, diff --git a/src/configs/providers.ts b/src/configs/providers.ts index 9e466a3121..5b66790c7b 100644 --- a/src/configs/providers.ts +++ b/src/configs/providers.ts @@ -10,6 +10,8 @@ export const providers = [ {name: 'openai', description: 'AI models and services by OpenAI.', title: 'OpenAI'}, {name: 'anthropic', description: 'AI language models and services powered by Claude.', title: 'Anthropic'}, {name: 'confluent', description: 'Managed Kafka clusters and streaming services on Confluent Cloud.', title: 'Confluent Cloud'}, + {name: 'databricks_account', description: 'Account-level features, identity and provisioning for Databricks.', title: 'Databricks Account'}, + {name: 'databricks_workspace', description: 'Manage clusters, jobs, notebooks, MLflow and other Databricks workspace resources.', title: 'Databricks Workspace'}, {name: 'linode', description: 'Cloud computing services by Akamai.', title: 'Linode'}, {name: 'netlify', description: 'Web development and content distribution platform.', title: 'Netlify'}, {name: 'okta', description: 'Authentication and authorization services.', title: 'Okta'}, diff --git a/static/img/providers/databricks_account/databricks_account.png b/static/img/providers/databricks_account/databricks_account.png new file mode 100644 index 0000000000..43adc54e48 Binary files /dev/null and b/static/img/providers/databricks_account/databricks_account.png differ diff --git a/static/img/providers/databricks_account/stackql-databricks-provider-featured-image.png b/static/img/providers/databricks_account/stackql-databricks-provider-featured-image.png new file mode 100644 index 0000000000..95fb654590 Binary files /dev/null and b/static/img/providers/databricks_account/stackql-databricks-provider-featured-image.png differ diff --git a/static/img/providers/databricks_workspace/databricks_workspace.png b/static/img/providers/databricks_workspace/databricks_workspace.png new file mode 100644 index 0000000000..43adc54e48 Binary files /dev/null and b/static/img/providers/databricks_workspace/databricks_workspace.png differ diff --git a/static/img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png b/static/img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png new file mode 100644 index 0000000000..95fb654590 Binary files /dev/null and b/static/img/providers/databricks_workspace/stackql-databricks-provider-featured-image.png differ