Snowflake Extension for Visual Studio Code

Snowflake는 Snowflake 사용자가 VS Code에서 직접 Snowflake SQL 문을 작성하고 실행할 수 있도록 Visual Studio Code (VS Code)의 확장 프로그램을 제공합니다. 또한 확장 프로그램은 Snowpark Python 과 통합되어 Python 코드에서 SQL에 대한 디버깅, 구문 강조 표시, 자동 완성 기능을 제공합니다.

확장 프로그램은 종종 서드 파티에서 제공하는 미리 패키지된 기능으로, VS Code에 새로운 특징과 기능을 추가합니다.

이 항목의 내용:

Snowflake Extension for Visual Studio Code 설치하기

Snowflake 사용자는 Visual Studio Marketplace에서 직접 VS Code 확장 프로그램을 설치하거나 .xsix 파일로 패키지된 확장 프로그램을 다운로드한 다음 설치할 수 있습니다.

Visual Studio Marketplace에서 설치하기

Visual Studio Marketplace에서 직접 설치하려면 다음을 수행하십시오.

  1. Visual Studio Code를 엽니다.

  2. Code » Preferences » Extensions 를 선택합니다.

    View » Extensions 를 선택하거나 VS Code Activity Bar에서 확장 프로그램 버튼 확장 프로그램 버튼 을 클릭할 수도 있습니다.

  3. Search Extensions 입력란에 Snowflake 라는 텍스트를 입력하여 Snowflake Visual Studio 확장 프로그램을 검색합니다.

  4. 확장 프로그램 세트에서 Snowflake가 작성한 확장 프로그램을 선택하고 Install 을 클릭합니다.

.vsix 파일에서 설치하기

.vsix 파일을 다운로드하여 이 파일에서 확장 프로그램을 설치하려면 다음을 수행하십시오.

  1. 확장 프로그램을 다운로드합니다.

    1. Snowflake Visual Studio Code 확장 프로그램 페이지를 엽니다.

    2. Version History 탭을 선택합니다.

    3. 다운로드할 버전을 선택하고 Download 를 클릭합니다. 파일이 다운로드되는 위치에 유의하십시오.

  2. Visual Studio Code를 엽니다.

  3. Code » Preferences » Extensions 를 선택합니다.

    View » Extensions 를 선택하거나 Activity Bar에서 확장 프로그램 버튼 확장 프로그램 버튼 을 클릭할 수도 있습니다.

  4. 더 보기(…) 메뉴에서 Install from VSIX 를 선택합니다.

  1. 컴퓨터에서 snowflake-x.y.z.vsix 파일을 찾아 선택한 다음 Install 을 선택합니다.

설치가 완료되면 VS Code에서 Extensions 메뉴의 INSTALLED 섹션에 Snowflake Extension for Visual Studio Code 이 나타납니다.

로그인하기

SQL 문을 실행하거나 Snowpark Python 기능을 사용하려면 먼저 Snowflake 계정에 로그인해야 합니다.

Snowflake 계정 식별자, 사용자 이름, 비밀번호를 사용하거나 SAML SSO를 사용하여 Snowflake에 페더레이션 인증을 사용하여 Snowflake에 로그인할 수 있습니다.

VS Code 확장 프로그램에서 Snowflake에 처음 로그인할 때 Snowflake 계정의 계정 식별자 또는 Snowflake에 연결하는 데 사용하는 URL을 입력하여 계정을 추가해야 합니다.

계정 식별자 결정 방법에 대한 자세한 내용은 계정 식별자 섹션을 참조하십시오.

VS Code 확장 프로그램에서 Snowflake에 로그인하려면 다음을 수행하십시오.

  1. Activity Bar 에서 Snowflake 아이콘을 클릭합니다.

    측면 표시줄 패널이 Snowflake 탐색으로 변경되고 Add Account 또는 Sign in 대화 상자가 표시됩니다.

  2. Add Account 아래에 계정 식별자를 입력하고 Continue 를 선택합니다.

    Add Account 는 이전에 아무런 계정도 지정되지 않은 경우에만 표시됩니다.

  1. 선택한 계정의 사용자 이름과 비밀번호를 입력하고 Sign in 을 선택합니다.

로그인에 성공하면 사이드바가 바뀌면서 세션 컨텍스트(ACCOUNT), 기본 역할의 사용자에 대한 DATABASE EXPLORER, QUERY HISTORY 를 표시합니다.

SnowSQL 구성 파일로 Snowflake Extension for Visual Studio Code 사용하기

Snowflake Extension for Visual Studio Code 는 연결 구성 로딩을 위해 Snow SQL 구성 파일 을 사용할 수 있습니다.

