CockroachDB

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

動作

本節列出連接器支援的操作。如要瞭解如何設定動作，請參閱「動作範例」。

ExecuteCustomQuery 動作

這項操作可讓您執行自訂查詢。

如要建立自訂查詢，請按照下列步驟操作：

1. 請按照詳細說明 新增連接器工作。
2. 設定連接器工作時，請在要執行的動作類型中選取「動作」。
3. 在「動作」清單中，選取「執行自訂查詢」，然後按一下「完成」。

   

4. 展開「Task input」(工作輸入) 區段，然後執行下列操作：
   1. 在「Timeout after」(逾時時間) 欄位中，輸入查詢執行前的等待秒數。

      預設值：180 秒。

   2. 在「資料列數量上限」欄位中，輸入要從資料庫傳回的資料列數量上限。

      預設值為 25。

   3. 如要更新自訂查詢，請按一下「編輯自訂指令碼」。「指令碼編輯器」對話方塊隨即開啟。

      

   4. 在「指令碼編輯器」對話方塊中輸入 SQL 查詢，然後按一下「儲存」。

      您可以在 SQL 陳述式中使用問號 (?) 代表單一參數，該參數必須在查詢參數清單中指定。舉例來說，下列 SQL 查詢會從 Employees 資料表選取與 LastName 資料欄指定值相符的所有資料列：

      SELECT * FROM Employees where LastName=?

   5. 如果您在 SQL 查詢中使用問號，請為每個問號點按「+ 新增參數名稱」，加入參數。執行整合時，這些參數會依序取代 SQL 查詢中的問號 (?)。舉例來說，如果您新增了三個問號 (?)，就必須依序新增三個參數。

      

      如要新增查詢參數，請按照下列步驟操作：

      1. 在「類型」清單中，選取參數的資料類型。
      2. 在「值」欄位中輸入參數值。
      3. 如要新增多個參數，請按一下「+ 新增查詢參數」。

執行成功後，這項動作會傳回狀態 200 (OK)，以及含有查詢結果的回應內容。

動作範例

範例 - 找出較大的值

這個範例說明如何執行使用者定義函式。在本範例中，find_greater 函式會比較兩個整數，並傳回較大的整數。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 find_greater 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

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

如果動作執行成功，連接器工作的 connectorOutputPayload 欄位會包含類似以下內容的值：

[{
"bignum": 5.0
}]

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 列出所有員工記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Employees。
3. 選取「List」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，您可以根據客戶需求設定 filterClause。

篩選子句的值一律應以單引號 (') 括住，格式如下：
可用於根據任何資料欄篩選記錄。

您可以對下列實體執行 List 作業：

Cockroach_Datatypes、Accounts、SpatialData、UNICODE、LANGUAGES 和 View_Cockroach

範例 - 取得員工記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Employees。
3. 選取「Get」作業，然後按一下「完成」。
4. 將實體 ID 設為 5，也就是要傳遞的鍵。如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 5，並選擇 EntityId 做為本機變數。

   實體 ID 的值應直接傳遞。這裡的 5 是應傳遞的不重複主鍵值。

   在某些情況下，傳遞單一實體 ID 會擲回錯誤，因為會有兩個複合鍵。
   在這種情況下，您可以運用篩選子句並傳遞值，例如 EmployeeId='5'。

您可以對下列實體執行 List 作業：

Cockroach_Datatypes、Accounts、SpatialData、UNICODE 和 LANGUAGES

範例 - 刪除員工記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Employees。
3. 選取「Delete」作業，然後按一下「完成」。
4. 將實體 ID 設為 2，也就是要傳遞的金鑰。如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 2，並選擇 EntityId 做為本機變數。

   如果實體有兩個複合式商家或主鍵，而非指定 entityId，您也可以將 filterClause 設為 EmployeeId='2'。

您可以對下列實體執行刪除作業：

Cockroach_Datatypes、Accounts、SpatialData、UNICODE 和 LANGUAGES

範例 - 建立「員工」記錄

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"
   }
   

範例 - 建立帳戶記錄

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
   }
   

範例 - 更新員工記錄

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取「員工」。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「資料對應」工作的「資料對應器」部分中，按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇 EntityId/ConnectorInputPayload/FilterClause 做為本機變數。

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

5. 在 Data Mapper 中，將實體 ID 設為「員工」實體。如要設定實體 ID，請按一下 Open Data Mapping Editor，然後在 Input Value 欄位中輸入類似下列的值，並選擇「EntityId/ConnectorInputPayload/FilterClause」做為本機變數。

   除了指定 entityId，您也可以將 filterClause 設為 1。

   執行這個範例後，Connector 工作的 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。

   執行這個範例後，Connector 工作的 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。

   執行這個範例後，Connector 工作的 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。

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

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

範例 - 更新帳戶記錄

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。

   執行這個範例後，Connector 工作的 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。

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
   }