メインコンテンツまでスキップ

外部コレクションを作成する

外部コレクションは、AWS S3 や Iceberg などの外部ストレージシステムまたはデータベーステーブルのデータにアクセスする Zilliz Cloud のデータコレクションの一種です。データを Zilliz Cloud にコピーすることなく、データレイクに対するクエリレイヤーとして機能し、Zilliz Cloud のクエリインターフェースとの互換性を維持します。

Notes

外部コレクションは、オンデマンドコンピューティング用データベースでのみ作成できます。Dedicated クラスターを提供する環境での外部コレクションの作成は、近日中にサポートされる予定です。

概要​

一般的な AI データパイプラインでは、ユーザーが AWS S3 などのストレージシステムに Parquet などの形式でデータをすでに保存している場合があります。Zilliz Cloud でこの外部に保存されたデータを使用するには、通常、Extract-Transform-Load(ETL)パイプラインを使用して Zilliz Cloud 独自のストレージにデータをインポートする必要があります。

このようにデータを Zilliz Cloud に持ち込むワークフローでは、同期が困難な冗長データが作成され、データの整合性を確保するためのエンジニアリング保守の負担が増加します。

YQXWwPQ3vheYa4b8398cWoPNnyN

これらの問題を解決するため、Zilliz Cloud は外部コレクションを提供しています。外部コレクションを使用すると、データの同期や ETL パイプラインを気にすることなく、Zilliz Cloud から外部に保存されたデータにアクセスできます。

Q6F4wtcd2h3PnKbnMxncw3urn3f

作成された外部コレクションはデータに直接アクセスし、データを保存している同じ場所にそのまま保持します。バックグラウンドで、Zilliz Cloud はマニフェストファイルを作成し、Zilliz Cloud のメタデータと外部データファイル内の行とのマッピングを記録します。マニフェストファイルの準備ができたら、マネージドコレクションの場合と同様に、外部コレクションにインデックスを作成できます。

データが変更された場合は、手動で 1 秒未満の更新をトリガーするとメタデータが更新され、Zilliz Cloud が常に最新の状態に保たれます。

外部コレクションは、オンデマンドコンピューティング用のデータベースで使用できます。

ステップ 1: スキーマを作成する​

マネージドコレクションを作成する場合と同様に、外部コレクションを作成する前にもスキーマを作成する必要があります。ただし、スキーマはマネージドコレクションのスキーマとは少し異なります。

事前準備​

  • オンデマンドコンピューティング用のデータベースで外部コレクションを作成するために十分な権限を持つ API キーを取得していること。

    詳細については、API キー を参照してください。

  • オブジェクトストレージバケットを Zilliz Cloud と統合していること。

    詳細については、AWS、GCP、Azure の各ドキュメントを参照してください。

  • バケット統合から外部ボリュームを作成していること。そのボリュームに対象のデータファイルが含まれていることを確認してください。

    詳細については、外部ボリューム を参照してください。

サポートされるデータソース​

Zilliz Cloud は次のデータソースをサポートしています。選択した形式に応じて、対応する外部ソースを指定してください。

  • parquet

    external_source には、対象の Parquet ファイルを含むフォルダーを設定します。

  • vortex,

    external_source には、バージョン 0.56 の Vortex 列指向ファイルを含むフォルダーを設定します。

  • lance-table

    external_source には、_transactions、_versions、data などのサブフォルダーを含むフォルダーパスを設定します。

  • iceberg-table

    external_source には Iceberg テーブルの metadata.json ファイルを設定し、次のようにスナップショット ID を渡します。

    python
    external_spec={
    "format": "iceberg-table",
    "snapshot_id": "473984310232959286"
    }
  • milvus-table

    external_source には、具体的な Milvus スナップショットメタデータ JSON ファイルを設定します。詳細については、スナップショットをデータソースとして使用する を参照してください。

スキーマを設定する​

対象のデータファイルを含む外部ボリュームを用意したら、コレクションの列を Parquet ファイル(parquet)、Lance テーブル(lance-table)、Iceberg テーブル(iceberg-table)、または 0.56.0 形式の Vortex ファイル(vortex)にマッピングするスキーマを作成します。

