Visual Studio Code를 위한 SQLTools용 Databricks 드라이버

SQLTools용 Databricks 드라이버를 사용하면 Visual Studio Code용 SQLTools 확장을 사용하여 SQL 개체를 찾아보고 원격 Azure Databricks 작업 영역에서 SQL 쿼리를 실행할 수 있습니다.

시작하기 전에

SQLTools용 Databricks 드라이버를 사용하려면 먼저 Azure Databricks 작업 영역과 로컬 개발 컴퓨터가 다음 요구 사항을 충족해야 합니다.

• 작업 영역 요구 사항:
• 로컬 개발 머신 요구 사항
• 인증
  • Azure Databricks 개인용 액세스 토큰 인증
  • Azure Databricks OAuth M2M(컴퓨터 대 컴퓨터) 인증
  • Azure Databricks OAuth U2M(사용자 대 컴퓨터) 인증
  • Azure CLI 인증

작업 영역 요구 사항:

하나 이상의 Azure Databricks 작업 영역을 사용할 수 있어야 하며 작업 영역이 다음 요구 사항을 충족해야 합니다.

• 작업 영역에 하나 이상의 Databricks SQL 웨어하우스가 포함되어야 합니다.

  참고 항목

  Azure Databricks 클러스터는 SQLTools용 Databricks 드라이버에서 지원되지 않습니다.

• Unity Catalog사용 설정이 된 작업 공간에는 하나 이상의 catalog이 포함되어야 하며, 그 catalog내에 최소 하나의 schema(공식적으로 데이터베이스라고 함)가 있어야 합니다.

  • 데이터베이스 개체를 검색합니다.
  • catalog 를 만드세요.
  • schema 를 제작합니다.

• Unity Catalog사용하도록 설정되지 않은 작업 영역의 경우 작업 영역에는 하나 이상의 schema(이전의 데이터베이스라고 함)가 포함되어야 합니다.

  • 데이터베이스 개체를 검색합니다.
  • schema 만듭니다.

로컬 개발 머신 요구 사항

로컬 개발 머신에 다음 항목이 있어야 합니다.

• Visual Studio Code 버전 1.70 이상. 설치된 버전을 보려면 Linux 또는 macOS의 경우 주 메뉴에서 코드 > Visual Studio Code 정보를 클릭하고, Windows의 경우 도움말 > 정보를 클릭합니다. Visual Studio Code를 다운로드하고, 설치하고, 구성하려면 Visual Studio Code 설정을 참조하세요.
• Visual Studio Code용 SQLTools 확장
• Visual Studio Code용 SQLTools용 Databricks 드라이버 확장

SQLTools 확장을 설치하려면 SQLTools로 이동한 다음, 설치를 클릭하거나 다음을 수행합니다.

1. Visual Studio Code의 주 메뉴에서 보기 > 확장을 클릭합니다.

2. 마켓플레이스에서 확장 검색 상자에 SQLTools를 입력합니다.

3. Matheus Teixeira에서 SQLTools 항목을 클릭합니다.

   참고 항목

   여러 SQLTools 항목이 나열될 수 있습니다. Matheus Teixeira에서 이 항목을 클릭해야 합니다.

4. 설치를 클릭합니다.

SQLTools용 Databricks 드라이버 확장을 설치하려면 SQLTools용 Databricks 드라이버로 이동한 다음, 설치를 클릭하거나 다음을 수행합니다.

1. Visual Studio Code의 주 메뉴에서 보기 > 확장을 클릭합니다.
2. 마켓플레이스에서 확장 검색 상자에 Databricks Driver for SQLTools를 입력합니다.
3. SQLTools용 Databricks 드라이버 항목을 클릭합니다.
4. 설치를 클릭합니다.

인증

다음과 같이 Databricks Driver for SQLTools에 대한 인증을 set 합니다.

SQLTools용 Databricks 드라이버는 다음과 같은 Azure Databricks 인증 유형을 지원합니다.

• Azure Databricks 개인용 액세스 토큰 인증
• Azure Databricks OAuth M2M(컴퓨터 대 컴퓨터) 인증
• Azure Databricks OAuth U2M(사용자 대 컴퓨터) 인증
• Azure CLI 인증

Azure Databricks 개인용 액세스 토큰 인증

