|
| 1 | +import logging |
| 2 | +from collections.abc import Iterator |
| 3 | +from dataclasses import replace |
| 4 | + |
| 5 | +from databricks.labs.blueprint.installation import Installation |
| 6 | + |
1 | 7 | from databricks.sdk import WorkspaceClient |
2 | | -from databricks.sdk.service.sql import Query |
| 8 | +from databricks.sdk.service.sql import Query, Dashboard |
| 9 | +from databricks.sdk.errors.platform import DatabricksError |
3 | 10 |
|
4 | | -from databricks.labs.ucx.source_code.base import Fixer |
| 11 | +from databricks.labs.ucx.hive_metastore.migration_status import MigrationIndex |
| 12 | +from databricks.labs.ucx.source_code.base import CurrentSessionState |
| 13 | +from databricks.labs.ucx.source_code.queries import FromTable |
| 14 | + |
| 15 | +logger = logging.getLogger(__name__) |
5 | 16 |
|
6 | 17 |
|
7 | 18 | class Redash: |
8 | | - def __init__(self, fixer: Fixer, ws: WorkspaceClient): |
9 | | - self._fixer = fixer |
| 19 | + MIGRATED_TAG = "Migrated by UCX" |
| 20 | + |
| 21 | + def __init__(self, index: MigrationIndex, ws: WorkspaceClient, installation: Installation): |
| 22 | + self._index = index |
10 | 23 | self._ws = ws |
| 24 | + self._installation = installation |
| 25 | + |
| 26 | + def migrate_dashboards(self, dashboard_id: str | None = None): |
| 27 | + for dashboard in self._list_dashboards(dashboard_id): |
| 28 | + assert dashboard.id is not None |
| 29 | + if dashboard.tags is not None and self.MIGRATED_TAG in dashboard.tags: |
| 30 | + logger.debug(f"Dashboard {dashboard.name} already migrated by UCX") |
| 31 | + continue |
| 32 | + for query in self.get_queries_from_dashboard(dashboard): |
| 33 | + self._fix_query(query) |
| 34 | + self._ws.dashboards.update(dashboard.id, tags=self._get_migrated_tags(dashboard.tags)) |
| 35 | + |
| 36 | + def revert_dashboards(self, dashboard_id: str | None = None): |
| 37 | + for dashboard in self._list_dashboards(dashboard_id): |
| 38 | + assert dashboard.id is not None |
| 39 | + if dashboard.tags is None or self.MIGRATED_TAG not in dashboard.tags: |
| 40 | + logger.debug(f"Dashboard {dashboard.name} was not migrated by UCX") |
| 41 | + continue |
| 42 | + for query in self.get_queries_from_dashboard(dashboard): |
| 43 | + self._revert_query(query) |
| 44 | + self._ws.dashboards.update(dashboard.id, tags=self._get_original_tags(dashboard.tags)) |
| 45 | + |
| 46 | + def _list_dashboards(self, dashboard_id: str | None) -> list[Dashboard]: |
| 47 | + try: |
| 48 | + if dashboard_id is None: |
| 49 | + return list(self._ws.dashboards.list()) |
| 50 | + return [self._ws.dashboards.get(dashboard_id)] |
| 51 | + except DatabricksError as e: |
| 52 | + logger.error(f"Cannot list dashboards: {e}") |
| 53 | + return [] |
| 54 | + |
| 55 | + def _fix_query(self, query: Query): |
| 56 | + assert query.id is not None |
| 57 | + assert query.query is not None |
| 58 | + # query already migrated |
| 59 | + if query.tags is not None and self.MIGRATED_TAG in query.tags: |
| 60 | + return |
| 61 | + # backup the query |
| 62 | + self._installation.save(query, filename=f'backup/queries/{query.id}.json') |
| 63 | + from_table = FromTable(self._index, self._get_session_state(query)) |
| 64 | + new_query = from_table.apply(query.query) |
| 65 | + try: |
| 66 | + self._ws.queries.update( |
| 67 | + query.id, |
| 68 | + query=new_query, |
| 69 | + tags=self._get_migrated_tags(query.tags), |
| 70 | + ) |
| 71 | + except DatabricksError: |
| 72 | + logger.warning(f"Cannot upgrade {query.name}") |
| 73 | + return |
11 | 74 |
|
12 | | - def fix(self, query: Query): |
| 75 | + @staticmethod |
| 76 | + def _get_session_state(query: Query) -> CurrentSessionState: |
| 77 | + session_state = CurrentSessionState() |
| 78 | + if query.options is None: |
| 79 | + return session_state |
| 80 | + if query.options.catalog: |
| 81 | + session_state = replace(session_state, catalog=query.options.catalog) |
| 82 | + if query.options.schema: |
| 83 | + session_state = replace(session_state, schema=query.options.schema) |
| 84 | + return session_state |
| 85 | + |
| 86 | + def _revert_query(self, query: Query): |
13 | 87 | assert query.id is not None |
14 | 88 | assert query.query is not None |
15 | | - query.query = self._fixer.apply(query.query) |
16 | | - self._ws.queries.update( |
17 | | - query.id, |
18 | | - data_source_id=query.data_source_id, |
19 | | - description=query.description, |
20 | | - name=query.name, |
21 | | - options=query.options, |
22 | | - query=query.query, |
23 | | - run_as_role=query.run_as_role, |
24 | | - ) |
| 89 | + if query.tags is None: |
| 90 | + return |
| 91 | + # find the backup query |
| 92 | + is_migrated = False |
| 93 | + for tag in query.tags: |
| 94 | + if tag == self.MIGRATED_TAG: |
| 95 | + is_migrated = True |
| 96 | + |
| 97 | + if not is_migrated: |
| 98 | + logger.debug(f"Query {query.name} was not migrated by UCX") |
| 99 | + return |
| 100 | + |
| 101 | + backup_query = self._installation.load(Query, filename=f'backup/queries/{query.id}.json') |
| 102 | + try: |
| 103 | + self._ws.queries.update(query.id, query=backup_query.query, tags=self._get_original_tags(backup_query.tags)) |
| 104 | + except DatabricksError: |
| 105 | + logger.warning(f"Cannot restore {query.name} from backup") |
| 106 | + return |
| 107 | + |
| 108 | + def _get_migrated_tags(self, tags: list[str] | None) -> list[str]: |
| 109 | + out = [self.MIGRATED_TAG] |
| 110 | + if tags: |
| 111 | + out.extend(tags) |
| 112 | + return out |
| 113 | + |
| 114 | + def _get_original_tags(self, tags: list[str] | None) -> list[str] | None: |
| 115 | + if tags is None: |
| 116 | + return None |
| 117 | + return [tag for tag in tags if tag != self.MIGRATED_TAG] |
| 118 | + |
| 119 | + @staticmethod |
| 120 | + def get_queries_from_dashboard(dashboard: Dashboard) -> Iterator[Query]: |
| 121 | + if dashboard.widgets is None: |
| 122 | + return |
| 123 | + for widget in dashboard.widgets: |
| 124 | + if widget is None: |
| 125 | + continue |
| 126 | + if widget.visualization is None: |
| 127 | + continue |
| 128 | + if widget.visualization.query is None: |
| 129 | + continue |
| 130 | + yield widget.visualization.query |
0 commit comments