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 クラスダイアグラム¶

次の図は、 Root オブジェクトから始まる、 snowflake.core パッケージの基本的なクラスと、それらの相互関係を示しています。

コレクションから Resource オブジェクトを取り出す¶

さらに、コレクションは、 API が接続されている基礎となる Snowflake データベース内の特定の Resource オブジェクトを取得するためのエントリポイントを提供します。コレクションで角括弧インデックス演算子（[ ]）を使用すると、そのコレクション内の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 fetched 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