Couchbase Lookup

支持的管道类型:

  •  Data Collector

Couchbase Lookup处理器在Couchbase Server中查找文档,并将值返回到记录中的字段。使用Couchbase Lookup处理器可以用其他数据丰富记录。

例如,假设Couchbase Server具有多个部门文档,每个文档都列出一个部门中的雇员。您可以配置管道以在记录头属性中存储Couchbase文档键,其唯一标识每个部门。然后,包括一个Couchbase Lookup处理器以查找匹配的文档,并将值返回到department_employees 记录中的新字段。

Couchbase Lookup处理器可以使用文档键或Couchbase服务器查询语言N1QL查找文档。对于键查找,处理器可以将整个文档中的数据返回到指定的map字段。另外,对于键和N1QL查找,处理器可以将数据从子文档返回到指定的map字段。对于N1QL查找,当查找导致多个匹配的文档时,Couchbase Lookup处理器可以从第一个匹配的文档返回值,或者从单独的记录中的所有匹配的文档返回值。

配置Couchbase Lookup处理器时,您输入连接信息,例如要连接的节点和存储桶,以及连接的超时属性。(可选)您可以为连接启用TLS。您还输入信息以通过Couchbase Server进行身份验证。

记录头属性

对于键/值查找,Couchbase Lookup处理器会创建一个记录头属性couchbase.cas,该属性存储一个表示所查找文档状态的值。

配置为使用CAS(比较和交换)时,Couchbase目标使用此属性值来防止与其他进程冲突。

配置Couchbase Lookup处理器

配置Couchbase Lookup处理器以在Couchbase服务器中查找数据。

  1. 在“Properties”面板的“General选项卡上,配置以下属性:
    一般属性 描述
    Name 艺名。
    Description 可选说明。
    Required Fields 必须包含用于将记录传递到阶段的记录的数据的字段。

    提示:您可能包括舞台使用的字段。

    根据为管道配置的错误处理,处理不包括所有必填字段的记录。

    前提条件 必须评估为TRUE的条件才能使记录进入处理阶段。单击 添加以创建其他前提条件。

    根据为该阶段配置的错误处理,处理不满足所有前提条件的记录。

    记录错误 该阶段的错误记录处理:

    • Discard-放弃记录。
    • To Error-将记录发送到管道以进行错误处理。
    • Stop Pipeline-停止管道。
  2. 在“Couchbase”选项卡上,配置以下属性:
    Couchbase属性 描述
    Node List Couchbase群集中的一个或多个节点,以逗号分隔。
    Bucket 要连接的现有Couchbase存储桶的名称。
    Key-Value Timeout (ms) 执行每个键值操作所允许的最大毫秒数。
    Connect Timeout (ms) 连接到Couchbase服务器所允许的最大毫秒数。
    Disconnect Timeout (ms) 正常关闭连接所允许的最大毫秒数。
    Advanced Environment Settings 与Couchbase Server连接的客户端设置。有关可用设置,请参阅Couchbase Java SDK文档
    Use TLS 启用TLS的使用。
    Keystore File 密钥库文件的路径。输入文件的绝对路径或相对于Data Collector资源目录$SDC_RESOURCES的路径。

    有关环境变量的更多信息,请参阅《 Data Collector环境配置》。

    默认情况下,不使用任何密钥库。

    Keystore Type 要使用的密钥库的类型。使用以下类型之一:

    • Java Keystore File (JKS)
    • PKCS #12 (p12 file)

    默认值为Java Keystore File(JKS)。

    Keystore Password 密钥库文件的密码。密码是可选的,但建议使用。

    提示:要保护敏感信息(例如密码),可以使用运行时资源或凭据存储。
    Keystore Key Algorithm 用于管理密钥库的算法。

    默认值为 SunX509

    Truststore File 信任库文件的路径。输入文件的绝对路径或相对于Data Collector资源目录$SDC_RESOURCES的路径。

    有关环境变量的更多信息,请参阅《 Data Collector环境配置》。

    默认情况下,不使用任何信任库。

    Truststore Type 要使用的信任库的类型。使用以下类型之一:

    • Java Keystore File (JKS)
    • PKCS #12 (p12 file)

    默认值为Java Keystore File(JKS)。

    Truststore Password 信任库文件的密码。密码是可选的,但建议使用。

    提示:要保护敏感信息(例如密码),可以使用运行时资源或凭据存储。
    Truststore Trust Algorithm 用于管理信任库的算法。

    默认值为SunX509

  3. 在“Credentials选项卡上,配置以下属性:
    Credentials属性 描述
    Authentication Mode 使用Couchbase服务器进行身份验证的方法:

    • Bucket Authentication-使用存储桶密码进行身份验证。用于Couchbase Server 4.x和更早版本。
    • User Authentication-使用Couchbase用户名和密码进行身份验证。用于Couchbase Server 5.0和更高版本。
    Bucket Password 如果存储桶在Couchbase数据库中受保护,则访问该存储桶的密码。

    提示: 要保护敏感信息(例如用户名和密码),可以使用运行时资源或凭据存储。

    可用于存储桶身份验证。

    User Name Couchbase用户名。

    可用于用户验证。

    Password Couchbase密码。

    提示: 要保护敏感信息(例如用户名和密码),可以使用 运行时资源或凭据存储。

    可用于用户验证。

  4. 在“Lookup选项卡上,配置以下属性:
    Lookup属性 描述
    Lookup Type 指定查找的方法:

    • 键/值-使用文档键来查找文档。
    • N1QL-使用Couchbase Server查询语言查找文档。
    Document Key 处理器查找的文档的唯一ID或键。例如,您可以指定一个解析为文档关键字的表达式。

    可用于键/值查找。

    N1QL Query 返回文档的查询。在N1QL中指定Couchbase服务器查询语言。有关更多信息,请参见Couchbase文档。

    可用于N1QL查找。

    Return Properties 返回特定的子文档,而不是完整的文档。

    可用于键/值查找。

    Property Mappings 将返回的子文档映射到记录中的字段的列表。

    输入以下内容:

    • Property Name-返回的子文档。使用点表示法语法可分隔文档层次结构中的组件。有关更多信息,请参见 Couchbase文档
    • SDC Field-处理器返回子文档的记录中的映射字段的名称。

    返回子文档时可用于键/值查询,也可用于N1QL查询。

    SDC Field 记录中处理器从其中返回数据的映射字段的名称。您可以指定一个现有字段或一个新字段。如果该字段不存在,则Couchbase查找处理器将创建该字段。

    不返回子文档时可用于键/值查找。

    Submit as Prepared Statement 将查询作为准备好的语句提交到Couchbase。

    可用于N1QL查找。

    Query Timeout (ms) Couchbase服务器完成查询所允许的最大毫秒数。

    可用于N1QL查找。

    Multiple Value Behavior 当查找找到多个文档时要采取的措施:

    • First value only-返回第一个文档中的值。
    • Split into multiple records-将每个文档中的值返回到单独的记录。

    可用于N1QL查找。

    Missing Value Behavior 查找不返回任何文档时要采取的措施:

    • Send to error-将记录发送到错误。
    • Pass the record along the pipeline unchanged-传递没有查找返回值的记录。