Referenz zur Resolver-Mapping-Vorlage für OpenSearch

Anmerkung

Wir unterstützen jetzt hauptsächlich die APPSYNC _JS-Laufzeit und ihre Dokumentation. Bitte erwägen Sie, die APPSYNC _JS-Laufzeit und ihre Anleitungen hier zu verwenden.

Mit dem AWS AppSync Resolver für Amazon OpenSearch Service können Sie GraphQL verwenden, um Daten in vorhandenen OpenSearch Service-Domains in Ihrem Konto zu speichern und abzurufen. Dieser Resolver ermöglicht es Ihnen, eine eingehende GraphQL-Anfrage einer Serviceanfrage zuzuordnen und die OpenSearch OpenSearch Serviceantwort dann wieder GraphQL zuzuordnen. In diesem Abschnitt werden die Zuordnungsvorlagen für die unterstützten OpenSearch Dienstoperationen beschrieben.

Zuordnungsvorlage anfordern

Die meisten Vorlagen für die Zuordnung von OpenSearch Serviceanfragen haben eine gemeinsame Struktur, bei der sich nur wenige Teile ändern. Im folgenden Beispiel wird eine Suche in einer OpenSearch Dienstdomäne ausgeführt, in der Dokumente unter einem Index namens organisiert sindpost. Die Suchparameter sind im body-Abschnitt definiert, viele der gemeinsamen Abfragebestimmungen sind im query-Feld definiert. In diesem Beispiel wird nach Dokumenten gesucht, die "Nadia", "Bailey" oder beides enthalten, und zwar in dem author-Feld eines Dokuments:

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

Vorlage für die Zuordnung von Antworten

Wie bei anderen Datenquellen sendet OpenSearch Service eine Antwort an AWS AppSync , die in GraphQL konvertiert werden muss.

Die meisten GraphQL-Abfragen suchen nach dem _source Feld aus einer OpenSearch Serviceantwort. Da Sie Suchen durchführen können, um entweder ein einzelnes Dokument oder eine Liste von Dokumenten zurückzugeben, werden in OpenSearch Service zwei häufig verwendete Vorlagen für die Antwortzuweisung verwendet:

Liste der Ergebnisse

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

Einzelnes Element

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

operation field

Anmerkung

Dies gilt nur für die Vorlage für die Anforderungszuweisung.

HTTPMethode oder Verb (GETPOST,PUT, HEAD oderDELETE), das AWS AppSync an die OpenSearch Service-Domäne sendet. Der Schlüssel und der Wert müssen beide Strings sein.

"operation" : "PUT"

path field

Anmerkung

Dies gilt nur für die Vorlage für die Anforderungszuweisung.

Der Suchpfad für eine OpenSearch Serviceanfrage von AWS AppSync. Dies bildet ein URL für das HTTP Verb der Operation. Der Schlüssel und der Wert müssen beide Strings sein.

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

Wenn die Zuordnungsvorlage ausgewertet wird, wird dieser Pfad als Teil der HTTP Anfrage gesendet, einschließlich der OpenSearch Dienstdomäne. Das vorherige Beispiel kann dann beispielsweise so aussehen:

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

params field

Anmerkung

Dies gilt nur für die Vorlage für die Anforderungszuweisung.

Wird verwendet, um anzugeben, welche Aktion Ihre Suche durchführt, meistens indem der Abfragewert in den Body setzt. Es gibt jedoch einige andere Funktionen, die konfiguriert werden können, wie z. B. die Formatierung von Antworten.

• Header

  Die Header-Informationen, wie beispielsweise Schlüssel-Wert-Paare. Der Schlüssel und der Wert müssen beide Strings sein. Beispielsweise:

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

  Anmerkung

  AWS AppSync wird derzeit nur JSON als unterstütztContent-Type.

• queryString

  Schlüssel-Wert-Paare, die allgemeine Optionen angeben, z. B. die Codeformatierung für JSON Antworten. Der Schlüssel und der Wert müssen beide Strings sein. Wenn Sie beispielsweise eine hübsche Formatierung wünschen, würden Sie Folgendes verwendenJSON:

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

• body

  Dies ist der Hauptteil Ihrer Anfrage, der es ermöglicht, eine wohlgeformte Suchanfrage für Ihre Service-Domain AWS AppSync zu erstellen. OpenSearch Der Schlüssel muss ein aus einem Objekt bestehender String sein. Ein paar Beispiele werden unten gezeigt.

Beispiel 1

Rückgabe aller Dokumente, die die Stadt „Seattle“ enthalten:

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

Beispiel 2

Rückgabe aller Dokumente, die „Washington“ als Stadt oder Staat enthalten:

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

Variablen übergeben

Anmerkung

Dies gilt nur für die Vorlage zur Anforderungszuweisung.

Sie können Variablen auch als Teil der Auswertung in der VTL Anweisung übergeben. Angenommen, Sie hatten die folgende GraphQL-Abfrage:

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

Die Zuweisungsvorlage könnte den Staat als Argument auffassen:

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

Eine Liste der Dienstprogramme, die Sie in die aufnehmen könnenVTL, finden Sie unter Access Request Headers.