Databricks Driver for SQLTools för Visual Studio Code

Viktigt

Den här funktionen finns som offentlig 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.

Requirements

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 arbetsytan

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

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ök efter tillägg i Marketplace anger du SQLTools.

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

    Obs!

    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 i huvudmenyn.
  2. I rutan Sök efter tillägg på Marketplace anger du Databricks Driver for SQLTools.
  3. Klicka på posten Databricks-drivrutin för SQLTools.
  4. Klicka på Install.

Autentisering

Du måste konfigurera autentisering för Databricks-drivrutinen för SQLTools enligt följande.

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

Obs!

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 Skapa personliga åtkomsttoken för arbetsyteanvändare.

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

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

Obs!

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 OAuth machine-to-machine (M2M)-autentisering.
  3. Installera och öppna Databricks-tillägget för Visual Studio Code på din lokala utvecklingsdator.
  4. I Databricks IDE-tillägget, klicka på Konfigurera-knappen i konfigurationspanelen. Om knappen Konfigurera inte visas klickar du på kugghjulsikonen (Konfigurera arbetsyta) i stället.
  5. I Kommandopaletten, för Databricks Host, anger du Azure Databricks-URL per arbetsyta, till exempel https://adb-1234567890123456.7.azuredatabricks.net, och trycker sedan på Retur.
  6. Välj den konfigurationsprofilpost som matchar den som du skapade i steg 2.
  7. Slutför autentiseringen med ditt Azure Databricks-konto genom att följa anvisningarna på skärmen i webbläsaren.

Azure Databricks OAuth-autentisering användare-till-maskin (U2M)

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

Obs!

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 IDE-tillägget, klicka på knappen Konfigurera i rutan Konfiguration. Om knappen Konfigurera inte visas klickar du på kugghjulsikonen (Konfigurera arbetsyta) i stället.
  3. I kommandopaletten anger du för Databricks Host din Azure Databricks-URL per arbetsyta, till exempel https://adb-1234567890123456.7.azuredatabricks.net. Tryck sedan på Enter.
  4. Välj OAuth (användare till dator).
  5. Slutför autentiseringen med ditt Azure Databricks-konto genom att följa anvisningarna på skärmen i webbläsaren. Tillåt all-apis åtkomst om du uppmanas att göra 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:

Obs!

Autentisering med Azure CLI är en experimentell funktion. 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 IDE-tillägget klickar du på Konfigurera-knappen i konfigurationspanelen. Om knappen Konfigurera inte visas klickar du på kugghjulsikonen (Konfigurera arbetsyta) i stället.
  4. I kommandopaletten för Databricks Host anger du Azure Databricks-URL för arbetsytan, till exempel https://adb-1234567890123456.7.azuredatabricks.net. Tryck sedan på Enter.
  5. Välj Azure CLI.
  6. Följ anvisningarna på skärmen för att slutföra autentiseringen med Azure CLI.

Anslut till ett schema

  1. I Visual Studio Code klickar du på ikonen SQLTools i sidofältet.

  2. I vyn SQLTools klickar du, om det här är första gången du använder SQLTools-tillägget, på Lägg till ny anslutning i fönstret Anslutningar. Annars klickar du på ikonen Lägg till ny anslutning i fönstrets namnlist.

  3. På fliken SQLTools Settings klickar du på ikonen Databricks för steget Välj en databasdrivrutin.

  4. I steget Anslutningsinställningar anger du följande information om ditt lager, din katalog och ditt schema:

    1. För 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 anslutningar i tillägget.
    1. Välj något av följande för Anslut via:
      • Om du vill använda en personlig Åtkomsttoken för Azure Databricks för autentisering väljer du Värdnamn och Token.
      • För Databricks-drivrutin för SQLTools-versioner 0.4.2 och senare väljer du VS Code-tillägg (beta) för att använda OAuth U2M- eller M2M- eller Azure CLI-autentisering.

    1. Om du har valt Värdnamn och Token för Anslut med, ange lagerplatsens serverns värdnamn inställningar för Värd. För att hämta inställningen för ett lagers servervärdnamn, se Hämta anslutningsinformation för en Azure Databricks-beräkningsresurs.

    2. För Sökväg anger du lagrets eller klustrets HTTP-sökväg. Information om hur du hämtar ett lagers HTTP-sökväg finns i Hämta anslutningsinformation för en Azure Databricks-beräkningsresurs.

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

    4. För Catalog, ange namnet på din katalog.

      Obs!

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

    5. För Schema, ange namnet på ditt schema.

    6. (Valfritt) För Visa posters standardgräns låter du standardvärdet 50 visa upp till de första 50 raderna för varje fråga eller anger en annan gräns.

  5. Klicka på Testa anslutning.

  6. Om anslutningstestet lyckas, klicka 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 sidofältet i Visual Studio Code.
  2. I rutan Anslutningar 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 anslutningen.
  6. Om anslutningstestet lyckas klickar du på Spara anslutning.

