Delen via

Databricks-stuurprogramma voor SQLTools voor Visual Studio Code

  • Artikel

Belangrijk

Deze functie is beschikbaar als openbare preview.

Met het Databricks-stuurprogramma voor SQLTools kunt u de SQLTools-extensie voor Visual Studio Code gebruiken om door SQL-objecten te bladeren en SQL-query's uit te voeren in externe Azure Databricks-werkruimten.

Voordat u begint

Voordat u het Databricks-stuurprogramma voor SQLTools kunt gebruiken, moeten uw Azure Databricks-werkruimte en uw lokale ontwikkelcomputer aan de volgende vereisten voldoen.

Werkruimtevereisten

U moet ten minste één Azure Databricks-werkruimte beschikbaar hebben en de werkruimte moet voldoen aan de volgende vereisten:

  • De werkruimte moet ten minste één Databricks SQL-warehouse bevatten.

    Notitie

    Azure Databricks-clusters worden niet ondersteund door het Databricks-stuurprogramma voor SQLTools.

  • Voor werkruimten die zijn ingeschakeld voor Unity Catalog, moet de werkruimte ten minste één catalogus bevatten, met ten minste één schema (formeel een database genoemd) in die catalogus.

  • Voor werkruimten die niet zijn ingeschakeld voor Unity Catalog, moet de werkruimte ten minste één schema bevatten (voorheen een database genoemd).

Vereisten voor lokale ontwikkelcomputers

U moet het volgende hebben op uw lokale ontwikkelcomputer:

Als u de SQLTools-extensie wilt installeren, gaat u naar SQLTools en klikt u op Installeren of:

  1. Klik in Visual Studio Code op Extensies weergeven > in het hoofdmenu.

  2. Voer in het vak Zoekextensies in Marketplace de tekst in SQLTools.

  3. Klik op de VERMELDING SQLTools van Matheus Teixeira.

    Notitie

    Er worden mogelijk meerdere SQLTools-vermeldingen vermeld. Klik op de vermelding van Matheus Teixeira.

  4. Klik op Install.

Als u het Databricks-stuurprogramma voor SQLTools-extensie wilt installeren, gaat u naar Het Databricks-stuurprogramma voor SQLTools en klikt u vervolgens op Installeren, of:

  1. Klik in Visual Studio Code op Extensies weergeven > in het hoofdmenu.
  2. Voer in het vak Zoekextensies in Marketplace de tekst in Databricks Driver for SQLTools.
  3. Klik op het Databricks-stuurprogramma voor SQLTools - vermelding.
  4. Klik op Install.

Verificatie

U moet als volgt verificatie instellen voor het Databricks-stuurprogramma voor SQLTools.

Het Databricks-stuurprogramma voor SQLTools ondersteunt de volgende Azure Databricks-verificatietypen:

Notitie

Het Databricks-stuurprogramma voor SQLTools biedt geen ondersteuning voor Microsoft Entra ID-tokens.

Verificatie van persoonlijke toegangstokens van Azure Databricks

Als u het Databricks-stuurprogramma voor SQLTools wilt gebruiken met persoonlijke toegangstokenverificatie van Azure Databricks, moet u een persoonlijk toegangstoken van Azure Databricks hebben. Ga als volgt te werk om een persoonlijk toegangstoken te maken:

  1. Klik in uw Azure Databricks-werkruimte op uw Azure Databricks-gebruikersnaam in de bovenste balk en selecteer vervolgens Instellingen in de vervolgkeuzelijst.
  2. Klik op Ontwikkelaars.
  3. Klik naast Access-tokens op Beheren.
  4. Klik op Nieuw token genereren.
  5. (Optioneel) Voer een opmerking in waarmee u dit token in de toekomst kunt identificeren en de standaardlevensduur van het token van 90 dagen kunt wijzigen. Als u een token zonder levensduur wilt maken (niet aanbevolen), laat u het vak Levensduur (dagen) leeg (leeg).
  6. Klik op Genereren.
  7. Kopieer het weergegeven token naar een veilige locatie en klik vervolgens op Gereed.

Notitie

Zorg ervoor dat u het gekopieerde token op een veilige locatie opslaat. Deel uw gekopieerde token niet met anderen. Als u het gekopieerde token kwijtraakt, kunt u dat token niet opnieuw genereren. In plaats daarvan moet u deze procedure herhalen om een nieuw token te maken. Als u het gekopieerde token kwijtraakt of als u denkt dat het token is aangetast, raadt Databricks u ten zeerste aan dat u dat token onmiddellijk uit uw werkruimte verwijdert door te klikken op het prullenbakpictogram (Intrekken) naast het token op de pagina Toegangstokens .

