Databricks Driver for SQLTools for Visual Studio Code

  • Cikk

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:

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:

  1. A Visual Studio Code-ban kattintson a Bővítmények megtekintése > elemre a főmenüben.

  2. A Marketplace Keresési bővítmények mezőjébe írja be a következőtSQLTools:

  3. 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.

  4. 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:

  1. A Visual Studio Code-ban kattintson a Bővítmények megtekintése > elemre a főmenüben.
  2. A Marketplace Keresési bővítmények mezőjébe írja be a következőtDatabricks Driver for SQLTools:
  3. Kattintson az SQLTools databricks-illesztőprogramjának bejegyzésére.
  4. 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:

Feljegyzés

Az SQLTools Databricks-illesztőprogramja nem támogatja a Microsoft Entra ID (korábbi nevén Azure Active Directory) 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:

  1. Az Azure Databricks-munkaterületen kattintson az Azure Databricks-felhasználónevére a felső sávon, majd válassza Gépház a legördülő menüből.
  2. Kattintson a Fejlesztőeszközök elemre.
  3. Az Access-jogkivonatok mellett kattintson a Kezelés gombra.
  4. Kattintson az Új jogkivonat létrehozása elemre.
  5. (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).
  6. Kattintson a Létrehozás lehetőségre.
  7. 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ő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.

  1. 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.
  2. 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.
  3. Telepítse és nyissa meg a Visual Studio Code Databricks bővítményét a helyi fejlesztői gépen.
  4. 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.
  5. A Databricks Host parancskatalógusában adja meg például https://adb-1234567890123456.7.azuredatabricks.netaz Azure Databricks munkaterületenkénti URL-címét, majd nyomja le az Enter billentyűt.
  6. Válassza ki azt a konfigurációs profilbejegyzést, amely megfelel a 2. lépésben létrehozottnak.
  7. 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.

  1. Telepítse és nyissa meg a Visual Studio Code Databricks bővítményét a helyi fejlesztői gépen.
  2. 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.
  3. A Databricks Host parancskatalógusában adja meg például https://adb-1234567890123456.7.azuredatabricks.netaz Azure Databricks munkaterületenkénti URL-címét. Nyomja le az Enter billentyűt.
  4. Válassza az OAuth (felhasználó a géphez) lehetőséget.
  5. 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.

  1. Ha még nem tette meg, telepítse az Azure CLI-t a helyi fejlesztőgépre.
  2. Telepítse és nyissa meg a Visual Studio Code Databricks bővítményét a helyi fejlesztői gépen.
  3. 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.
  4. A Databricks Host parancskatalógusában adja meg például https://adb-1234567890123456.7.azuredatabricks.netaz Azure Databricks munkaterületenkénti URL-címét. Nyomja le az Enter billentyűt.
  5. Válassza az Azure CLI-t.
  6. Kövesse a képernyőn megjelenő utasításokat az Azure CLI hitelesítésének befejezéséhez.

