Dela via

Databricks-drivrutin för SQLTools för Visual Studio Code

  • Artikel

Viktigt!

Den här funktionen finns som allmänt tillgänglig förhandsversion.

Med Databricks-drivrutinen för SQLTools kan du använda SQLTools-tillägget för Visual Studio Code för att bläddra i SQL-objekt och köra SQL-frågor på azure Databricks-fjärrarbetsytor.

Innan du börjar

Innan du kan använda Databricks-drivrutinen för SQLTools måste din Azure Databricks-arbetsyta och din lokala utvecklingsdator uppfylla följande krav.

Krav för arbetsyta

Du måste ha minst en Azure Databricks-arbetsyta tillgänglig och arbetsytan måste uppfylla följande krav:

  • Arbetsytan måste innehålla minst ett Databricks SQL-lager.

    Kommentar

    Azure Databricks-kluster stöds inte av Databricks-drivrutinen för SQLTools.

  • För arbetsytor som är aktiverade för Unity Catalogmåste arbetsytan innehålla minst en catalog, med minst en schema (kallas formellt en databas) i den catalog.

  • För arbetsytor som inte är aktiverade för Unity Catalogmåste arbetsytan innehålla minst en schema (kallades tidigare en databas).

Krav för lokala utvecklingsdatorer

Du måste ha följande på din lokala utvecklingsdator:

Om du vill installera SQLTools-tillägget går du till SQLTools och klickar sedan på Installera, eller:

  1. I Visual Studio Code klickar du på Visa > tillägg på huvudmenyn.

  2. I rutan Söktillägg på Marketplace anger du SQLTools.

  3. Klicka på posten SQLTools från Matheus Teixeira.

    Kommentar

    Det kan finnas flera SQLTools-poster i listan. Se till att klicka på posten från Matheus Teixeira.

  4. Klicka på Installera.

Om du vill installera Databricks-drivrutinen för SQLTools-tillägget går du till Databricks-drivrutinen för SQLTools och klickar sedan på Installera, eller:

  1. I Visual Studio Code klickar du på Visa > tillägg på huvudmenyn.
  2. I rutan Söktillägg på Marketplace anger du Databricks Driver for SQLTools.
  3. Klicka på posten Databricks-drivrutin för SQLTools.
  4. Klicka på Installera.

Autentisering

Du måste set upp autentiseringen för Databricks-drivrutinen för SQLTools enligt följande.

Databricks-drivrutinen för SQLTools stöder följande Azure Databricks-autentiseringstyper:

Kommentar

Databricks-drivrutinen för SQLTools stöder inte Microsoft Entra ID-token.

Personlig åtkomsttokenautentisering i Azure Databricks

Om du vill använda Databricks-drivrutinen för SQLTools med personlig åtkomsttokenautentisering i Azure Databricks måste du ha en personlig åtkomsttoken för Azure Databricks. Om du vill skapa en personlig åtkomsttoken följer du stegen i Personliga åtkomsttoken för Azure Databricks för arbetsyteanvändare.

Azure Databricks OAuth-autentisering från dator till dator (M2M)

Du kan använda autentisering med Azure Databricks OAuth från dator till dator (M2M) för att autentisera med Databricks-drivrutinen för SQLTools på följande sätt:

Kommentar

Azure Databricks OAuth M2M-autentisering är tillgängligt i Databricks Driver för SQLTools-versionerna 0.4.2 och senare.

  1. Slutför konfigurationsstegen för OAuth M2M-autentisering. Se OAuth-autentisering från dator till dator (M2M).
  2. Skapa en Azure Databricks-konfigurationsprofil med konfigurationsinställningarna för OAuth M2M-autentisering. Se avsnittet "Konfiguration" i M2M-autentisering (OAuth machine-to-machine).
  3. Installera och öppna Databricks-tillägget för Visual Studio Code på din lokala utvecklingsdator.
  4. I Databricks-tillägget för Visual Studio Code klickar du på knappen Konfigurera i fönstret Konfiguration . Om knappen Konfigurera inte visas klickar du på kugghjulsikonen (Konfigurera arbetsyta) i stället.
  5. I kommandopaletten för Databricks Host anger du url:en för Azure Databricks per arbetsyta, till exempel https://adb-1234567890123456.7.azuredatabricks.netoch trycker sedan på Retur.
  6. Select konfigurationsprofilposten som matchar den som du skapade i steg 2.
  7. Slutför autentisera med ditt Azure Databricks-konto genom att följa anvisningarna på skärmen i webbläsaren.

Azure Databricks OAuth-autentisering från användare till dator (U2M)

Du kan använda Azure Databricks OAuth-autentisering från användare till dator (U2M) för att autentisera med Databricks-drivrutinen för SQLTools på följande sätt:

Kommentar

