Pular para o conteúdo principal

VillageSQL is a drop-in replacement for MySQL with extensions.

All examples on this page work on VillageSQL. Install Now →
O MySQL não tem uma forma embutida de fazer requisições de rede. Se você quer chamar uma API HTTP, você tira os dados do banco de dados, faz a requisição no código da aplicação e envia os resultados de volta. A extensão vsql_http do VillageSQL adiciona http_get(), http_post() e toda a gama de métodos HTTP diretamente ao SQL — para que você possa chamar APIs externas do mesmo lugar onde os dados estão.

O Problema: Sair do Banco de Dados a Cada Chamada de API

Um padrão típico sem o VillageSQL:
Isso funciona, mas cada linha são três idas e voltas: SELECT, chamada de API, UPDATE. A lógica de enriquecimento vive no código da aplicação em vez de no schema, onde os dados estão.

Com o VillageSQL: HTTP a partir do SQL

http_get(url) faz uma requisição GET e retorna uma string JSON com a resposta completa.
Toda função em vsql_http retorna a mesma forma de JSON:

A conversão de charset

No VillageSQL 0.0.6 e anteriores, as funções STRING do VEF retornam o charset binary. Antes de passar o resultado para JSON_VALUE ou JSON_EXTRACT, envolva-o com CONVERT(... USING utf8mb4):
O VillageSQL 0.0.7 e posteriores retornam o charset correto diretamente, então CONVERT não é mais necessário neles — mas é inofensivo mantê-lo, e todos os exemplos abaixo ainda o usam para compatibilidade com o 0.0.6 e anteriores. Atribua a uma variável com CONVERT uma vez e reutilize a variável para evitar repetir a conversão.

Requisições POST

http_post(url, content_type, body) envia um POST com um corpo:

Cabeçalhos Personalizados e Outros Métodos

http_request(method, url, headers_json, body, content_type, options_json) trata qualquer método com cabeçalhos personalizados:
O argumento headers_json é um objeto JSON em que as chaves são nomes de cabeçalho e os valores são valores de cabeçalho.

Todas as funções disponíveis

Todas as funções retornam NULL para entrada NULL. Em caso de falha de conexão (conexão recusada, falha de DNS, timeout), as funções HTTP também retornam NULL e emitem um warning com a mensagem de erro do curl — verifique-o com SHOW WARNINGS quando uma requisição parecer desaparecer.

Codificação de URL

url_encode() e url_decode() tratam o percent-encoding para parâmetros de consulta:

Limitações Conhecidas

Limite de resposta de 256KB — Respostas maiores que 256KB são truncadas. Isso cobre os payloads de API típicos usados em consultas SQL; não é adequado para download de arquivos grandes. Uma resposta cortada por esse limite não é mais um JSON válido: JSON_EXTRACT/JSON_UNQUOTE geram ERROR 3141 sobre ela, enquanto JSON_VALUE retorna NULL com um Warning 3141 em vez de gerar erro, sob seu comportamento padrão NULL ON ERROR. Limite de tamanho de JSON_VALUE — JSON_VALUE retorna NULL quando o valor extraído excede o limite de tamanho interno do MySQL. Para corpos de resposta grandes, use JSON_UNQUOTE(JSON_EXTRACT(...)) em vez disso:
Síncrono — Toda chamada HTTP bloqueia até ser concluída ou atingir o timeout. max_execution_time não limita nem interrompe uma chamada bloqueante de vsql_http — um endpoint lento ou inacessível segura a instrução pelo seu próprio timeout de conexão/leitura, independentemente disso. http_get/http_post/http_put/http_delete/http_patch não recebem opções; somente http_request(method, url, headers_json, body, content_type, options_json) aceita um timeout, como {"timeout": N} em segundos no seu argumento options_json (padrão 30). Use http_request em vez das funções abreviadas quando precisar encurtá-lo (consulte Webhooks HTTP).

Solução de Problemas

Próximos Passos

Veja também