Releases: databricks/databricks-sdk-py
v0.15.0
Bugfixes:
Other changes:
- Updated GCP OAuth Readme (#464).
- Reference Documentation Refactoring (#467).
- Installed local library when generating docs (#469).
- Fixed readme links in pypi (#472).
- Updated a note for installing Python SDK on Databricks Runtime 13.1+ (#474).
- Updated GCP auth readme (#470).
API Changes:
- Changed
update()
method for w.connections workspace-level service with new required argument order. - Added
cloudflare_api_token
field fordatabricks.sdk.service.catalog.CreateStorageCredential
. - Added
cloudflare_api_token
field fordatabricks.sdk.service.catalog.StorageCredentialInfo
. - Changed
name
field fordatabricks.sdk.service.catalog.UpdateCatalog
to be required. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateCatalog
. - Changed
name
field fordatabricks.sdk.service.catalog.UpdateConnection
to no longer be required. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateConnection
. - Changed
name
field fordatabricks.sdk.service.catalog.UpdateExternalLocation
to be required. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateExternalLocation
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateMetastore
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateRegisteredModelRequest
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateSchema
. - Changed
name
field fordatabricks.sdk.service.catalog.UpdateStorageCredential
to be required. - Added
cloudflare_api_token
field fordatabricks.sdk.service.catalog.UpdateStorageCredential
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateStorageCredential
. - Added
new_name
field fordatabricks.sdk.service.catalog.UpdateVolumeRequestContent
. - Added
cloudflare_api_token
field fordatabricks.sdk.service.catalog.ValidateStorageCredential
. - Added
databricks.sdk.service.catalog.CloudflareApiToken
dataclass. - Removed
continuous
field fordatabricks.sdk.service.jobs.BaseRun
. - Removed
continuous
field fordatabricks.sdk.service.jobs.Run
. - Changed
job_parameters
field fordatabricks.sdk.service.jobs.RunJobTask
todatabricks.sdk.service.jobs.ParamPairs
dataclass. - Added
run_if
field fordatabricks.sdk.service.jobs.SubmitTask
. - Added
run_job_task
field fordatabricks.sdk.service.jobs.SubmitTask
. - Changed
update_config()
method for w.serving_endpoints workspace-level service with new required argument order. - Added
put()
method for w.serving_endpoints workspace-level service. - Added
rate_limits
field fordatabricks.sdk.service.serving.CreateServingEndpoint
. - Changed
served_models
field fordatabricks.sdk.service.serving.EndpointCoreConfigInput
to no longer be required. - Added
auto_capture_config
field fordatabricks.sdk.service.serving.EndpointCoreConfigInput
. - Added
served_entities
field fordatabricks.sdk.service.serving.EndpointCoreConfigInput
. - Added
auto_capture_config
field fordatabricks.sdk.service.serving.EndpointCoreConfigOutput
. - Added
served_entities
field fordatabricks.sdk.service.serving.EndpointCoreConfigOutput
. - Added
served_entities
field fordatabricks.sdk.service.serving.EndpointCoreConfigSummary
. - Added
served_entities
field fordatabricks.sdk.service.serving.EndpointPendingConfig
. - Added
extra_params
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
input
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
max_tokens
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
messages
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
n
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
prompt
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
stop
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
stream
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Added
temperature
field fordatabricks.sdk.service.serving.QueryEndpointInput
. - Changed
predictions
field fordatabricks.sdk.service.serving.QueryEndpointResponse
to no longer be required. - Added
choices
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
created
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
data
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
id
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
model
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
object
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Added
usage
field fordatabricks.sdk.service.serving.QueryEndpointResponse
. - Changed
workload_size
field fordatabricks.sdk.service.serving.ServedModelInput
todatabricks.sdk.service.serving.ServedModelInputWorkloadSize
dataclass. - Changed
workload_type
field fordatabricks.sdk.service.serving.ServedModelInput
todatabricks.sdk.service.serving.ServedModelInputWorkloadType
dataclass. - Added
task
field fordatabricks.sdk.service.serving.ServingEndpoint
. - Added
task
field fordatabricks.sdk.service.serving.ServingEndpointDetailed
. - Added
databricks.sdk.service.serving.Ai21LabsConfig
dataclass. - Added
databricks.sdk.service.serving.AnthropicConfig
dataclass. - Added
databricks.sdk.service.serving.AutoCaptureConfigInput
dataclass. - Added
databricks.sdk.service.serving.AutoCaptureConfigOutput
dataclass. - Added
databricks.sdk.service.serving.AutoCaptureState
dataclass. - Added
databricks.sdk.service.serving.AwsBedrockConfig
dataclass. - Added
databricks.sdk.service.serving.AwsBedrockConfigBedrockProvider
dataclass. - Added
databricks.sdk.service.serving.ChatMessage
dataclass. - Added
databricks.sdk.service.serving.ChatMessageRole
dataclass. - Added
databricks.sdk.service.serving.CohereConfig
dataclass. - Added
databricks.sdk.service.serving.DatabricksModelServingConfig
dataclass. - Added
databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElement
dataclass. - Added
databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElementObject
dataclass. - Added
databricks.sdk.service.serving.ExternalModel
dataclass. - Added
databricks.sdk.service.serving.ExternalModelConfig
dataclass. - Added
databricks.sdk.service.serving.ExternalModelProvider
dataclass. - Added
databricks.sdk.service.serving.ExternalModelUsageElement
dataclass. - Added
databricks.sdk.service.serving.FoundationModel
dataclass. - Added
databricks.sdk.service.serving.OpenAiConfig
dataclass. - Added
databricks.sdk.service.serving.PaLmConfig
dataclass. - Added
databricks.sdk.service.serving.PayloadTable
dataclass. - Added
databricks.sdk.service.serving.PutRequest
dataclass. - Added
databricks.sdk.service.serving.PutResponse
dataclass. - Added
databricks.sdk.service.serving.QueryEndpointResponseObject
dataclass. - Added
databricks.sdk.service.serving.RateLimit
dataclass. - Added
databricks.sdk.service.serving.RateLimitKey
dataclass. - Added
databricks.sdk.service.serving.RateLimitRenewalPeriod
dataclass. - Added
databricks.sdk.service.serving.ServedEntityInput
dataclass. - Added
databricks.sdk.service.serving.ServedEntityOutput
dataclass. - Added
databricks.sdk.service.serving.ServedEntitySpec
dataclass. - Added
databricks.sdk.service.serving.ServedModelInputWorkloadSize
dataclass. - Added
databricks.sdk.service.serving.ServedModelInputWorkloadType
dataclass. - Added
databricks.sdk.service.serving.V1ResponseChoiceElement
dataclass. - Removed a.account_network_policy account-level service.
- Removed
databricks.sdk.service.settings.AccountNetworkPolicyMessage
dataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest
dataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse
dataclass. - Removed
databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest
dataclass. - Removed
databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest
dataclass. - Removed
name
field fordatabricks.sdk.service.sharing.UpdateCleanRoom
. - Changed
name
field fordatabricks.sdk.service.sharing.UpdateProvider
to be required. - Added
new_name
field fordatabricks.sdk.service.sharing.UpdateProvider
. - Changed
name
field fordatabricks.sdk.service.sharing.UpdateRecipient
to be required. - Added
new_name
field fordatabricks.sdk.service.sharing.UpdateRecipient
. - Changed
name
field fordatabricks.sdk.service.sharing.UpdateShare
to be required. - Added
new_name
field fordatabricks.sdk.service.sharing.UpdateShare
. - Added
statement_ids
field fordatabricks.sdk.service.sql.QueryFilter
. - Added
databricks.sdk.service.sql.StatementId
dataclass.
OpenAPI SHA: 63caa3cb0c05045e81d3dcf2451fa990d8670f36, Date: 2023-12-12
v0.14.0
Major changes:
- GCP Auth is now supported in the Python SDK. To use Google credentials-based authentication, specify your Default Application Credentials in the
GOOGLE_CREDENTIALS
environment variable or correspondinggoogle_credentials
parameter inConfig
or the client constructors. You may provide either the path to the file containing your credentials or the credentials themselves serialized as JSON. To use Google impersonation, specify the service principal to impersonate in theDATABRICKS_GOOGLE_SERVICE_ACCOUNT
environment variable or the correspondinggoogle_service_account
parameter inConfig
or the client constructors. See #444 for the changes.
Bug fixes:
- Fix flask app example (#445).
- Fix deserialization of repeated enums (#450, #452).
- Capture stdout and stderr separately when calling Azure CLI (#460).
Other changes:
- Change the name of retries logger to
databricks.sdk.retries
(#453).
API Changes:
- Added
pipeline_id
field fordatabricks.sdk.service.catalog.TableInfo
. - Added
enable_predictive_optimization
field fordatabricks.sdk.service.catalog.UpdateCatalog
anddatabricks.sdk.service.catalog.UpdateSchema
. - Removed
databricks.sdk.service.catalog.UpdatePredictiveOptimization
anddatabricks.sdk.service.catalog.UpdatePredictiveOptimizationResponse
dataclasses. - Removed
enable_optimization()
method for w.metastores workspace-level service. - Added
description
field fordatabricks.sdk.service.jobs.CreateJob
anddatabricks.sdk.service.jobs.JobSettings
. - Added
list_network_connectivity_configurations()
andlist_private_endpoint_rules()
methods for a.network_connectivity account-level service. - Added
databricks.sdk.service.settings.ListNccAzurePrivateEndpointRulesResponse
,databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsRequest
,databricks.sdk.service.settings.ListNetworkConnectivityConfigurationsResponse
, anddatabricks.sdk.service.settings.ListPrivateEndpointRulesRequest
dataclasses.
Internal changes:
- Make ucws tests skipped when DATABRICKS_ACCOUNT_ID is present (#448).
OpenAPI SHA: 22f09783eb8a84d52026f856be3b2068f9498db3, Date: 2023-11-23
Dependency updates:
- Introduced "google-auth" dependency to support Google authentication.
v0.13.0
- Introduce more specific exceptions, like
NotFound
,AlreadyExists
,BadRequest
,PermissionDenied
,InternalError
, and others (#376). This makes it easier to handle errors thrown by the Databricks API. Instead of catchingDatabricksError
and checking the error_code field, you can catch one of these subtypes ofDatabricksError
, which is more ergonomic and removes the need to rethrow exceptions that you don't want to catch. For example:
try:
return (self._ws
.permissions
.get(object_type, object_id))
except DatabricksError as e:
if e.error_code in [
"RESOURCE_DOES_NOT_EXIST",
"RESOURCE_NOT_FOUND",
"PERMISSION_DENIED",
"FEATURE_DISABLED",
"BAD_REQUEST"]:
logger.warning(...)
return None
raise RetryableError(...) from e
can be replaced with
try:
return (self._ws
.permissions
.get(object_type, object_id))
except PermissionDenied, FeatureDisabled:
logger.warning(...)
return None
except NotFound:
raise RetryableError(...)
- Paginate all SCIM list requests in the SDK (#440). This change ensures that SCIM list() APIs use a default limit of 100 resources, leveraging SCIM's offset + limit pagination to batch requests to the Databricks API.
- Added taskValues support in remoteDbUtils (#406).
- Added more detailed error message on default credentials not found error (#419).
- Request management token via Azure CLI only for Service Principals and not human users (#408).
API Changes:
- Fixed
create()
method for w.functions workspace-level service and correspondingdatabricks.sdk.service.catalog.CreateFunction
anddatabricks.sdk.service.catalog.FunctionInfo
dataclasses. - Changed
create()
method for w.metastores workspace-level service with new required argument order. - Changed
storage_root
field fordatabricks.sdk.service.catalog.CreateMetastore
to be optional. - Added
skip_validation
field fordatabricks.sdk.service.catalog.UpdateExternalLocation
. - Added
libraries
field fordatabricks.sdk.service.compute.CreatePolicy
,databricks.sdk.service.compute.EditPolicy
anddatabricks.sdk.service.compute.Policy
. - Added
init_scripts
field fordatabricks.sdk.service.compute.EventDetails
. - Added
file
field fordatabricks.sdk.service.compute.InitScriptInfo
. - Added
zone_id
field fordatabricks.sdk.service.compute.InstancePoolGcpAttributes
. - Added several dataclasses related to init scripts.
- Added
databricks.sdk.service.compute.LocalFileInfo
dataclass. - Replaced
ui_state
field withedit_mode
fordatabricks.sdk.service.jobs.CreateJob
anddatabricks.sdk.service.jobs.JobSettings
. - Replaced
databricks.sdk.service.jobs.CreateJobUiState
dataclass withdatabricks.sdk.service.jobs.CreateJobEditMode
. - Added
include_resolved_values
field fordatabricks.sdk.service.jobs.GetRunRequest
. - Replaced
databricks.sdk.service.jobs.JobSettingsUiState
dataclass withdatabricks.sdk.service.jobs.JobSettingsEditMode
. - Removed a.o_auth_enrollment account-level service. This was only used to aid in OAuth enablement during the public preview of OAuth. OAuth is now enabled for all AWS E2 accounts, so usage of this API is no longer needed.
- Added
network_connectivity_config_id
field fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest
. - Added a.network_connectivity account-level service.
- Added
string_shared_as
field fordatabricks.sdk.service.sharing.SharedDataObject
.
Internal changes:
- Added regression question to issue template (#414).
- Made test_auth no longer fail if you have a default profile setup (#426).
OpenAPI SHA: d136ad0541f036372601bad9a4382db06c3c912d, Date: 2023-11-14
v0.12.0
- Retry on all 429 and 503, even when missing Retry-After header (#402).
- Add support for tokenless authentication for GitHub Actions configured with OpenID Connect with Azure User Managed Identity (or Service Principal) (#385).
- Reduce redundant warning messages in azure-cli credential provider (#410).
API Changes:
- Added
attributes
,count
,excluded_attributes
,filter
,sort_by
,sort_order
, andstart_index
fields fordatabricks.sdk.service.iam.GetAccountUserRequest
anddatabricks.sdk.service.iam.GetUserRequest
. - Added
schemas
field fordatabricks.sdk.service.iam.Group
,databricks.sdk.service.iam.ListGroupsResponse
,databricks.sdk.service.iam.ListServicePrincipalResponse
,databricks.sdk.service.iam.ListUsersResponse
,databricks.sdk.service.iam.ServicePrincipal
, anddatabricks.sdk.service.iam.User
. - Added
databricks.sdk.service.iam.GetSortOrder
,databricks.sdk.service.iam.GroupSchema
,databricks.sdk.service.iam.ListResponseSchema
,databricks.sdk.service.iam.ServicePrincipalSchema
, anddatabricks.sdk.service.iam.UserSchema
dataclasses. - Added
webhook_notifications
field fordatabricks.sdk.service.jobs.SubmitTask
. - Added w.apps workspace-level service and related dataclasses
- Added a.account_network_policy account-level service and related dataclasses.
OpenAPI SHA: 5903bb39137fd76ac384b2044e425f9c56840e00, Date: 2023-10-23
v0.11.0
- Added Python 3.12 to project classifiers (#381).
- Fix serialization issues for generated resources (#382).
- Fix select spark version in staging (#388).
- Adjust token expiry window to 40 seconds because of Azure (#392).
- Add retries on
RPC token bucket limit has been exceeded
(#395). - Regenerate to fix template drift (#398).
- Update OpenAPI spec to 12 Oct 2023 (#399).
Internal:
API Changes:
- Changed
download()
method for a.billable_usage account-level service to start returningdatabricks.sdk.service.billing.DownloadResponse
dataclass. - Added
databricks.sdk.service.billing.DownloadResponse
dataclass. - Changed
delete()
method for a.account_storage_credentials account-level service with new required argument order. - Changed
get()
method for a.account_storage_credentials account-level service with new required argument order. - Changed
update()
method for a.account_storage_credentials account-level service with new required argument order. - Added
get_bindings()
method for w.workspace_bindings workspace-level service. - Added
update_bindings()
method for w.workspace_bindings workspace-level service. - Removed
name
field fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredential
. - Added
storage_credential_name
field fordatabricks.sdk.service.catalog.AccountsUpdateStorageCredential
. - Removed
name
field fordatabricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest
. - Added
storage_credential_name
field fordatabricks.sdk.service.catalog.DeleteAccountStorageCredentialRequest
. - Removed
name
field fordatabricks.sdk.service.catalog.GetAccountStorageCredentialRequest
. - Added
storage_credential_name
field fordatabricks.sdk.service.catalog.GetAccountStorageCredentialRequest
. - Added
owner
field fordatabricks.sdk.service.catalog.UpdateConnection
. - Added
databricks.sdk.service.catalog.GetBindingsRequest
dataclass. - Added
databricks.sdk.service.catalog.UpdateWorkspaceBindingsParameters
dataclass. - Added
databricks.sdk.service.catalog.WorkspaceBinding
dataclass. - Added
databricks.sdk.service.catalog.WorkspaceBindingBindingType
dataclass. - Added
databricks.sdk.service.catalog.WorkspaceBindingsResponse
dataclass. - Added
spec
field fordatabricks.sdk.service.compute.ClusterDetails
. - Added
apply_policy_default_values
field fordatabricks.sdk.service.compute.ClusterSpec
. - Removed
aws_attributes
field fordatabricks.sdk.service.compute.EditInstancePool
. - Removed
azure_attributes
field fordatabricks.sdk.service.compute.EditInstancePool
. - Removed
disk_spec
field fordatabricks.sdk.service.compute.EditInstancePool
. - Removed
enable_elastic_disk
field fordatabricks.sdk.service.compute.EditInstancePool
. - Removed
gcp_attributes
field fordatabricks.sdk.service.compute.EditInstancePool
. - Removed
preloaded_docker_images
field fordatabricks.sdk.service.compute.EditInstancePool
. - Removed
preloaded_spark_versions
field fordatabricks.sdk.service.compute.EditInstancePool
. - Added
deployment
field fordatabricks.sdk.service.jobs.CreateJob
. - Added
ui_state
field fordatabricks.sdk.service.jobs.CreateJob
. - Added
deployment
field fordatabricks.sdk.service.jobs.JobSettings
. - Added
ui_state
field fordatabricks.sdk.service.jobs.JobSettings
. - Removed
condition_task
field fordatabricks.sdk.service.jobs.RunOutput
. - Added
webhook_notifications
field fordatabricks.sdk.service.jobs.Task
. - Added
databricks.sdk.service.jobs.CreateJobUiState
dataclass. - Added
databricks.sdk.service.jobs.JobDeployment
dataclass. - Added
databricks.sdk.service.jobs.JobDeploymentKind
dataclass. - Added
databricks.sdk.service.jobs.JobSettingsUiState
dataclass. - Added
workload_type
field fordatabricks.sdk.service.serving.ServedModelInput
. - Added
workload_type
field fordatabricks.sdk.service.serving.ServedModelOutput
. - Removed a.account_network_policy account-level service.
- Changed
list()
method for w.ip_access_lists workspace-level service to returndatabricks.sdk.service.settings.ListIpAccessListResponse
dataclass. - Removed
databricks.sdk.service.settings.AccountNetworkPolicyMessage
dataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest
dataclass. - Removed
databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse
dataclass. - Removed
ip_access_lists
field fordatabricks.sdk.service.settings.GetIpAccessListResponse
. - Added
ip_access_list
field fordatabricks.sdk.service.settings.GetIpAccessListResponse
. - Removed
databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest
dataclass. - Removed
databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest
dataclass. - Added
databricks.sdk.service.settings.ListIpAccessListResponse
dataclass.
OpenAPI SHA: 493a76554afd3afdd15dc858773d01643f80352a, Date: 2023-10-12
v0.10.0
- Respect
retry_timeout_seconds
config setting and align retry implementation with Go SDK (#337).
Breaking API Changes:
- Changed
list()
method for a.account_metastore_assignments account-level service to returndatabricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponse
dataclass. - Removed
owner
field fordatabricks.sdk.service.catalog.CreateConnection
. Instead, use theowner
field ofUpdateConnection
. - Removed
options
field fordatabricks.sdk.service.catalog.UpdateCatalog
. - Changed
job_parameters
field fordatabricks.sdk.service.jobs.RunNow
todatabricks.sdk.service.jobs.ParamPairs
dataclass. - Changed
query()
method for w.serving_endpoints workspace-level service . New request type isdatabricks.sdk.service.serving.QueryEndpointInput
dataclass. - Renamed
databricks.sdk.service.serving.QueryRequest
dataclass toQueryEndpointInput
. - Changed
list()
method for w.clean_rooms workspace-level service to require request ofdatabricks.sdk.service.sharing.ListCleanRoomsRequest
dataclass.
API Changes:
- Added
databricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponse
dataclass. - Added
job_parameters
field fordatabricks.sdk.service.jobs.RepairRun
. - Added
job_parameters
field fordatabricks.sdk.service.jobs.RunParameters
. - Added
notifications
field fordatabricks.sdk.service.pipelines.CreatePipeline
. - Added
notifications
field fordatabricks.sdk.service.pipelines.EditPipeline
. - Added
notifications
field fordatabricks.sdk.service.pipelines.PipelineSpec
. - Added
databricks.sdk.service.pipelines.Notifications
dataclass. - Added
databricks.sdk.service.serving.DataframeSplitInput
dataclass. - Added w.settings workspace-level service.
- Added
databricks.sdk.service.settings.DefaultNamespaceSetting
dataclass. - Added
databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceRequest
dataclass. - Added
databricks.sdk.service.settings.DeleteDefaultWorkspaceNamespaceResponse
dataclass. - Added
databricks.sdk.service.settings.ReadDefaultWorkspaceNamespaceRequest
dataclass. - Added
databricks.sdk.service.settings.StringMessage
dataclass. - Added
databricks.sdk.service.settings.UpdateDefaultWorkspaceNamespaceRequest
dataclass. - Added
next_page_token
field fordatabricks.sdk.service.sharing.ListCleanRoomsResponse
. - Added
databricks.sdk.service.sharing.ListCleanRoomsRequest
dataclass.
OpenAPI SHA: bcbf6e851e3d82fd910940910dd31c10c059746c, Date: 2023-10-02
v0.9.0
- Don't try to import runtime_auth when not in runtime (#327).
- Handled Azure authentication when WorkspaceResourceID is provided (#328).
- Added ErrorInfo to API errors (#347).
- Fixed eager default argument evaluation in
DatabricksError
(#353). - Fixed code generation of primitive types (#354).
- Updated SDK to changes in OpenAPI specification (#355).
API Changes:
- Changed
list()
method for a.account_metastore_assignments account-level service to returndatabricks.sdk.service.catalog.WorkspaceIdList
dataclass. - Changed
artifact_matchers
field fordatabricks.sdk.service.catalog.ArtifactAllowlistInfo
todatabricks.sdk.service.catalog.ArtifactMatcherList
dataclass. - Changed
artifact_matchers
field fordatabricks.sdk.service.catalog.SetArtifactAllowlist
todatabricks.sdk.service.catalog.ArtifactMatcherList
dataclass. - Added
databricks.sdk.service.catalog.WorkspaceId
dataclass. - Changed
cancel_all_runs()
method for w.jobs workspace-level service with new required argument order. - Changed
job_id
field fordatabricks.sdk.service.jobs.CancelAllRuns
to no longer be required. - Added
all_queued_runs
field fordatabricks.sdk.service.jobs.CancelAllRuns
. - Added
queue
field fordatabricks.sdk.service.jobs.CreateJob
. - Added
queue
field fordatabricks.sdk.service.jobs.JobSettings
. - Added
queue
field fordatabricks.sdk.service.jobs.RunNow
. - Added
queue_reason
field fordatabricks.sdk.service.jobs.RunState
. - Added
queue_duration
field fordatabricks.sdk.service.jobs.RunTask
. - Added
queue
field fordatabricks.sdk.service.jobs.SubmitRun
. - Added
databricks.sdk.service.jobs.QueueSettings
dataclass. - Added a.o_auth_published_apps account-level service.
- Added
databricks.sdk.service.oauth2.GetPublishedAppsOutput
dataclass. - Added
databricks.sdk.service.oauth2.ListOAuthPublishedAppsRequest
dataclass. - Added
databricks.sdk.service.oauth2.PublishedAppOutput
dataclass. - Added
patch()
method for w.serving_endpoints workspace-level service. - Added
tags
field fordatabricks.sdk.service.serving.CreateServingEndpoint
. - Added
tags
field fordatabricks.sdk.service.serving.ServingEndpoint
. - Added
tags
field fordatabricks.sdk.service.serving.ServingEndpointDetailed
. - Added
databricks.sdk.service.serving.EndpointTag
dataclass. - Added
databricks.sdk.service.serving.PatchServingEndpointTags
dataclass. - Added w.credentials_manager workspace-level service.
- Added
databricks.sdk.service.settings.ExchangeToken
dataclass. - Added
databricks.sdk.service.settings.ExchangeTokenRequest
dataclass. - Added
databricks.sdk.service.settings.ExchangeTokenResponse
dataclass. - Added
databricks.sdk.service.settings.PartitionId
dataclass. - Added
databricks.sdk.service.settings.TokenType
dataclass. - Changed
execute_statement()
method for w.statement_execution workspace-level service with new required argument order. - Added
empty_result_state
field fordatabricks.sdk.service.sql.AlertOptions
. - Removed
databricks.sdk.service.sql.ChunkInfo
dataclass. - Changed
on_wait_timeout
field fordatabricks.sdk.service.sql.ExecuteStatementRequest
todatabricks.sdk.service.sql.ExecuteStatementRequestOnWaitTimeout
dataclass. - Changed
statement
field fordatabricks.sdk.service.sql.ExecuteStatementRequest
to be required. - Changed
warehouse_id
field fordatabricks.sdk.service.sql.ExecuteStatementRequest
to be required. - Changed
chunks
field fordatabricks.sdk.service.sql.ResultManifest
todatabricks.sdk.service.sql.BaseChunkInfoList
dataclass. - Added
truncated
field fordatabricks.sdk.service.sql.ResultManifest
. - Removed
databricks.sdk.service.sql.TimeoutAction
dataclass. - Added
databricks.sdk.service.sql.AlertOptionsEmptyResultState
dataclass. - Added
databricks.sdk.service.sql.BaseChunkInfo
dataclass. - Added
databricks.sdk.service.sql.ExecuteStatementRequestOnWaitTimeout
dataclass.
OpenAPI SHA: b52a3b410976501f08f76ca0b355fb2dca876953, Date: 2023-09-15
v0.8.0
- Fixed redeclared
test_streaming_response_read_partial
test (#335). - Fixed
Incorrect type
warning (#336). - Add notebook installation instructions (#334).
API Changes:
- Renamed permissions APIs to no longer include the service name, for example:
get_job_permission_levels
->get_permission_levels
get_job_permissions
->get_permissions
set_job_permissions
->set_permissions
update_job_permissions
->update_permissions
- Changed
create()
method for w.volumes workspace-level service with new required argument order. - Added
supports_elastic_disk
field fordatabricks.sdk.service.compute.NodeType
. - Changed
create()
method for w.dashboards workspace-level service with new required argument order. - Added w.dashboard_widgets workspace-level service.
- Added w.query_visualizations workspace-level service.
- Changed
name
field fordatabricks.sdk.service.sql.CreateDashboardRequest
to be required. - Added
dashboard_filters_enabled
field fordatabricks.sdk.service.sql.CreateDashboardRequest
. - Added
run_as_role
field fordatabricks.sdk.service.sql.CreateDashboardRequest
. - Added
run_as_role
field fordatabricks.sdk.service.sql.Query
. - Added
run_as_role
field fordatabricks.sdk.service.sql.QueryPostContent
. - Removed
dashboard_id
field fordatabricks.sdk.service.sql.WidgetOptions
. - Changed
position
field fordatabricks.sdk.service.sql.WidgetOptions
todatabricks.sdk.service.sql.WidgetPosition
dataclass. - Removed
text
field fordatabricks.sdk.service.sql.WidgetOptions
. - Added
description
field fordatabricks.sdk.service.sql.WidgetOptions
. - Added
title
field fordatabricks.sdk.service.sql.WidgetOptions
. - Added
databricks.sdk.service.sql.CreateQueryVisualizationRequest
dataclass. - Added
databricks.sdk.service.sql.CreateWidget
dataclass. - Added
databricks.sdk.service.sql.DeleteDashboardWidgetRequest
dataclass. - Added
databricks.sdk.service.sql.DeleteQueryVisualizationRequest
dataclass. - Added
databricks.sdk.service.sql.RunAsRole
dataclass. - Added
databricks.sdk.service.sql.WidgetPosition
dataclass.
OpenAPI SHA: 09a7fa63d9ae243e5407941f200960ca14d48b07, Date: 2023-09-04
v0.7.1
Release v0.7.1 (#322) * Improve file download performance ([#319](https://github.com/databricks/databricks-sdk-py/pull/319)).
v0.7.0
- Added support for GZIP'ed streaming responses (#306).
- Added support for per-method request headers to ApiClient (#302).
- Added support for BinaryIO for streaming request and response bodies (#303).
- Added a link to the API reference (#311).
- Check workspaceUrl explicitly in runtime repl auth (#312).
Breaking Changes:
- Added support for the Files API (using application/octet-stream) in OpenAPI. The names of parameters have changed from
src
tocontents
, andw.files.download()
now returns afiles.DownloadResponse
, whosecontents
field is aBinaryIO
object. When reading a download, the user must explicitly close this object to allow the connection to return to the connection pool.
Breaking API Changes:
- Changed
list()
method for a.account_storage_credentials account-level service to returndatabricks.sdk.service.catalog.StorageCredentialInfoList
dataclass. - Removed w.securable_tags workspace-level service and all associated classes.
- Removed w.subentity_tags workspace-level service and all associated classes.
- Removed
instance_pool_fleet_attributes
field fordatabricks.sdk.service.compute.CreateInstancePool
. - Removed
instance_pool_fleet_attributes
field fordatabricks.sdk.service.compute.EditInstancePool
. - Removed
databricks.sdk.service.compute.FleetLaunchTemplateOverride
dataclass. - Removed
databricks.sdk.service.compute.FleetOnDemandOption
dataclass. - Removed
databricks.sdk.service.compute.FleetOnDemandOptionAllocationStrategy
dataclass. - Removed
databricks.sdk.service.compute.FleetSpotOption
dataclass. - Removed
databricks.sdk.service.compute.FleetSpotOptionAllocationStrategy
dataclass. - Removed
instance_pool_fleet_attributes
field fordatabricks.sdk.service.compute.GetInstancePool
. - Removed
instance_pool_fleet_attributes
field fordatabricks.sdk.service.compute.InstancePoolAndStats
. - Removed
databricks.sdk.service.compute.InstancePoolFleetAttributes
dataclass. - Changed
get_by_name()
method for w.experiments workspace-level service to returndatabricks.sdk.service.ml.GetExperimentResponse
dataclass. - Changed
get_experiment()
method for w.experiments workspace-level service to returndatabricks.sdk.service.ml.GetExperimentResponse
dataclass. - Renamed
databricks.sdk.service.ml.GetExperimentByNameResponse
dataclass todatabricks.sdk.service.ml.GetExperimentResponse
. - Renamed
databricks.sdk.service.catalog.ProvisioningState
todatabricks.sdk.service.catalog.ProvisioningInfoState
dataclass.
API Changes:
- Added w.model_versions workspace-level service.
- Added w.registered_models workspace-level service.
- Added
browse_only
field fordatabricks.sdk.service.catalog.CatalogInfo
. - Added
full_name
field fordatabricks.sdk.service.catalog.CatalogInfo
. - Added
provisioning_info
field fordatabricks.sdk.service.catalog.CatalogInfo
. - Added
securable_kind
field fordatabricks.sdk.service.catalog.CatalogInfo
. - Added
securable_type
field fordatabricks.sdk.service.catalog.CatalogInfo
. - Added
provisioning_info
field fordatabricks.sdk.service.catalog.ConnectionInfo
. - Added
options
field fordatabricks.sdk.service.catalog.CreateCatalog
. - Added
options
field fordatabricks.sdk.service.catalog.UpdateCatalog
. - Added
databricks.sdk.service.catalog.CatalogInfoSecurableKind
dataclass. - Added
databricks.sdk.service.catalog.CreateRegisteredModelRequest
dataclass. - Added
databricks.sdk.service.catalog.DeleteAliasRequest
dataclass. - Added
databricks.sdk.service.catalog.DeleteModelVersionRequest
dataclass. - Added
databricks.sdk.service.catalog.DeleteRegisteredModelRequest
dataclass. - Added
databricks.sdk.service.catalog.GetByAliasRequest
dataclass. - Added
databricks.sdk.service.catalog.GetModelVersionRequest
dataclass. - Added
databricks.sdk.service.catalog.GetRegisteredModelRequest
dataclass. - Added
databricks.sdk.service.catalog.ListModelVersionsRequest
dataclass. - Added
databricks.sdk.service.catalog.ListModelVersionsResponse
dataclass. - Added
databricks.sdk.service.catalog.ListRegisteredModelsRequest
dataclass. - Added
databricks.sdk.service.catalog.ListRegisteredModelsResponse
dataclass. - Added
databricks.sdk.service.catalog.ModelVersionInfo
dataclass. - Added
databricks.sdk.service.catalog.ModelVersionInfoStatus
dataclass. - Added
databricks.sdk.service.catalog.ProvisioningInfo
dataclass. - Added
databricks.sdk.service.catalog.RegisteredModelAlias
dataclass. - Added
databricks.sdk.service.catalog.RegisteredModelInfo
dataclass. - Added
databricks.sdk.service.catalog.SetRegisteredModelAliasRequest
dataclass. - Added
databricks.sdk.service.catalog.UpdateModelVersionRequest
dataclass. - Added
databricks.sdk.service.catalog.UpdateRegisteredModelRequest
dataclass. - Added
volumes
field fordatabricks.sdk.service.compute.InitScriptInfo
. - Added
databricks.sdk.service.compute.VolumesStorageInfo
dataclass. - Added w.files workspace-level service.
- Added
databricks.sdk.service.files.DeleteFileRequest
dataclass. - Added
databricks.sdk.service.files.DownloadRequest
dataclass. - Added
databricks.sdk.service.files.DownloadResponse
dataclass. - Added
databricks.sdk.service.files.UploadRequest
dataclass. - Added
custom_tags
field fordatabricks.sdk.service.provisioning.CreateWorkspaceRequest
. - Added
custom_tags
field fordatabricks.sdk.service.provisioning.UpdateWorkspaceRequest
. - Added
custom_tags
field fordatabricks.sdk.service.provisioning.Workspace
. - Added
databricks.sdk.service.provisioning.CustomTags
dataclass. - Added
parameters
field fordatabricks.sdk.service.sql.ExecuteStatementRequest
. - Added
row_limit
field fordatabricks.sdk.service.sql.ExecuteStatementRequest
. - Added
databricks.sdk.service.sql.StatementParameterListItem
dataclass.
SDK Internal Changes:
- Skip Graviton runtimes for testing notebook native auth (#294).
- Fixed integration tests to not use beta DBR (#309).
OpenAPI SHA: 5d0ccbb790d341eae8e85321a685a9e9e2d5bf24, Date: 2023-08-29