Azure Databricks OAuth U2M-autentisering är tillgängligt i Databricks Driver för SQLTools version 0.4.2 och senare.

  1. Installera och öppna Databricks-tillägget för Visual Studio Code på din lokala utvecklingsdator.
  2. I Databricks-tillägget för Visual Studio Code klickar du på knappen Konfigurera i fönstret Konfiguration . Om knappen Konfigurera inte visas klickar du på kugghjulsikonen (Konfigurera arbetsyta) i stället.
  3. I kommandopaletten för Databricks Host anger du url:en för Azure Databricks per arbetsyta, till exempel https://adb-1234567890123456.7.azuredatabricks.net. Tryck sedan på RETUR.
  4. Select OAuth (användare till dator).
  5. Slutför autentisera med ditt Azure Databricks-konto genom att följa anvisningarna på skärmen i webbläsaren. Tillåt åtkomst om du uppmanas att göra all-apis det.

Azure CLI-autentisering

Du kan använda Azure CLI för att autentisera med Databricks-drivrutinen för SQLTools på följande sätt:

Kommentar

Autentiseringen med Azure CLI är i ett experimentellt funktionstillstånd . Den här funktionen är tillgänglig i Databricks Driver för SQLTools version 0.4.2 och senare.

  1. Installera Azure CLI på din lokala utvecklingsdator om du inte redan har gjort det.
  2. Installera och öppna Databricks-tillägget för Visual Studio Code på din lokala utvecklingsdator.
  3. I Databricks-tillägget för Visual Studio Code klickar du på knappen Konfigurera i fönstret Konfiguration . Om knappen Konfigurera inte visas klickar du på kugghjulsikonen (Konfigurera arbetsyta) i stället.
  4. I kommandopaletten för Databricks Host anger du url:en för Azure Databricks per arbetsyta, till exempel https://adb-1234567890123456.7.azuredatabricks.net. Tryck sedan på RETUR.
  5. Select Azure CLI.
  6. Följ anvisningarna på skärmen för att slutföra autentiseringen med Azure CLI.

Ansluta till en schema

  1. Klicka på ikonen SQLTools i sidofältet i Visual Studio Code.
  2. I vyn SQLTools klickar du på Lägg till ny anslutning i Connections fönstret om det är första gången du använder SQLTools-tillägget. Annars klickar du på ikonen Lägg till ny anslutning i fönstrets namnlist.
  3. På fliken SQLTools-inställningar, för steget Select en databasdrivrutin, klicka på ikonen Databricks.
  4. För anslutningsinställningar steg anger du följande information om ditt lager, catalogoch schema:

    1. Som Anslutningsnamn anger du ett unikt namn för den här anslutningen.

    2. (Valfritt) För Anslutningsgrupp anger du namnet på en befintlig anslutningsgrupp för att lägga till den nya anslutningen till den gruppen. Eller ange ett unikt namn för att skapa en ny anslutningsgrupp med den nya anslutningen. Anslutningsgrupper gör det enklare att hitta connections i tillägget.

    3. För att ansluta med hjälp av, använd något av följande: select

      • För att använda en personlig åtkomsttoken för autentisering i Azure Databricks: selectVärdnamn och Token.
      • För Databricks-drivrutiner för SQLTools-versioner 0.4.2 och senare måste du använda OAuth U2M- eller M2M-autentisering eller Azure CLI-autentisering via selectVS Code-tillägget (beta).

    4. Om du har valt Värdnamn och Token för Anslut med anger du för Värd lagerplatsens värdnamnsinställning för server. Information om hur du getservervärdnamn finns i Get anslutningsinformation för en Azure Databricks-beräkningsresurs.

    5. För Sökväg anger du informationslagrets eller klustrets HTTP-sökvägsinställning. Information om hur du get ett lagers HTTP-sökväg finns i Get anslutningsinformation för en Azure Databricks-beräkningsresurs.

    6. Om du har valt Värdnamn och Token för Anslut med anger du värdet för din personliga åtkomsttoken för Azure Databricks i Token.

    7. För Cataloganger du namnet på din catalog.

      Kommentar

      För arbetsytor som inte är aktiverade för Unity Catalogkan du lämna Catalog tom om du vill använda standardvärdet för hive_metastore.

    8. För Schemaanger du namnet på din schema.

    9. (Valfritt) För visa poster som standard limit, behåll standardvärdet 50 för att visa endast upp till de första 50 raderna för varje fråga, eller ange ett annat värde för limit.

  5. Klicka på Testa anslutning.
  6. Om anslutningstestet lyckas klickar du på Spara anslutning.

Ändra inställningarna för en anslutning

