Releases: databricks/databricks-sdk-go
Releases · databricks/databricks-sdk-go
v0.44.0
New Features and Improvements
- Remove deprecated
WithImpl
andImpl
service methods (#1003). w.Clusters.List()
is no longer limited to returning 200 all-purpose and 30 jobs clusters from the last 30 days. It now returns all terminated clusters in the last 30 days.
Bug Fixes
- Allowed filtering for graviton DBRs in
ClusterAPI.SelectSparkVersion
(#1004). - Avoid loading the response bodies twice in memory when parsing
bytes.Buffer
(#984). - Bump google.golang.org/grpc from 1.64.0 to 1.64.1 (#974).
- Fix default-auth example when less than 10 clusters (#1012).
- Infer Azure tenant ID if not set (#910).
Internal Changes
- Add comment to validate workflow (#987).
- Add error mapping for GetRun (#1006).
- Add missing Package to Entity (#995).
- Add prefix to Dependabot commit messages (#976).
- Configure Dependabot for security updates only (#988).
- Enable mixins via struct embedding (#1000).
- Fix GetWorkspaceClient test & GCP SQL Warehouse Creation test (#1010).
- Fix integration tests (#1008).
- Fix processing of
quoted
titles (#989). - Generate SDK from Open API (#997).
- Log a warning when declaring inline entities (#994).
- Move PR message validation to a separate workflow (#983).
- Pin jobs APIs to 2.1 in SDKs (#993).
- Prefix all extension files with
ext_
(#1001). - Trigger the
validate
workflow in the merge queue (#986). - Update OpenAPI spec (#991).
- Use HTTP status text as message if the error response body is empty (#990).
API Changes:
- Added apps package.
- Added a.UsageDashboards account-level service.
- Added w.AlertsLegacy workspace-level service, w.QueriesLegacy workspace-level service and w.QueryVisualizationsLegacy workspace-level service.
- Added w.Genie workspace-level service.
- Added w.NotificationDestinations workspace-level service.
- Added
Update
method for w.Clusters workspace-level service. - Added
ListVisualizations
method for w.Queries workspace-level service. - Added catalog.GetBindingsSecurableType and catalog.UpdateBindingsSecurableType.
- Added billing.ActionConfiguration, billing.ActionConfigurationType, billing.AlertConfiguration, billing.AlertConfigurationQuantityType, billing.AlertConfigurationTimePeriod, billing.AlertConfigurationTriggerType, billing.BudgetConfiguration, billing.BudgetConfigurationFilter, billing.BudgetConfigurationFilterClause, billing.BudgetConfigurationFilterOperator, billing.BudgetConfigurationFilterTagClause, billing.BudgetConfigurationFilterWorkspaceIdClause, billing.CreateBillingUsageDashboardRequest, billing.CreateBillingUsageDashboardResponse, billing.CreateBudgetConfigurationBudget, billing.CreateBudgetConfigurationBudgetActionConfigurations, billing.CreateBudgetConfigurationBudgetAlertConfigurations, billing.CreateBudgetConfigurationRequest, billing.CreateBudgetConfigurationResponse, billing.DeleteBudgetConfigurationRequest,
any
, billing.GetBillingUsageDashboardRequest, billing.GetBillingUsageDashboardResponse, billing.GetBudgetConfigurationRequest, billing.GetBudgetConfigurationResponse, billing.ListBudgetConfigurationsRequest, billing.ListBudgetConfigurationsResponse, billing.UpdateBudgetConfigurationBudget, billing.UpdateBudgetConfigurationRequest, billing.UpdateBudgetConfigurationResponse and billing.UsageDashboardType. - Added compute.ListClustersFilterBy, compute.ListClustersSortBy, compute.ListClustersSortByDirection, compute.ListClustersSortByField, compute.UpdateCluster, compute.UpdateClusterResource and
any
. - Added [dashboards.ExecuteMessageQueryRequest](https://pkg.go.dev/github.com/databricks/databric...
v0.43.2
v0.43.1
v0.43.0
Major Changes and Improvements:
- Support partners in user agent for SDK (#925).
- Add
serverless_compute_id
field to the config (#952).
Other Changes:
API Changes:
- Changed
IsolationMode
field for catalog.CatalogInfo to catalog.CatalogIsolationMode. - Added
IsolationMode
field for catalog.ExternalLocationInfo. - Added
MaxResults
andPageToken
fields for catalog.ListCatalogsRequest. - Added
NextPageToken
field for catalog.ListCatalogsResponse. - Added
TableServingUrl
field for catalog.OnlineTable. - Added
IsolationMode
field for catalog.StorageCredentialInfo. - Changed
IsolationMode
field for catalog.UpdateCatalog to catalog.CatalogIsolationMode. - Added
IsolationMode
field for catalog.UpdateExternalLocation. - Added
IsolationMode
field for catalog.UpdateStorageCredential. - Added catalog.CatalogIsolationMode.
- Added
CreateSchedule
,CreateSubscription
,DeleteSchedule
,DeleteSubscription
,GetSchedule
,GetSubscription
,List
,ListSchedules
,ListSubscriptions
andUpdateSchedule
methods for w.Lakeview workspace-level service. - Added dashboards.CreateScheduleRequest, dashboards.CreateSubscriptionRequest, dashboards.CronSchedule, dashboards.DashboardView, dashboards.DeleteScheduleRequest, dashboards.DeleteSubscriptionRequest, dashboards.GetScheduleRequest, dashboards.GetSubscriptionRequest, dashboards.ListDashboardsRequest, dashboards.ListDashboardsResponse, dashboards.ListSchedulesRequest, dashboards.ListSchedulesResponse, dashboards.ListSubscriptionsRequest, dashboards.ListSubscriptionsResponse, dashboards.Schedule, dashboards.SchedulePauseStatus, dashboards.Subscriber, dashboards.Subscription, dashboards.SubscriptionSubscriberDestination, dashboards.SubscriptionSubscriberUser and dashboards.UpdateScheduleRequest structs.
- Added
OnStreamingBacklogExceeded
field for jobs.JobEmailNotifications. - Added
EnvironmentKey
field for jobs.RunTask. - Removed
ConditionTask
,DbtTask
,NotebookTask
,PipelineTask
,PythonWheelTask
,RunJobTask
,SparkJarTask
,SparkPythonTask
,SparkSubmitTask
,SqlTask
andEnvironments
fields for jobs.SubmitRun. - Added
DbtTask
andEnvironmentKey
field for jobs.SubmitTask. - Added
OnStreamingBacklogExceeded
field for jobs.TaskEmailNotifications. - Added
Periodic
field for jobs.TriggerSettings. - Added
OnStreamingBacklogExceeded
field for jobs.WebhookNotifications. - Added jobs.PeriodicTriggerConfiguration.
- Added jobs.PeriodicTriggerConfigurationTimeUnit.
- Added
ProviderSummary
field for marketplace.Listing. - Added marketplace.ProviderIconFile.
- Added marketplace.ProviderIconType.
- Added marketplace.ProviderListingSummaryInfo.
- Added
Start
method for w.Apps workspace-level service. - Added w.ServingEndpointsDataPlane workspace-level service.
- Added
ServicePrincipalId
field for serving.App. - Added
ServicePrincipalName
field for serving.App. - Added serving.StartAppRequest.
- Added
QueryNextPage
method for w.VectorSearchIndexes workspace-level service. - Added
QueryType
field for vectorsearch.QueryVectorIndexRequest. - Added
NextPageToken
field for vectorsearch.QueryVectorIndexResponse. - Added vectorsearch.QueryVectorIndexNextPageRequest.
OpenAPI SHA: 7437dabb9dadee402c1fc060df4c1ce8cc5369f0, Date: 2024-06-25
v0.42.0
- Ignore additional flaky test (#930).
- Ignore DataPlane Services during generation (#933).
- Update OpenAPI spec (#934).
API Changes:
- Changed
List
method for a.AccountStorageCredentials account-level service to return catalog.ListAccountStorageCredentialsResponse. - Added catalog.ListAccountStorageCredentialsResponse.
- Added
TerminationCategory
field for jobs.ForEachTaskErrorMessageStats. - Added oauth2.DataPlaneInfo.
- Removed
CreateDeployment
method for w.Apps workspace-level service. - Added
Deploy
method for w.Apps workspace-level service. - Added
Mode
field for serving.AppDeployment. - Added
Mode
field for serving.CreateAppDeploymentRequest. - Added
DataPlaneInfo
field for serving.ServingEndpointDetailed. - Added serving.AppDeploymentMode.
- Added serving.ModelDataPlaneInfo.
OpenAPI SHA: 37b925eba37dfb3d7e05b6ba2d458454ce62d3a0, Date: 2024-06-03
Dependency updates:
v0.41.0
Backward incompatible changes
- Renamed
CredentialsProvider
toCredentialsStrategy
.
Improvements and new features
- Create a method to generate OAuth tokens (#886).
- Better error message when private link enabled workspaces reject requests (#924).
- Update OpenAPI spec (#926).
API Changes:
- Changed
List
method for w.Connections workspace-level service to require request of catalog.ListConnectionsRequest. - Renamed w.LakehouseMonitors workspace-level service to w.QualityMonitors.
- Renamed catalog.DeleteLakehouseMonitorRequest.
- Changed
SchemaName
field for catalog.DisableRequest tostring
. - Removed catalog.DisableSchemaName to catalog.DeleteQualityMonitorRequest.
- Changed
SchemaName
field for catalog.EnableRequest tostring
. - Removed catalog.EnableSchemaName.
- Renamed catalog.GetLakehouseMonitorRequest to catalog.GetQualityMonitorRequest.
- Added
NextPageToken
field for catalog.ListConnectionsResponse. - Added
DashboardId
field for catalog.UpdateMonitor. - Added catalog.ListConnectionsRequest.
- Added catalog.MonitorRefreshListResponse.
- Changed
ClusterStatus
method for w.Libraries workspace-level service to return compute.ClusterLibraryStatuses. - Removed
ClusterSource
field for compute.ClusterAttributes. - Changed
Spec
field for compute.ClusterDetails to compute.ClusterSpec. - Removed
CloneFrom
andClusterSource
fields for compute.ClusterSpec. - Removed compute.ClusterStatusResponse.
- Removed
ClusterSource
field for compute.CreateCluster. - Removed
CloneFrom
andClusterSource
fields for compute.EditCluster. - Rename
SortBySpec
field toSortBy
for marketplace.ListListingsRequest. - Added
IsAscending
field for marketplace.ListListingsRequest. - Added
IsAscending
field for marketplace.SearchListingsRequest. - Removed marketplace.SortBySpec.
- Removed marketplace.SortOrder.
- Added
GatewayDefinition
field for pipelines.CreatePipeline. - Added
GatewayDefinition
field for pipelines.EditPipeline. - Added
TableConfiguration
field for pipelines.ManagedIngestionPipelineDefinition. - Added
GatewayDefinition
field for pipelines.PipelineSpec. - Added
TableConfiguration
field for pipelines.SchemaSpec. - Added
TableConfiguration
field for pipelines.TableSpec. - Added pipelines.IngestionGatewayPipelineDefinition.
- Added pipelines.TableSpecificConfig.
- Added pipelines.TableSpecificConfigScdType.
- Added
DeploymentArtifacts
field for serving.AppDeployment. - Added
RouteOptimized
field for serving.CreateServingEndpoint. - Added
Contents
field for serving.ExportMetricsResponse. - Changed
OpenaiApiKey
field for serving.OpenAiConfig to no longer be required. - Added
MicrosoftEntraClientId
,MicrosoftEntraClientSecret
andMicrosoftEntraTenantId
fields for serving.OpenAiConfig. - Added
EndpointUrl
andRouteOptimized
field for serving.ServingEndpointDetailed. - Added serving.AppDeploymentArtifacts.
- Added
StorageRoot
field for sharing.CreateShare. - Added
StorageLocation
andStorageRoot
field for sharing.ShareInfo. - Added
StorageRoot
field for sharing.UpdateShare. - Added
ScanIndex
method for w.VectorSearchIndexes workspace-level service. - Added
EmbeddingWritebackTable
field for vectorsearch.DeltaSyncVectorIndexSpecRequest. - Added
EmbeddingWritebackTable
field for vectorsearch.DeltaSyncVectorIndexSpecResponse. - Added vectorsearch.ListValue.
- Added vectorsearch.MapStringValueEntry.
- Added vectorsearch.ScanVectorIndexRequest.
- Added vectorsearch.ScanVectorIndexResponse.
- Added vectorsearch.Struct.
- Added vectorsearch.Value.
OpenAPI SHA: 7eb5ad9a2ed3e3f1055968a2d1014ac92c06fe92, Date: 2024-05-21
v0.40.1
v0.40.0
0.40.0
- Allow unlimited timeouts in retries (#904). By setting RETRY_TIMEOUT_SECONDS to a negative value, WorkspaceClient and AccountClient will retry retriable failures indefinitely. As a reminder, without setting this parameter, the default retry timeout is 5 minutes.
API Changes:
- Changed
Create
method for w.Apps workspace-level service . New request type is serving.CreateAppRequest. - Changed
Create
method for w.Apps workspace-level service to return serving.App. - Removed
DeleteApp
method for w.Apps workspace-level service. - Removed
GetApp
method for w.Apps workspace-level service. - Removed
GetAppDeploymentStatus
method for w.Apps workspace-level service. - Removed
GetApps
method for w.Apps workspace-level service. - Removed
GetEvents
method for w.Apps workspace-level service. - Added
CreateDeployment
method for w.Apps workspace-level service. - Added
Delete
method for w.Apps workspace-level service. - Added
Get
method for w.Apps workspace-level service. - Added
GetDeployment
method for w.Apps workspace-level service. - Added
GetEnvironment
method for w.Apps workspace-level service. - Added
List
method for w.Apps workspace-level service. - Added
ListDeployments
method for w.Apps workspace-level service. - Added
Stop
method for w.Apps workspace-level service. - Added
Update
method for w.Apps workspace-level service. - Removed serving.AppEvents.
- Removed serving.AppManifest.
- Removed serving.AppServiceStatus.
- Removed serving.DeleteAppResponse.
- Removed serving.DeployAppRequest.
- Removed serving.DeploymentStatus.
- Removed serving.DeploymentStatusState.
- Removed serving.GetAppDeploymentStatusRequest.
- Removed serving.GetAppResponse.
- Removed serving.GetEventsRequest.
- Removed serving.ListAppEventsResponse.
- Changed
Apps
field for serving.ListAppsResponse to serving.AppList. - Added serving.App.
- Added serving.AppDeployment.
- Added serving.AppDeploymentState.
- Added serving.AppDeploymentStatus.
- Added serving.AppEnvironment.
- Added serving.AppState.
- Added serving.AppStatus.
- Added serving.CreateAppDeploymentRequest.
- Added serving.CreateAppRequest.
- Added serving.EnvVariable.
- Added serving.GetAppDeploymentRequest.
- Added serving.GetAppEnvironmentRequest.
- Added serving.ListAppDeploymentsRequest.
- Added serving.ListAppDeploymentsResponse.
- Added serving.ListAppsRequest.
- Added serving.StopAppRequest.
- Added
any
. - Added serving.UpdateAppRequest.
- Removed w.CspEnablement workspace-level service.
- Removed w.EsmEnablement workspace-level service.
- Added w.ComplianceSecurityProfile workspace-level service.
- Added w.EnhancedSecurityMonitoring workspace-level service.
- Removed settings.CspEnablement.
- Removed settings.CspEnablementSetting.
- Removed settings.EsmEnablement.
- Removed settings.EsmEnablementSetting.
- Removed settings.GetCspEnablementSettingRequest.
- Removed settings.GetEsmEnablementSettingRequest.
- Removed settings.UpdateCspEnablementSettingRequest.
- Removed settings.UpdateEsmEnablementSettingRequest.
- Added settings.ComplianceSecurityProfile.
- Added settings.ComplianceSecurityProfileSetting.
- Added settings.EnhancedSecurityMonitoring.
- Added settings.EnhancedSecurityMonitoringSetting.
- Added settings.GetComplianceSecurityProfileSettingRequest.
- Added settings.GetEnhancedSecurityMonitoringSettingRequest.
- Added [settings.UpdateComplianceSecurityProfileSettingRequest](https://pkg.go.dev/github.com/databricks...
v0.39.0
0.39.0
- Ignored flaky integration tests (#894).
- Added retries for "worker env WorkerEnvId(workerenv-XXXXX) not found" (#890).
- Updated SDK to OpenAPI spec (#899).
Note: This release contains breaking changes, please see the API changes below for more details.
API Changes:
- Added
IngestionDefinition
field for pipelines.CreatePipeline, pipelines.EditPipeline and pipelines.PipelineSpec. - Added
Deployment
field for pipelines.CreatePipeline, pipelines.EditPipeline and pipelines.PipelineSpec. - Added compute.ClusterStatus.
- Added compute.ClusterStatusResponse.
- Added compute.LibraryInstallStatus.
- Added
WarehouseId
field for jobs.NotebookTask. - Added
RunAs
field for jobs.SubmitRun. - Added pipelines.DeploymentKind.
- Added pipelines.IngestionConfig.
- Added pipelines.ManagedIngestionPipelineDefinition.
- Added pipelines.PipelineDeployment.
- Added pipelines.SchemaSpec.
- Added pipelines.TableSpec.
- Added
GetOpenApi
method for w.ServingEndpoints workspace-level service. - Added serving.GetOpenApiRequest.
- Added
SchemaId
field for catalog.SchemaInfo. - Added
Operation
field for catalog.ValidationResult. - Added catalog.ValidationResultOperation.
- Added
Requirements
field for compute.Library. - Removed
AwsOperation
field for catalog.ValidationResult. - Removed
AzureOperation
field for catalog.ValidationResult. - Removed
GcpOperation
field for catalog.ValidationResult. - Removed catalog.ValidationResultAwsOperation.
- Removed catalog.ValidationResultAzureOperation.
- Removed catalog.ValidationResultGcpOperation.
- Removed compute.ClusterStatusRequest.
- Removed compute.LibraryFullStatusStatus.
- Changed
ClusterStatus
method for w.Libraries workspace-level service . New request type is compute.ClusterStatus. - Changed
ClusterStatus
method for w.Libraries workspace-level service to return compute.ClusterStatusResponse. - Changed
Status
field for compute.LibraryFullStatus to compute.LibraryInstallStatus.
OpenAPI SHA: 21f9f1482f9d0d15228da59f2cd9f0863d2a6d55, Date: 2024-04-23
v0.38.0
Behavior Changes
- Override INVALID_PARAMETER_VALUE on fetching non-existent job/cluster (#864). The error returned when fetching a non-existent job or cluster has been changed from
INVALID_PARAMETER_VALUE
toRESOURCE_DOES_NOT_EXIST
. Update your error handling code to check fordatabricks.ErrResourceDoesNotExist
instead ofdatabricks.ErrInvalidParameterValue
. For example, if you are using theJobs.GetById
method, you should update your error handling code to:
_, err := w.Jobs.GetById(ctx, "id")
if errors.Is(err, databricks.ErrResourceDoesNotExist) {
// handle the error
}
Note that the original error code is still accessible in the ErrorCode
field of APIError
.
Other Improvements
- Do not leak secondary authorization tokens in debug logs (#882).
- Fix logging of request bodies containing percent characters. (#881).
- Added clientId and clientSecret to oauth-m2m auth_types (#885).
Internal Changes
- Support custom AuthVisitors (#874).
API Changes:
- Replaced catalog.AzureManagedIdentity with catalog.AzureManagedIdentityRequest and catalog.AzureManagedIdentityResponse.
- Renamed
FullName
field toTableName
for catalog.CancelRefreshRequest, catalog.CreateMonitor, catalog.DeleteLakehouseMonitorRequest, catalog.GetLakehouseMonitorRequest, catalog.GetRefreshRequest, catalog.ListRefreshesRequest. - Changed
CustomMetrics
field for catalog.CreateMonitor to catalog.MonitorMetricList. - Changed
InferenceLog
field for catalog.CreateMonitor to catalog.MonitorInferenceLog. - Changed
Notifications
field for catalog.CreateMonitor to catalog.MonitorNotifications. - Changed
Snapshot
field for catalog.CreateMonitor toany
. - Changed
TimeSeries
field for catalog.CreateMonitor to catalog.MonitorTimeSeries. - Changed
QuartzCronExpression
field for catalog.MonitorCronSchedule to be required. - Changed
TimezoneId
field for catalog.MonitorCronSchedule to be required. - Renamed catalog.MonitorCustomMetric to catalog.MonitorMetric.
- Renamed catalog.MonitorCustomMetricType to catalog.MonitorMetricType.
- Renamed catalog.MonitorDestinations to catalog.MonitorDestination.
- Renamed catalog.MonitorInferenceLogProfileType to catalog.MonitorInferenceLog.
- Renamed catalog.MonitorInferenceLogProfileTypeProblemType to catalog.MonitorInferenceLogProblemType.
- Renamed catalog.MonitorNotificationsConfig to catalog.MonitorNotifications.
- Changed
CustomMetrics
field for catalog.MonitorInfo to catalog.MonitorMetricList. - Changed
DriftMetricsTableName
field for catalog.MonitorInfo to be required. - Changed
InferenceLog
field for catalog.MonitorInfo to catalog.MonitorInferenceLog. - Changed
MonitorVersion
field for catalog.MonitorInfo to be required. - Changed
Notifications
field for catalog.MonitorInfo to catalog.MonitorNotifications. - Changed
ProfileMetricsTableName
field for catalog.MonitorInfo to be required. - Changed
Snapshot
field for catalog.MonitorInfo toany
. - Changed
Status
field for catalog.MonitorInfo to be required. - Changed
TableName
field for catalog.MonitorInfo to be required. - Changed
TimeSeries
field for catalog.MonitorInfo to catalog.MonitorTimeSeries. - Changed
RefreshId
field for catalog.MonitorRefreshInfo to be required. - Changed
StartTimeMs
field for catalog.MonitorRefreshInfo to be required. - Changed
State
field for catalog.MonitorRefreshInfo to be required. - Added
Trigger
field for catalog.MonitorRefreshInfo. - Removed catalog.MonitorTimeSeriesProfileType.
- Removed
FullName
field for catalog.RunRefreshRequest. - Added
TableName
field for catalog.RunRefreshRequest. - Changed
AzureManagedIdentity
field for catalog.StorageCredentialInfo to . - Removed
Name
field for catalog.TableRowFilter. - Added
FunctionName
field for catalog.TableRowFilter. - Changed
CustomMetrics
field for catalog.UpdateMonitor to catalog.MonitorMetricList. - Removed
FullName
field for [catalog.UpdateMonitor](https://pkg.go.dev/github...