CockroachDB

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

• エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

  ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

• オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
  • リスト
  • 取得
  • 作成
  • 更新
  • 削除

  使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

• アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

アクション

このセクションには、コネクタでサポートされているアクションが一覧表示されます。アクションの構成方法については、アクションの例をご覧ください。

ExecuteCustomQuery アクション

このアクションにより、カスタムクエリを実行できます。

カスタムクエリを作成する手順は次のとおりです。

1. 詳細な手順に沿って、コネクタタスクを追加します。
2. コネクタタスクを構成するときに、実行するアクションの種類で [Actions] を選択します。
3. [Actions] リストで [Execute custom query] を選択し、[Done] をクリックします。

   

4. [Task input] セクションを開き、次の操作を行います。
   1. [タイムアウト後] フィールドに、クエリが実行されるまで待機する秒数を入力します。

      デフォルト値: 180 秒

   2. [Maximum number of rows] フィールドに、データベースから返される最大行数を入力します。

      デフォルト値: 25。

   3. カスタムクエリを更新するには、[Edit Custom Script] をクリックします。[Script editor] ダイアログが開きます。

      

   4. [Script editor] ダイアログで、SQL クエリを入力して [Save] をクリックします。

      SQL ステートメントで疑問符（?）を使用して、クエリ パラメータ リストで指定する必要がある 1 つのパラメータを表すことができます。たとえば、次の SQL クエリは、LastName 列に指定された値と一致する Employees テーブルからすべての行を選択します。

      SELECT * FROM Employees where LastName=?

   5. SQL クエリで疑問符を使用した場合は、各疑問符の [+ パラメータ名を追加] をクリックして、パラメータを追加する必要があります。統合の実行中に、これらのパラメータにより SQL クエリ内の疑問符（?）が順番に置き換わります。たとえば、3 つの疑問符（?）を追加した場合、3 つのパラメータを順番に追加する必要があります。

      

      クエリ パラメータを追加する手順は次のとおりです。

      1. [Type] リストから、パラメータのデータ型を選択します。
      2. [Value] フィールドに、パラメータの値を入力します。
      3. 複数のパラメータを追加するには、[+ クエリ パラメータを追加] をクリックします。

アクションが正常に実行されると、クエリ結果のあるレスポンスの本文でステータス 200（OK）を返します。

アクションの例

例 - 大きい方の値を求める

この例では、ユーザー定義関数の実行方法を示します。この例の find_greater 関数は、2 つの整数を比較し、大きい方の整数を返します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [find_greater] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
   "$1": 1.0,
   "$2": 5.0
   }

アクションの実行に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

[{
"bignum": 5.0
}]

エンティティ オペレーションの例

このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。

例 - すべての Employees レコードを一覧表示する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Employees を選択します。
3. [List] オペレーションを選択し、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで、お客様の要件に応じて filterClause を設定できます。

フィルタ句の値は、常にこの形式で単一引用符（'）で渡す必要があります。
任意の列に基づいてレコードをフィルタできます。

List オペレーションは、次のエンティティに対して実行できます。

Cockroach_Datatypes、Accounts、SpatialData、UNICODE、LANGUAGES、View_Cockroach

例 - Employees レコードを取得する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Employees を選択します。
3. [Get] オペレーションを選択し、[完了] をクリックします。
4. エンティティ ID を 5 に設定します。これは渡されるキーです。エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに 5 を入力し、EntityId をローカル変数として選択します。

   エンティティ ID の値は直接渡す必要があります。ここで、5 は一意の主キー値であり、渡す必要があります。

   2 つの複合キーが存在するため、単一のエンティティ ID を渡すとエラーがスローされる場合があります。
   このような場合は、フィルタ句を使用して、EmployeeId='5' などの値を渡すことができます。

List オペレーションは、次のエンティティに対して実行できます。

Cockroach_Datatypes、Accounts、SpatialData、UNICODE、LANGUAGES

例 - Employees レコードを削除する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Employees を選択します。
3. [Delete] オペレーションを選択し、[完了] をクリックします。
4. エンティティ ID を 2 に設定します。これは渡されるキーです。エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに 2 を入力し、EntityId をローカル変数として選択します。

   エンティティに 2 つの複合ビジネスキーまたは主キーがある場合、entityId を指定する代わりに、filterClause を EmployeeId='2' に設定することもできます。

Delete オペレーションは、次のエンティティに対して実行できます。

Cockroach_Datatypes、Accounts、SpatialData、UNICODE、LANGUAGES

例 - Employees レコードを作成する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Employees を選択します。
3. [Create] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。

   {
     "id": 100.0,
     "gender": "Male",
     "firstname": "Charlie",
     "lastname": "Cruz",
     "designation": "Tester",
     "dept": "IT"
   }
   

   統合が成功すると、Employees タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

   {
     "id": 100.0,
     "gender": "Male",
     "firstname": "Charlie",
     "lastname": "Cruz",
     "designation": "Tester",
     "dept": "IT"
     }
     