Csatlakozás sémába

  1. A Visual Studio Code oldalsávján kattintson az SQLTools ikonra.
  2. Az SQLTools nézetben, ha először használja az SQLTools bővítményt, kattintson az Új Csatlakozás ion hozzáadása elemre a Csatlakozás ions panelen. Ellenkező esetben kattintson az Új Csatlakozás ion hozzáadása ikonra a panel címsorában.
  3. Az SQLTools Gépház lapon az Adatbázis-illesztőprogram kiválasztása lépésnél kattintson a Databricks ikonra.
  4. A Csatlakozás ion Gépház 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:

    1. A Csatlakozás ion névhez adjon meg egy egyedi nevet ehhez a kapcsolathoz.

    2. (Nem kötelező) A Csatlakozás ion csoportnál adja meg egy meglévő kapcsolatcsoport nevét, hogy hozzáadja az új kapcsolatot az adott csoporthoz. Vagy adjon meg egy egyedi nevet, ha új kapcsolatcsoportot szeretne létrehozni az új kapcsolattal. Csatlakozás ion csoportok megkönnyítik a bővítményben lévő kapcsolatok megtalálását.

    3. Ha Csatlakozás használ, válasszon az alábbiak 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ó).

    4. Ha a gazdagépnevet és a jogkivonatot választotta a Csatlakozás használatához, 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.

    5. 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.

    6. Ha a Hostname és a Token lehetőséget választotta Csatlakozás használatához, adja meg az Azure Databricks személyes hozzáférési jogkivonat értékét a Tokenben.

    7. 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_metastoreaz alapértelmezett értéket.

    8. Séma esetén adja meg a séma nevét.

    9. (Nem kötelező) A Rekordok alapértelmezett korlátjának50 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.

  5. Kattintson a Kapcsolat tesztelése elemre.
  6. Ha a kapcsolatteszt sikeres, kattintson a Save Csatlakozás ion (Mentés Csatlakozás ion) 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.

  1. Ha az SQLTools nézet nem látható, akkor a Visual Studio Code oldalsávján kattintson az SQLTools ikonra.
  2. A Csatlakozás ions panelen bontsa ki a kapcsolatcsoportot, ha létezik ilyen a célkapcsolathoz.
  3. Kattintson a jobb gombbal a kapcsolatra, és válassza a Szerkesztés Csatlakozás ion parancsot.
  4. Módosítsa a célbeállításokat.
  5. Kattintson a Kapcsolat tesztelése elemre.
  6. Ha a kapcsolatteszt sikeres, kattintson a Save Csatlakozás ion (Mentés Csatlakozás ion) gombra.

Sémaobjektumok tallózása

  1. A Csatlakozás ions panelen bontsa ki a kapcsolatcsoportot, ha létezik ilyen a célkapcsolathoz.
  2. Kattintson vagy bontsa ki duplán a raktár célkapcsolatát.
  3. Bontsa ki a céladatbázist (sémát), ha létezik ilyen a kapcsolathoz.
  4. 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).
  5. 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 kibontva a Csatlakozás ions 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ázatvagy a Nézet leírása parancsra.

Lekérdezés beszúrása táblázathoz

  1. Helyezze a kurzort egy meglévő szerkesztőbe arra a helyre, ahová be szeretné szúrni a lekérdezést.
  2. Ha a Táblák kibontva van a Csatlakozás ions panelen, kattintson a jobb gombbal a táblára, és válassza a Lekérdezés beszúrása parancsot. 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.

  1. A Csatlakozás ions panelen bontsa ki a kapcsolatcsoportot, ha létezik ilyen a célkapcsolathoz.
  2. Kattintson vagy bontsa ki duplán a raktár célkapcsolatát.
  3. Ha a kapcsolat ki van jelölve, kattintson az Új SQL-fájlra a Csatlakozás ions panel címsorában. Megjelenik egy új szerkesztőlap.
  4. Írja be az SQL-lekérdezést az új szerkesztőbe.
  5. 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.

  1. A Csatlakozás ions panelen bontsa ki a kapcsolatcsoportot, ha létezik ilyen a célkapcsolathoz.
  2. Kattintson vagy bontsa ki duplán a raktár célkapcsolatát.
  3. 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.
  4. 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.
  5. 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:

  1. Telepítse a Visual Studio Code Databricks-bővítményét a helyi fejlesztőgépre.
  2. Kapcsolja be a naplózást a Naplók: Engedélyezett beállítás vagy beállítás beállításával databricks.logs.enabledtruea Visual Studio Code Databricks bővítményének Gépház leírtak szerint. A naplózás bekapcsolása után mindenképpen indítsa újra a Visual Studio Code-ot.
  3. Próbálja meg reprodukálni a problémát.
  4. A parancskatalógusban (a főmenü parancskatalógusának megtekintése>) futtassa a Databricks: Open full logs parancsot.
  5. Küldje el a Databricks Logs.logDatabricks támogatási szolgálatának megjelenő , databricks-cli-logs.jsonés sdk-and-extension-logs.json fájlokat.
  6. 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 Gépház 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

További erőforrások