Als u geen tokens in uw werkruimte kunt maken of gebruiken, kan dit komen doordat uw werkruimtebeheerder tokens heeft uitgeschakeld of u geen toestemming hebt gegeven om tokens te maken of te gebruiken. Raadpleeg uw werkruimtebeheerder of de volgende onderwerpen:

Verificatie van Azure Databricks OAuth-machine-to-machine (M2M)

U kunt azure Databricks OAuth-verificatie van machine-naar-machine (M2M) gebruiken om te verifiëren met het Databricks-stuurprogramma voor SQLTools, als volgt:

Notitie

Azure Databricks OAuth M2M-verificatie is beschikbaar in Databricks Driver voor SQLTools-versies 0.4.2 en hoger.

  1. Voltooi de configuratiestappen voor OAuth M2M-verificatie. Zie verificatie van OAuth-machine-naar-machine (M2M).
  2. Maak een Azure Databricks-configuratieprofiel met de configuratie-instellingen voor OAuth M2M-verificatie. Zie de sectie 'Config' van verificatie van OAuth-machine-to-machine (M2M).
  3. Installeer en open de Databricks-extensie voor Visual Studio Code op uw lokale ontwikkelcomputer.
  4. Klik in de Databricks-extensie voor Visual Studio Code op de knop Configureren in het deelvenster Configuratie . Als de knop Configureren niet wordt weergegeven, klikt u in plaats daarvan op het tandwielpictogram (Werkruimte configureren).
  5. Voer in het opdrachtpalet voor Databricks Host bijvoorbeeld https://adb-1234567890123456.7.azuredatabricks.netde URL van uw Azure Databricks per werkruimte in en druk op Enter.
  6. Selecteer de vermelding van het configuratieprofiel die overeenkomt met de vermelding die u in stap 2 hebt gemaakt.
  7. Voltooi de instructies op het scherm in uw webbrowser om de verificatie met uw Azure Databricks-account te voltooien.

Verificatie van Azure Databricks OAuth-gebruiker naar machine (U2M)

U kunt azure Databricks OAuth-verificatie van gebruikers-naar-machine (U2M) gebruiken om te verifiëren met het Databricks-stuurprogramma voor SQLTools, als volgt:

Notitie

Azure Databricks OAuth U2M-verificatie is beschikbaar in Databricks Driver voor SQLTools-versies 0.4.2 en hoger.

  1. Installeer en open de Databricks-extensie voor Visual Studio Code op uw lokale ontwikkelcomputer.
  2. Klik in de Databricks-extensie voor Visual Studio Code op de knop Configureren in het deelvenster Configuratie . Als de knop Configureren niet wordt weergegeven, klikt u in plaats daarvan op het tandwielpictogram (Werkruimte configureren).
  3. Voer in het opdrachtenpalet voor Databricks Host bijvoorbeeld https://adb-1234567890123456.7.azuredatabricks.netde URL van uw Azure Databricks per werkruimte in. Druk vervolgens op Enter.
  4. Selecteer OAuth (gebruiker naar computer).
  5. Voltooi de instructies op het scherm in uw webbrowser om de verificatie met uw Azure Databricks-account te voltooien. Als u hierom wordt gevraagd, staat u toegang toe all-apis .

Azure CLI-verificatie

U kunt de Azure CLI als volgt gebruiken om te verifiëren met het Databricks-stuurprogramma voor SQLTools:

Notitie

Verificatie met de Azure CLI heeft een experimentele functiestatus. Deze functie is beschikbaar in Databricks Driver voor SQLTools-versies 0.4.2 en hoger.

  1. Installeer de Azure CLI op uw lokale ontwikkelcomputer als u dit nog niet hebt gedaan.
  2. Installeer en open de Databricks-extensie voor Visual Studio Code op uw lokale ontwikkelcomputer.
  3. Klik in de Databricks-extensie voor Visual Studio Code op de knop Configureren in het deelvenster Configuratie . Als de knop Configureren niet wordt weergegeven, klikt u in plaats daarvan op het tandwielpictogram (Werkruimte configureren).
  4. Voer in het opdrachtenpalet voor Databricks Host bijvoorbeeld https://adb-1234567890123456.7.azuredatabricks.netde URL van uw Azure Databricks per werkruimte in. Druk vervolgens op Enter.
  5. Selecteer Azure CLI.
  6. Volg de aanwijzingen op het scherm om de verificatie met de Azure CLI te voltooien.