Notes

外部ソースは、フォルダーであることを示すためにスラッシュ (/) で終わる必要があります。

python
from pymilvus import MilvusClient, DataType

schema = MilvusClient.create_schema(
external_source='volume://my_volume/path/to/a/folder/',
external_spec='{"format": "parquet"}'
)

ステップ 2: フィールドを追加する​

スキーマの準備ができたら、次のようにフィールドを追加できます。

python
schema.add_field(
field_name="product_id",
datatype=DataType.INT64,
# highlight-next
external_field="id" # field name in the external data file
)
schema.add_field(
field_name="product_name",
datatype=DataType.VARCHAR,
max_length=512,
# highlight-next
external_field="name"
)
schema.add_field(
field_name="embedding",
datatype=DataType.FLOAT_VECTOR,
dim=768,
# highlight-next
external_field="vector"
)

ステップ 3: コレクションを作成する​

スキーマにすべてのフィールドを追加したら、外部コレクションを作成できます。

Notes

外部コレクションは、通常オンデマンドクラスターに関連付けられているプロジェクトレベルのデータベースで作成できます。

python
# connect the database
client = MilvusClient(
uri="https://{project-id}.{region}.vectordb.zillizcloud.com",
token="YOUR_API_KEY"
)

client.use_database(
db_name="my_database"
)
# create the collection
client.create_collection(
collection_name="test_collection",
schema=schema
)

ステップ 4: インデックスを作成する​

マネージドコレクションの場合と同様に、外部コレクションの列にインデックスを作成できます。

python
index_params = client.prepare_index_params()
# Add indexes
index_params.add_index(
field_name="embedding",
index_type="AUTOINDEX",
metric_type="COSINE"
)
index_params.add_index(
field_name="product_name",
index_type="AUTOINDEX"
)
client.create_index(
db_name="my_database",
collection_name="test_collection",
index_params=index_params
)

ステップ 5: データを更新する​

コレクションの準備ができたら、データのメタデータとインデックスを作成するために更新します。

python
import time

job_id = client.refresh_external_collection(
db_name="my_database",
collection_name="test_collection"
)
while True:
progress = client.get_refresh_external_collection_progress(job_id=job_id)
print(f" {progress.state}: {progress.progress}%")
if progress.state == "RefreshCompleted":
elapsed = progress.end_time - progress.start_time
print(f" Completed in {elapsed}ms")
break
elif progress.state == "RefreshFailed":
print(f" Failed: {progress.reason}")
break
time.sleep(2)

更新操作は非同期で実行されるため、進行状況を監視するループを設定する必要があります。

Notes
  • 更新操作では、データファイルのメタデータをスキャンし、それに応じてマニフェストファイルを生成します。通常、150-250 ms かかります。

  • マニフェストファイルには、Milvus のメタデータと外部ファイル内の行とのマッピングが記録されます。

  • ソースデータに更新がある場合は、Zilliz Cloud を最新の状態に保つために、手動で再度更新を呼び出す必要があります。

  • 挿入を伴わずにアクティブなメタデータをすべて削除する必要がある更新は拒否されます。

  • オンデマンドコンピューティング用のデータベース内の外部コレクションは、手動でロードおよびリリースする必要はありません。

次のステップ​

外部コレクションを更新したら、マネージドコレクションの場合と同様に、外部コレクションで類似検索およびクエリを実行できます。ただし、オンデマンドコンピューティング用のデータベース内のコレクションは、検索およびクエリのためにオンデマンドクラスターにアタッチする必要があります。詳細については、オンデマンドクラスターを作成する およびその関連ページを参照してください。

search、query、get、ハイブリッド検索などの DQL 操作を実行する前に、オンデマンドクラスターのコンピューティングリソースをアタッチするセッションを作成する必要があります。詳細については、オンデマンド DQL 操作 を参照してください。

スナップショットをソースとして使用

スナップショットメタデータの JSON パスを `externalsource` として使用し、`externalspec.format` を `"milvus-table"` に設定することで、Milvus スナップショットから外部コレクションを作成できます。 | BYOC