Azure Databricks 개인용 액세스 토큰 인증과 함께 Databricks Driver for SQLTools를 사용하려면 Azure Databricks 개인용 액세스 토큰이 있어야 합니다. 개인 액세스 토큰을 만들려면 작업 영역 사용자를 위한 Azure Databricks 개인용 액세스 토큰의 단계를 따릅니다.

Azure Databricks OAuth M2M(컴퓨터 대 컴퓨터) 인증

다음과 같이 Azure Databricks OAuth M2M(컴퓨터 대 컴퓨터) 인증을 사용하여 Databricks Driver for SQLTools를 인증할 수 있습니다.

1. OAuth M2M 인증을 위한 구성 단계를 완료하세요. OAuth M2M(컴퓨터 대 컴퓨터) 인증을 참조하세요.
2. OAuth M2M 인증 구성 설정으로 Azure Databricks 구성 프로필을 만듭니다. OAuth M2M(컴퓨터 대 컴퓨터) 인증의 "구성" 섹션을 참조하세요.
3. 로컬 개발 컴퓨터에서 Visual Studio Code용 Databricks 확장을 설치하고 엽니다.
4. Visual Studio Code용 Databricks 확장에서 구성 창에서 구성 버튼을 클릭합니다. 구성 버튼이 표시되지 않으면 대신 톱니 바퀴(작업 영역 구성) 아이콘을 클릭하세요.
5. 명령 팔레트에서 Databricks 호스트에 Azure Databricks의 작업 영역별 URL(예: https://adb-1234567890123456.7.azuredatabricks.net)을 입력한 다음 Enter를 누릅니다.
6. 2단계에서 만든 항목과 일치하는 구성 프로필 항목을 찾으십시오: Select.
7. 웹 브라우저에서 화면의 지시를 완료하여 Azure Databricks 계정 인증을 완료합니다.

Azure Databricks OAuth U2M(사용자 대 컴퓨터) 인증

다음과 같이 Azure Databricks OAuth U2M(사용자 대 컴퓨터) 인증을 사용하여 Databricks Driver for SQLTools를 인증할 수 있습니다.

1. 로컬 개발 컴퓨터에서 Visual Studio Code용 Databricks 확장을 설치하고 엽니다.
2. Visual Studio Code용 Databricks 확장에서 구성 창에서 구성 버튼을 클릭합니다. 구성 버튼이 표시되지 않으면 대신 톱니 바퀴(작업 영역 구성) 아이콘을 클릭하세요.
3. 명령 팔레트의 Databricks 호스트에 Azure Databricks 작업 영역별 URL(예: https://adb-1234567890123456.7.azuredatabricks.net)을 입력합니다. 그런 다음, Enter 키를 누릅니다.
4. Select OAuth (사용자-컴퓨터 간).
5. 웹 브라우저에서 화면의 지시를 완료하여 Azure Databricks 계정 인증을 완료합니다. 메시지가 표시되면 all-apis 액세스를 허용합니다.

Azure CLI 인증

다음과 같이 Azure CLI를 사용하여 SQLTools용 Databricks Driver에 인증할 수 있습니다.

1. 아직 설치하지 않았다면 로컬 개발 컴퓨터에 Azure CLI를 설치하세요.
2. 로컬 개발 컴퓨터에서 Visual Studio Code용 Databricks 확장을 설치하고 엽니다.
3. Visual Studio Code용 Databricks 확장에서 구성 창에서 구성 버튼을 클릭합니다. 구성 버튼이 표시되지 않으면 대신 톱니 바퀴(작업 영역 구성) 아이콘을 클릭하세요.
4. 명령 팔레트의 Databricks 호스트에 Azure Databricks 작업 영역별 URL(예: https://adb-1234567890123456.7.azuredatabricks.net)을 입력합니다. 그런 다음, Enter 키를 누릅니다.
5. Select Azure CLI.
6. 화면에 표시되는 프롬프트에 따라 Azure CLI로 인증을 완료합니다.

schema에 연결하세요

1. Visual Studio Code의 사이드바에서 SQLTools 아이콘을 클릭합니다.
2. SQLTools 보기에서 SQLTools 확장을 처음 사용하는 경우 Connections 창에서 새 연결 추가를 클릭합니다. 그렇지 않으면 창의 제목 표시줄에서 새 연결 추가 아이콘을 클릭합니다.
3. SQLTools 설정 탭에서 Select 데이터베이스 드라이버 단계에 대해 Databricks 아이콘을 클릭합니다.
4. 연결 설정 단계에서 웨어하우스, catalog및 schema대한 다음 정보를 입력합니다.

   1. 연결 이름에 이 연결의 고유한 이름을 입력합니다.

   2. (선택 사항) 연결 그룹에 기존 연결 그룹의 이름을 입력하여 해당 그룹에 새 연결을 추가합니다. 또는 고유한 이름을 입력하여 새 연결로 새 연결 그룹을 만듭니다. 연결 그룹을 사용하면 확장에서 connections 쉽게 찾을 수 있습니다.

   3. Connect에 연결하려면을 사용하여 다음 중 하나를 select하십시오.

      • 인증에 Azure Databricks 개인용 액세스 토큰을 사용하려면 select호스트 이름 및 토큰.
      • SqlTools용 Databricks Driver 버전 0.4.2 이상에서 OAuth U2M 또는 M2M 또는 Azure CLI 인증을 사용하기 위해서는 selectVS Code 확장(베타)을 사용하십시오.

   4. 연결에 사용할 항목에 호스트 이름과 토큰을 선택한 경우 호스트에 웨어하우스의 서버 호스트 이름 설정을 입력합니다. 웨어하우스의 Server 호스트 이름 설정을 Azure Databricks 컴퓨팅 리소스대한 연결 세부 정보를 참조하세요.

   5. 경로에 웨어하우스 또는 클러스터의 HTTP 경로 설정을 입력합니다. 웨어하우스의 HTTP 경로 설정을 Azure Databricks 컴퓨팅 리소스대한 연결 세부 정보를 참조하세요.

   6. 연결에 사용할 항목에 호스트 이름과 토큰을 선택한 경우 토큰에 Azure Databricks 개인용 액세스 토큰 값을 입력합니다.

   7. Catalog에 대해, 당신의 catalog의 이름을 입력하세요.

      참고 항목

      Unity Catalog사용하도록 설정되지 않은 작업 영역의 경우 기본값인 hive_metastore사용하려면 Catalog 비워 둘 수 있습니다.

   8. Schema에 귀하의 schema이름을 입력하십시오.

   9. (선택 사항) 레코드 기본 limit표시의 경우 각 쿼리에 대해 처음 50개 행만 표시하도록 50 기본값을 그대로 두거나 다른 limit입력합니다.

5. 연결 테스트를 클릭합니다.
6. 연결 테스트에 성공하면 연결 저장을 클릭합니다.

연결 설정 변경

이 절차에서는 하나 이상의 웨어하우스에 성공적으로 연결한 것으로 가정합니다.

1. SQLTools 보기가 표시되지 않으면 Visual Studio Code의 사이드바에서 SQLTools 아이콘을 클릭합니다.
2. Connections 창에서 대상 연결에 대한 연결 그룹이 있는 경우 연결 그룹을 확장합니다.
3. 연결을 마우스 오른쪽 단추로 클릭하고 연결 편집을 클릭합니다.
4. 대상 설정을 변경합니다.
5. 연결 테스트를 클릭합니다.
6. 연결 테스트에 성공하면 연결 저장을 클릭합니다.

schema의 개체들 찾아보기

1. Connections 창에서 대상 연결에 대한 연결 그룹이 있는 경우 연결 그룹을 확장합니다.
2. 웨어하우스의 대상 연결을 두 번 클릭하거나 확장합니다.
3. 연결에 대한 대상 데이터베이스(schema)가 있는 경우 확장합니다.
4. 데이터베이스(schema)에 대해 하나 이상의 tables 또는 views가 있는 경우, Tables 또는 Views을 확장하십시오.
5. 대상 table이나 뷰를 확장하여 table이나 뷰의 columns를 확인합니다.

table의 행을 보거나 schema을(를) 보십시오.

Tables 또는 Views이 Connections 창에서 확장된 상태일 때 다음 중 하나를 수행합니다.

• table또는 보기의 행을 표시하려면 table 또는 보기를 마우스 오른쪽 단추로 클릭한 다음, Table 레코드를 표시하거나 보기 레코드을(를) 표시합니다.
• 또는 보기의 표시하려면 또는 보기를 마우스 오른쪽 단추로 클릭하고 설명 또는 보기 설명클릭합니다.

table를 위한 insert 쿼리 Generate

1. 기존 편집기의 where 위치에 insert 쿼리를 추가할 커서를 배치합니다.
2. Connections 창에서 Tables을 확장한 후, table를 마우스 오른쪽 버튼으로 클릭하고 GenerateInsert 쿼리을 클릭합니다. insert 쿼리의 정의는 커서의 삽입 지점에 추가됩니다.

쿼리 만들기 및 실행

이 절차에서는 하나 이상의 웨어하우스에 성공적으로 연결한 것으로 가정합니다.

1. Connections 창에서 대상 연결에 대한 연결 그룹이 있는 경우 연결 그룹을 확장합니다.
2. 웨어하우스의 대상 연결을 두 번 클릭하거나 확장합니다.
3. 연결을 선택한 상태에서 Connections 창의 제목 표시줄에서 새 SQL 파일을 클릭합니다. 새 편집기 탭이 나타납니다.
4. 새 편집기에서 SQL 쿼리를 입력합니다.
5. SQL 쿼리를 실행하려면 편집기에서 활성 연결에서 실행을 클릭합니다. 쿼리 결과가 새 편집기 탭에 표시됩니다.

기존 쿼리 실행

이 절차에서는 하나 이상의 웨어하우스에 성공적으로 연결한 것으로 가정합니다.

1. Connections 창에서 대상 연결에 대한 연결 그룹이 있는 경우 연결 그룹을 확장합니다.
2. 웨어하우스의 대상 연결을 두 번 클릭하거나 확장합니다.
3. 연결을 선택한 상태에서 파일 확장명이 .sql인 파일이나, 이전에 연 편집기에서 연속된 SQL 문 그룹 select를 엽니다.
4. 열려 있는 .sql 파일에서 SQL 쿼리를 실행하려면 편집기에 .sql 파일의 내용이 표시된 상태에서 편집기에서 활성 연결에서 실행을 클릭합니다. 쿼리 결과가 새 편집기 탭에 표시됩니다.
5. 이전에 연 편집기에서 선택한 연속 SQL 문 그룹을 실행하려면 선택 항목을 마우스 오른쪽 단추로 클릭한 다음, 선택한 쿼리 실행을 클릭합니다. 쿼리 결과가 새 편집기 탭에 표시됩니다.

Databricks에 사용 현황 로그 보내기

SQLTools용 Databricks Driver를 사용하는 동안 문제가 발생하면 다음을 수행하여 사용 로그와 관련 정보를 Databricks 지원팀으로 보낼 수 있습니다.

1. 로컬 개발 컴퓨터에서 Visual Studio Code용 Databricks 확장을 설치합니다.
2. Visual Studio Code용 Databricks 확장 설정에 설명된 대로 databricks.logs.enabled 설정을 선택하거나 true을(를) (으)로 설정하여 로깅을 켭니다. 로깅을 활성화한 후에는 Visual Studio Code를 다시 시작해야 합니다.
3. 문제를 재현해 봅니다.
4. 명령 팔레트(주 메뉴의 보기 >명령 팔레트)에서 Databricks: 전체 로그 열기 명령을 실행합니다.
5. 표시되는 Databricks Logs.log, databricks-cli-logs.json 및 sdk-and-extension-logs.json 파일을 Databricks 고객 지원팀에 보냅니다.
6. 또한 문제의 컨텍스트에서 터미널(보기 >터미널)의 내용을 복사하여 Databricks 고객 지원팀에 보냅니다.

출력 보기(뷰 > 출력, Databricks 로그)는 로그: 활성화됨이 선택되거나 databricks.logs.enabled이 set할 true인 경우 잘린 정보를 표시합니다. 더 많은 정보를 표시하려면 Visual Studio Code용 Databricks 확장 설정에 설명된 대로 다음 설정을 변경하세요.

• 로그: 최대 배열 길이 또는 databricks.logs.maxArrayLength
• 로그: 최대 필드 길이 또는 databricks.logs.maxFieldLength
• 로그: 잘림 깊이 또는 databricks.logs.truncationDepth

추가 리소스

• SQLTools 설명서
• GitHub의 SQLTools용 Databricks 드라이버