Den här proceduren förutsätter att du har anslutit till minst ett lager.

  1. Om SQLTools-vyn inte visas klickar du på IKONEN SQLTools i Visual Studio Code i sidofältet.
  2. I fönstret Connections expanderar du anslutningsgruppen om det finns någon för målanslutningen.
  3. Högerklicka på anslutningen och klicka på Redigera anslutning.
  4. Ändra målinställningarna.
  5. Klicka på Testa anslutning.
  6. Om anslutningstestet lyckas klickar du på Spara anslutning.

Bläddra bland schema:s objekt

  1. I fönstret Connections expanderar du anslutningsgruppen om det finns någon för målanslutningen.
  2. Dubbelklicka på eller expandera målanslutningen för ditt lager.
  3. Expandera måldatabasen (schema), om det finns en för din anslutning.
  4. Expandera Tables eller Viewsom det finns en eller flera tables eller views för databasen (schema).
  5. Expandera valfri table eller vy för att visa tableeller vyns columns.

Visa raderna eller schema för en table eller vy

När Tables eller Views expanderas i fönstret Connections gör du något av följande:

  • Om du vill visa raderna i tableeller vyn högerklickar du på table eller vyn och klickar på Visa Table poster eller Visa vyposter.
  • Om du vill visa tableeller vyns schemahögerklickar du på table eller vyn och klickar på Beskriv Table eller Beskriv vy.

Generate en insert sökfråga för en table

  1. Placera markören i en befintlig redigerare på den plats where du vill att insert frågan ska läggas till.
  2. När Tables expanderats i fönstret Connections högerklickar du på tableoch klickar på GenerateInsert Query. Definitionen för insert fråga läggs till vid markörens insättningspunkt.

Skapa och köra en fråga

Den här proceduren förutsätter att du har anslutit till minst ett lager.

  1. I fönstret Connections expanderar du anslutningsgruppen om det finns någon för målanslutningen.
  2. Dubbelklicka på eller expandera målanslutningen för ditt lager.
  3. När anslutningen är markerad klickar du på Ny SQL-fil i Connections-fönstrets namnlist. En ny redigeringsflik visas.
  4. Ange din SQL-fråga i den nya redigeraren.
  5. Om du vill köra SQL-frågan klickar du på Kör vid aktiv anslutning i redigeraren. Frågans resultat visas på en ny redigeringsflik.

Köra en befintlig fråga

Den här proceduren förutsätter att du har anslutit till minst ett lager.

  1. I fönstret Connections expanderar du anslutningsgruppen om det finns någon för målanslutningen.
  2. Dubbelklicka på eller expandera målanslutningen för ditt lager.
  3. När anslutningen är markerad öppnar du en fil med filnamnstillägget .sqleller select någon grupp med kontinuerliga SQL-instruktioner i alla redigeringsprogram som tidigare öppnats.
  4. Om du vill köra SQL-frågan från en öppen .sql fil, med .sql filens innehåll som visas i redigeraren, klickar du på Kör vid aktiv anslutning i redigeraren. Frågans resultat visas på en ny redigeringsflik.
  5. Om du vill köra en vald grupp med kontinuerliga SQL-instruktioner i ett redigeringsprogram som tidigare öppnats högerklickar du på ditt val och klickar sedan på Kör vald fråga. Frågans resultat visas på en ny redigeringsflik.

Skicka användningsloggar till Databricks

Om du stöter på problem när du använder Databricks-drivrutinen för SQLTools kan du skicka användningsloggar och relaterad information till Databricks-supporten genom att göra följande:

  1. Installera Databricks-tillägget för Visual Studio Code på din lokala utvecklingsdator.
  2. Aktivera loggning genom att kontrollera inställningen Loggar: Aktiverad eller inställningen databricks.logs.enabled till true, enligt beskrivningen i Inställningar för Databricks-tillägget för Visual Studio Code . Se till att starta om Visual Studio Code när du har aktiverat loggning.
  3. Försök återskapa problemet.
  4. Från kommandopaletten (Visa > kommandopaletten från huvudmenyn) kör du kommandot Databricks: Öppna fullständiga loggar.
  5. Skicka filerna Databricks Logs.log, databricks-cli-logs.jsonoch sdk-and-extension-logs.json som visas för Databricks-supporten.
  6. Kopiera även innehållet i terminalen (visa > terminalen) i samband med problemet och skicka det här innehållet till Databricks-supporten.

Vyn Utdata (View > Output, Databricks Logs) visar trunkerad information om Loggar: Aktiverad är markerad eller databricks.logs.enabledsettrue. Om du vill visa mer information ändrar du följande inställningar enligt beskrivningen i Inställningar för Databricks-tillägget för Visual Studio Code:

  • Loggar: Maximal matrislängd eller databricks.logs.maxArrayLength
  • Loggar: Maximal fältlängd eller databricks.logs.maxFieldLength
  • Loggar: Trunkeringsdjup eller databricks.logs.truncationDepth

Ytterligare resurser