Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v0.17.0 #502

Merged
merged 4 commits into from
Jan 11, 2024
Merged

Release v0.17.0 #502

merged 4 commits into from
Jan 11, 2024

Conversation

tanmay-db
Copy link
Contributor

@tanmay-db tanmay-db commented Jan 10, 2024

  • Use covariant type for @retried(on=[...]) (#486).
  • Configure request timeout using existing parameter from Config (#489).
  • Make contents of __init__.py equal across projects (#488).
  • Update SDK to Latest OpenAPI Specification (#501).

Note: This release contains breaking changes, please see below for more details.

API Changes:

  • [Breaking] Changed list() method for w.tokens workspace-level service to return databricks.sdk.service.settings.ListPublicTokensResponse dataclass.
  • Changed list() method for w.external_locations workspace-level service to require request of databricks.sdk.service.catalog.ListExternalLocationsRequest dataclass and w.storage_credentials workspace-level service to require request of databricks.sdk.service.catalog.ListStorageCredentialsRequest dataclass.
  • Added next_page_token field for databricks.sdk.service.catalog.ListExternalLocationsResponse, databricks.sdk.service.catalog.ListFunctionsResponse, databricks.sdk.service.catalog.ListSchemasResponse and databricks.sdk.service.catalog.ListStorageCredentialsResponse.
  • Added max_results field for databricks.sdk.service.catalog.ListFunctionsRequest and databricks.sdk.service.catalog.ListSchemasRequest.
  • Added page_token field for databricks.sdk.service.catalog.ListFunctionsRequest and databricks.sdk.service.catalog.ListSchemasRequest.
  • Added omit_columns field for databricks.sdk.service.catalog.ListTablesRequest.
  • Added omit_properties field for databricks.sdk.service.catalog.ListTablesRequest.
  • Added init_scripts field for databricks.sdk.service.pipelines.PipelineCluster.
  • Added validate_only field for databricks.sdk.service.pipelines.StartUpdate and databricks.sdk.service.pipelines.UpdateInfo.
  • Changed create() method for w.dashboards workspace-level service . New request type is databricks.sdk.service.sql.DashboardPostContent dataclass.
  • Added update() method for w.dashboards workspace-level service.
  • Added http_headers field for databricks.sdk.service.sql.ExternalLink.
  • Added run_as_role field for databricks.sdk.service.sql.QueryEditContent.
  • Added package: databricks.sdk.service.dashboards and databricks.sdk.service.vectorsearch.
  • Added dataclass: databricks.sdk.service.catalog.ListExternalLocationsRequest, databricks.sdk.service.catalog.ListStorageCredentialsRequest, databricks.sdk.service.settings.ListPublicTokensResponse, databricks.sdk.service.sql.DashboardEditContent and databricks.sdk.service.sql.DashboardPostContent.
  • Removed dataclass: databricks.sdk.service.catalog.TableConstraintList and databricks.sdk.service.sql.CreateDashboardRequest.

OpenAPI SHA: 0e0d4cbe87193e36c73b8b2be3b0dd0f1b013e00, Date: 2024-01-10

* Use covariant type for `@retried(on=[...])` ([#486](#486)).
* Configure request timeout using existing parameter from Config ([#489](#489)).
* Make contents of `__init__.py` equal across projects ([#488](#488)).
* Update SDK to Latest OpenAPI Specification ([#501](#501)).

API Changes:

 * Changed `list()` method for [w.external_locations](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/external_locations.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListExternalLocationsRequest` dataclass.
 * Changed `list()` method for [w.storage_credentials](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/storage_credentials.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListStorageCredentialsRequest` dataclass.
 * Added `next_page_token` field for `databricks.sdk.service.catalog.ListExternalLocationsResponse`.
 * Added `max_results` field for `databricks.sdk.service.catalog.ListFunctionsRequest`.
 * Added `page_token` field for `databricks.sdk.service.catalog.ListFunctionsRequest`.
 * Added `next_page_token` field for `databricks.sdk.service.catalog.ListFunctionsResponse`.
 * Added `max_results` field for `databricks.sdk.service.catalog.ListSchemasRequest`.
 * Added `page_token` field for `databricks.sdk.service.catalog.ListSchemasRequest`.
 * Added `next_page_token` field for `databricks.sdk.service.catalog.ListSchemasResponse`.
 * Added `next_page_token` field for `databricks.sdk.service.catalog.ListStorageCredentialsResponse`.
 * Added `omit_columns` field for `databricks.sdk.service.catalog.ListTablesRequest`.
 * Added `omit_properties` field for `databricks.sdk.service.catalog.ListTablesRequest`.
 * Removed `databricks.sdk.service.catalog.TableConstraintList` dataclass.
 * Added `databricks.sdk.service.catalog.ListExternalLocationsRequest` dataclass.
 * Added `databricks.sdk.service.catalog.ListStorageCredentialsRequest` dataclass.
 * Added `init_scripts` field for `databricks.sdk.service.pipelines.PipelineCluster`.
 * Added `validate_only` field for `databricks.sdk.service.pipelines.StartUpdate`.
 * Added `validate_only` field for `databricks.sdk.service.pipelines.UpdateInfo`.
 * Changed `list()` method for [w.tokens](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/tokens.html) workspace-level service to return `databricks.sdk.service.settings.ListPublicTokensResponse` dataclass.
 * Added `databricks.sdk.service.settings.ListPublicTokensResponse` dataclass.
 * Changed `create()` method for [w.dashboards](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards.html) workspace-level service . New request type is `databricks.sdk.service.sql.DashboardPostContent` dataclass.
 * Added `update()` method for [w.dashboards](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards.html) workspace-level service.
 * Removed `databricks.sdk.service.sql.CreateDashboardRequest` dataclass.
 * Added `http_headers` field for `databricks.sdk.service.sql.ExternalLink`.
 * Added `run_as_role` field for `databricks.sdk.service.sql.QueryEditContent`.
 * Added `databricks.sdk.service.sql.DashboardEditContent` dataclass.
 * Added `databricks.sdk.service.sql.DashboardPostContent` dataclass.
 * Added `databricks.sdk.service.dashboards` package.
 * Added `databricks.sdk.service.vectorsearch` package.

OpenAPI SHA: 0e0d4cbe87193e36c73b8b2be3b0dd0f1b013e00, Date: 2024-01-10
@codecov-commenter
Copy link

codecov-commenter commented Jan 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (11d4f35) 57.69% compared to head (cb848fc) 57.69%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #502   +/-   ##
=======================================
  Coverage   57.69%   57.69%           
=======================================
  Files          40       40           
  Lines       27148    27148           
=======================================
  Hits        15664    15664           
  Misses      11484    11484           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tanmay-db
Copy link
Contributor Author

Integration tests are running ...

* Make contents of `__init__.py` equal across projects ([#488](https://github.com/databricks/databricks-sdk-py/pull/488)).
* Update SDK to Latest OpenAPI Specification ([#501](https://github.com/databricks/databricks-sdk-py/pull/501)).

Note: This release contains breaking changes, please see below for more details.
Copy link
Contributor Author

@tanmay-db tanmay-db Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Highlight for breaking change. Clubbed similar types of changes in changelog manually for better readability.

Copy link
Contributor

@mgyucht mgyucht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small question. Python doesn't have the same breaking/non-breaking issues as Go/Java as request objects are not used in Python directly.

CHANGELOG.md Outdated

API Changes:

* [Breaking] Changed `list()` method for [w.external_locations](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/external_locations.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListExternalLocationsRequest` dataclass, [w.storage_credentials](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/storage_credentials.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListStorageCredentialsRequest` dataclass and [w.tokens](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/tokens.html) workspace-level service to return `databricks.sdk.service.settings.ListPublicTokensResponse` dataclass.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this breaking for the Python SDK?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed offline, mentioning for visibility:

Changed list() method for w.tokens workspace-level service to return databricks.sdk.service.settings.ListPublicTokensResponse dataclass.

would be breaking is someone is using mypy along with type annotations. Splitting up the breaking change from other list() method changes.

@tanmay-db tanmay-db added this pull request to the merge queue Jan 11, 2024
Merged via the queue into main with commit a558d97 Jan 11, 2024
9 checks passed
@tanmay-db tanmay-db deleted the prepare/0.17.0 branch January 11, 2024 10:03
@tanmay-db tanmay-db mentioned this pull request Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants