com.databricks.sdk.service.settings

Interface SettingsService

@Generated
public interface SettingsService

The default namespace setting API allows users to configure the default namespace for a Databricks workspace.

Through this API, users can retrieve, set, or modify the default namespace used when queries do not reference a fully qualified three-level name. For example, if you use the API to set 'retail_prod' as the default catalog, then a query 'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable' (the schema 'default' is always assumed).

This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
DeleteDefaultNamespaceSettingResponse	deleteDefaultNamespaceSetting(DeleteDefaultNamespaceSettingRequest deleteDefaultNamespaceSettingRequest) Delete the default namespace setting.
DeleteRestrictWorkspaceAdminsSettingResponse	deleteRestrictWorkspaceAdminsSetting(DeleteRestrictWorkspaceAdminsSettingRequest deleteRestrictWorkspaceAdminsSettingRequest) Delete the restrict workspace admins setting.
DefaultNamespaceSetting	getDefaultNamespaceSetting(GetDefaultNamespaceSettingRequest getDefaultNamespaceSettingRequest) Get the default namespace setting.
RestrictWorkspaceAdminsSetting	getRestrictWorkspaceAdminsSetting(GetRestrictWorkspaceAdminsSettingRequest getRestrictWorkspaceAdminsSettingRequest) Get the restrict workspace admins setting.
DefaultNamespaceSetting	updateDefaultNamespaceSetting(UpdateDefaultNamespaceSettingRequest updateDefaultNamespaceSettingRequest) Update the default namespace setting.
RestrictWorkspaceAdminsSetting	updateRestrictWorkspaceAdminsSetting(UpdateRestrictWorkspaceAdminsSettingRequest updateRestrictWorkspaceAdminsSettingRequest) Update the restrict workspace admins setting.

Method Detail

deleteDefaultNamespaceSetting

DeleteDefaultNamespaceSettingResponse deleteDefaultNamespaceSetting(DeleteDefaultNamespaceSettingRequest deleteDefaultNamespaceSettingRequest)

Delete the default namespace setting.

Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in DELETE requests (as a query parameter). The etag can be retrieved by making a GET request before the DELETE request. If the setting is updated/deleted concurrently, DELETE will fail with 409 and the request will need to be retried by using the fresh etag in the 409 response.

deleteRestrictWorkspaceAdminsSetting

DeleteRestrictWorkspaceAdminsSettingResponse deleteRestrictWorkspaceAdminsSetting(DeleteRestrictWorkspaceAdminsSettingRequest deleteRestrictWorkspaceAdminsSettingRequest)

Delete the restrict workspace admins setting.

Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be provided in DELETE requests (as a query parameter). The etag can be retrieved by making a GET request before the DELETE request. If the setting is updated/deleted concurrently, DELETE will fail with 409 and the request will need to be retried by using the fresh etag in the 409 response.

getDefaultNamespaceSetting

DefaultNamespaceSetting getDefaultNamespaceSetting(GetDefaultNamespaceSettingRequest getDefaultNamespaceSettingRequest)

Get the default namespace setting.

Gets the default namespace setting.

getRestrictWorkspaceAdminsSetting

RestrictWorkspaceAdminsSetting getRestrictWorkspaceAdminsSetting(GetRestrictWorkspaceAdminsSettingRequest getRestrictWorkspaceAdminsSettingRequest)

Get the restrict workspace admins setting.

Gets the restrict workspace admins setting.

updateDefaultNamespaceSetting

DefaultNamespaceSetting updateDefaultNamespaceSetting(UpdateDefaultNamespaceSettingRequest updateDefaultNamespaceSettingRequest)

Update the default namespace setting.

Updates the default namespace setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH request. Note that if the setting does not exist, GET will return a NOT_FOUND error and the etag will be present in the error response, which should be set in the PATCH request. If the setting is updated concurrently, PATCH will fail with 409 and the request will need to be retried by using the fresh etag in the 409 response.

updateRestrictWorkspaceAdminsSetting

RestrictWorkspaceAdminsSetting updateRestrictWorkspaceAdminsSetting(UpdateRestrictWorkspaceAdminsSettingRequest updateRestrictWorkspaceAdminsSettingRequest)

Update the restrict workspace admins setting.

Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH request. If the setting is updated concurrently, PATCH will fail with 409 and the request will need to be retried by using the fresh etag in the 409 response.