注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。
オントロジー SQL 関数を使用すると、SQL を使ってオントロジーのオブジェクトに対する、再利用可能なパラメーター化クエリを定義できます。公開後は、Workshop、Actions、Automate、オントロジー SDK (OSDK) など、オントロジー関数を受け付ける Foundry 内のあらゆる場所でオントロジー SQL 関数を使用できます。
オントロジー SQL 関数は読み取り専用です。オントロジー SQL 関数内からオントロジーを変更することはできません。
SQL Studio でオントロジー SQL 関数を記述できます。関数を作成するには、オブジェクトモードにする必要があります。
関数はパラメーターをサポートしており、SQL 方言の変数を使って宣言します。以下の例では、animalParam は関数の呼び出し時に渡されるパラメーターです。エディターでクエリをテストする際には、デフォルト値の 'dog' が使用されます。
リテラルパラメーターに格納できるのは、オントロジー SQL 方言でサポートされているデータ型のリテラル値(たとえば、文字列、数値、ブール値)のみです。パラメーターに SQL フラグメントや式を含めることはできません。また、WHERE 句の比較の右辺など、SQL 方言でリテラル値が求められる位置でのみ使用できます。
ObjectSet パラメーターは、FROM 句でのみ使用できます。
Copied!1 2 3 4 5DECLARE @animalParam STRING = 'dog'; SELECT * FROM `ri.ontology.main.object-type...` WHERE animaltype = @animalParam;
関数の内容に問題がなければ、ワークシートを保存し、公開ボタンを選択します。関数を公開するには、事前にワークシートをプロジェクトに保存する必要があります。
関数を公開ダイアログで、Foundry のほかの関数と同様に、関数の名前と API 名を指定します。
オントロジー SQL 関数は、選択した列に対応するフィールドを持つ構造体のリストを返します。結果の各行につき1個の構造体が返されます。選択した列が1列のみの場合は、代わりにその列のデータ型のリストを返します。たとえば、SELECT animal, animalType, age FROM ... は List<Struct<animal: STRING, animalType: STRING, age: INTEGER>> を返し、SELECT animal FROM ... は List<STRING> を返します。
関数を公開すると、ほかのオントロジー関数と同様に、Workshop、Actions、Automate、OSDK など、Foundry 全体で使用できます。オントロジー SQL 関数は、TypeScript 関数や Python 関数から呼び出すこともできます。Foundry のほかの関数と同様に、オントロジー SQL 関数はブランチおよびシナリオに対するクエリをサポートしています。
オントロジー SQL 全般の詳細については、オントロジー SQL の概要を参照してください。