例 - Cockroach_Datatypes レコードを作成する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity リストから Cockroach_Datatypes を選択します。
3. [Create] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。

   {
     "col_int": 8.0,
     "col_date": "2016-03-26",
     "col_inet": "190.0.0.0",
     "col_collate": "Cruz",
     "col_string": "Charlie",
     "col_timestamp": "1992-10-05 12:12:12",
     "col_float": 12.12,
     "col_decimal": 10.1,
     "col_json": "{\"type\": \"account creation\", \"username\": \"harvestboy93\"}",
     "col_bool": true,
     "col_interval": "1 year 2 mons 3 days 04:05:06",
     "col_array": "{sky,road,car}",
     "col_uuid": "63616665-6630-3064-6465-616462656562",
     "col_time": "05:41:39",
     "col_bytes": "abc",
     "col_bit": "1",
     "col_name": "Charlie",
     "col_character": "A",
     "col_tsvector": "ts",
     "col_tsquery": "normal",
     "col_oid": "11",
     "col_bytea": "01100001"
   }
   

   統合が成功すると、Cockroach_Datatypes タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

   {
     "col_int": 8.0,
     "col_date": "2016-03-26",
     "col_inet": "190.0.0.0",
     "col_collate": "Cruz",
     "col_string": "Charlie",
     "col_timestamp": "1992-10-05 12:12:12",
     "col_float": 12.12,
     "col_decimal": 10.1,
     "col_json": "{\"type\": \"account creation\", \"username\": \"harvestboy93\"}",
     "col_bool": true,
     "col_interval": "1 year 2 mons 3 days 04:05:06",
     "col_array": "{sky,road,car}",
     "col_uuid": "63616665-6630-3064-6465-616462656562",
     "col_time": "05:41:39",
     "col_bytes": "abc",
     "col_bit": "1",
     "col_name": "Charlie",
     "col_character": "A",
     "col_tsvector": "ts",
     "col_tsquery": "normal",
     "col_oid": "11",
     "col_bytea": "01100001"
     }
     

例 - エンティティ LANGUAGES レコードを作成する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から LANGUAGES を選択します。
3. [Create] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。

   {
     "id": 5.0,
     "hinditext": "नमस्ते",
     "englishtest": "Namaste",
     "arabictext": "مرحبا",
     "germantext": "Günther"
   } 
   

   アクションが成功すると、LANGUAGES タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

   {
   "id": 6.0,
   "hinditext": "नमस्ते",
   "englishtest": "Namaste",
   "arabictext": "مرحبا",
   "germantext": "Günther"
   }
   

例 - UNICODE レコードを作成する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity リストから UNICODE を選択します。
3. [Create] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。

   {
     "id": 2.0,
     "unicodedata": "Unicode データ型はグローバル化されたデータの保存に使用されます",
     "test": "UnicodeTest"
   }
   

アクションが成功すると、UNICODE タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

{
"id": 2.0,
"unicodedata": "Unicode データ型はグローバル化されたデータの保存に使用されます",
"test": "UnicodeTest"
}

例 - SpatialData レコードを作成する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity リストから SpatialData を選択します。
3. [Create] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。

   {
     "id": 10.0,
     "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164548"
   }
   

   この例では、SpatialData レコードを作成します。アクションが成功すると、SpatialData タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

   {
   "id": 10.0,
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164548"
   }
   

例 - Accounts レコードを作成する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Accounts を選択します。
3. [Create] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。

   {
     "balance": 2000.0,
     "status": "open",
     "id": 7.0
   }
   

   この例では、SpatialData レコードを作成します。アクションが成功すると、SpatialData タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

   {
   "balance": 2000.0,
   "status": "open",
   "id": 7.0
   }
   

例 - Employees レコードを更新する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity リストから [Employees] を選択します。
3. [Update] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データマッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

    {
     "dept": "Comp",
     "designation": "QA"
   }
   

5. データマッパーでエンティティ ID を従業員のエンティティに設定します。エンティティ ID を設定するには、[Open Data Mapping Editor] をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   [entityId] を指定する代わりに、[filterClause] を 1 に設定することもできます。

   この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

   {
   }
   

例 - LANGUAGES レコードを更新する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から LANGUAGES を選択します。
3. [Update] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データマッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

    {
     "englishtest": "UpdateTest_TEST"
   }
   

5. データマッパーでエンティティ ID を配列のエンティティに設定します。エンティティ ID を設定するには、[Open Data Mapping Editor] をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   [entityId] を指定する代わりに、[filterClause] を 1 に設定することもできます。

   この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

   {
   }
   

例 - UNICODE レコードを更新する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から UNICODE を選択します。
3. [Update] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データマッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

    {
     "unicodedata": "ータ型はグロ",
     "test": "UpdateTest"
   }
   

5. データマッパーでエンティティ ID を ObjectType のエンティティに設定します。エンティティ ID を設定するには、[Open Data Mapping Editor] をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   [entityId] を指定する代わりに、[filterClause] を 3 に設定することもできます。

   この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

   {
   }
   

例 - SpatialData レコードを更新する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Spatialdata を選択します。
3. [Update] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データマッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   {
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164543"
   } 
   

5. データマッパーでエンティティ ID を TableType のエンティティに設定します。エンティティ ID を設定するには、[Open Data Mapping Editor] をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   [entityId] を指定する代わりに、[filterClause] を id= 1 に設定することもできます。

   この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

   {
   "id": 1,
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164543"
   }
   

例 - Accounts レコードを更新する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Accounts を選択します。
3. [Update] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データマッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   {
   "balance": 1500.0,
   "status": "open"
   }
   

5. データマッパーでエンティティ ID を TableType のエンティティに設定します。エンティティ ID を設定するには、[Open Data Mapping Editor] をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   [entityId] を指定する代わりに、[filterClause] を id= 1 に設定することもできます。

   この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

   {
   "id": 1,
   "balance": 1500,
   "status": "open"
   }
   

例 - Cockroach_Datatypes レコードを更新する

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Cockroach_Datatypes を選択します。
3. [Update] オペレーションを選択し、[完了] をクリックします。
4. [データ マッピング] タスクの [データマッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   {
   "col_date": "2019-03-26",
   "col_collate": "Charlie",
   "col_string": "Cruz"
   }
   

5. データマッパーでエンティティ ID を TableType のエンティティに設定します。エンティティ ID を設定するには、[Open Data Mapping Editor] をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

   [entityId] を指定する代わりに、[filterClause] を 2 に設定することもできます。

   この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

   {
   }