Snowflake Python APIs: 일반 개념¶

계정, 데이터베이스 및 스키마 범위¶

Root 오브젝트를 사용하면 웨어하우스(root.warehouses), 데이터베이스(root.databases), 외부 볼륨(root.external_volumes)과 같은 계정 범위 지정 오브젝트의 컬렉션에 액세스할 수 있습니다.

DatabaseResource 아래에서 데이터베이스 범위 오브젝트에 액세스할 수 있으며, Root 아래에서 DatabaseCollection 오브젝트를 통해 검색할 수 있습니다. 현재, SchemaCollection 은 데이터베이스 범위에서 사용할 수 있는 유일한 오브젝트 유형입니다.

테이블, 뷰, 스트림, 스테이지와 같은 스키마 범위 지정 오브젝트에 SchemaResource 오브젝트를 통해 액세스할 수 있습니다.

예를 들어, 다음 코드는 StageCollection 에 먼저 액세스한 다음 StageResource 에 액세스합니다.

root = Root(my_connection)
stages = root.databases["my_db"].schemas["my_schema"].stages
my_stage = stages["my_stage"] # Access the "my_stage" StageResource

snowflake.core 클래스 다이어그램¶

다음 다이어그램은 snowflake.core 패키지의 몇 가지 기본 클래스와 이들이 서로 어떻게 연관되는지 Root 오브젝트부터 보여줍니다.

컬렉션에서 Resource 오브젝트 검색하기¶

또한 컬렉션은 Resource 가 연결된 기본 Snowflake 데이터베이스에서 특정 API 오브젝트를 검색할 수 있는 진입점을 제공합니다. 컬렉션에서 대괄호 인덱스 연산자([ ])를 사용하여 해당 컬렉션 내의 Snowflake 오브젝트를 “가리키거나” 참조를 가져올 수 있습니다.

예를 들어, 다음 코드는 Snowflake 계정의 my_wh 라는 기존 웨어하우스에 대한 참조를 검색합니다.

# my_wh_ref is retrieved from an existing warehouse
# This returns a WarehouseResource object, which is a reference to a warehouse named "my_wh" in your Snowflake account
my_wh_ref = root.warehouses["my_wh"]

Resource 에서 모델 오브젝트 가져오기¶

현재 Snowflake 데이터베이스에 존재하는 오브젝트의 속성 백을 반환하려면 Resource 오브젝트에 대해 fetch() 작업을 실행합니다.

예를 들어, 다음 코드는 모델 오브젝트를 사용하여 수행할 수 있는 일부 작업을 보여줍니다.

# my_wh is fetched from an existing warehouse
my_wh = root.warehouses["my_wh"].fetch()
print(my_wh.name, my_wh.auto_resume)

# my_wh is fetched from an existing warehouse
my_wh = root.warehouses["my_wh"].fetch()
my_wh.warehouse_size = "X-Small"
root.warehouses["my_wh"].create_or_alter(my_wh)

Resource 오브젝트에서 유형별 작업 수행하기¶

Resource 클래스는 오브젝트 타입의 특수한 API 작업도 구현합니다. 예를 들어, WarehouseResource 오브젝트를 사용하여 웨어하우스를 재개하거나 StageResource 오브젝트를 사용하여 스테이지에 있는 파일을 나열할 수 있습니다.

다음 코드 예제는 각각의 Resource 오브젝트를 사용하여 이러한 유형별 작업을 수행하는 방법을 보여줍니다.

# my_wh_ref is retrieved from an existing warehouse
my_wh_ref = root.warehouses["my_wh"]

# Resume a warehouse using a WarehouseResource object
my_wh_ref.resume()

# my_stage is retrieved from an existing stage
stage_ref = root.databases["my_db"].schemas["my_schema"].stages["my_stage"]

# Print file names and their sizes on a stage using a StageResource object
for file in stage_ref.list_files():
  print(file.name, file.size)

create_or_alter API 사용하기¶

Resource 오브젝트는 리소스에서 지원하는 경우 create_or_alter API 메서드도 노출합니다. 이름에서 알 수 있듯이 이 방법을 사용하면 Snowflake 오브젝트를 생성하거나 변경할 수 있습니다.

1. Root 에서 WarehouseCollection 가져오기¶

웨어하우스는 Root 에서 직접 액세스할 수 있는 계정 범위의 오브젝트입니다.

my_warehouses = root.warehouses # my_warehouses is a WarehouseCollection

2. WarehouseCollection 에서 WarehouseResource 오브젝트 가져오기¶

Resource 오브젝트를 검색하려면 일반적으로 해당 컬렉션부터 시작합니다. Collection 오브젝트는 대괄호 인덱스 연산자([ ])를 사용하여 기본 Snowflake 데이터베이스에서 특정 리소스를 검색할 수 있는 진입점을 제공합니다.

my_wh_ref = my_warehouses.warehouses["my_wh"] # my_wh_ref is a WarehouseResource

3. WarehouseResource 에서 Warehouse 모델 가져오기¶

WarehouseResource 오브젝트를 사용하여 해당 Warehouse 모델과 해당 속성을 Snowflake에서 가져옵니다.

my_wh = my_wh_ref.fetch() # my_wh is a Warehouse model object

4. Warehouse 모델에서 속성 수정하기¶

웨어하우스 모델에서 warehouse_size 와 같은 속성을 수정합니다.

my_wh.warehouse_size = "X-Small"

5. Snowflake에서 기존 웨어하우스 오브젝트 변경¶

마지막으로 수정된 웨어하우스 모델 사양을 사용하여 Snowflake의 기존 웨어하우스 오브젝트를 변경합니다(웨어하우스 오브젝트가 없으면 새로 생성합니다).

my_wh_ref.create_or_alter(my_wh) # Use the WarehouseResource to perform create_or_alter

이 my_wh_ref 참조를 사용하여 필요한 경우 Snowflake의 오브젝트에 대해 삭제와 같은 다른 작업을 수행할 수도 있습니다.

전체 코드 예제¶

다음 코드 예제는 처음부터 끝까지의 전체 웨어하우스 생성 또는 변경 작업을 보여줍니다.

# my_wh is fetched from an existing warehouse
my_warehouses = root.warehouses # my_warehouses is a WarehouseCollection
my_wh_ref = my_warehouses.warehouses["my_wh"] # my_wh_ref is a WarehouseResource
my_wh = my_wh_ref.fetch() # my_wh is a Warehouse model object
my_wh.warehouse_size = "X-Small"

my_wh_ref.create_or_alter(my_wh) # Use the WarehouseResource perform create_or_alter