참고

연결 구성 값만 사용됩니다. 다른 SnowSQL 구성 값은 무시됩니다.

Snow SQL 구성 파일을 사용하도록 Snowflake Extension for Visual Studio Code 를 구성하려면 다음을 수행하십시오.

  1. Activity Bar 에서 Snowflake 아이콘을 선택합니다.

    측면 표시줄 패널이 Snowflake 탐색으로 변경되고 Add Account 또는 Sign in 대화 상자가 표시됩니다.

  2. Username 드롭다운을 선택한 다음 Sign in to another account 를 선택합니다.

  3. Use SnowSQL Config 를 선택합니다. Snowflake Extension for Visual Studio Code 의 Visual Studio 코드 설정 페이지가 열리는데 SnowSQL Config Path 가 선택되어 있습니다.

  4. 유효한 SnowSQL 구성 파일의 경로를 입력합니다.

지정된 구성 파일에 정의된 모든 연결을 포함하도록 계정 드롭다운이 업데이트됩니다.

SQL 파일 사용하기

Snowflake Extension for Visual Studio Code 을 사용하여 SQL 파일을 만들고 로드할 수 있습니다. SQL 파일은 하나 이상의 SQL 문을 포함하는 간단한 텍스트 파일입니다.

SQL 파일 열기

Snowflake SQL 파일을 만들거나 열려면 다음을 수행하십시오.

  1. File » Open 을 선택하고 SQL을 포함한 텍스트 파일을 찾아 엽니다.

    기존 SQL 파일이 없는 경우 새 파일을 만들 수 있습니다. File » New File 을 선택하고 Snowflake SQL File 유형의 파일을 만듭니다. 또는 데이터베이스 탐색기 패널에서 (새 SQL 파일 버튼)을 선택하여 새 SQL 파일을 만듭니다.

  2. 하나 이상의 Snowflake SQL 문을 파일에 추가합니다.

  3. 행을 선택하고 행 위에서 [Execute]를 눌러 명령을 실행합니다.

명령 또는 쿼리 실행하기

하나 이상의 명령 또는 쿼리를 실행하려면 다음을 수행하십시오.

  1. 선택한 SQL 파일에 대한 모든 문 실행 버튼 을 선택하여 해당 파일의 모든 문을 실행합니다.

  2. 실행할 문에 커서를 놓아 실행할 행을 선택합니다.

    둘 이상의 명령 선택 - 선택한 명령이 전부 실행됩니다.

  3. 선택한 첫 번째 명령 위에 있는 [Execute] 버튼을 누릅니다.

여러 명령을 선택하면 명령이 위에서 아래로 순서대로 실행됩니다.

바로 가기 키를 사용하여 문을 실행할 수도 있습니다. 실행하려는 SQL 문을 선택한 후 Mac 키보드에서는 Apple OSX 명령 키. + [enter], Windows 키보드에서는 일반 제어 키. + [enter]를 누릅니다.

Output 섹션의 SNOWFLAKE:QUERY RESULTS 테이블에서 SQL 문의 결과를 확인할 수 있습니다.

진행 중인 쿼리는 취소할 수 있습니다. 진행 중인 쿼리를 취소하려면 QUERY HISTORY 에서 쿼리를 찾고 쿼리 취소(쿼리 취소 버튼)를 선택합니다.

쿼리 기록 사용하기

쿼리 결과는 QUERY HISTORY 에서 추적됩니다.

이전에 실행한 쿼리 결과를 살펴보려면 다음을 수행하십시오.

  1. Query History 를 확장합니다.

  2. 문을 선택합니다.

  3. Output 창의 SNOWFLAKE:QUERY RESULTS 탭에서 결과를 검사합니다.

Query History 를 사용하여 쿼리를 다시 실행하거나(쿼리 재실행 버튼), 쿼리 텍스트를 클립보드에 복사하거나(쿼리 텍스트를 클립보드로 복사 버튼), 쿼리를 삭제할 수 있습니다(쿼리 삭제 버튼).

쿼리 결과 사용하기

쿼리 결과를 정렬, 재정렬, 숨기기 또는 고정하거나 디스크에 저장할 수 있습니다.

특정 쿼리의 표시를 수정하려면 다음을 수행하십시오.

  1. QUERY HISTORY 에서 쿼리를 선택합니다.

  2. QUERY RESULTS 에서 열을 선택합니다.

  3. 아래쪽 화살표(↓)를 선택한 다음 SORT A-Z (내림차순), Sort Z-A (오름차순), Hide column “column name” 또는 Freeze columns up to “column name” 중 하나를 선택합니다.

내용 표시가 적절히 변경됩니다.