Verbinding maken met een schema

  1. Klik in Visual Studio Code op de zijbalk op het pictogram SQLTools .
  2. Als dit de eerste keer is dat u de SQLTools-extensie gebruikt, klikt u in de weergave SQLTools op Nieuwe verbinding toevoegen in het deelvenster Verbindingen . Klik anders op het pictogram Nieuwe verbinding toevoegen in de titelbalk van het deelvenster.
  3. Klik op het tabblad SQLTools-instellingen voor de stap Een databasestuurprogramma selecteren op het databricks-pictogram .
  4. Voer voor de stap Verbindingsinstellingen de volgende informatie in over uw magazijn, catalogus en schema:

    1. Voer voor verbindingsnaam een unieke naam in voor deze verbinding.

    2. (Optioneel) Voer voor de verbindingsgroep de naam in van een bestaande verbindingsgroep om de nieuwe verbinding aan die groep toe te voegen. U kunt ook een unieke naam opgeven om een nieuwe verbindingsgroep met de nieuwe verbinding te maken. Verbindingsgroepen maken het gemakkelijker om verbindingen in de extensie te vinden.

    3. Selecteer een van de volgende opties voor Verbinding maken met behulp van:

      • Als u een persoonlijk toegangstoken van Azure Databricks wilt gebruiken voor verificatie, selecteert u Hostnaam en Token.
      • Voor Databricks-stuurprogramma voor SQLTools-versies 0.4.2 en hoger selecteert u VS Code-extensie (bèta) om OAuth U2M- of M2M- of Azure CLI-verificatie te gebruiken.

    4. Als u Hostnaam en Token hebt geselecteerd voor Verbinding maken met behulp van host, voert u voor Host de instelling serverhostnaam van het magazijn in. Zie Verbindingsgegevens ophalen voor een Azure Databricks-rekenresource om de hostnaaminstelling van een magazijnserver op te halen.

    5. Voer bij Pad de HTTP-padinstelling van het magazijn of het cluster in. Zie Verbindingsgegevens ophalen voor een Azure Databricks-rekenresource om de instelling voor het HTTP-pad van een magazijn op te halen.

    6. Als u Hostname en Token hebt geselecteerd voor Verbinding maken met behulp van, voert u de persoonlijke toegangstokenwaarde van Azure Databricks in token in.

    7. Voer voor Catalogus de naam van uw catalogus in.

      Notitie

      Voor werkruimten die niet zijn ingeschakeld voor Unity Catalog, kunt u Catalogus leeg laten om de standaardwaarde van hive_metastore.

    8. Voer voor Schema de naam van uw schema in.

    9. (Optioneel) Voor Standaardlimiet records weergeven laat u de standaardwaarde 50alleen weergeven tot de eerste 50 rijen voor elke query of voert u een andere limiet in.

  5. Klik op Verbinding testen.
  6. Als de verbindingstest is geslaagd, klikt u op Verbinding opslaan.

De instellingen van een verbinding wijzigen

In deze procedure wordt ervan uitgegaan dat u verbinding hebt gemaakt met ten minste één magazijn.

  1. Als de weergave SQLTools niet zichtbaar is, klikt u in Visual Studio Code op de zijbalk op het pictogram SQLTools .
  2. Vouw in het deelvenster Verbindingen de verbindingsgroep uit, als deze bestaat voor de doelverbinding.
  3. Klik met de rechtermuisknop op de verbinding en klik op Verbinding bewerken.
  4. Wijzig de doelinstellingen.
  5. Klik op Verbinding testen.
  6. Als de verbindingstest is geslaagd, klikt u op Verbinding opslaan.

Door de objecten van een schema bladeren

  1. Vouw in het deelvenster Verbindingen de verbindingsgroep uit, als deze bestaat voor de doelverbinding.
  2. Dubbelklik of vouw de doelverbinding voor uw magazijn uit.
  3. Vouw de doeldatabase (schema) uit als er een bestaat voor uw verbinding.
  4. Vouw tabellen of weergaven uit als er een of meer tabellen of weergaven bestaan voor uw database (schema).
  5. Vouw een doeltabel of -weergave uit om de kolommen van de tabel of weergave weer te geven.

De rijen of het schema voor een tabel of weergave weergeven

Voer een van de volgende handelingen uit wanneer tabellen of weergaven zijn uitgevouwen in het deelvenster Verbindingen :

  • Als u de rijen van de tabel of weergave wilt weergeven, klikt u met de rechtermuisknop op de tabel of weergave en klikt u op Tabelrecords weergeven of Weergaverecords weergeven.
  • Als u het schema van de tabel of weergave wilt weergeven, klikt u met de rechtermuisknop op de tabel of weergave en klikt u op Tabel beschrijven of Weergave beschrijven.

