Databricks Driver for SQLTools for Visual Studio Code
Fontos
Ez a funkció a nyilvános előzetes verzióban érhető el.
Az SQLTools Databricks-illesztője lehetővé teszi a Visual Studio Code SQLTools bővítményének használatát SQL-objektumok böngészéséhez és SQL-lekérdezések távoli Azure Databricks-munkaterületeken való futtatásához.
Mielőtt elkezdené
Az SQLTools Databricks-illesztőprogramjának használata előtt az Azure Databricks-munkaterületnek és a helyi fejlesztőgépnek meg kell felelnie az alábbi követelményeknek.
Munkaterületre vonatkozó követelmények
Legalább egy Elérhető Azure Databricks-munkaterülettel kell rendelkeznie, és a munkaterületnek meg kell felelnie a következő követelményeknek:
A munkaterületnek tartalmaznia kell legalább egy Databricks SQL Warehouse-t.
A Unity Cataloghoz engedélyezett munkaterületek esetében a munkaterületnek tartalmaznia kell legalább egy katalógust, amelynek legalább egy sémája (hivatalosan adatbázis) szerepel a katalógusban.
A Unity Cataloghoz nem engedélyezett munkaterületek esetében a munkaterületnek legalább egy sémát (korábbi nevén adatbázist) kell tartalmaznia.
Helyi fejlesztőgép-követelmények
A helyi fejlesztőgépen a következőknek kell lenniük:
- A Visual Studio Code 1.70-es vagy újabb verziója. A telepített verzió megtekintéséhez kattintson a Code About Visual Studio Code (Kód a Visual Studio Code-ról) parancsra a Linux vagy macOS rendszeren futó manin menüben, valamint a Windows súgójában>.> A Visual Studio Code letöltéséhez, telepítéséhez és konfigurálásához lásd: Visual Studio Code beállítása.
- A Visual Studio Code SQLTools bővítménye.
- A Databricks Driver for SQLTools bővítmény a Visual Studio Code-hoz.
Az SQLTools bővítmény telepítéséhez nyissa meg az SQLTools alkalmazást, majd kattintson a Telepítés gombra, vagy:
A Visual Studio Code-ban kattintson a Bővítmények megtekintése > elemre a főmenüben.
A Marketplace Keresési bővítmények mezőjébe írja be a következőt
SQLTools
:Kattintson a Matheus Teixeira SQLTools bejegyzésére.
Feljegyzés
A listában több SQLTools-bejegyzés is szerepelhet. Mindenképpen kattintson a Matheus Teixeira bejegyzésére.
Kattintson az Install (Telepítés) gombra.
Az SQLTools Databricks-illesztőprogramjának telepítéséhez nyissa meg az SQLTools Databricks-illesztőprogramot, majd kattintson a Telepítés vagy:
- A Visual Studio Code-ban kattintson a Bővítmények megtekintése > elemre a főmenüben.
- A Marketplace Keresési bővítmények mezőjébe írja be a következőt
Databricks Driver for SQLTools
: - Kattintson az SQLTools databricks-illesztőprogramjának bejegyzésére.
- Kattintson az Install (Telepítés) gombra.
Hitelesítés
Az SQLTools Databricks-illesztőprogramjának hitelesítését az alábbiak szerint kell beállítania.
Az SQLTools Databricks-illesztőprogramja a következő Azure Databricks-hitelesítési típusokat támogatja:
- Hitelesítés személyes Azure Databricks hozzáférési jogkivonattal
- Azure Databricks OAuth gépről gépre (M2M) történő hitelesítés
- Azure Databricks OAuth felhasználó–gép (U2M) hitelesítés
- Azure CLI hitelesítés
Feljegyzés
Az SQLTools Databricks-illesztőprogramja nem támogatja a Microsoft Entra ID-jogkivonatokat.
Azure Databricks személyes hozzáférési jogkivonat hitelesítése
Ha az SQLTools Databricks-illesztőjét Azure Databricks személyes hozzáférési jogkivonat-hitelesítéssel szeretné használni, rendelkeznie kell egy Azure Databricks személyes hozzáférési jogkivonattal. Személyes hozzáférési jogkivonat létrehozásához tegye a következőket:
- Az Azure Databricks-munkaterületen kattintson az Azure Databricks-felhasználónevére a felső sávon, majd válassza a legördülő menü Beállítások elemét .
- Kattintson a Fejlesztőeszközök elemre.
- Az Access-jogkivonatok mellett kattintson a Kezelés gombra.
- Kattintson az Új jogkivonat létrehozása elemre.
- (Nem kötelező) Írjon be egy megjegyzést, amely segít azonosítani a jogkivonatot a jövőben, és módosíthatja a jogkivonat alapértelmezett 90 napos élettartamát. Élettartam nélküli (nem ajánlott) jogkivonat létrehozásához hagyja üresen az Élettartam (nap) mezőt (üres).
- Kattintson a Létrehozás lehetőségre.
- Másolja a megjelenített jogkivonatot egy biztonságos helyre, majd kattintson a Kész gombra.
Feljegyzés
Ügyeljen arra, hogy a másolt jogkivonatot biztonságos helyre mentse. Ne ossza meg másokkal a másolt jogkivonatot. Ha elveszíti a másolt jogkivonatot, nem tudja pontosan ugyanazt a jogkivonatot újragenerálni. Ehelyett meg kell ismételnie ezt az eljárást egy új jogkivonat létrehozásához. Ha elveszíti a másolt jogkivonatot, vagy úgy véli, hogy a jogkivonat sérült, a Databricks határozottan javasolja, hogy azonnal törölje a jogkivonatot a munkaterületről az Access-jogkivonatok lapon a jogkivonat melletti kuka (Visszavonás) ikonra kattintva.
Ha nem tud jogkivonatokat létrehozni vagy használni a munkaterületen, ennek az lehet az oka, hogy a munkaterület rendszergazdája letiltotta a jogkivonatokat, vagy nem adott engedélyt a jogkivonatok létrehozására vagy használatára. Tekintse meg a munkaterület rendszergazdáját vagy a következő témaköröket:
Azure Databricks OAuth gépről gépre (M2M) történő hitelesítés
Az Azure Databricks OAuth machine-to-machine (M2M) hitelesítéssel hitelesítést végezhet az SQLTools Databricks-illesztőprogramjával az alábbiak szerint:
Feljegyzés
Az Azure Databricks OAuth M2M-hitelesítés a Databricks Driver for SQLTools 0.4.2-es és újabb verzióiban érhető el.
- Végezze el az OAuth M2M-hitelesítés konfigurációs lépéseit. Lásd: OAuth machine-to-machine (M2M) hitelesítés.
- Hozzon létre egy Azure Databricks-konfigurációs profilt az OAuth M2M hitelesítési konfigurációs beállításaival. Lásd az OAuth machine-to-machine (M2M) hitelesítés "Konfiguráció" szakaszát.
- Telepítse és nyissa meg a Visual Studio Code Databricks bővítményét a helyi fejlesztői gépen.
- A Visual Studio Code Databricks bővítményében kattintson a Konfiguráció panel Konfigurálás gombjára. Ha a Konfigurálás gomb nem jelenik meg, kattintson helyette a fogaskerék (Munkaterület konfigurálása) ikonra.
- A Databricks Host parancskatalógusában adja meg például
https://adb-1234567890123456.7.azuredatabricks.net
az Azure Databricks munkaterületenkénti URL-címét, majd nyomja le az Enter billentyűt. - Válassza ki azt a konfigurációs profilbejegyzést, amely megfelel a 2. lépésben létrehozottnak.
- A webböngészőben végezze el a képernyőn megjelenő utasításokat az Azure Databricks-fiók hitelesítésének befejezéséhez.
Azure Databricks OAuth felhasználó–gép (U2M) hitelesítés
Az Azure Databricks OAuth felhasználó–gép (U2M) hitelesítéssel hitelesítést végezhet az SQLTools Databricks-illesztőprogramjával az alábbiak szerint:
Feljegyzés
Az Azure Databricks OAuth U2M-hitelesítés a Databricks Driver for SQLTools 0.4.2-es és újabb verzióiban érhető el.
- Telepítse és nyissa meg a Visual Studio Code Databricks bővítményét a helyi fejlesztői gépen.
- A Visual Studio Code Databricks bővítményében kattintson a Konfiguráció panel Konfigurálás gombjára. Ha a Konfigurálás gomb nem jelenik meg, kattintson helyette a fogaskerék (Munkaterület konfigurálása) ikonra.
- A Databricks Host parancskatalógusában adja meg például
https://adb-1234567890123456.7.azuredatabricks.net
az Azure Databricks munkaterületenkénti URL-címét. Nyomja le az Enter billentyűt. - Válassza az OAuth (felhasználó a géphez) lehetőséget.
- A webböngészőben végezze el a képernyőn megjelenő utasításokat az Azure Databricks-fiók hitelesítésének befejezéséhez. Ha a rendszer kéri, engedélyezze
all-apis
a hozzáférést.
Azure CLI-hitelesítés
Az Azure CLI használatával hitelesítheti magát az SQLTools Databricks-illesztőprogramjával az alábbiak szerint:
Feljegyzés
Az Azure CLI hitelesítése kísérleti funkció állapotban van. Ez a funkció a Databricks Driver for SQLTools 0.4.2-s és újabb verzióiban érhető el.
- Ha még nem tette meg, telepítse az Azure CLI-t a helyi fejlesztőgépre.
- Telepítse és nyissa meg a Visual Studio Code Databricks bővítményét a helyi fejlesztői gépen.
- A Visual Studio Code Databricks bővítményében kattintson a Konfiguráció panel Konfigurálás gombjára. Ha a Konfigurálás gomb nem jelenik meg, kattintson helyette a fogaskerék (Munkaterület konfigurálása) ikonra.
- A Databricks Host parancskatalógusában adja meg például
https://adb-1234567890123456.7.azuredatabricks.net
az Azure Databricks munkaterületenkénti URL-címét. Nyomja le az Enter billentyűt. - Válassza az Azure CLI-t.
- Kövesse a képernyőn megjelenő utasításokat az Azure CLI hitelesítésének befejezéséhez.
Csatlakozás sémához
- A Visual Studio Code oldalsávján kattintson az SQLTools ikonra.
- Az SQLTools nézetben, ha először használja az SQLTools bővítményt, kattintson az Új kapcsolat hozzáadása elemre a Kapcsolatok panelen. Ellenkező esetben kattintson az Új kapcsolat hozzáadása ikonra a panel címsorában.
- Az SQLTools Beállítások lapján az Adatbázis-illesztőprogram kiválasztása lépésnél kattintson a Databricks ikonra.
- A Kapcsolatbeállítások lépéshez adja meg a következő információkat a raktárról, a katalógusról és a sémáról:
A Kapcsolat neve mezőben adjon meg egy egyedi nevet a kapcsolatnak.
(Nem kötelező) A Kapcsolatcsoport mezőben adja meg egy meglévő kapcsolatcsoport nevét, hogy hozzáadja az új kapcsolatot a csoporthoz. Vagy adjon meg egy egyedi nevet, ha új kapcsolatcsoportot szeretne létrehozni az új kapcsolattal. A kapcsolatcsoportok megkönnyítik a kapcsolatok keresését a bővítményben.
Csatlakozáshoz válasszon az alábbi lehetőségek közül:
- Ha azure Databricks személyes hozzáférési jogkivonatot szeretne használni a hitelesítéshez, válassza a Hostname és a Token lehetőséget.
- Az SQLTools 0.4.2-es és újabb verzióihoz készült Databricks-illesztő esetén az OAuth U2M, az M2M vagy az Azure CLI-hitelesítés használatához válassza a VS Code-bővítményt (bétaverzió).
Ha a Hostname és a Token for Connect lehetőséget választotta, akkor a gazdagép esetében adja meg a raktár kiszolgálói állomásnévbeállítását. A raktár kiszolgálói állomásnévbeállításának lekéréséhez tekintse meg az Azure Databricks számítási erőforrás kapcsolati adatainak lekérése című témakört.
Az Elérési út mezőben adja meg a raktár vagy a fürt HTTP-elérési útbeállítását. A raktár HTTP-elérésiút-beállításának lekéréséről az Azure Databricks számítási erőforrás kapcsolati adatainak lekérése című témakörben olvashat.
Ha a Hostname és a Token for Connect lehetőséget választotta, adja meg az Azure Databricks személyes hozzáférési jogkivonat értékét a Tokenben.
Katalógus esetén adja meg a katalógus nevét.
Feljegyzés
A Unity Cataloghoz nem engedélyezett munkaterületek esetén a katalógust üresen hagyva használhatja
hive_metastore
az alapértelmezett értéket.Séma esetén adja meg a séma nevét.
(Nem kötelező) A Rekordok alapértelmezett korlátjának
50
megjelenítése beállításnál hagyja meg az alapértelmezett értéket, hogy csak az első 50 sort jelenítse meg az egyes lekérdezésekhez, vagy adjon meg egy másik korlátot.
- Kattintson a Kapcsolat tesztelése elemre.
- Ha a kapcsolatteszt sikeres, kattintson a Kapcsolat mentése gombra.
Kapcsolat beállításainak módosítása
Ez az eljárás feltételezi, hogy sikeresen csatlakozott legalább egy raktárhoz.
- Ha az SQLTools nézet nem látható, akkor a Visual Studio Code oldalsávján kattintson az SQLTools ikonra.
- A Kapcsolatok panelen bontsa ki a kapcsolatcsoportot, ha létezik ilyen a célkapcsolathoz.
- Kattintson a jobb gombbal a kapcsolatra, és válassza a Kapcsolat szerkesztése parancsot.
- Módosítsa a célbeállításokat.
- Kattintson a Kapcsolat tesztelése elemre.
- Ha a kapcsolatteszt sikeres, kattintson a Kapcsolat mentése gombra.
Sémaobjektumok tallózása
- A Kapcsolatok panelen bontsa ki a kapcsolatcsoportot, ha létezik ilyen a célkapcsolathoz.
- Kattintson vagy bontsa ki duplán a raktár célkapcsolatát.
- Bontsa ki a céladatbázist (sémát), ha létezik ilyen a kapcsolathoz.
- Bontsa ki a Táblák vagy nézetek elemet, ha egy vagy több tábla vagy nézet létezik az adatbázishoz (séma).
- Bontsa ki a céltáblát vagy nézetet a tábla vagy a nézet oszlopainak megtekintéséhez.
Táblázat vagy nézet sorainak vagy sémájának megtekintése
Ha a Táblák vagy nézetek ki van bontva a Kapcsolatok panelen, tegye az alábbiak egyikét:
- A táblázat vagy nézet sorainak megjelenítéséhez kattintson a jobb gombbal a táblázatra vagy nézetre, és válassza a Táblarekordok megjelenítése vagy a Nézetrekordok megjelenítése parancsot.
- A táblázat vagy nézet sémájának megjelenítéséhez kattintson a jobb gombbal a táblázatra vagy nézetre, és kattintson a Táblázat vagy a Nézet leírása parancsra.
Lekérdezés beszúrása táblázathoz
- Helyezze a kurzort egy meglévő szerkesztőbe arra a helyre, ahová be szeretné szúrni a lekérdezést.
- Ha a Táblák ki van bontva a Kapcsolatok panelen, kattintson a jobb gombbal a táblára, és kattintson a Lekérdezés beszúrása parancsra. A beszúrási lekérdezés definíciója a kurzor beszúrási pontján lesz hozzáadva.
Lekérdezés létrehozása és futtatása
Ez az eljárás feltételezi, hogy sikeresen csatlakozott legalább egy raktárhoz.
- A Kapcsolatok panelen bontsa ki a kapcsolatcsoportot, ha létezik ilyen a célkapcsolathoz.
- Kattintson vagy bontsa ki duplán a raktár célkapcsolatát.
- Ha a kapcsolat ki van jelölve, kattintson az Új SQL-fájl gombra a Kapcsolatok panel címsorában. Megjelenik egy új szerkesztőlap.
- Írja be az SQL-lekérdezést az új szerkesztőbe.
- Az SQL-lekérdezés futtatásához kattintson a Futtatás aktív kapcsolaton elemre a szerkesztőben. A lekérdezés eredményei egy új szerkesztőlapon jelennek meg.
Meglévő lekérdezés futtatása
Ez az eljárás feltételezi, hogy sikeresen csatlakozott legalább egy raktárhoz.
- A Kapcsolatok panelen bontsa ki a kapcsolatcsoportot, ha létezik ilyen a célkapcsolathoz.
- Kattintson vagy bontsa ki duplán a raktár célkapcsolatát.
- Ha a kapcsolat ki van jelölve, nyisson meg egy fájlt a fájlkiterjesztésével
.sql
, vagy válassza ki a folyamatos SQL-utasítások bármelyik csoportját bármely korábban megnyitott szerkesztőben. - Ha egy megnyitott
.sql
fájlból szeretné futtatni az SQL-lekérdezést, a.sql
fájl tartalma megjelenik a szerkesztőben, kattintson a Futtatás aktív kapcsolaton a szerkesztőben lehetőségre. A lekérdezés eredményei egy új szerkesztőlapon jelennek meg. - Ha egy korábban megnyitott szerkesztőben szeretné futtatni a folyamatos SQL-utasítások kijelölt csoportját, kattintson a jobb gombbal a kijelölésre, majd kattintson a Kijelölt lekérdezés futtatása parancsra. A lekérdezés eredményei egy új szerkesztőlapon jelennek meg.
Használati naplók küldése a Databricksnek
Ha problémákat tapasztal az SQLTools Databricks-illesztőprogramjának használata során, a következő lépésekkel küldhet használati naplókat és kapcsolódó információkat a Databricks ügyfélszolgálatának:
- Telepítse a Visual Studio Code Databricks-bővítményét a helyi fejlesztőgépre.
- Kapcsolja be a naplózást a Naplók: Engedélyezett beállítás vagy beállítás
databricks.logs.enabled
true
beállításával a Visual Studio Code Databricks bővítményének Beállításai szakaszában leírtak szerint. A naplózás bekapcsolása után mindenképpen indítsa újra a Visual Studio Code-ot. - Próbálja meg reprodukálni a problémát.
- A parancskatalógusban (a főmenü parancskatalógusának megtekintése>) futtassa a Databricks: Open full logs parancsot.
- Küldje el a
Databricks Logs.log
Databricks támogatási szolgálatának megjelenő ,databricks-cli-logs.json
éssdk-and-extension-logs.json
fájlokat. - Másolja a terminál tartalmát (terminál megtekintése>) is a probléma kontextusában, és küldje el ezt a tartalmat a Databricks ügyfélszolgálatának.
A Kimeneti nézet (Kimenet megtekintése > , Databricks-naplók) csonkolt adatokat jelenít meg, ha a naplók: Engedélyezve van, vagy databricks.logs.enabled
be van állítva true
. További információk megjelenítéséhez módosítsa az alábbi beállításokat a Visual Studio Code Databricks bővítményének Beállításai szakaszában leírtak szerint:
- Naplók: Maximális tömbhossz vagy
databricks.logs.maxArrayLength
- Naplók: Maximális mezőhossz vagy
databricks.logs.maxFieldLength
- Naplók: Csonkolás mélysége vagy
databricks.logs.truncationDepth