ローカルオントロジー SDK

TypeScript v2 および Python の関数は、ローカルオントロジー SDK をサポートしています。ローカルオントロジー SDK は、個別のパッケージとして手動でバージョン管理してインストールするのではなく、リソースのインポートから自動生成されます。このため、SDK のデータ型は常に最新のリソースのインポートに対応しています。Global Branching を完全にサポートするには、ローカル SDK が必要です。

新しいローカル SDK をセットアップする

リポジトリ用のローカル SDK を初めて作成する場合は、以下の手順に沿って進めてください。

1. Code Repositories または VS Code で、リソースサイドパネルを開きます。
2. パネルの右下から選択を選びます。コードエディターにインポートするリソースを変更タブが開きます。
3. ドロップダウンメニューから利用可能なオントロジーを選択します。
4. サイドパネルから、インポートするオブジェクトタイプ、リンクタイプ、インターフェースタイプ、およびその他のリソースを選びます。

オントロジーからリソースを追加すると、SDK が新しいバージョンに自動更新され、リポジトリ内にコードバインディングが生成されます。その後、SDK パッケージからオントロジーリソースをインポートし、関数シグネチャで使用できます。関数のバージョンにタグを付けると、タグ付け時点のオントロジーの状態を反映した SDK が CI で生成され、その関数バージョンにバンドルされます。

コマンドラインから SDK を生成する

VS Code を使用していない場合は、./rune コマンドラインツールを使用してローカル SDK を生成および再生成できます。まず、開発環境を準備します。

Copied!
1
./rune env prepare

SDK を初めて生成するには、パッケージ名を指定します。

Copied!
1
./rune sdk generate --sdk-package-name ontology

パッケージ名によって、コード内のオントロジーリソースのインポートパスが決まります（例：import { MyObjectType } from "@ontology/sdk"）。任意のパッケージ名を選べますが、デフォルトでは ontology を使用するのが慣例です。

リソースのインポートを変更した後に SDK を再生成するには、次を実行します。

Copied!
1
./rune sdk generate

リポジトリに ./rune がない場合は、.palantir-scripts/install-rune を実行してインストールします。

既存のリポジトリをローカル SDK に移行する

リポジトリをスタンドアロン SDK からローカル SDK に移行するには、次の手順を実行します。

1. リポジトリ内の functions.json ファイルを見つけ、useSdkSidebar を false に設定します。

2. リソースサイドパネルに移動します。上部の移行を選択してローカル SDK を生成し、自動生成された変更をコミットします。TypeScript v2 では、これにより package.json ファイルと package-lock.json ファイルが更新されます。Python では、meta.yaml ファイルと hawk.lock ファイルが更新されます。