ソースエイリアス

ソースエイリアスは、Data Connection ソースを参照する、名前付きの移植可能な参照です。特定のソース識別子ではなくエイリアスキーでソースを参照すると、関数のロジックが特定のソースに依存しなくなります。これにより、関数の環境間での移植性が保たれます。

ソースをインポートする

ソースをインポートするには、次の手順に従います。

1. TypeScript v2 または Python のコードリポジトリを開き、リソースのインポートパネルに移動します。

2. オントロジー SDK タブを選択します。

3. 追加 > ソースを選択します。

   

4. インポートするソースを検索して選択し、選択を確定を選択します。

ソースエイリアスを追加する

ソースをインポートした後、そのソースにエイリアスを追加できます。

1. リソースのインポートパネルのソースで、対象のソースを見つけます。

2. ソース名の下にあるエイリアスを追加を選択します。

   

ソースエイリアスを編集する

既存のソースエイリアスを編集するには、リソースのインポートパネルのソースセクションに移動します。エイリアスの横にあるペンアイコンを選択して、インラインで編集します。

コードでソースエイリアスを使用する

関数でソースエイリアスを使用するには、ソースを宣言および取得するすべての箇所で、キーを使ってエイリアスを参照します。エイリアスキーを sources 設定と、getSource（TypeScript v2）または get_source（Python）に渡します。

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import { getSource, getHttpsConnection, getFetch } from "@palantir/functions-sources";

export const config = {
    sources: ["demoSource"]
}

async function myExternalFunction(): Promise<string> {
    const source = await getSource("demoSource");
    const { url } = getHttpsConnection(source);
    const fetch = await getFetch(source);

    const response = await fetch(url);

    return response.text();
}

Copied!
1
2
3
4
5
6
7
8
9
10
11
from functions.api import function
from functions.sources import get_source


@function(sources=["demoSource"])
def my_external_function() -> str:
    source = get_source("demoSource")
    url = source.get_https_connection().url
    client = source.get_https_connection().get_client()
    response = client.get(url)
    return response.text

エイリアスの解決先となるソースのリソース識別子（RID）が必要な場合は、TypeScript v2 の Aliases.source ユーティリティまたは Python の source ユーティリティを使用します。解決された RID は .rid プロパティから読み取ります。

Copied!
1
2
3
import { Aliases } from "@osdk/functions";

const sourceRid = Aliases.source("demoSource").rid;

Copied!
1
2
3
from functions.aliases import source

source_rid = source("demoSource").rid

資格情報へのアクセスや事前設定済みクライアントの使用など、関数でのソースの使用について詳しくは、関数から API を呼び出すを参照してください。

Marketplace でソースエイリアスを使用する

ソースエイリアスを使用する関数を Marketplace 製品に追加すると、エイリアスが設定されたソースがそれぞれData Connection ソースの下に設定可能な入力として表示されます。インストール担当者は、関数のソースコードを変更せずに、インストール時に各入力ソースを環境内の利用可能なソースにマッピングできます。

説明を設定する

インストール担当者が指定すべきソースを理解できるように、ソース入力に説明を追加できます。入力でソースを選択して詳細パネルを開き、全般タブで説明を入力します。

インストール時の操作

インストール時に、インストール担当者にはソースの説明が表示され、環境に適したソースを選択できます。Marketplace は、選択されたソースを定義済みのエイリアスに自動的に再マッピングするため、関数のコードは変更されません。