열이 이전에 숨겨진 경우 다른 열을 선택하고 Unhide N columns 를 선택합니다.

쿼리 결과를 디스크에 저장하려면 쿼리와 관련된 디스크(결과 다운로드 버튼) 또는 다운로드(결과 저장 버튼)를 선택하십시오. 압축된 gzip 또는 쉼표로 구분된 파일 형식으로 내용이 파일에 저장됩니다.

Snowpark Python 코드 사용하기

Snowflake Extension for Visual Studio Code 를 사용하여 Snowpark Python 코드에서 Snowflake SQL 문을 작성하고 디버깅할 수 있습니다.

Snowpark Python 함수 디버깅하기

Snowpark Python 함수를 디버깅하려면 다음 안내를 따르십시오.

  1. 첫 번째 매개 변수가 Snowpark Session 오브젝트인 Python 함수에 Snowflake 저장 프로시저를 작성합니다.

  2. 함수 이름 위에 인라인 Snowflake: Debug 옵션이 나타날 것입니다. 확장 프로그램을 통해 현재 활성 세션을 사용하여 함수에서 저장 프로시저를 실행하려면 이 옵션을 선택합니다. 디버그 중단점을 설정할 수도 있습니다.

Python에서 SQL에 대한 구문 강조 표시 및 자동 완성

자동 감지를 활성화하거나 주석을 사용하여 SQL 문자열을 수동으로 표시함으로써 Python 코드에서 SQL의 구문 강조 표시를 추가할 수 있습니다.

SQL 문을 자동으로 감지하기

자동 SQL 구문 강조 표시를 설정하려면 확장 프로그램 설정 Auto Detect Sql in Python 을 활성화하십시오. 확장 프로그램은 다음 스크린샷과 같이 Python 문자열의 첫 번째 단어가 모두 대문자로 된 SQL 키워드를 찾아서 SQL 문을 자동으로 감지합니다.

자동 SQL 구문 강조 표시를 보여주는 Python 문자열에서 Snowflake SQL 문의 코드 조각.

SQL 문을 수동으로 표시하기

Python 문자열에서 SQL 문을 수동으로 표시하려면 다음 안내를 따르십시오.

  1. (선택 사항) 확장 프로그램 설정 Auto Detect Sql in Python 을 비활성화합니다.

  2. 주석을 사용하여 SQL 문의 시작과 끝을 나타냅니다. 다음 마커를 원하는 대로 조합하여 사용할 수 있습니다.

    • 시작 마커: -–startsql, -–beginsql, -–start-sql, -–begin-sql

    • 종료 마커: –-endsql, –-end-sql

예를 들어 다음 스크린샷은 --begin-sql--end-sql 을 사용하여 SQL 문을 수동으로 표시하는 코드를 보여줍니다.

SQL 구문 강조 표시를 수동으로 활성화하기 위해 주석을 사용하는 Python 문자열로 된 Snowflake SQL 문의 코드 조각.

Python 문자열에서 SQL 자동 완성 사용하기

Python 문자열의 SQL 문에 자동 완성을 사용하려면 다음 안내를 따르십시오.

  1. Python 파일에서 확장 프로그램을 통해 활성 Snowflake 세션에 연결된 동안 Python 문자열을 만듭니다.

  2. SQL 문 작성을 시작하고 나타나는 자동 완성 제안을 확인하십시오.

예를 들어, SELECT * FROM db1.public 과 같은 문 작성을 시작하면 확장 프로그램에서 자동으로 테이블 이름을 제안합니다.

마찬가지로, 테이블을 참조하는 SELECT 문 내에서 열을 채우기 시작하면 다음 스크린샷과 같이 확장 프로그램에서 자동으로 열 이름을 제안합니다.

열 이름에 대한 자동 완성 제안을 표시하는 Python 문자열로 된 Snowflake SQL 문의 코드 조각.

Jinja 템플릿 구문 강조 표시

기본적으로, 확장 프로그램은 다음 스크린샷과 같이 Snowflake SQL에서 Jinja 템플릿 을 작성하기 위한 기본 구문 강조 표시 및 대괄호 자동 완성을 추가합니다.

구문 강조 표시 및 대괄호 자동 완성을 표시하는 Jinja 템플릿을 사용한 Snowflake SQL 문의 코드 조각.

세션 컨텍스트 변경하기

Side Bar 패널의 Account 섹션을 사용하여 역할, 데이터베이스, 스키마, 웨어하우스를 선택할 수 있습니다. 관련 드롭다운을 사용하여 각각 적절히 선택합니다.

계정 드롭다운을 사용하여 로그인하거나 다양한 계정 간에 전환합니다.

계정에 로그인하거나 계정 간에 전환합니다.