Een invoegquery voor een tabel genereren

  1. Plaats de cursor in een bestaande editor op de locatie waar u de invoegquery wilt toevoegen.
  2. Als tabellen zijn uitgevouwen in het deelvenster Verbindingen, klikt u met de rechtermuisknop op de tabel en klikt u op Query invoegen genereren. De definitie van de invoegquery wordt toegevoegd aan de invoegpositie van de cursor.

Een query maken en uitvoeren

In deze procedure wordt ervan uitgegaan dat u verbinding hebt gemaakt met ten minste één magazijn.

  1. Vouw in het deelvenster Verbindingen de verbindingsgroep uit, als deze bestaat voor de doelverbinding.
  2. Dubbelklik of vouw de doelverbinding voor uw magazijn uit.
  3. Klik terwijl de verbinding is geselecteerd op Nieuw SQL-bestand in de titelbalk van het deelvenster Verbindingen . Er wordt een nieuw tabblad editor weergegeven.
  4. Voer uw SQL-query in de nieuwe editor in.
  5. Als u de SQL-query wilt uitvoeren, klikt u op Uitvoeren op actieve verbinding in de editor. De resultaten van de query worden weergegeven op een nieuw editortabblad.

Een bestaande query uitvoeren

In deze procedure wordt ervan uitgegaan dat u verbinding hebt gemaakt met ten minste één magazijn.

  1. Vouw in het deelvenster Verbindingen de verbindingsgroep uit, als deze bestaat voor de doelverbinding.
  2. Dubbelklik of vouw de doelverbinding voor uw magazijn uit.
  3. Als de verbinding is geselecteerd, opent u een bestand met de bestandsextensie of .sqlselecteert u een groep doorlopende SQL-instructies in een editor die eerder is geopend.
  4. Als u de SQL-query wilt uitvoeren vanuit een geopend .sql bestand, klikt .sql u in de editor op Uitvoeren op actieve verbinding in de editor. De resultaten van de query worden weergegeven op een nieuw editortabblad.
  5. Als u een geselecteerde groep continue SQL-instructies wilt uitvoeren in een editor die eerder is geopend, klikt u met de rechtermuisknop op de selectie en klikt u vervolgens op Geselecteerde query uitvoeren. De resultaten van de query worden weergegeven op een nieuw editortabblad.

Gebruikslogboeken verzenden naar Databricks

Als u problemen ondervindt tijdens het gebruik van het Databricks-stuurprogramma voor SQLTools, kunt u gebruikslogboeken en gerelateerde informatie verzenden naar Databricks Support door het volgende te doen:

  1. Installeer de Databricks-extensie voor Visual Studio Code op uw lokale ontwikkelcomputer.
  2. Schakel logboekregistratie in door de logboeken te controleren: Instelling ingeschakeld of ingesteld databricks.logs.enabled trueop , zoals beschreven in Instellingen voor de Databricks-extensie voor Visual Studio Code , zorg ervoor dat u Visual Studio Code opnieuw start nadat u logboekregistratie hebt ingeschakeld.
  3. Probeer uw probleem te reproduceren.
  4. Voer vanuit het opdrachtpalet (Opdrachtpalet weergeven > vanuit het hoofdmenu) de opdracht Databricks: Open de opdracht Volledige logboeken uit.
  5. Verzend de Databricks Logs.log, databricks-cli-logs.jsonen sdk-and-extension-logs.json bestanden die naar databricks-ondersteuning worden weergegeven.
  6. Kopieer ook de inhoud van de Terminal (View > Terminal) in de context van het probleem en verzend deze inhoud naar Databricks Support.

In de uitvoerweergave (Uitvoer weergeven, Databricks-logboeken) worden afgekapte gegevens weergegeven als Logboeken: Ingeschakeld is ingeschakeld of databricks.logs.enabled is ingesteld op true.> Als u meer informatie wilt weergeven, wijzigt u de volgende instellingen, zoals beschreven in Instellingen voor de Databricks-extensie voor Visual Studio Code:

  • Logboeken: Maximale matrixlengte of databricks.logs.maxArrayLength
  • Logboeken: Maximale veldlengte of databricks.logs.maxFieldLength
  • Logboeken: Afkappingsdiepte of databricks.logs.truncationDepth

Aanvullende bronnen