From 5e72c63085a4ed0a08612ff05a9518de36709e60 Mon Sep 17 00:00:00 2001 From: Miles Yucht Date: Fri, 26 Jan 2024 09:42:06 +0100 Subject: [PATCH] more fixes --- docs/account/access_control.rst | 4 +-- docs/account/billable_usage.rst | 4 +-- docs/account/budgets.rst | 4 +-- docs/account/credentials.rst | 4 +-- docs/account/custom_app_integration.rst | 4 +-- docs/account/encryption_keys.rst | 4 +-- docs/account/groups.rst | 4 +-- docs/account/ip_access_lists.rst | 4 +-- docs/account/log_delivery.rst | 4 +-- docs/account/metastore_assignments.rst | 4 +-- docs/account/metastores.rst | 4 +-- docs/account/network_connectivity.rst | 4 +-- docs/account/networks.rst | 4 +-- docs/account/o_auth_published_apps.rst | 4 +-- docs/account/private_access.rst | 4 +-- docs/account/published_app_integration.rst | 4 +-- docs/account/service_principal_secrets.rst | 4 +-- docs/account/service_principals.rst | 4 +-- docs/account/settings.rst | 4 +-- docs/account/storage.rst | 4 +-- docs/account/storage_credentials.rst | 4 +-- docs/account/users.rst | 4 +-- docs/account/vpc_endpoints.rst | 4 +-- docs/account/workspace_assignment.rst | 4 +-- docs/account/workspaces.rst | 4 +-- docs/gen-client-docs.py | 8 +++-- docs/getting-started.md | 35 +++++++++++++++++++ .../account_access_control_proxy.rst | 4 +-- docs/workspace/alerts.rst | 4 +-- docs/workspace/apps.rst | 4 +-- docs/workspace/artifact_allowlists.rst | 4 +-- docs/workspace/catalogs.rst | 4 +-- docs/workspace/clean_rooms.rst | 4 +-- docs/workspace/cluster_policies.rst | 4 +-- docs/workspace/clusters.rst | 4 +-- docs/workspace/command_execution.rst | 4 +-- docs/workspace/connections.rst | 4 +-- docs/workspace/credentials_manager.rst | 4 +-- docs/workspace/current_user.rst | 4 +-- docs/workspace/dashboard_widgets.rst | 4 +-- docs/workspace/dashboards.rst | 4 +-- docs/workspace/data_sources.rst | 4 +-- docs/workspace/dbfs.rst | 4 +-- docs/workspace/dbsql_permissions.rst | 4 +-- docs/workspace/experiments.rst | 4 +-- docs/workspace/external_locations.rst | 4 +-- docs/workspace/functions.rst | 4 +-- docs/workspace/git_credentials.rst | 4 +-- docs/workspace/global_init_scripts.rst | 4 +-- docs/workspace/grants.rst | 4 +-- docs/workspace/groups.rst | 4 +-- docs/workspace/instance_pools.rst | 4 +-- docs/workspace/instance_profiles.rst | 4 +-- docs/workspace/ip_access_lists.rst | 4 +-- docs/workspace/jobs.rst | 4 +-- docs/workspace/lakeview.rst | 4 +-- docs/workspace/libraries.rst | 4 +-- docs/workspace/metastores.rst | 4 +-- docs/workspace/model_registry.rst | 4 +-- docs/workspace/model_versions.rst | 4 +-- docs/workspace/permissions.rst | 4 +-- docs/workspace/pipelines.rst | 4 +-- docs/workspace/policy_families.rst | 4 +-- docs/workspace/providers.rst | 4 +-- docs/workspace/queries.rst | 4 +-- docs/workspace/query_history.rst | 4 +-- docs/workspace/query_visualizations.rst | 4 +-- docs/workspace/recipient_activation.rst | 4 +-- docs/workspace/recipients.rst | 4 +-- docs/workspace/registered_models.rst | 4 +-- docs/workspace/repos.rst | 4 +-- docs/workspace/schemas.rst | 4 +-- docs/workspace/secrets.rst | 4 +-- docs/workspace/service_principals.rst | 4 +-- docs/workspace/serving_endpoints.rst | 4 +-- docs/workspace/settings.rst | 4 +-- docs/workspace/shares.rst | 4 +-- docs/workspace/statement_execution.rst | 4 +-- docs/workspace/storage_credentials.rst | 4 +-- docs/workspace/system_schemas.rst | 4 +-- docs/workspace/table_constraints.rst | 4 +-- docs/workspace/tables.rst | 4 +-- docs/workspace/token_management.rst | 4 +-- docs/workspace/tokens.rst | 4 +-- docs/workspace/users.rst | 4 +-- docs/workspace/vector_search_endpoints.rst | 4 +-- docs/workspace/vector_search_indexes.rst | 4 +-- docs/workspace/volumes.rst | 4 +-- docs/workspace/warehouses.rst | 4 +-- docs/workspace/workspace.rst | 4 +-- docs/workspace/workspace_bindings.rst | 4 +-- docs/workspace/workspace_conf.rst | 4 +-- 92 files changed, 221 insertions(+), 182 deletions(-) diff --git a/docs/account/access_control.rst b/docs/account/access_control.rst index f4a1ebc1a..2537e262c 100644 --- a/docs/account/access_control.rst +++ b/docs/account/access_control.rst @@ -1,5 +1,5 @@ -Account Access Control -====================== +``a.access_control``: Account Access Control +============================================ .. currentmodule:: databricks.sdk.service.iam .. py:class:: AccountAccessControlAPI diff --git a/docs/account/billable_usage.rst b/docs/account/billable_usage.rst index 46ebc1ea1..51c2eb2fa 100644 --- a/docs/account/billable_usage.rst +++ b/docs/account/billable_usage.rst @@ -1,5 +1,5 @@ -Billable usage download -======================= +``a.billable_usage``: Billable usage download +============================================= .. currentmodule:: databricks.sdk.service.billing .. py:class:: BillableUsageAPI diff --git a/docs/account/budgets.rst b/docs/account/budgets.rst index 26440896e..85f7ee133 100644 --- a/docs/account/budgets.rst +++ b/docs/account/budgets.rst @@ -1,5 +1,5 @@ -Budgets -======= +``a.budgets``: Budgets +====================== .. currentmodule:: databricks.sdk.service.billing .. py:class:: BudgetsAPI diff --git a/docs/account/credentials.rst b/docs/account/credentials.rst index 8ebf3ec60..5255a6a29 100644 --- a/docs/account/credentials.rst +++ b/docs/account/credentials.rst @@ -1,5 +1,5 @@ -Credential configurations -========================= +``a.credentials``: Credential configurations +============================================ .. currentmodule:: databricks.sdk.service.provisioning .. py:class:: CredentialsAPI diff --git a/docs/account/custom_app_integration.rst b/docs/account/custom_app_integration.rst index 0e218e78a..382ce0bd0 100644 --- a/docs/account/custom_app_integration.rst +++ b/docs/account/custom_app_integration.rst @@ -1,5 +1,5 @@ -OAuth Custom App Integration -============================ +``a.custom_app_integration``: OAuth Custom App Integration +========================================================== .. currentmodule:: databricks.sdk.service.oauth2 .. py:class:: CustomAppIntegrationAPI diff --git a/docs/account/encryption_keys.rst b/docs/account/encryption_keys.rst index a6cfc08ec..c711727c5 100644 --- a/docs/account/encryption_keys.rst +++ b/docs/account/encryption_keys.rst @@ -1,5 +1,5 @@ -Key configurations -================== +``a.encryption_keys``: Key configurations +========================================= .. currentmodule:: databricks.sdk.service.provisioning .. py:class:: EncryptionKeysAPI diff --git a/docs/account/groups.rst b/docs/account/groups.rst index cb951b299..be1af3c86 100644 --- a/docs/account/groups.rst +++ b/docs/account/groups.rst @@ -1,5 +1,5 @@ -Account Groups -============== +``a.groups``: Account Groups +============================ .. currentmodule:: databricks.sdk.service.iam .. py:class:: AccountGroupsAPI diff --git a/docs/account/ip_access_lists.rst b/docs/account/ip_access_lists.rst index 3e0b5f41c..135dd2b55 100644 --- a/docs/account/ip_access_lists.rst +++ b/docs/account/ip_access_lists.rst @@ -1,5 +1,5 @@ -Account IP Access Lists -======================= +``a.ip_access_lists``: Account IP Access Lists +============================================== .. currentmodule:: databricks.sdk.service.settings .. py:class:: AccountIpAccessListsAPI diff --git a/docs/account/log_delivery.rst b/docs/account/log_delivery.rst index b47ae0d68..04ef4e349 100644 --- a/docs/account/log_delivery.rst +++ b/docs/account/log_delivery.rst @@ -1,5 +1,5 @@ -Log delivery configurations -=========================== +``a.log_delivery``: Log delivery configurations +=============================================== .. currentmodule:: databricks.sdk.service.billing .. py:class:: LogDeliveryAPI diff --git a/docs/account/metastore_assignments.rst b/docs/account/metastore_assignments.rst index 6bfd1c8e9..f5b00c6b3 100644 --- a/docs/account/metastore_assignments.rst +++ b/docs/account/metastore_assignments.rst @@ -1,5 +1,5 @@ -Account Metastore Assignments -============================= +``a.metastore_assignments``: Account Metastore Assignments +========================================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: AccountMetastoreAssignmentsAPI diff --git a/docs/account/metastores.rst b/docs/account/metastores.rst index b3f5499f6..d0c2752ed 100644 --- a/docs/account/metastores.rst +++ b/docs/account/metastores.rst @@ -1,5 +1,5 @@ -Account Metastores -================== +``a.metastores``: Account Metastores +==================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: AccountMetastoresAPI diff --git a/docs/account/network_connectivity.rst b/docs/account/network_connectivity.rst index 2feea131a..979491e4f 100644 --- a/docs/account/network_connectivity.rst +++ b/docs/account/network_connectivity.rst @@ -1,5 +1,5 @@ -Network Connectivity -==================== +``a.network_connectivity``: Network Connectivity +================================================ .. currentmodule:: databricks.sdk.service.settings .. py:class:: NetworkConnectivityAPI diff --git a/docs/account/networks.rst b/docs/account/networks.rst index fec6a4491..e7491f202 100644 --- a/docs/account/networks.rst +++ b/docs/account/networks.rst @@ -1,5 +1,5 @@ -Network configurations -====================== +``a.networks``: Network configurations +====================================== .. currentmodule:: databricks.sdk.service.provisioning .. py:class:: NetworksAPI diff --git a/docs/account/o_auth_published_apps.rst b/docs/account/o_auth_published_apps.rst index 21b930f6d..69aecb8ad 100644 --- a/docs/account/o_auth_published_apps.rst +++ b/docs/account/o_auth_published_apps.rst @@ -1,5 +1,5 @@ -OAuth Published App -=================== +``a.o_auth_published_apps``: OAuth Published App +================================================ .. currentmodule:: databricks.sdk.service.oauth2 .. py:class:: OAuthPublishedAppsAPI diff --git a/docs/account/private_access.rst b/docs/account/private_access.rst index 553d81803..10022068e 100644 --- a/docs/account/private_access.rst +++ b/docs/account/private_access.rst @@ -1,5 +1,5 @@ -Private Access Settings -======================= +``a.private_access``: Private Access Settings +============================================= .. currentmodule:: databricks.sdk.service.provisioning .. py:class:: PrivateAccessAPI diff --git a/docs/account/published_app_integration.rst b/docs/account/published_app_integration.rst index 5ae31494f..0488415cd 100644 --- a/docs/account/published_app_integration.rst +++ b/docs/account/published_app_integration.rst @@ -1,5 +1,5 @@ -OAuth Published App Integration -=============================== +``a.published_app_integration``: OAuth Published App Integration +================================================================ .. currentmodule:: databricks.sdk.service.oauth2 .. py:class:: PublishedAppIntegrationAPI diff --git a/docs/account/service_principal_secrets.rst b/docs/account/service_principal_secrets.rst index f2045e683..4249b9dea 100644 --- a/docs/account/service_principal_secrets.rst +++ b/docs/account/service_principal_secrets.rst @@ -1,5 +1,5 @@ -Service Principal Secrets -========================= +``a.service_principal_secrets``: Service Principal Secrets +========================================================== .. currentmodule:: databricks.sdk.service.oauth2 .. py:class:: ServicePrincipalSecretsAPI diff --git a/docs/account/service_principals.rst b/docs/account/service_principals.rst index 9b5d7697f..baef75be9 100644 --- a/docs/account/service_principals.rst +++ b/docs/account/service_principals.rst @@ -1,5 +1,5 @@ -Account Service Principals -========================== +``a.service_principals``: Account Service Principals +==================================================== .. currentmodule:: databricks.sdk.service.iam .. py:class:: AccountServicePrincipalsAPI diff --git a/docs/account/settings.rst b/docs/account/settings.rst index 7a19f5d84..7f9d44534 100644 --- a/docs/account/settings.rst +++ b/docs/account/settings.rst @@ -1,5 +1,5 @@ -Personal Compute Enablement -=========================== +``a.settings``: Personal Compute Enablement +=========================================== .. currentmodule:: databricks.sdk.service.settings .. py:class:: AccountSettingsAPI diff --git a/docs/account/storage.rst b/docs/account/storage.rst index 2484b12c2..611a8cdc6 100644 --- a/docs/account/storage.rst +++ b/docs/account/storage.rst @@ -1,5 +1,5 @@ -Storage configurations -====================== +``a.storage``: Storage configurations +===================================== .. currentmodule:: databricks.sdk.service.provisioning .. py:class:: StorageAPI diff --git a/docs/account/storage_credentials.rst b/docs/account/storage_credentials.rst index 467fa42ff..9972ffbf8 100644 --- a/docs/account/storage_credentials.rst +++ b/docs/account/storage_credentials.rst @@ -1,5 +1,5 @@ -Account Storage Credentials -=========================== +``a.storage_credentials``: Account Storage Credentials +====================================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: AccountStorageCredentialsAPI diff --git a/docs/account/users.rst b/docs/account/users.rst index 6d10876b6..54a113542 100644 --- a/docs/account/users.rst +++ b/docs/account/users.rst @@ -1,5 +1,5 @@ -Account Users -============= +``a.users``: Account Users +========================== .. currentmodule:: databricks.sdk.service.iam .. py:class:: AccountUsersAPI diff --git a/docs/account/vpc_endpoints.rst b/docs/account/vpc_endpoints.rst index 98e31adeb..d2622dc0f 100644 --- a/docs/account/vpc_endpoints.rst +++ b/docs/account/vpc_endpoints.rst @@ -1,5 +1,5 @@ -VPC Endpoint Configurations -=========================== +``a.vpc_endpoints``: VPC Endpoint Configurations +================================================ .. currentmodule:: databricks.sdk.service.provisioning .. py:class:: VpcEndpointsAPI diff --git a/docs/account/workspace_assignment.rst b/docs/account/workspace_assignment.rst index bc7fc4c4d..a09af197c 100644 --- a/docs/account/workspace_assignment.rst +++ b/docs/account/workspace_assignment.rst @@ -1,5 +1,5 @@ -Workspace Assignment -==================== +``a.workspace_assignment``: Workspace Assignment +================================================ .. currentmodule:: databricks.sdk.service.iam .. py:class:: WorkspaceAssignmentAPI diff --git a/docs/account/workspaces.rst b/docs/account/workspaces.rst index 087856155..41f46f881 100644 --- a/docs/account/workspaces.rst +++ b/docs/account/workspaces.rst @@ -1,5 +1,5 @@ -Workspaces -========== +``a.workspaces``: Workspaces +============================ .. currentmodule:: databricks.sdk.service.provisioning .. py:class:: WorkspacesAPI diff --git a/docs/gen-client-docs.py b/docs/gen-client-docs.py index c1280072e..37ae3c5f8 100644 --- a/docs/gen-client-docs.py +++ b/docs/gen-client-docs.py @@ -81,6 +81,7 @@ def as_rst(self, usage) -> str: @dataclass class ServiceDoc: + client_prefix: str service_name: str class_name: str methods: list[MethodDoc] @@ -90,8 +91,9 @@ class ServiceDoc: def as_rst(self) -> str: if not self.doc: self.doc = '' + title = f'``{self.client_prefix}.{self.service_name}``: {self.tag.name}' out = [ - self.tag.name, '=' * len(self.tag.name), + title, '=' * len(title), f'.. currentmodule:: databricks.sdk.service.{self.tag.package.name}', '', f'.. py:class:: {self.class_name}', '', f' {self.doc}' ] @@ -274,6 +276,7 @@ def class_methods(self, inst) -> list[MethodDoc]: return method_docs def service_docs(self, client_inst) -> list[ServiceDoc]: + client_prefix = 'w' if isinstance(client_inst, WorkspaceClient) else 'a' ignore_client_fields = ('config', 'dbutils', 'api_client', 'files') all = [] for service_name, service_inst in inspect.getmembers(client_inst): @@ -284,7 +287,8 @@ def service_docs(self, client_inst) -> list[ServiceDoc]: class_doc = service_inst.__doc__ class_name = service_inst.__class__.__name__ all.append( - ServiceDoc(service_name=service_name, + ServiceDoc(client_prefix=client_prefix, + service_name=service_name, class_name=class_name, doc=class_doc, tag=self._get_tag_name(service_inst.__class__.__name__, service_name), diff --git a/docs/getting-started.md b/docs/getting-started.md index 2e97cd805..71f735c62 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -20,6 +20,41 @@ followed by dbutils.library.restartPython() ``` +## Usage Overview + +At its core, the SDK exposes two primary clients: `databricks.sdk.WorkspaceClient` and `databricks.sdk.AccountClient`. The `WorkspaceClient` is tailored for interacting with resources within the Databricks workspace, such as notebooks, jobs, and clusters, while the `AccountClient` focuses on account-level functionalities including user and group management, billing, and workspace provisioning and management. + +To use the SDK to call an API, first find the API in either the [Workspace API Reference](workspace/index.rst) or [Account API reference](account/index.rst). Then, on the appropriate client, call the corresponding method. All API calls have the form + +``` +w..() +``` +or +``` +a..(parameters) +``` + +For example, to list all SQL queries in the workspace, run: + +```python +# Authenticate as described above +from databricks.sdk import WorkspaceClient +w = WorkspaceClient() +for query in w.queries.list(): + print(f'query {query.name} was created at {query.created_at}') +``` + +To list all workspaces in the account, run: + +```python +# Authenticate as described above +from databricks.sdk import AccountClient +a = AccountClient() +for workspace in a.workspaces.list(): + print(f'workspace {workspace.workspace_name} was created at {workspace.creation_time}') +``` + + ## Authentication There are two primary entry points to the Databricks SDK: diff --git a/docs/workspace/account_access_control_proxy.rst b/docs/workspace/account_access_control_proxy.rst index 031f96672..3265b29cc 100644 --- a/docs/workspace/account_access_control_proxy.rst +++ b/docs/workspace/account_access_control_proxy.rst @@ -1,5 +1,5 @@ -Account Access Control Proxy -============================ +``w.account_access_control_proxy``: Account Access Control Proxy +================================================================ .. currentmodule:: databricks.sdk.service.iam .. py:class:: AccountAccessControlProxyAPI diff --git a/docs/workspace/alerts.rst b/docs/workspace/alerts.rst index c118598c9..49a518bda 100644 --- a/docs/workspace/alerts.rst +++ b/docs/workspace/alerts.rst @@ -1,5 +1,5 @@ -Alerts -====== +``w.alerts``: Alerts +==================== .. currentmodule:: databricks.sdk.service.sql .. py:class:: AlertsAPI diff --git a/docs/workspace/apps.rst b/docs/workspace/apps.rst index a305eba98..bd2f6bed2 100644 --- a/docs/workspace/apps.rst +++ b/docs/workspace/apps.rst @@ -1,5 +1,5 @@ -Databricks Apps -=============== +``w.apps``: Databricks Apps +=========================== .. currentmodule:: databricks.sdk.service.serving .. py:class:: AppsAPI diff --git a/docs/workspace/artifact_allowlists.rst b/docs/workspace/artifact_allowlists.rst index f12e0d3cc..349bbbd0f 100644 --- a/docs/workspace/artifact_allowlists.rst +++ b/docs/workspace/artifact_allowlists.rst @@ -1,5 +1,5 @@ -Artifact Allowlists -=================== +``w.artifact_allowlists``: Artifact Allowlists +============================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: ArtifactAllowlistsAPI diff --git a/docs/workspace/catalogs.rst b/docs/workspace/catalogs.rst index 45f48ba97..5592152bb 100644 --- a/docs/workspace/catalogs.rst +++ b/docs/workspace/catalogs.rst @@ -1,5 +1,5 @@ -Catalogs -======== +``w.catalogs``: Catalogs +======================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: CatalogsAPI diff --git a/docs/workspace/clean_rooms.rst b/docs/workspace/clean_rooms.rst index 84f854138..827b39f0d 100644 --- a/docs/workspace/clean_rooms.rst +++ b/docs/workspace/clean_rooms.rst @@ -1,5 +1,5 @@ -Clean Rooms -=========== +``w.clean_rooms``: Clean Rooms +============================== .. currentmodule:: databricks.sdk.service.sharing .. py:class:: CleanRoomsAPI diff --git a/docs/workspace/cluster_policies.rst b/docs/workspace/cluster_policies.rst index 03ac4de85..f5c27d5c2 100644 --- a/docs/workspace/cluster_policies.rst +++ b/docs/workspace/cluster_policies.rst @@ -1,5 +1,5 @@ -Cluster Policies -================ +``w.cluster_policies``: Cluster Policies +======================================== .. currentmodule:: databricks.sdk.service.compute .. py:class:: ClusterPoliciesAPI diff --git a/docs/workspace/clusters.rst b/docs/workspace/clusters.rst index c6c1278c8..5fb2592e0 100644 --- a/docs/workspace/clusters.rst +++ b/docs/workspace/clusters.rst @@ -1,5 +1,5 @@ -Clusters -======== +``w.clusters``: Clusters +======================== .. currentmodule:: databricks.sdk.service.compute .. py:class:: ClustersExt diff --git a/docs/workspace/command_execution.rst b/docs/workspace/command_execution.rst index b0326cc80..a5b94b5a5 100644 --- a/docs/workspace/command_execution.rst +++ b/docs/workspace/command_execution.rst @@ -1,5 +1,5 @@ -Command Execution -================= +``w.command_execution``: Command Execution +========================================== .. currentmodule:: databricks.sdk.service.compute .. py:class:: CommandExecutionAPI diff --git a/docs/workspace/connections.rst b/docs/workspace/connections.rst index efda2cf97..6125db714 100644 --- a/docs/workspace/connections.rst +++ b/docs/workspace/connections.rst @@ -1,5 +1,5 @@ -Connections -=========== +``w.connections``: Connections +============================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: ConnectionsAPI diff --git a/docs/workspace/credentials_manager.rst b/docs/workspace/credentials_manager.rst index b3dcb1d74..1767ba34e 100644 --- a/docs/workspace/credentials_manager.rst +++ b/docs/workspace/credentials_manager.rst @@ -1,5 +1,5 @@ -Credentials Manager -=================== +``w.credentials_manager``: Credentials Manager +============================================== .. currentmodule:: databricks.sdk.service.settings .. py:class:: CredentialsManagerAPI diff --git a/docs/workspace/current_user.rst b/docs/workspace/current_user.rst index 052988f70..b2ba795db 100644 --- a/docs/workspace/current_user.rst +++ b/docs/workspace/current_user.rst @@ -1,5 +1,5 @@ -CurrentUser -=========== +``w.current_user``: CurrentUser +=============================== .. currentmodule:: databricks.sdk.service.iam .. py:class:: CurrentUserAPI diff --git a/docs/workspace/dashboard_widgets.rst b/docs/workspace/dashboard_widgets.rst index b3fee7edb..d4bbcde1d 100644 --- a/docs/workspace/dashboard_widgets.rst +++ b/docs/workspace/dashboard_widgets.rst @@ -1,5 +1,5 @@ -Dashboard Widgets -================= +``w.dashboard_widgets``: Dashboard Widgets +========================================== .. currentmodule:: databricks.sdk.service.sql .. py:class:: DashboardWidgetsAPI diff --git a/docs/workspace/dashboards.rst b/docs/workspace/dashboards.rst index 0a44a9280..29cafb7cc 100644 --- a/docs/workspace/dashboards.rst +++ b/docs/workspace/dashboards.rst @@ -1,5 +1,5 @@ -Dashboards -========== +``w.dashboards``: Dashboards +============================ .. currentmodule:: databricks.sdk.service.sql .. py:class:: DashboardsAPI diff --git a/docs/workspace/data_sources.rst b/docs/workspace/data_sources.rst index 523195f1f..5cf1ed526 100644 --- a/docs/workspace/data_sources.rst +++ b/docs/workspace/data_sources.rst @@ -1,5 +1,5 @@ -Data Sources -============ +``w.data_sources``: Data Sources +================================ .. currentmodule:: databricks.sdk.service.sql .. py:class:: DataSourcesAPI diff --git a/docs/workspace/dbfs.rst b/docs/workspace/dbfs.rst index bf16ecee0..9bde1e8b6 100644 --- a/docs/workspace/dbfs.rst +++ b/docs/workspace/dbfs.rst @@ -1,5 +1,5 @@ -DBFS -==== +``w.dbfs``: DBFS +================ .. currentmodule:: databricks.sdk.service.files .. py:class:: DbfsExt diff --git a/docs/workspace/dbsql_permissions.rst b/docs/workspace/dbsql_permissions.rst index 7edd0e8eb..07aa4f00f 100644 --- a/docs/workspace/dbsql_permissions.rst +++ b/docs/workspace/dbsql_permissions.rst @@ -1,5 +1,5 @@ -ACL / Permissions -================= +``w.dbsql_permissions``: ACL / Permissions +========================================== .. currentmodule:: databricks.sdk.service.sql .. py:class:: DbsqlPermissionsAPI diff --git a/docs/workspace/experiments.rst b/docs/workspace/experiments.rst index a7d7c7f61..62e16fc24 100644 --- a/docs/workspace/experiments.rst +++ b/docs/workspace/experiments.rst @@ -1,5 +1,5 @@ -Experiments -=========== +``w.experiments``: Experiments +============================== .. currentmodule:: databricks.sdk.service.ml .. py:class:: ExperimentsAPI diff --git a/docs/workspace/external_locations.rst b/docs/workspace/external_locations.rst index c19e2be50..e9e86fb41 100644 --- a/docs/workspace/external_locations.rst +++ b/docs/workspace/external_locations.rst @@ -1,5 +1,5 @@ -External Locations -================== +``w.external_locations``: External Locations +============================================ .. currentmodule:: databricks.sdk.service.catalog .. py:class:: ExternalLocationsAPI diff --git a/docs/workspace/functions.rst b/docs/workspace/functions.rst index 9e84164cf..2cc572294 100644 --- a/docs/workspace/functions.rst +++ b/docs/workspace/functions.rst @@ -1,5 +1,5 @@ -Functions -========= +``w.functions``: Functions +========================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: FunctionsAPI diff --git a/docs/workspace/git_credentials.rst b/docs/workspace/git_credentials.rst index b27d5045b..f43b25b07 100644 --- a/docs/workspace/git_credentials.rst +++ b/docs/workspace/git_credentials.rst @@ -1,5 +1,5 @@ -Git Credentials -=============== +``w.git_credentials``: Git Credentials +====================================== .. currentmodule:: databricks.sdk.service.workspace .. py:class:: GitCredentialsAPI diff --git a/docs/workspace/global_init_scripts.rst b/docs/workspace/global_init_scripts.rst index 102d8ccfc..3688ed25c 100644 --- a/docs/workspace/global_init_scripts.rst +++ b/docs/workspace/global_init_scripts.rst @@ -1,5 +1,5 @@ -Global Init Scripts -=================== +``w.global_init_scripts``: Global Init Scripts +============================================== .. currentmodule:: databricks.sdk.service.compute .. py:class:: GlobalInitScriptsAPI diff --git a/docs/workspace/grants.rst b/docs/workspace/grants.rst index cac02cd47..8def7ff83 100644 --- a/docs/workspace/grants.rst +++ b/docs/workspace/grants.rst @@ -1,5 +1,5 @@ -Grants -====== +``w.grants``: Grants +==================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: GrantsAPI diff --git a/docs/workspace/groups.rst b/docs/workspace/groups.rst index cdf53fcc7..0dd76485b 100644 --- a/docs/workspace/groups.rst +++ b/docs/workspace/groups.rst @@ -1,5 +1,5 @@ -Groups -====== +``w.groups``: Groups +==================== .. currentmodule:: databricks.sdk.service.iam .. py:class:: GroupsAPI diff --git a/docs/workspace/instance_pools.rst b/docs/workspace/instance_pools.rst index c7e43e08e..277844170 100644 --- a/docs/workspace/instance_pools.rst +++ b/docs/workspace/instance_pools.rst @@ -1,5 +1,5 @@ -Instance Pools -============== +``w.instance_pools``: Instance Pools +==================================== .. currentmodule:: databricks.sdk.service.compute .. py:class:: InstancePoolsAPI diff --git a/docs/workspace/instance_profiles.rst b/docs/workspace/instance_profiles.rst index e18faf62a..a7a25f869 100644 --- a/docs/workspace/instance_profiles.rst +++ b/docs/workspace/instance_profiles.rst @@ -1,5 +1,5 @@ -Instance Profiles -================= +``w.instance_profiles``: Instance Profiles +========================================== .. currentmodule:: databricks.sdk.service.compute .. py:class:: InstanceProfilesAPI diff --git a/docs/workspace/ip_access_lists.rst b/docs/workspace/ip_access_lists.rst index 3511b6e83..a265c5943 100644 --- a/docs/workspace/ip_access_lists.rst +++ b/docs/workspace/ip_access_lists.rst @@ -1,5 +1,5 @@ -IP Access Lists -=============== +``w.ip_access_lists``: IP Access Lists +====================================== .. currentmodule:: databricks.sdk.service.settings .. py:class:: IpAccessListsAPI diff --git a/docs/workspace/jobs.rst b/docs/workspace/jobs.rst index 66b790015..54a42c979 100644 --- a/docs/workspace/jobs.rst +++ b/docs/workspace/jobs.rst @@ -1,5 +1,5 @@ -Jobs -==== +``w.jobs``: Jobs +================ .. currentmodule:: databricks.sdk.service.jobs .. py:class:: JobsAPI diff --git a/docs/workspace/lakeview.rst b/docs/workspace/lakeview.rst index fde9d4e70..56e9bfb4b 100644 --- a/docs/workspace/lakeview.rst +++ b/docs/workspace/lakeview.rst @@ -1,5 +1,5 @@ -Lakeview -======== +``w.lakeview``: Lakeview +======================== .. currentmodule:: databricks.sdk.service.dashboards .. py:class:: LakeviewAPI diff --git a/docs/workspace/libraries.rst b/docs/workspace/libraries.rst index 8a10bd2fa..41ed1c72e 100644 --- a/docs/workspace/libraries.rst +++ b/docs/workspace/libraries.rst @@ -1,5 +1,5 @@ -Managed Libraries -================= +``w.libraries``: Managed Libraries +================================== .. currentmodule:: databricks.sdk.service.compute .. py:class:: LibrariesAPI diff --git a/docs/workspace/metastores.rst b/docs/workspace/metastores.rst index 73978e452..a5beb397a 100644 --- a/docs/workspace/metastores.rst +++ b/docs/workspace/metastores.rst @@ -1,5 +1,5 @@ -Metastores -========== +``w.metastores``: Metastores +============================ .. currentmodule:: databricks.sdk.service.catalog .. py:class:: MetastoresAPI diff --git a/docs/workspace/model_registry.rst b/docs/workspace/model_registry.rst index 27426a223..8ac52916f 100644 --- a/docs/workspace/model_registry.rst +++ b/docs/workspace/model_registry.rst @@ -1,5 +1,5 @@ -Model Registry -============== +``w.model_registry``: Model Registry +==================================== .. currentmodule:: databricks.sdk.service.ml .. py:class:: ModelRegistryAPI diff --git a/docs/workspace/model_versions.rst b/docs/workspace/model_versions.rst index 961609ffa..9b609f304 100644 --- a/docs/workspace/model_versions.rst +++ b/docs/workspace/model_versions.rst @@ -1,5 +1,5 @@ -Model Versions -============== +``w.model_versions``: Model Versions +==================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: ModelVersionsAPI diff --git a/docs/workspace/permissions.rst b/docs/workspace/permissions.rst index 5a1adc5c6..243b633c6 100644 --- a/docs/workspace/permissions.rst +++ b/docs/workspace/permissions.rst @@ -1,5 +1,5 @@ -Permissions -=========== +``w.permissions``: Permissions +============================== .. currentmodule:: databricks.sdk.service.iam .. py:class:: PermissionsAPI diff --git a/docs/workspace/pipelines.rst b/docs/workspace/pipelines.rst index 5d95bb2e4..29872c900 100644 --- a/docs/workspace/pipelines.rst +++ b/docs/workspace/pipelines.rst @@ -1,5 +1,5 @@ -Pipelines -========= +``w.pipelines``: Pipelines +========================== .. currentmodule:: databricks.sdk.service.pipelines .. py:class:: PipelinesAPI diff --git a/docs/workspace/policy_families.rst b/docs/workspace/policy_families.rst index 4da1ab089..43194ef01 100644 --- a/docs/workspace/policy_families.rst +++ b/docs/workspace/policy_families.rst @@ -1,5 +1,5 @@ -Policy Families -=============== +``w.policy_families``: Policy Families +====================================== .. currentmodule:: databricks.sdk.service.compute .. py:class:: PolicyFamiliesAPI diff --git a/docs/workspace/providers.rst b/docs/workspace/providers.rst index 7ff8c1ffb..1382b5a92 100644 --- a/docs/workspace/providers.rst +++ b/docs/workspace/providers.rst @@ -1,5 +1,5 @@ -Providers -========= +``w.providers``: Providers +========================== .. currentmodule:: databricks.sdk.service.sharing .. py:class:: ProvidersAPI diff --git a/docs/workspace/queries.rst b/docs/workspace/queries.rst index 0b0c139ad..32803f6d3 100644 --- a/docs/workspace/queries.rst +++ b/docs/workspace/queries.rst @@ -1,5 +1,5 @@ -Queries / Results -================= +``w.queries``: Queries / Results +================================ .. currentmodule:: databricks.sdk.service.sql .. py:class:: QueriesAPI diff --git a/docs/workspace/query_history.rst b/docs/workspace/query_history.rst index 0e7bdd553..c4c6ee9ae 100644 --- a/docs/workspace/query_history.rst +++ b/docs/workspace/query_history.rst @@ -1,5 +1,5 @@ -Query History -============= +``w.query_history``: Query History +================================== .. currentmodule:: databricks.sdk.service.sql .. py:class:: QueryHistoryAPI diff --git a/docs/workspace/query_visualizations.rst b/docs/workspace/query_visualizations.rst index 08f0e350a..7ef5b1cdc 100644 --- a/docs/workspace/query_visualizations.rst +++ b/docs/workspace/query_visualizations.rst @@ -1,5 +1,5 @@ -Query Visualizations -==================== +``w.query_visualizations``: Query Visualizations +================================================ .. currentmodule:: databricks.sdk.service.sql .. py:class:: QueryVisualizationsAPI diff --git a/docs/workspace/recipient_activation.rst b/docs/workspace/recipient_activation.rst index c5bf5456e..2c214d9c0 100644 --- a/docs/workspace/recipient_activation.rst +++ b/docs/workspace/recipient_activation.rst @@ -1,5 +1,5 @@ -Recipient Activation -==================== +``w.recipient_activation``: Recipient Activation +================================================ .. currentmodule:: databricks.sdk.service.sharing .. py:class:: RecipientActivationAPI diff --git a/docs/workspace/recipients.rst b/docs/workspace/recipients.rst index 41da7d587..86a004d36 100644 --- a/docs/workspace/recipients.rst +++ b/docs/workspace/recipients.rst @@ -1,5 +1,5 @@ -Recipients -========== +``w.recipients``: Recipients +============================ .. currentmodule:: databricks.sdk.service.sharing .. py:class:: RecipientsAPI diff --git a/docs/workspace/registered_models.rst b/docs/workspace/registered_models.rst index 7669b16ee..784e0d272 100644 --- a/docs/workspace/registered_models.rst +++ b/docs/workspace/registered_models.rst @@ -1,5 +1,5 @@ -Registered Models -================= +``w.registered_models``: Registered Models +========================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: RegisteredModelsAPI diff --git a/docs/workspace/repos.rst b/docs/workspace/repos.rst index 440c74b93..584ad70b3 100644 --- a/docs/workspace/repos.rst +++ b/docs/workspace/repos.rst @@ -1,5 +1,5 @@ -Repos -===== +``w.repos``: Repos +================== .. currentmodule:: databricks.sdk.service.workspace .. py:class:: ReposAPI diff --git a/docs/workspace/schemas.rst b/docs/workspace/schemas.rst index 7c9ae3fd9..46ea49ff4 100644 --- a/docs/workspace/schemas.rst +++ b/docs/workspace/schemas.rst @@ -1,5 +1,5 @@ -Schemas -======= +``w.schemas``: Schemas +====================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: SchemasAPI diff --git a/docs/workspace/secrets.rst b/docs/workspace/secrets.rst index ec2b618bc..add03d224 100644 --- a/docs/workspace/secrets.rst +++ b/docs/workspace/secrets.rst @@ -1,5 +1,5 @@ -Secret -====== +``w.secrets``: Secret +===================== .. currentmodule:: databricks.sdk.service.workspace .. py:class:: SecretsAPI diff --git a/docs/workspace/service_principals.rst b/docs/workspace/service_principals.rst index 0e5c0c532..41829fc87 100644 --- a/docs/workspace/service_principals.rst +++ b/docs/workspace/service_principals.rst @@ -1,5 +1,5 @@ -Service Principals -================== +``w.service_principals``: Service Principals +============================================ .. currentmodule:: databricks.sdk.service.iam .. py:class:: ServicePrincipalsAPI diff --git a/docs/workspace/serving_endpoints.rst b/docs/workspace/serving_endpoints.rst index 2daf72e5d..8972b0877 100644 --- a/docs/workspace/serving_endpoints.rst +++ b/docs/workspace/serving_endpoints.rst @@ -1,5 +1,5 @@ -Serving endpoints -================= +``w.serving_endpoints``: Serving endpoints +========================================== .. currentmodule:: databricks.sdk.service.serving .. py:class:: ServingEndpointsAPI diff --git a/docs/workspace/settings.rst b/docs/workspace/settings.rst index aa2b9c587..0395213d3 100644 --- a/docs/workspace/settings.rst +++ b/docs/workspace/settings.rst @@ -1,5 +1,5 @@ -Default Namespace -================= +``w.settings``: Default Namespace +================================= .. currentmodule:: databricks.sdk.service.settings .. py:class:: SettingsAPI diff --git a/docs/workspace/shares.rst b/docs/workspace/shares.rst index a6ce1302f..63c9b1ebe 100644 --- a/docs/workspace/shares.rst +++ b/docs/workspace/shares.rst @@ -1,5 +1,5 @@ -Shares -====== +``w.shares``: Shares +==================== .. currentmodule:: databricks.sdk.service.sharing .. py:class:: SharesAPI diff --git a/docs/workspace/statement_execution.rst b/docs/workspace/statement_execution.rst index 9e475ab26..d5c479462 100644 --- a/docs/workspace/statement_execution.rst +++ b/docs/workspace/statement_execution.rst @@ -1,5 +1,5 @@ -Statement Execution -=================== +``w.statement_execution``: Statement Execution +============================================== .. currentmodule:: databricks.sdk.service.sql .. py:class:: StatementExecutionAPI diff --git a/docs/workspace/storage_credentials.rst b/docs/workspace/storage_credentials.rst index 18344433b..42a830f09 100644 --- a/docs/workspace/storage_credentials.rst +++ b/docs/workspace/storage_credentials.rst @@ -1,5 +1,5 @@ -Storage Credentials -=================== +``w.storage_credentials``: Storage Credentials +============================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: StorageCredentialsAPI diff --git a/docs/workspace/system_schemas.rst b/docs/workspace/system_schemas.rst index 37f250ba9..13c4a56df 100644 --- a/docs/workspace/system_schemas.rst +++ b/docs/workspace/system_schemas.rst @@ -1,5 +1,5 @@ -SystemSchemas -============= +``w.system_schemas``: SystemSchemas +=================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: SystemSchemasAPI diff --git a/docs/workspace/table_constraints.rst b/docs/workspace/table_constraints.rst index c8d6f5ae2..dd46c42f3 100644 --- a/docs/workspace/table_constraints.rst +++ b/docs/workspace/table_constraints.rst @@ -1,5 +1,5 @@ -Table Constraints -================= +``w.table_constraints``: Table Constraints +========================================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: TableConstraintsAPI diff --git a/docs/workspace/tables.rst b/docs/workspace/tables.rst index 4973dad22..90b51ca57 100644 --- a/docs/workspace/tables.rst +++ b/docs/workspace/tables.rst @@ -1,5 +1,5 @@ -Tables -====== +``w.tables``: Tables +==================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: TablesAPI diff --git a/docs/workspace/token_management.rst b/docs/workspace/token_management.rst index 41ed68a0b..cf1860419 100644 --- a/docs/workspace/token_management.rst +++ b/docs/workspace/token_management.rst @@ -1,5 +1,5 @@ -Token management -================ +``w.token_management``: Token management +======================================== .. currentmodule:: databricks.sdk.service.settings .. py:class:: TokenManagementAPI diff --git a/docs/workspace/tokens.rst b/docs/workspace/tokens.rst index df75f2f9d..899db00d1 100644 --- a/docs/workspace/tokens.rst +++ b/docs/workspace/tokens.rst @@ -1,5 +1,5 @@ -Token -===== +``w.tokens``: Token +=================== .. currentmodule:: databricks.sdk.service.settings .. py:class:: TokensAPI diff --git a/docs/workspace/users.rst b/docs/workspace/users.rst index e52dc540d..2adaee935 100644 --- a/docs/workspace/users.rst +++ b/docs/workspace/users.rst @@ -1,5 +1,5 @@ -Users -===== +``w.users``: Users +================== .. currentmodule:: databricks.sdk.service.iam .. py:class:: UsersAPI diff --git a/docs/workspace/vector_search_endpoints.rst b/docs/workspace/vector_search_endpoints.rst index 7c47354db..64d92cec2 100644 --- a/docs/workspace/vector_search_endpoints.rst +++ b/docs/workspace/vector_search_endpoints.rst @@ -1,5 +1,5 @@ -Endpoints -========= +``w.vector_search_endpoints``: Endpoints +======================================== .. currentmodule:: databricks.sdk.service.vectorsearch .. py:class:: VectorSearchEndpointsAPI diff --git a/docs/workspace/vector_search_indexes.rst b/docs/workspace/vector_search_indexes.rst index fd1da43fa..f79335e4f 100644 --- a/docs/workspace/vector_search_indexes.rst +++ b/docs/workspace/vector_search_indexes.rst @@ -1,5 +1,5 @@ -Indexes -======= +``w.vector_search_indexes``: Indexes +==================================== .. currentmodule:: databricks.sdk.service.vectorsearch .. py:class:: VectorSearchIndexesAPI diff --git a/docs/workspace/volumes.rst b/docs/workspace/volumes.rst index 4d9628244..0e0426e5e 100644 --- a/docs/workspace/volumes.rst +++ b/docs/workspace/volumes.rst @@ -1,5 +1,5 @@ -Volumes -======= +``w.volumes``: Volumes +====================== .. currentmodule:: databricks.sdk.service.catalog .. py:class:: VolumesAPI diff --git a/docs/workspace/warehouses.rst b/docs/workspace/warehouses.rst index 37c5faf81..793852680 100644 --- a/docs/workspace/warehouses.rst +++ b/docs/workspace/warehouses.rst @@ -1,5 +1,5 @@ -SQL Warehouses -============== +``w.warehouses``: SQL Warehouses +================================ .. currentmodule:: databricks.sdk.service.sql .. py:class:: WarehousesAPI diff --git a/docs/workspace/workspace.rst b/docs/workspace/workspace.rst index 2925cf3d3..53b875b0c 100644 --- a/docs/workspace/workspace.rst +++ b/docs/workspace/workspace.rst @@ -1,5 +1,5 @@ -Workspace -========= +``w.workspace``: Workspace +========================== .. currentmodule:: databricks.sdk.service.workspace .. py:class:: WorkspaceExt diff --git a/docs/workspace/workspace_bindings.rst b/docs/workspace/workspace_bindings.rst index 6dd9a6d06..e1ec753d4 100644 --- a/docs/workspace/workspace_bindings.rst +++ b/docs/workspace/workspace_bindings.rst @@ -1,5 +1,5 @@ -Workspace Bindings -================== +``w.workspace_bindings``: Workspace Bindings +============================================ .. currentmodule:: databricks.sdk.service.catalog .. py:class:: WorkspaceBindingsAPI diff --git a/docs/workspace/workspace_conf.rst b/docs/workspace/workspace_conf.rst index 672f255e0..892819383 100644 --- a/docs/workspace/workspace_conf.rst +++ b/docs/workspace/workspace_conf.rst @@ -1,5 +1,5 @@ -Workspace Conf -============== +``w.workspace_conf``: Workspace Conf +==================================== .. currentmodule:: databricks.sdk.service.settings .. py:class:: WorkspaceConfAPI