Ferramentas de produtividade
O OmniDB tem várias ferramentas que poupam cliques e teclas. Funcionam com todas as bases de dados suportadas, salvo indicação em contrário, e tudo o que alteraria uma base de dados (uma mudança de nome, uma sincronização de esquema, uma restauração) é mostrado primeiro como SQL: é o próprio utilizador que o executa.
Encontrar as coisas
Pesquisar em tudo. Prima Shift duas vezes para abrir a paleta. Num único campo, encontra secções, ligações, favoritos, snippets e, para a ligação selecionada, tabelas (a partir de dois carateres escritos), sem distinguir maiúsculas nem acentos. As setas movem a seleção, Enter abre o resultado (uma tabela abre no Edit Data) e Esc fecha a paleta.
Favoritos. Clique com o botão direito numa tabela da árvore e escolha Adicionar aos favoritos. A secção Favoritos da barra esquerda lista as tabelas fixadas por ligação; um clique abre a ligação (se ainda não estiver aberta) e a tabela no Edit Data, e a cruz remove-a. Os favoritos são privados para cada utilizador do OmniDB.
A barra esquerda e as ligações
Painel de navegação. Em Definições > Painel de navegação escolhe-se que itens a barra da esquerda mostra, ordenam-se com as setas e move-se o separador entre a sua parte superior e a inferior. O ícone das Definições é sempre o último e não pode ser ocultado. Cada alteração tem efeito de imediato, sem recarregar, e é guardada para o seu utilizador.
Conexão somente leitura. Assinale-a no formulário da ligação e as escritas através dessa ligação são recusadas; a lista de ligações, o separador da base de dados e o menu da ligação mostram um cadeado. O PostgreSQL, o MySQL/MariaDB e o SQLite colocam ainda a própria sessão só em leitura e, em todos os motores, o editor de consultas, a consola e o Edit Data recusam tudo o que não sejam instruções do tipo SELECT. É uma rede de segurança contra acidentes (o separador de produção deixado aberto), não uma fronteira de segurança: para uma garantia firme, utilize uma função da base de dados sem privilégios de escrita.
O editor SQL
- Preenchimento automático consoante o contexto. A instrução em edição é analisada
para saber em que cláusula está o cursor e de que tabelas, subconsultas e CTE lê.
alias.,tabela.ecte.listam as colunas dessa referência; uma palavra solta em SELECT, WHERE, GROUP BY, ORDER BY, HAVING, SET, RETURNING ou na lista de colunas de um INSERT oferece as colunas das tabelas da instrução; depois deON, as condições de chave estrangeira entre a tabela associada e as anteriores aparecem em primeiro lugar; depois de FROM, JOIN, UPDATE ou INTO vêm os nomes de CTE da instrução e as tabelas da ligação. - Inspeções em tempo real. Após uma pausa na escrita, os problemas são assinalados na
margem (a mensagem surge ao passar o rato) e com um sublinhado ponteado:
UPDATEouDELETEsemWHERE, comparações comNULLatravés de=ou<>, umJOINsemONnemUSING, um alias a que nada se refere e uma tabela ou vista que a base de dados não conhece. - Ir para a definição e Localizar usos. Ctrl/Cmd+clique (ou Ctrl/Cmd+B) num nome: um alias ou CTE salta para onde foi definido, uma tabela ou vista abre o seu DDL num novo separador. Alt+F7 seleciona todas as menções de um alias ou CTE na instrução e, no caso de uma tabela, lista onde aparece (no editor, nos seus snippets e no histórico de consultas); cada entrada é clicável.
- Renomear… (Shift+F6 ou o menu de contexto do
editor). Um alias ou CTE é renomeado de uma só vez em toda a instrução. Uma tabela ou coluna abre uma
pré-visualização: a instrução
ALTER/RENAMEpara a sua base de dados é escrita num novo separador para a executar, juntamente com as linhas dos seus snippets que mencionam o nome antigo (cada uma com uma caixa de seleção) e as menções no editor atual. Só o código é reescrito, nunca cadeias de texto nem comentários. - Modelos dinâmicos. Escreva uma abreviatura e prima Tab para a expandir
no esqueleto de uma instrução; depois, Tab / Shift+Tab percorrem os
marcadores. Incluídos:
sel,cnt,grp,ins,upd,del,jn,cte,crt. Os seus ficam na secção Snippets, como snippets dentro de uma pasta chamada Live templates: o nome do snippet é a abreviatura e o seu texto o modelo (${1:valor}para um marcador,$0para a posição final do cursor). - Parâmetros com nome. Uma instrução com marcadores
:nomepede um valor por parâmetro antes de ser executada. Cada valor é deduzido (números,NULLeTRUE/FALSEficam como estão, qualquer outra coisa passa a texto entre aspas), forçado a texto ou colado como SQL em bruto. Os marcadores dentro de cadeias de texto, comentários,::castse fatias de matrizes são deixados em paz. - Histórico local. O que se escreve é guardado como versão (após uma pausa na escrita e quando o editor perde o foco), até 100 por ligação e utilizador. O botão de histórico da barra de ferramentas de consultas lista-as e mostra as linhas que desapareceriam e voltariam se restaurasse a versão escolhida; Restaurar coloca-a no editor, guardando antes o texto que substitui.
- Recolher e vários cursores. As instruções de várias linhas ganham um controlo de recolha na margem; Alt+J seleciona a ocorrência seguinte da palavra sob o cursor (Alt+Shift+J a anterior) para editar vários pontos ao mesmo tempo.
- Gerar (menu de contexto de uma tabela).
SELECT com JOINs (chaves estrangeiras) escreve um SELECT das colunas da tabela mais as de cada tabela para
que apontam as suas chaves estrangeiras, cada uma como LEFT JOIN; Script CRUD escreve
INSERT / SELECT / UPDATE / DELETE para uma linha endereçada pela chave primária, com parâmetros
:com_nome. Ambos abrem num novo separador de consulta.
Resultados de consultas
- Filtro. A caixa junto ao botão de exportação reduz a grelha às linhas que contêm
todas as palavras escritas (em qualquer célula, sem distinguir maiúsculas;
nullcorresponde a células NULL) e mostra «N de M». Só olha para as linhas já obtidas. - Ações sobre a linha (clique direito numa célula): Vista de registro mostra a linha como uma tabela vertical coluna / valor; Copiar linha como INSERT, Copiar linha como JSON, Copiar linha como Markdown e Copiar linha como CSV copiam-na nesse formato; Estatísticas da coluna conta valores não vazios, NULL e distintos e, nos numéricos, soma, média e limites das linhas carregadas.
- Visualizador do conteúdo de uma célula. Abrir o conteúdo de uma célula oferece Format JSON e Minify JSON enquanto o texto for JSON válido (números e cadeias de texto mantêm-se carácter a carácter), um comutador Wrap lines e um botão Copy.
- Gráfico do resultado. O botão de gráfico da barra de ferramentas de consultas desenha as linhas que a grelha mostra como gráfico de barras, de linhas, circular ou anelar: escolha a coluna do eixo x e assinale as colunas numéricas a desenhar (até às primeiras 500 linhas).
- Exportação SQL. Entre os formatos de exportação está SQL, que escreve
instruções
INSERT INTO … VALUES …;, uma por linha, com as aspas adequadas à base de dados da ligação.
Edit Data e importação
- Duplicar linha copia uma linha para um novo INSERT pendente (as colunas da chave primária ficam vazias para a base de dados as gerar).
- Ir para a linha referenciada (clique direito numa célula de chave estrangeira) abre a tabela referenciada no Edit Data, já filtrada pela linha para que o valor aponta; as chaves compostas são suportadas.
- Importar dados… (clique direito numa tabela) carrega um ficheiro CSV, TSV ou JSON (uma matriz de objetos ou de matrizes). O delimitador é detetado ou escolhido, as colunas do ficheiro são mapeadas para as da tabela com uma pré-visualização das primeiras linhas, e os valores vazios podem passar a NULL. As linhas são inseridas numa única transação, pelo que uma linha errada (indicada no erro) deixa a tabela intacta; até 200 000 linhas de cada vez e nunca numa ligação só de leitura.
Dump, restauro e execução de ficheiros de script
Exportar tabela (estrutura e dados) para arquivo SQL e Exportar tabela (só estrutura) para arquivo SQL (menu Gerar de uma tabela) escrevem o DDL da tabela, seguido de um INSERT por linha, num ficheiro SQL — não é necessário nenhum programa externo. O botão Executar um script SQL de um arquivo (restaurar um dump) da barra de ferramentas de consultas executa esse ficheiro (ou qualquer script SQL) instrução a instrução numa só transação, pelo que uma instrução que falhe (indicada no erro) anula o restante onde quer que a base de dados tenha DDL transacional. Até 48 MB e 1 000 000 de instruções; recusado numa ligação só de leitura.
Comparar
O botão com setas da barra de ferramentas de consultas compara a ligação atual com outra: ou o
esquema (tabelas, colunas e respetivos tipos), ou as linhas de uma tabela pela chave primária. O
resultado é um resumo mais um script que deixa o destino igual à origem (CREATE TABLE,
ADD COLUMN, alterações de tipo, INSERT/UPDATE de linhas), aberto
num separador da ligação de destino para o ler e executar — comparar não altera nada. As instruções
destrutivas (DROP, DELETE de linhas) só são escritas como comentários, a
menos que peça as eliminações. A possibilidade de NULL, os valores por omissão, os índices e as
restrições não são comparados.
Consultas agendadas
A secção Consultas agendadas da barra esquerda executa SQL numa ligação a cada N minutos (de 1 minuto a uma semana). Os agendamentos aparecem à esquerda, numa lista com rodapé + / −; as definições do selecionado (nome, intervalo, SQL) ficam à direita, com Executar agora, Pausar / Retomar e as suas últimas 50 execuções (estado, duração e o que cada instrução fez, ou o erro em que parou). O botão de calendário da barra de ferramentas de consultas guarda o SQL do editor (a seleção ou, se não houver, o texto todo) como um novo agendamento. O agendador vive no processo servidor do OmniDB, pelo que só funciona enquanto o OmniDB estiver aberto; uma execução que venceu com a aplicação fechada acontece uma vez no arranque seguinte. As ligações só de leitura continuam a recusar escritas, e as ligações com túnel SSH ou autenticação por token não podem ser agendadas.
Controle de versão (git)
O botão de ramo por baixo da árvore de snippets (e por baixo da lista de unidades de monitorização)
guarda as suas definições partilháveis num repositório git como ficheiros de texto: os snippets como
ficheiros .sql em snippets/ (uma diretoria por pasta de snippets), as
unidades de monitorização próprias como monitoring/<motor>/*.json e as consultas
agendadas como schedules/<alias da ligação>/*.json (apenas o alias e o SQL — nunca um
endereço nem credenciais). Fazer commit escreve os ficheiros, remove os ficheiros
.sql/.json que já não correspondem a nada e faz o commit deles;
Importar da pasta lê-os de volta, criando ou atualizando definições e nunca eliminando nenhuma. Um
agendamento importado começa em pausa para que nada corra sem supervisão.
O git corre dentro do OmniDB, pelo que não é preciso ter o git instalado. Na aplicação
de ambiente de trabalho, o repositório fica numa pasta dentro da diretoria própria do OmniDB até
escolher outra com Escolher pasta… (memorizada entre arranques). No macOS, essa pasta integrada
fica dentro do contentor da aplicação, que outros programas não conseguem abrir — escolha uma pasta sua
se quiser fazer push do repositório com as suas próprias ferramentas git. Num servidor multiutilizador
escreve-se o caminho da pasta e a funcionalidade fica limitada aos superutilizadores. O push e o pull
ficam a cargo das suas próprias ferramentas git.