Consulta dos dados do Amazon OpenSearch Service com SQL

Você pode usar SQL para consultar seu Amazon OpenSearch Service em vez de usar a DSL de consultas do OpenSearch baseada em JSON. Consultar com SQL é útil se você já está familiarizado com a linguagem ou se deseja integrar seu domínio a uma aplicação que usa SQL.

Use a tabela a seguir para encontrar a versão do plug-in SQL compatível com cada versão do OpenSearch e Elasticsearch.

OpenSearch
Versão do OpenSearch	Versão do plug-in SQL	Recursos notáveis
2.11.0	2.11.0.0	Adicionar suporte para linguagem e consultas PPL
2.9.0	2.9.0.0	Adicione o conector Spark e suporte à tabela e às funções PromQL
2.7.0	2.7.0.0	Adicionar API datasource
2.5.0	2.5.0.0
2.3.0	2.3.0.0	Adicione funções de data e hora maketime e makedate
1.3.0	1.3.0.0	Suporta tamanho limite de consulta padrão e cláusula IN para selecionar em uma lista de valores
1.2.0	1.2.0.0	Adicionar novo protocolo para o formato de resposta de visualização
1.1.0	1.1.0.0	Ofereça suporte à função de correspondência como um filtro no SQL e PPL
1.0.0	1.0.0.0	Suporte à consulta de um fluxo de dados

Open Distro for Elasticsearch
Versão do Elasticsearch	Versão do plug-in SQL	Recursos notáveis
7.10	1.13.0	NULL FIRST e LAST para funções de janela, função CAST (), comandos SHOW e DESCRIBE
7.9	1.11.0	Funções adicionais de data/hora adicionais, palavra-chave ORDER BY
7.8	1.9.0
7.7	1.8.0
7.3	1.3.0	Operadores de strings e numéricos diversos
7.1	1.1.0

O suporte a SQL está disponível em domínios que executam o OpenSearch ou Elasticsearch 6.5 ou superior. A documentação completa do plugin SQL está disponível na documentação do OpenSearch.

Chamada de exemplo

Para consultar seus dados usando o SQL, envie solicitações HTTP para _sql usando o seguinte formato:

POST domain-endpoint/_plugins/_sql
{
  "query": "SELECT * FROM my-index LIMIT 50"
}

nota

Se o seu domínio estiver executando o Elasticsearch em vez do OpenSearch, o formato será _opendistro/_sql.

Notas e diferenças

As chamadas para _plugins/_sql incluem nomes de índice no corpo da solicitação, portanto, elas têm as mesmas considerações da política de acesso das operações bulk, mget, e msearch. Como sempre, siga o princípio do privilégio mínimo ao conceder permissões para operações de API.

Para obter considerações de segurança sobre o uso de SQL com o controle de acesso refinado, consulte Controle de acesso refinado no Amazon Service OpenSearch .

O plugin do OpenSearch SQL inclui muitas configurações ajustáveis. No OpenSearch Service, use o caminho _cluster/settings, e não o caminho das configurações do plugin (_plugins/_query/settings):

PUT _cluster/settings
{
  "transient" : {
    "plugins.sql.enabled" : true
  }
}

Para domínios herdados do Elasticsearch, substitua plugins por opendistro:

PUT _cluster/settings
{
  "transient" : {
    "opendistro.sql.enabled" : true
  }
}

SQL Workbench

O SQL Workbench é uma interface do usuário do OpenSearch Dashboards que permite executar consultas SQL sob demanda, traduzir SQL em seu equivalente REST e exibir e salvar resultados como texto, JSON, JDBC ou CSV. Para obter mais informações, consulte Query Workbench.

SQL CLI

O SQL CLI é uma aplicação Python autônoma que você pode executar com o comando opensearchsql. Para obter as etapas de instalação, configuração e uso, consulte SQL CLI.

Driver JDBC

O driver Java Database Connectivity (JDBC) permite integrar domínios do OpenSearch Service a suas aplicações favoritas de business intelligence (BI). Para baixar o driver, clique aqui. Para obter mais informações, consulte o repositório GitHub.

As tabelas a seguir resumem a compatibilidade de versões do driver.

OpenSearch
Versão do OpenSearch	Versão do driver JDBC
2.11	1.1.0.1
2.9	1.1.0.1
2.7	1.1.0.1
2,5	1.1.0.1
2.3	1.1.0.1
1.3	1.1.0.1
1.2	1.1.0.1
1.1	1.1.0.1
1,0	1.1.0.1

Open Distro for Elasticsearch
Versão do Elasticsearch	Versão do driver JDBC
7.10	1.13.0
7.9	1.11.0
7.8	1.9.0
7.7	1.8.0
7.4	1.4.0
7.1	1.0.0
6.8	0.9.0
6.7	0.9.0
6.5	0.9.0

Driver ODBC

O driver de conectividade do banco de dados aberta (ODBC) é um driver ODBC somente leitura para Windows e macOS que permite conectar aplicativos de business intelligence e visualização de dados, como o Microsoft Excel, ao plug-in SQL.

Você pode baixar um exemplo de arquivo de driver funcional na página de artefatos do OpenSearch. Para obter informações sobre como instalar o driver, consulte o repositório de SQL no GitHub.