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

Add method to dashboards to get dashboard url #211

Merged
merged 8 commits into from
Jul 10, 2024
Merged

Conversation

JCZuurmond
Copy link
Member

Copy link

github-actions bot commented Jul 10, 2024

✅ 35/35 passed, 9 flaky, 2 skipped, 15m58s total

Flaky tests:

  • 🤪 test_dashboard_deploys_dashboard_with_table (31.167s)
  • 🤪 test_dashboard_deploys_dashboard_with_display_name (31.413s)
  • 🤪 test_dashboards_deploys_dashboard_with_order_overwrite_in_dashboard_yaml (31.822s)
  • 🤪 test_dashboards_deploys_dashboard_with_order_overwrite_in_query_header (33.803s)
  • 🤪 test_dashboard_deploys_dashboard_with_empty_title (16.493s)
  • 🤪 test_dashboards_deploys_dashboard_with_widget_title_and_description (29.453s)
  • 🤪 test_dashboards_deploys_dashboard_with_invalid_query (29.246s)
  • 🤪 test_dashboards_deploys_dashboard_from_query_with_cte (30.288s)
  • 🤪 test_dashboards_deploys_dashboard_with_markdown_header (32.242s)

Running from acceptance #298

@JCZuurmond JCZuurmond marked this pull request as ready for review July 10, 2024 09:41
src/databricks/labs/lsql/dashboards.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@nfx nfx left a comment

Choose a reason for hiding this comment

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

lgtm

@nfx nfx merged commit e36702a into main Jul 10, 2024
8 checks passed
@nfx nfx deleted the feat/get-dashboard-url branch July 10, 2024 14:52
nfx added a commit that referenced this pull request Jul 11, 2024
* Added method to dashboards to get dashboard url ([#211](#211)). In this release, we have added a new method `get_url` to the `lakeview_dashboards` object in the `laksedashboard` library. This method utilizes the Databricks SDK to retrieve the dashboard URL, simplifying the code and making it more maintainable. Previously, the dashboard URL was constructed by concatenating the host and dashboard ID, but this new method ensures that the URL is obtained correctly, even if the format changes in the future. Additionally, a new unit test has been added for a method that gets the dashboard URL using the workspace client. This new functionality allows users to easily retrieve the URL for a dashboard using its ID and the workspace client.
* Extend replace database in query ([#210](#210)). This commit extends the database replacement functionality in the `DashboardMetadata` class, allowing users to specify which database and catalog to replace. The enhancement includes support for catalog replacement and a new `replace_database` method in the `DashboardMetadata` class, which replaces the catalog and/or database in the query based on provided parameters. These changes enhance the flexibility and customization of the database replacement feature in queries, making it easier for users to control how their data is displayed in the dashboard. The `create_dashboard` function has also been updated to use the new method for replacing the database and catalog. Additionally, the `TileMetadata` update method has been replaced with a new merge method, and the `QueryTile` and `Tile` classes have new properties and methods for handling content, width, height, and position. The commit also includes several unit tests to ensure the new functionality works as expected.
* Improve object oriented dashboard-as-code implementation ([#208](#208)). In this release, the object-oriented implementation of the dashboard-as-code feature has been significantly improved, addressing previous pull request comments ([#201](#201)). The `TileMetadata` dataclass now includes methods for updating and comparing tile metadata, and the `DashboardMetadata` class has been removed and its functionality incorporated into the `Dashboards` class. The `Dashboards` class now generates tiles, datasets, and layouts for dashboards using the provided `query_transformer`. The code's readability and maintainability have been further enhanced by replacing the use of the `copy` module with `dataclasses.replace` for creating object copies. Additionally, updates have been made to the unit tests for dashboard functionality in the project, with new methods and attributes added to check for valid dashboard metadata and handle duplicate query or widget IDs, as well as to specify the order in which tiles and widgets should be displayed in the dashboard.
@nfx nfx mentioned this pull request Jul 11, 2024
nfx added a commit that referenced this pull request Jul 11, 2024
* Added method to dashboards to get dashboard url
([#211](#211)). In this
release, we have added a new method `get_url` to the
`lakeview_dashboards` object in the `laksedashboard` library. This
method utilizes the Databricks SDK to retrieve the dashboard URL,
simplifying the code and making it more maintainable. Previously, the
dashboard URL was constructed by concatenating the host and dashboard
ID, but this new method ensures that the URL is obtained correctly, even
if the format changes in the future. Additionally, a new unit test has
been added for a method that gets the dashboard URL using the workspace
client. This new functionality allows users to easily retrieve the URL
for a dashboard using its ID and the workspace client.
* Extend replace database in query
([#210](#210)). This commit
extends the database replacement functionality in the
`DashboardMetadata` class, allowing users to specify which database and
catalog to replace. The enhancement includes support for catalog
replacement and a new `replace_database` method in the
`DashboardMetadata` class, which replaces the catalog and/or database in
the query based on provided parameters. These changes enhance the
flexibility and customization of the database replacement feature in
queries, making it easier for users to control how their data is
displayed in the dashboard. The `create_dashboard` function has also
been updated to use the new method for replacing the database and
catalog. Additionally, the `TileMetadata` update method has been
replaced with a new merge method, and the `QueryTile` and `Tile` classes
have new properties and methods for handling content, width, height, and
position. The commit also includes several unit tests to ensure the new
functionality works as expected.
* Improve object oriented dashboard-as-code implementation
([#208](#208)). In this
release, the object-oriented implementation of the dashboard-as-code
feature has been significantly improved, addressing previous pull
request comments
([#201](#201)). The
`TileMetadata` dataclass now includes methods for updating and comparing
tile metadata, and the `DashboardMetadata` class has been removed and
its functionality incorporated into the `Dashboards` class. The
`Dashboards` class now generates tiles, datasets, and layouts for
dashboards using the provided `query_transformer`. The code's
readability and maintainability have been further enhanced by replacing
the use of the `copy` module with `dataclasses.replace` for creating
object copies. Additionally, updates have been made to the unit tests
for dashboard functionality in the project, with new methods and
attributes added to check for valid dashboard metadata and handle
duplicate query or widget IDs, as well as to specify the order in which
tiles and widgets should be displayed in the dashboard.
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.

2 participants