Udostępnij przez


Aktualizacja do najnowszej wersji interfejsu API SQL usługi Databricks

Na tej stronie opisano zmiany w interfejsach API zapytań, alertów, uprawnień, źródeł danych i wizualizacji zawartych w najnowszej wersji interfejsu API SQL usługi Databricks. Starszy interfejs API jest przestarzały i wkrótce zakończy się obsługa techniczna. Użyj tej strony, aby przeprowadzić migrację aplikacji i integracji do nowej wersji interfejsu API.

Zmiany interfejsu API zapytań

Nowy interfejs API zapytań zawiera bardziej przyjazne dla użytkownika środowisko z bardziej opisowymi nazwami, odpowiedziami podzielonymi na strony i odpowiedziami listy automatycznie posortowanymi według czasu utworzenia. Poniższa lista zawiera opis zmian w interfejsie API zapytań:

  • Ścieżka interfejsu API to teraz api/2.0/sql/queries, zastępuje starszą ścieżkę /api/2.0/preview/sql/queries.
  • Zawiera nową definicję zapytania z bardziej opisowymi nazwami pól i typami.
  • Punkt końcowy aktualizacji obsługuje teraz częściowe aktualizacje przy użyciu PATCH zamiast POST.
  • Punkt końcowy aktualizacji obsługuje teraz przenoszenie własności zapytań. Wcześniej było to dozwolone tylko przy użyciu API przeniesienia własności obiektu.
  • Odpowiedzi punktu końcowego listy są teraz stronicowane przy użyciu stronicowania opartego na tokenach.
  • Punkt końcowy listy nie obsługuje już filtrowania według nazwy ani niestandardowego porządkowania. Zamiast tego wszystkie dostępne zapytania są zwracane i sortowane w kolejności rosnącej według czasu tworzenia.
  • Punkt końcowy przywracania nie jest już obsługiwany. Usunięte zapytania mogą być nadal przywracane za pośrednictwem interfejsu użytkownika Azure Databricks.

Aby uzyskać pełną dokumentację dotyczącą zaktualizowanego interfejsu API zapytań, zobacz Zapytania.

Zmiany interfejsu API alertów

Nowy interfejs API alertów zawiera bardziej przyjazne dla użytkownika środowisko z bardziej opisowymi nazwami pól i typami, odpowiedziami podzielonymi na strony w celu wyświetlenia listy punktów końcowych i obsługą częściowych aktualizacji. Poniższa lista zawiera opis zmian w interfejsie API alertów:

  • Ścieżka interfejsu API to teraz api/2.0/sql/alerts, zastępuje starszą ścieżkę /api/2.0/preview/sql/alerts.
  • Zawiera nową definicję alertu z bardziej opisowymi nazwami pól i typami, które są używane.
  • Punkt końcowy aktualizacji obsługuje teraz częściowe aktualizacje przy użyciu PATCH zamiast POST.
  • Punkt końcowy aktualizacji obsługuje teraz przenoszenie własności zapytań. Wcześniej było to dozwolone tylko przy użyciu API przeniesienia własności obiektu.
  • Odpowiedzi punktu końcowego listy są teraz stronicowane przy użyciu stronicowania opartego na tokenach.
  • Punkt końcowy 'usuń' przenosi teraz alert do kosza zamiast trwale go usuwać. Powiadomienia z kosza zostaną automatycznie wyczyszczone po 30 dniach. Alerty przeniesione do kosza można przywrócić w ciągu 30 dni od usunięcia poprzez interfejs użytkownika Azure Databricks.

Aby uzyskać pełną dokumentację dotyczącą zaktualizowanego interfejsu API alertów, zobacz Alerty.

Przestarzałe API uprawnień

Interfejs API uprawnień jest teraz oznaczony jako przestarzały. Zarządzanie uprawnieniami obiektów przy użyciu interfejsu API obszaru roboczego . Użyj interfejsów API do aktualizacji zapytań i alertów, aby przenieść własność obiektu.

Przestarzały interfejs API źródeł danych

Interfejs API źródeł danych jest teraz oznaczony jako przestarzały. Obecnie jej funkcjonalność jest ograniczona do uzyskiwania listy magazynów SQL. Ponieważ nowy interfejs API zapytań obsługuje przekazywanie i zwracanie identyfikatorów usługi SQL Warehouse zamiast identyfikatorów źródeł danych, oddzielne wywołanie interfejsu API do konwersji między źródłami danych i magazynami SQL nie jest już wymagane.

Uaktualnianie wersji zestawu SDK

Jeśli uzyskujesz dostęp do starszego interfejsu API SQL usługi Databricks za pomocą zestawów SDK usługi Databricks, przeprowadź uaktualnienie do najnowszej wersji zestawu SDK i przeprowadź migrację do nowych interfejsów API. Zapoznaj się z dokumentacją zestawów SDK usługi Databricks .

Migrowanie poleceń interfejsu wiersza polecenia

Jeśli uzyskujesz dostęp do starszego interfejsu API SQL usługi Databricks za pośrednictwem interfejsu wiersza polecenia usługi Databricks, przeprowadź migrację z tych przestarzałych grup poleceń:

Deprecated Użyj zamiast tego
zapytania-legacy queries
alerts-legacy alerts
źródła danych Brak zamiany

Migrowanie zasobów programu Terraform

Jeśli używasz narzędzia Terraform do zarządzania zasobami SQL usługi Databricks, przeprowadź migrację do nowych definicji zasobów:

Przestarzały zasób Użyj zamiast tego Przewodnik migracji
databricks_sql_query databricks_query Przewodnik migracji
databricks_sql_alert databricks_alert Przewodnik migracji
databricks_sql_visualization databricks_dashboard Brak przewodnika po migracji

W przypadku databricks_sql_endpoint i databricks_sql_warehouse:

Zaktualizuj provider Terraform dla Databricks do wersji 1.105.0 lub nowszej. Pole data_source_id jest przestarzałe. Uaktualnij, aby zapobiec błędom, gdy przestarzały interfejs API źródeł danych jest wyłączony.