Cloud SQL for MySQL

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

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

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

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

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

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

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

サポートされているデータ型

このコネクタでサポートされているデータ型は次のとおりです。

• BIGINT
• BINARY
• BIT
• BOOLEAN
• CHAR
• DATE
• DECIMAL
• DOUBLE
• FLOAT
• INTEGER
• LONGN VARCHAR
• LONG VARCHAR
• NCHAR
• NUMERIC
• NVARCHAR
• REAL
• SMALL INT
• TIME
• TIMESTAMP
• TINY INT
• VARBINARY
• VARCHAR

アクション

このコネクタは、次のアクションの実行をサポートしています。

• ユーザー定義のストアド プロシージャと関数。バックエンドにストアド プロシージャと関数がある場合、それらは Configure connector task ダイアログの Actions 列に表示されます。
• カスタム SQL クエリ。カスタム SQL クエリを実行するため、コネクタは [カスタムクエリを実行する] アクションを備えています。

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

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

     

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

        デフォルト値: 180 秒

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

        デフォルト値: 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. [値] フィールドに、パラメータの値を入力します。
        3. 複数のパラメータを追加するには、[+ クエリ パラメータを追加] をクリックします。

アクションの例

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

この例では、ユーザー定義関数の実行方法を示します。この例の 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
}]

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

例 - エンティティのレコードを一覧表示する

この例では、Users エンティティのレコードを一覧表示します。

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

   たとえば、フィルタ句を employeeCode='5100' and startDate='2010-01-01 00:00:00' に設定すると、employeeCode が 5100 であり、startDate が 2010-01-01 00:00:00 であるレコードのみが一覧表示されます。

例 - エンティティから単一レコードを取得する

この例では、Users エンティティからレコードを取得します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から User を選択します。
3. [Get] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 103032 を入力します。

   ここで、103032 は Users エンティティの主キー値です。

例 - エンティティからレコードを削除する

この例では、Users エンティティからレコードを削除します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Users を選択します。
3. [Delete] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタタスクの [タスク入力] セクションの [entityId] をクリックし、[デフォルト値] フィールドに 113132 を入力します。

   または、エンティティに複合主キーがある場合、entityId を指定する代わりに、filterClause を設定できます。たとえば、employeeCode='5100' and startDate='2010-01-01 00:00:00' です。

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

この例では、Users エンティティに レコードを作成します。

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

   {
   "employeeCode": "5100",
   "startDate": "2010-01-01 00:00:00.0",
   "country": "US"
   }

統合が成功すると、コネクタタスクの connectorOutputPayload フィールドに create オペレーションのレスポンスが返されます。

例 - エンティティ内のレコードを更新する

この例では、Users エンティティに レコードを作成します。

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

   {
   "country": "IN"
   }

5. [コネクタタスクの [タスク入力] セクションの [entityId] をクリックし、[デフォルト値] フィールドに 113132 を入力します。

   または、エンティティに複合主キーがある場合、entityId を指定する代わりに、filterClause を設定できます。たとえば、employeeCode='5100' and startDate='2010-01-01 00:00:00' です。

統合が成功すると、コネクタタスクの connectorOutputPayload フィールドに update オペレーションのレスポンスが返されます。