Bläddra bland ett schemas objekt

  1. I fönstret Anslutningar expanderar du anslutningsgruppen, om det finns någon för målanslutningen.
  2. Dubbelklicka på målanslutningen eller expandera den för ditt lager.
  3. Expandera måldatabasen (schemat), om det finns en för anslutningen.
  4. Expandera Tabeller eller vyer om det finns en eller flera tabeller eller vyer för databasen (schema).
  5. Expandera valfri måltabell eller vy för att visa tabellens eller vyns kolumner.

Visa raderna eller schemat för en tabell eller vy

När Tabeller eller vyer har expanderats i fönstret Anslutningar gör du något av följande:

  • Om du vill visa tabellens eller vyns rader högerklickar du på tabellen eller vyn och klickar på Visa tabellposter eller Visa vyposter.
  • Om du vill visa tabellens eller vyns schema högerklickar du på tabellen eller vyn och klickar på Beskriv tabell eller Beskriv vy.

Generera en insert-fråga för en tabell

  1. Placera markören i en befintlig redigerare på den plats där du vill att infogningsfrågan ska läggas till.
  2. När Tabeller har expanderats i fönstret Anslutningar högerklickar du på tabellen och klickar på Generate Insert Query. Definitionen av infogningsfrågan läggs till vid markörens insättningspunkt.

Skapa och kör en fråga

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

  1. I rutan Anslutningar expanderar du anslutningsgruppen, om det finns någon för målanslutningen.
  2. Dubbelklicka på målanslutningen eller expandera den för ditt lager.
  3. När anslutningen är markerad klickar du på Ny SQL-fil i fönstret Anslutningars 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 på aktiv anslutning i redigeraren. Frågans resultat visas på en ny redigeringsflik.

Kör en befintlig fråga

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

  1. I fönstret Anslutningar expanderar du anslutningsgruppen, om det finns någon för målanslutningen.
  2. Dubbelklicka eller expandera målanslutningen för ditt lager.
  3. När anslutningen är markerad öppna valfri fil med filnamnstillägget .sql, eller välj någon grupp med kontinuerliga SQL-instruktioner i valfri redigerare som öppnades tidigare.
  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 Continuous SQL-satser i en redigerare som tidigare öppnats högerklickar du på ditt val och klickar sedan på Kör markerad 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. Slå på loggning genom att markera inställningen Loggar: Aktiverad, eller genom att ställa in databricks.logs.enabled på true, som beskrivs i Inställningar för Databricks IDE-tillägg. Se till att starta om Visual Studio Code efter att du 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 de filer Databricks Logs.log, databricks-cli-logs.json och sdk-and-extension-logs.json som visas till Databricks-supporten.
  6. Kopiera även innehållet i Terminal (visa > terminalen) i samband med problemet och skicka det här innehållet till Databricks-supporten.

Utdatavyn (Visa > utdata, Databricks-loggar) visar trunkerad information om Loggar: Aktiverad är markerat eller är inställt på . För att visa mer information, ändra följande inställningar, som beskrivs i Inställningar för Databricks IDE-tillägg:

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

Ytterligare resurser

  • Uppdaterades senast