OpenSearch 的解析器映射模板参考 - Amazon AppSync
请求映射模板响应映射模板operation 字段path 字段params 字段传递变量
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

OpenSearch 的解析器映射模板参考

注意

我们现在主要支持 APPSYNC_JS 运行时环境及其文档。请考虑使用 APPSYNC_JS 运行时环境和此处的指南。

通过使用适用于 Amazon OpenSearch Service 的 Amazon AppSync 解析器，您可以使用 GraphQL 在您的账户的现有 OpenSearch Service 域中存储和检索数据。该解析器的工作方式是，允许您将传入的 GraphQL 请求映射到 OpenSearch Service 请求，然后将 OpenSearch Service 响应映射回 GraphQL。本节介绍了支持的 OpenSearch Service 操作的映射模板。

请求映射模板

大多数 OpenSearch Service 请求映射模板具有通用结构，其中仅几个部分发生变化。以下示例对 OpenSearch Service 域运行搜索，其中文档是按照名为 post 的索引组织的。搜索参数在 body 部分定义，而许多常用查询子句在 query 字段中定义。此示例将搜索在文档的 "Nadia" 字段中包含 "Bailey" 和/或 author 的文档。

{
    "version":"2017-02-28",
    "operation":"GET",
    "path":"/post/_search",
    "params":{
        "headers":{},
        "queryString":{},
        "body":{
            "from":0,
            "size":50,
            "query" : {
                "bool" : {
                    "should" : [
                        {"match" : { "author" : "Nadia" }},
                        {"match" : { "author" : "Bailey" }}
                    ]
                }
            }
        }
    }
}

响应映射模板

与其他数据源一样，OpenSearch Service 向 Amazon AppSync 发送响应，该响应需要转换为 GraphQL。

大多数 GraphQL 查询从 OpenSearch Service 响应中查找 _source 字段。由于您可以搜索以返回单个文档或文档列表，因此，可以在 OpenSearch Service 中使用两种常见的响应映射模板：

结果列表 

[
    #foreach($entry in $context.result.hits.hits)
      #if( $velocityCount > 1 ) , #end
        $utils.toJson($entry.get("_source"))
    #end
]

单个项目 

$utils.toJson($context.result.get("_source"))

operation 字段

（仅限请求映射模板）

Amazon AppSync 发送到 OpenSearch Service 域的 HTTP 方法或动词（GET、POST、PUT、HEAD 或 DELETE）。键和值都必须是字符串。

"operation" : "PUT"

path 字段

（仅限请求映射模板）

来自 Amazon AppSync 的 OpenSearch Service 请求的搜索路径。这构成了操作的 HTTP 谓词的 URL。键和值都必须是字符串。

"path" : "/<indexname>/_doc/<_id>"
"path" : "/<indexname>/_doc"
"path" : "/<indexname>/_search"
"path" : "/<indexname>/_update/<_id>

在评估映射模板时，该路径作为 HTTP 请求的一部分发送，包括 OpenSearch Service 域。例如，上一个示例可能会转换为：

GET https://opensearch-domain-name.REGION.es.amazonaws.com/indexname/type/_search

params 字段

（仅限请求映射模板）

用于指定搜索执行的操作，最常见的是在正文中设置查询值。但是，可以配置若干其他功能，如响应的格式设置。

  • headers

    标头信息（为键值对）。键和值都必须是字符串。例如：

    "headers" : {
    "Content-Type" : "application/json"
}
    注意

    Amazon AppSync 目前仅支持将 JSON 作为 Content-Type。

  • queryString

    指定常用选项的键值对，如 JSON 响应的代码格式设置。键和值都必须是字符串。例如，如果您要获得格式正确的 JSON，应使用：

    "queryString" : {
    "pretty" : "true"
}

  • body

    这是请求的主要部分，它允许 Amazon AppSync 为您的 OpenSearch Service 域创建正确格式的搜索请求。键必须是组成对象的一个字符串。下面介绍了几个演示。

示例 1

返回城市与“seattle”匹配的所有文档：

"body":{
    "from":0,
    "size":50,
    "query" : {
        "match" : {
            "city" : "seattle"
        }
    }
}

示例 2

返回将“washington”作为城市或州匹配的所有文档。

"body":{
    "from":0,
    "size":50,
    "query" : {
        "multi_match" : {
            "query" : "washington",
            "fields" : ["city", "state"]
        }
    }
}

传递变量

（仅限请求映射模板）

还可以在 VTL 语句中作为评估的一部分传递变量。例如，假设您具有以下 GraphQL 查询，如下所示：

query {
    searchForState(state: "washington"){
        ...
    }
}

映射模板可能将状态作为参数：

"body":{
    "from":0,
    "size":50,
    "query" : {
        "multi_match" : {
            "query" : "$context.arguments.state",
            "fields" : ["city", "state"]
        }
    }
}

有关可以包含在 VTL 中的实用工具的列表，请参阅访问请求标头。