CockroachDB

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则 Operations 列表中不会列出此类不受支持的操作。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作会有一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

操作

本部分列出了该连接器支持的操作。如需了解如何配置操作，请参阅操作示例。

ExecuteCustomQuery 操作

通过此操作，您可以执行自定义查询。

如需创建自定义查询，请按照下列步骤操作：

1. 按照详细说明添加连接器任务。
2. 配置连接器任务时，在要执行的动作类型中选择动作。
3. 在动作列表中，选择执行自定义查询，然后点击完成。

   

4. 展开任务输入部分，然后执行以下操作：
   1. 在在以下时间后超时字段中，输入查询执行前要等待的秒数。

      默认值：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. 在连接器任务的任务输入部分中，点击 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。

过滤条件子句的值应始终以此格式通过单引号 (') 传递。
可用于根据任何列过滤记录。

您可以对以下实体执行“列出”操作：

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 是应传递的唯一主键值。

   在某些情况下，传递单个实体 ID 会抛出错误，因为系统会使用两个复合键。
   在这种情况下，您可以使用过滤条件子句并传递值，例如 EmployeeId='5'。

您可以对以下实体执行“列出”操作：

Cockroach_Datatypes、Accounts、SpatialData、UNICODE 和 LANGUAGES

示例 - 删除“Employees”记录

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

示例 - 创建“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 列表中选择“员工”。
3. 选择 Update 操作，然后点击完成。
4. 在数据映射任务的数据映射器部分，点击 Open Data Mapping Editor，然后在 Input Value 字段中输入类似于以下内容的值，并选择 EntityId/ConnectorInputPayload/FilterClause 作为“本地变量”。

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

5. 将 Data Mapper 中的实体 ID 设置为“Employees”的实体。如需设置实体 ID，请点击 Open Data Mapping Editor，然后在 Input Value 字段中输入类似于以下内容的值，并选择 EntityId/ConnectorInputPayload/FilterClause 作为“本地变量”。

   您也可以将 filterClause 设置为 1，而不是指定 entityId。

   运行此示例会在连接器任务的 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 作为本地变量。

   您也可以将 filterClause 设置为 1，而不是指定 entityId。

   运行此示例会在连接器任务的 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 作为本地变量。

   您也可以将 filterClause 设置为 3，而不是指定 entityId。

   运行此示例会在连接器任务的 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 作为“本地变量”。

   您也可以将 filterClause 设置为 id= 1，而不是指定 entityId。

   运行此示例会在连接器任务的 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 作为“本地变量”。

   您也可以将 filterClause 设置为 id= 1，而不是指定 entityId。

   运行此示例会在连接器任务的 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 作为“本地变量”。

   您也可以将 filterClause 设置为 2，而不是指定 entityId。

   运行此示例会在连接器任务的 connectorOutputPayload 输出变量中返回类似于以下内容的响应：

   {
   }