VillageSQL is a drop-in replacement for MySQL with extensions.
All examples on this page work on VillageSQL. Install Now →
Este guia usa uma capability Preview. Inicie o servidor com
--vsql_allow_preview_extensions=ON, ou o INSTALL EXTENSION é recusado.vsql_rest do VillageSQL serve essas tabelas de dentro do processo do servidor, então não há um segundo processo nem uma implantação nova.
Os padrões foram feitos para uma máquina de desenvolvedor, não para uma rede. Leia “Antes de expor a porta” abaixo antes de abri-la para qualquer coisa.
Ligando
vsql_rest.schema_ttl segundos, 60 por padrão, então uma tabela criada depois responde table not found até esse cache expirar.
Lendo
Uma tabela é um caminho, e a query string faz a filtragem. Cada filtro écoluna=operador.valor:
or=(...):
limit e offset:
eq, neq, lt, lte, gt, gte, like, cs_like, in e is. in recebe uma lista, como em ?id=in.(1,3), e is recebe null, como em ?price=is.null ou ?price=is.not.null. Uma requisição sem limit retorna no máximo vsql_rest.max_rows linhas, que começa em 1000.
A allowlist
Uma tabela que não está emallowed_tables não existe para a API:
Restringindo métodos por tabela
table_methods diz quais métodos HTTP cada tabela aceita, como tabela:MÉTODO,MÉTODO com um | entre as tabelas:
Observando o funcionamento
Cinco contadores de status reportam sobre o listener, incluindo a porta que ele de fato vinculou:http_port mostra 0 quando nada está escutando, que é a forma mais rápida de saber se o listener iniciou. Definir vsql_rest.port como 0 pede ao sistema operacional que escolha uma porta, e esse contador é onde você lê qual porta ele escolheu.
Antes de expor a porta
Os padrões deixam o acesso aberto, e cada um deles é razoável isoladamente.require_auth começa em OFF, então nenhuma requisição carrega ou precisa de um token. Um allowed_tables vazio publica o schema inteiro. Um table_methods vazio permite todos os métodos, incluindo DELETE, e um DELETE contra um listener nesse estado tem sucesso:
ssl_cert e ssl_key. Não existe uma configuração de endereço de bind, e o listener vincula todas as interfaces a partir do momento em que inicia, então bloqueie a porta no firewall e deixe somente um proxy reverso alcançá-la.
Solução de Problemas
Veja também
- vsql_rest — a página de referência da extensão, com todas as configurações que ela adiciona
- Fazendo Requisições HTTP a partir do SQL — o mesmo servidor chamando para fora em vez de responder
- Enriquecendo Linhas com Dados de APIs Externas — unindo uma consulta à API de outra pessoa
- Hardening de Segurança do MySQL — o que mais fechar antes de uma porta ficar acessível