확장 프로그램 세부 정보 보기

언제든지 Snowflake SQL Visual Studio Code 확장 프로그램 정보를 볼 수 있습니다.

다음을 포함하여 확장 프로그램에 대한 다음 세부 정보를 볼 수 있습니다.

  • 버전 정보: 현재 설치된 확장 프로그램의 버전.

  • 변경 로그: 추가, 변경 또는 업데이트된 기능에 대한 버전별 정보.

  • 기능 둘러보기.

또한 활성화/비활성화 드롭다운을 사용하여 확장 프로그램을 비활성화하거나 활성화할 수 있습니다.

확장 프로그램 정보를 보려면 다음을 수행하십시오.

  1. Code » Preferences » Extensions 를 선택합니다.

  2. Snowflake VS Code SQL 확장 프로그램을 선택합니다.

    View » Extensions 를 선택하거나 Activities 표시줄에서 확장 프로그램 버튼 확장 프로그램 버튼 을 클릭할 수도 있습니다.

변경 로그 표시

확장 프로그램의 변경 로그를 확인하려면 Show Change Log 명령을 사용할 수도 있습니다.

  1. Mac 키보드에서 CMD+Shift+P 를 누르거나 Windows 키보드에서 CTRL+Shift+P 를 눌러 Command Palette 를 엽니다.

  2. 다음 명령을 입력합니다.

    Show Change Log
    
    Copy

확장 프로그램 설정

Snowflake Extension for Visual Studio Code 에서는 다음 설정을 지원합니다.

설정

설명

기본값

CSV 내보내기 » 구분 기호

열 구분 기호를 지정합니다.

쉼표

CSV 내보내기 » 헤더

내보낸 CSV 파일에 헤더 행 포함을 활성화합니다.

활성화됨

CSV 내보내기 » 빈 행 포함

내보낸 CSV 파일에 빈 행 포함을 활성화합니다.

제외

CSV 내보내기 » 따옴표

내보낸 CSV 파일의 모든 값을 큰따옴표로 묶습니다.

활성화됨

쿼리 강조 표시

현재 SQL 문에서 배경 강조 표시를 활성화합니다.

활성화됨

문 위에 실행 표시

각 문 위에서 클릭 가능한 실행 작업을 활성화합니다.

활성화됨

Snowsql 구성 경로

설정된 경우 이 파일에서 연결 구성이 로드됩니다.

설정 해제

자동 완성 오브젝트 세부 정보

자동 완성 항목을 선택한 후 Snowflake 오브젝트의 세부 정보 표시

비활성화됨

클라이언트 세션 연결 유지 설정

활동에 관계없이 연결이 활성화되어 있는 동안 세션을 무기한 활성 상태로 유지할지 여부를 지정합니다. 세션을 활성화하지 않은 경우 4시간 동안 활동이 없으면 다시 로그인해야 합니다.

활성화됨

자동 완성 베리언트 키

OBJECT/VARIANT 키 자동 완성 제안 표시

비활성화됨

오브젝트 탐색기: 검색

오브젝트 탐색기에서 검색 활성화

활성화됨

쿼리 기록: 항목 제한

기록에 표시되는 최대 쿼리 수를 지정합니다. 더 많은 쿼리를 표시하면 성능에 영향을 미칠 수 있습니다.

1000

미리 보기의 확장 프로그램 설정

현재 미리 보기로 사용할 수 있는 확장 프로그램 설정은 다음과 같습니다.

설정

설명

기본값

구문 강조 표시: Python에서 SQL 자동 감지

Python 문자열에서 SQL 문의 자동 구문 강조 표시 활성화

활성화됨

공개 미리 보기 기능 활성화

확장 프로그램에 대한 공개 미리 보기 기능 활성화

비활성화됨

확장 프로그램 설정 변경하기

확장 프로그램 설정을 변경하려면 다음을 수행하십시오.

  1. Windows/Linux에서는 File » Preferences » Settings 를 선택합니다. . macOS에서는 Code » Preferences » Settings 를 선택합니다.

  2. Search settings 텍스트 상자에 Snowflake 를 입력합니다.

  3. User 또는 Workspace 탭을 선택하여 사용자별 설정 또는 작업 공간별 설정을 보거나 수정합니다.

  4. Settings 탭을 닫습니다.

확장 프로그램 제거하기

확장 프로그램을 비활성화하거나 제거하려면 다음을 수행하십시오.

  1. Code » Preferences » Extensions 를 선택합니다.

  2. 확장 프로그램을 선택합니다.

  3. 마우스 오른쪽 버튼을 클릭하고 Disable 또는 Uninstall 을 선택합니다.