Referência de função do resolvedor de JavaScript do AWS AppSync para OpenSearch

O resolvedor do AWS AppSync para o Amazon OpenSearch Service permite usar o GraphQL para armazenar e recuperar dados em domínios do OpenSearch Service existentes na sua conta. Esse resolvedor funciona permitindo que você mapeie uma solicitação do GraphQL de entrada em uma solicitação do OpenSearch Service e, em seguida, mapeie a resposta do OpenSearch Service de volta para o GraphQL. Esta seção descreve os manipuladores de solicitações e respostas de função para as operações suportadas do OpenSearch Service.

Solicitação

A maioria dos objetos da solicitação do OpenSearch Service têm uma estrutura comum em que apenas algumas peças mudam. O exemplo a seguir executa uma pesquisa em um domínio do OpenSearch Service, onde os documentos são do tipo post e são indexados em id. Os parâmetros de pesquisa são definidos na seção body, com muitas das cláusulas de consulta comuns definidas no campo query. Esse exemplo pesquisará documentos que contém "Nadia", "Bailey" ou ambos no campo author de um documento:

export function request(ctx) {
  return {
    operation: 'GET',
    path: '/id/post/_search',
    params: {
      headers: {},
      queryString: {},
      body: {
        from: 0,
        size: 50,
        query: {
          bool: {
            should: [
              { match: { author: 'Nadia' } },
              { match: { author: 'Bailey' } },
            ],
          },
        },
      },
    },
  };
}

Resposta

Assim como ocorre com outras fontes de dados, o OpenSearch Service envia uma resposta ao AWS AppSync que precisa ser convertida em GraphQL.

A maioria das consultas do GraphQL estão buscando o campo _source de uma resposta do OpenSearch Service. Como você pode fazer pesquisas para retornar um documento individual ou uma lista de documentos, existem dois padrões de resposta comuns usados no OpenSearch Service:

Lista de resultados

export function response(ctx) {
  const entries = [];
  for (const entry of ctx.result.hits.hits) {
    entries.push(entry['_source']);
  }
  return entries;
}

Item individual

export function response(ctx) {
  return ctx.result['_source']
}

operation field

Método ou verbo HTTP (GET, POST, PUT, HEAD ou DELETE) que o AWS AppSync envia ao domínio do OpenSearch Service. A chave e o valor devem ser strings.

"operation" : "PUT"

path field

O caminho de pesquisa para uma solicitação do OpenSearch Service do AWS AppSync. Isso forma um URL para o verbo HTTP da operação. A chave e o valor devem ser strings.

"path" : "/indexname/type"

"path" : "/indexname/type/_search"

Quando o manipulador de solicitação é avaliado, esse caminho é enviado como parte da solicitação HTTP, incluindo o domínio do OpenSearch Service. Por exemplo, o exemplo anterior pode ser traduzido como:

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

params field

Usado para especificar qual é executada pela pesquisa, geralmente definindo o valor consulta dentro do corpo. No entanto, existem vários outros recursos que podem ser configurados, como a formatação de respostas.

Exemplo 1

Retornar todos os documentos com uma cidade correspondente a "seattle":

export function request(ctx) {
  return {
    operation: 'GET',
    path: '/id/post/_search',
    params: {
      headers: {},
      queryString: {},
      body: { from: 0, size: 50, query: { match: { city: 'seattle' } } },
    },
  };
}

Exemplo 2

Retornar todos os documentos correspondentes a "washington" como a cidade ou o estado:

export function request(ctx) {
  return {
    operation: 'GET',
    path: '/id/post/_search',
    params: {
      headers: {},
      queryString: {},
      body: {
        from: 0,
        size: 50,
        query: {
          multi_match: { query: 'washington', fields: ['city', 'state'] },
        },
      },
    },
  };
}

Envio de variáveis

Você também pode passar variáveis como parte da avaliação no seu manipulador de solicitações. Por exemplo, digamos que tenha uma consulta do GraphQL como a seguinte:

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

O manipulador de solicitação de função pode ser o seguinte:

export function request(ctx) {
  return {
    operation: 'GET',
    path: '/id/post/_search',
    params: {
      headers: {},
      queryString: {},
      body: {
        from: 0,
        size: 50,
        query: {
          multi_match: { query: ctx.args.state, fields: ['city', 'state'] },
        },
      },
    },
  };
}