Releases: databricks/databricks-sdk-go
v0.29.1
This patch release contains two small changes:
- Retry on Status Code 503 (#733), improving the stability of the SDK in light of transient API unavailability.
- Simplify mocking of iterator and waiter objects (#769, #770). See the Testing section of the README.md for usage information and examples.
v0.29.0
- Extract API interfaces for all services and generate mock clients (#740).
- Handle empty response for errors (#756).
- Update SDK to OpenAPI spec + Fix tests (#755).
- Add utility to retry on specific errors (#757).
- Integration test fixes for TestMwsAccWorkspaces (#763) and TestMwsAccUsageDownload (#764).
Note: This release contains breaking changes, please see below.
API Changes:
- [Breaking] Changed
List
method for w.ExternalLocations workspace-level service to require request of catalog.ListExternalLocationsRequest, w.StorageCredentials workspace-level service to require request of catalog.ListStorageCredentialsRequest and w.Tokens workspace-level service to return settings.ListPublicTokensResponse. - Added
NextPageToken
field for catalog.ListExternalLocationsResponse, catalog.ListFunctionsResponse, catalog.ListSchemasResponse and catalog.ListStorageCredentialsResponse. - Added
MaxResults
field for catalog.ListFunctionsRequest and catalog.ListSchemasRequest. - Added
PageToken
field for catalog.ListFunctionsRequest and catalog.ListSchemasRequest. - Added
OmitColumns
andOmitProperties
field for catalog.ListTablesRequest. - Added catalog.ListExternalLocationsRequest.
- Added catalog.ListStorageCredentialsRequest.
- Added settings.ListPublicTokensResponse.
- Added dashboards package.
- Added vectorsearch package.
OpenAPI SHA: a7a9dc025bb80303e676bf3708942c6aa06689f1, Date: 2024-01-04
Dependency updates:
v0.28.1
v0.28.0
- Consolidate usage of named sorting (#736).
- Remove redundant retries for token refreshes as they're already handled in
httpclient
(#729). - Skip auth, config loading, and rate limits when fixture transport is present in the config (#739).
- Generate SDK to latest OpenAPI specification with bugfix (#742).
API Changes:
- Added
AzureWorkspaceInfo
field for provisioning.Workspace. - Added provisioning.AzureWorkspaceInfo.
- Changed
UpdateConfig
method for w.ServingEndpoints workspace-level service with new required argument order. - Changed
ServedEntities
field for serving.EndpointCoreConfigInput to no longer be required. - Changed
Create
method for a.AccountIpAccessLists account-level service with new required argument order. - Changed
Replace
method for a.AccountIpAccessLists account-level service with new required argument order. - Changed
Update
method for a.AccountIpAccessLists account-level service with new required argument order. - Changed
Create
method for w.IpAccessLists workspace-level service with new required argument order. - Changed
Replace
method for w.IpAccessLists workspace-level service with new required argument order. - Changed
Update
method for w.IpAccessLists workspace-level service with new required argument order. - Changed
IpAddresses
field for settings.CreateIpAccessList to no longer be required. - Changed
IpAddresses
field for settings.ReplaceIpAccessList to no longer be required. - Removed
ListId
field for settings.ReplaceIpAccessList. - Changed
Enabled
field for settings.UpdateIpAccessList to no longer be required. - Changed
IpAddresses
field for settings.UpdateIpAccessList to no longer be required. - Changed
Label
field for settings.UpdateIpAccessList to no longer be required. - Removed
ListId
field for settings.UpdateIpAccessList. - Changed
ListType
field for settings.UpdateIpAccessList to no longer be required.
OpenAPI SHA: d3853c8dee5806d04da2ae8910f273ffb35719a5, Date: 2023-12-14
v0.27.0
API Changes:
- Changed
Update
method for w.Connections workspace-level service with new required argument order. - Added
CloudflareApiToken
field for catalog.CreateStorageCredential. - Added
CloudflareApiToken
field for catalog.StorageCredentialInfo. - Changed
Name
field for catalog.UpdateCatalog to be required. - Added
NewName
field for catalog.UpdateCatalog. - Changed
Name
field for catalog.UpdateConnection to no longer be required. - Added
NewName
field for catalog.UpdateConnection. - Changed
Name
field for catalog.UpdateExternalLocation to be required. - Added
NewName
field for catalog.UpdateExternalLocation. - Added
NewName
field for catalog.UpdateMetastore. - Added
NewName
field for catalog.UpdateRegisteredModelRequest. - Added
NewName
field for catalog.UpdateSchema. - Changed
Name
field for catalog.UpdateStorageCredential to be required. - Added
CloudflareApiToken
field for catalog.UpdateStorageCredential. - Added
NewName
field for catalog.UpdateStorageCredential. - Added
NewName
field for catalog.UpdateVolumeRequestContent. - Added
CloudflareApiToken
field for catalog.ValidateStorageCredential. - Added catalog.CloudflareApiToken.
- Removed
Continuous
field for jobs.BaseRun. - Removed
Continuous
field for jobs.Run. - Changed
JobParameters
field for jobs.RunJobTask to jobs.ParamPairs. - Added
RunIf
field for jobs.SubmitTask. - Added
RunJobTask
field for jobs.SubmitTask. - Changed
UpdateConfig
method for w.ServingEndpoints workspace-level service with new required argument order. - Added
Put
method for w.ServingEndpoints workspace-level service. - Added
RateLimits
field for serving.CreateServingEndpoint. - Changed
ServedModels
field for serving.EndpointCoreConfigInput to no longer be required. - Added
AutoCaptureConfig
field for serving.EndpointCoreConfigInput. - Added
ServedEntities
field for serving.EndpointCoreConfigInput. - Added
AutoCaptureConfig
field for serving.EndpointCoreConfigOutput. - Added
ServedEntities
field for serving.EndpointCoreConfigOutput. - Added
ServedEntities
field for serving.EndpointCoreConfigSummary. - Added
ServedEntities
field for serving.EndpointPendingConfig. - Added
ExtraParams
field for serving.QueryEndpointInput. - Added
Input
field for serving.QueryEndpointInput. - Added
MaxTokens
field for serving.QueryEndpointInput. - Added
Messages
field for serving.QueryEndpointInput. - Added
N
field for serving.QueryEndpointInput. - Added
Prompt
field for serving.QueryEndpointInput. - Added
Stop
field for serving.QueryEndpointInput. - Added
Stream
field for serving.QueryEndpointInput. - Added
Temperature
field for serving.QueryEndpointInput. - Changed
Predictions
field for serving.QueryEndpointResponse to no longer be required. - Added
Choices
field for serving.QueryEndpointResponse. - Added
Created
field for serving.QueryEndpointResponse. - Added
Data
field for serving.QueryEndpointResponse. - Added
Id
field for serving.QueryEndpointResponse. - Added
Model
field for serving.QueryEndpointResponse. - Added
Object
field for serving.QueryEndpointResponse. - Added
Usage
field for serving.QueryEndpointResponse. - Changed
WorkloadSize
field for serving.ServedModelInput to serving.ServedModelInputWorkloadSize. - Changed
WorkloadType
field for serving.ServedModelInput to serving.ServedModelInputWorkloadType. - Added
Task
field for serving.ServingEndpoint. - Added
Task
field for serving.ServingEndpointDetailed. - Added serving.Ai21LabsConfig.
- Added serving.AnthropicConfig.
- Added serving.AutoCaptureConfigInput.
- Added serving.AutoCaptureConfigOutput.
- Added serving.AutoCaptureState.
- Added serving.AwsBedrockConfig.
- Added [serving.AwsBedrockConfigBedrockProvider](https://pkg.go.dev/github...
v0.26.2
This is a bugfix release, including a fix correcting issues with OAuth flows, due to a bug with the propagation of the response status in httpclient
's RoundTrip()
implementation. This fixes the failed during request visitor: token: oauth2: cannot fetch token: Response: {...}
error.
All fixes:
Release v0.26.1
v0.26.0
Major changes:
- There has been a major overhaul of error handling. Users can now compare errors in API responses to the well-known error responses defined in the
apierr
package and reexported in thedatabricks
package. Users can check whether a specific error was returned, for exampleerrors.Is(err, databricks.ErrResourceAlreadyExists)
, rather than converting the error to*APIError
to check the status code and error code. This change is backwards-compatible; users do not need to modify existing error-handling code when upgrading the SDK. See #682 and #703 for the changes and https://github.com/databricks/databricks-sdk-go/blob/main/error_alias.go for the full set of errors.
Bug fixes:
- Handle "no configuration file found at" error during databricks-cli authentication (#707).
- Introduce
DatabricksEnvironment
and fix Azure MSI auth from ACR, where IMDS doesn't give host environment information (#700). - Fix SCIM Pagination default parameters in the Go SDK (#717).
Other changes:
- Update
slog
example with the correct interface (#694). - Fixed typo in error message for unknown azure environment (#701).
- Allow injection of HTTP transport to enable HTTP replayer pattern (#697).
- Decouple HTTP retries and error mapping mechanics from
DatabricksClient
intohttpclient.ApiClient
(#699, #702, #712). - Port
qa.HTTPFixtures
to faster transport-level stubs (#708).
API Changes:
- Removed
EnableOptimization
method for w.Metastores workspace-level service. - Added
PipelineId
field for catalog.TableInfo. - Added
EnablePredictiveOptimization
field for catalog.UpdateCatalog and catalog.UpdateSchema. - Removed catalog.UpdatePredictiveOptimization and catalog.UpdatePredictiveOptimizationResponse.
- Added
Description
field for jobs.CreateJob and jobs.JobSettings. - Added
ListNetworkConnectivityConfigurations
andListPrivateEndpointRules
method for a.NetworkConnectivity account-level service. - Added settings.ListNccAzurePrivateEndpointRulesResponse, settings.ListNetworkConnectivityConfigurationsRequest, settings.ListNetworkConnectivityConfigurationsResponse, and settings.ListPrivateEndpointRulesRequest.
- Added
StringSharedAs
field for sharing.SharedDataObject.
Internal changes:
- Added
contains
method in OpenAPI Generator (#690). - Skip recipients tests in Azure (#692).
- Allow Files API tests to run in UC environments (#695).
- More cleanup in Unity Catalog integration test (#719).
OpenAPI SHA: 22f09783eb8a84d52026f856be3b2068f9498db3, Date: 2023-11-23
Dependency updates:
- Bump golang.org/x/oauth2 from 0.13.0 to 0.14.0 (#689).
- Bump google.golang.org/api from 0.150.0 to 0.151.0 (#698).
- Bump the OpenAPI Spec (#706).
- Bump golang.org/x/oauth2 from 0.14.0 to 0.15.0 (#715).
- Bump golang.org/x/time from 0.4.0 to 0.5.0 (#714).
- Bump google.golang.org/api from 0.151.0 to 0.152.0 (#716).
v0.25.0
- Make sure path parameters are first in order in RequiredFields (#669).
- Added Field.IsRequestBodyField method for code generation (#670).
- Added regressions question to the issue template (#676).
- Added telemetry for CI/CD platform to useragent (#665).
- Skiped GCP Integration Tests using Statement Execution API (#678).
- Added more detailed error message on default credentials not found error (#679).
- Updated SDK to latest OpenAPI Spec (#685).
API Changes:
- Changed
Create
method for w.Functions and w.Metastores workspace-level service with new required argument order. - Changed
InputParams
field for catalog.CreateFunction and catalog.FunctionInfo to catalog.FunctionParameterInfos. - Changed
Properties
field for catalog.CreateFunction and catalog.FunctionInfo tostring
. - Changed
ReturnParams
field for catalog.CreateFunction and catalog.FunctionInfo to catalog.FunctionParameterInfos - Changed
StorageRoot
field for catalog.CreateMetastore to no longer be required. - Added
SkipValidation
field for catalog.UpdateExternalLocation. - Added
Libraries
field for compute.CreatePolicy, compute.EditPolicy and compute.Policy. - Added compute.InitScriptEventDetails.
- Added
InitScripts
field for compute.EventDetails. - Added
File
field for compute.InitScriptInfo. - Added
ZoneId
field for compute.InstancePoolGcpAttributes. - Added
IncludeResolvedValues
field for jobs.GetRunRequest. - Added
EditMode
field for jobs.CreateJob and jobs.JobSettings. - Added
NetworkConnectivityConfigId
field for provisioning.UpdateWorkspaceRequest. - Added
ContainerLogs
andExtraInfo
field for serving.DeploymentStatus. - Added catalog.CreateFunctionRequest, catalog.DependencyList and catalog.FunctionParameterInfos.
- Added compute.InitScriptExecutionDetails, compute.InitScriptExecutionDetailsStatus, compute.InitScriptInfoAndExecutionDetails, compute.LocalFileInfo.
- Added jobs.CreateJobEditMode and jobs.JobSettingsEditMode.
- Added
DeleteApp
,GetApp
,GetAppDeploymentStatus
,GetApps
andGetEvents
method for w.Apps workspace-level service. - Added serving.AppEvents, serving.AppServiceStatus, serving.DeleteAppResponse, serving.GetAppDeploymentStatusRequest, serving.GetAppResponse, serving.GetEventsRequest, serving.ListAppEventsResponse and serving.ListAppsResponse.
- Added a.NetworkConnectivity account-level service.
- Added settings.CreateNetworkConnectivityConfigRequest, settings.CreatePrivateEndpointRuleRequest, settings.CreatePrivateEndpointRuleRequestGroupId, settings.DeleteNetworkConnectivityConfigurationRequest, settings.DeletePrivateEndpointRuleRequest, settings.GetNetworkConnectivityConfigurationRequest, settings.GetPrivateEndpointRuleRequest, settings.NccAzurePrivateEndpointRule, settings.NccAzurePrivateEndpointRuleConnectionState, settings.NccAzurePrivateEndpointRuleGroupId, settings.NccAzureServiceEndpointRule, settings.NccEgressConfig, settings.NccEgressDefaultRules, settings.NccEgressTargetRules, settings.NetworkConnectivityConfiguration.
- Removed
Delete
,Get
, method for w.Apps workspace-level service. - Removed jobs.JobSettingsUiState and jobs.CreateJobUiState.
- Removed a.OAuthEnrollment account-level service.
- Removed oauth2.CreateOAuthEnrollment and [oauth2.OAuthEnrollmen...
v0.24.0
- Implemented Iterator support for paginated endpoints or endpoints returning a list (#543). The Iterator interface allows users to get the next resource in the iterator and to check whether another resource is available in the iterator. Iterators for paginated endpoints fetch pages lazily, allowing users to only fetch the pages needed for their use case.
- Removed
photon
andgraviton
selectors incompute.SparkVersionRequ…
(#622). Going forward, photon is determined by theRuntimeEngine
field incompute.CreateCluster
, and graviton is chosen depending on theaws_instance_type
field incompute.CreateCluster
.
API Changes:
- Added
Attributes
,Count
,ExcludedAttributes
,Filter
,SortBy
,SortOrder
, andStartIndex
fields to iam.GetAccountUserRequest and iam.GetUserRequest. - Added
Schemas
field to iam.Group, iam.ListGroupsResponse, iam.ListServicePrincipalResponse, iam.ListUsersResponse, iam.ServicePrincipal, and iam.User. - Added iam.GetSortOrder.
- Added iam.GroupSchema.
- Added iam.ListResponseSchema.
- Added iam.ServicePrincipalSchema.
- Added iam.UserSchema.
- Added
WebhookNotifications
field for jobs.SubmitTask. - Added w.Apps workspace-level service and related methods.
- Added a.AccountNetworkPolicy account-level service and related methods.
Internal SDK Changes:
- Update to actions/checkout@v4 (#650).
- Skip unshallow step in test workflow (#649).
- Add integration tests for
Jobs
:ListRuns
(#645). - Only log pkg.Load after checking whether the operation is tagged (#655).
- Prefix library paths with the target directory to construct absolute paths (#656).
- Fixed HasRequiredNonBodyField method (#660).
- Added CanSetRequiredFieldsFromJson method for OpenAPI generator (#661).
- Add integration tests for
ServicePrincipals
:Patch
(#662). - Add integration tests for
Users
:Patch
,Update
(#663). - Enforce running
az login --service-principal
on nightly runs (#659). - Add integration tests for
Connections
:Create
,Delete
,Get
,List
,Update
(#653).
OpenAPI SHA: 5903bb39137fd76ac384b2044e425f9c56840e00, Date: 2023-10-23