Formato do arquivo de conexão

funcional

Como o arquivo de conexões do SQLly é estruturado - rótulos, logins compartilhados, perfis de túnel e conexões - com todas as chaves que ele aceita e um exemplo completo.

Um arquivo de conexão SQLly é um único documento JSON. É o que tanto Arquivo → Exportar conexões… e Arquivo → Exportar conexão com credenciais… escrever e o que Arquivo → Importar conexões… lê (veja Exportar e importar conexões). Você também pode escrever um à mão. Esta página é uma visão geral de como o arquivo está organizado e o que cada parte aceita.

Senhas são opcionais e ficam em texto claro quando presentes. Cada password, passphrase, e token campo pode ser omitido: Export Connections não escreve nenhum deles, e uma conexão sem um deles solicita na primeira conexão. Um arquivo que os possui é um segredo por si só. SQLly move cada senha para seu chaveiro do sistema na importação e nunca mantém uma cópia do arquivo; exclua-o depois de importado.

Layout de relance

{
  "format": "sqlly-credentials",   // required, always this value (with or without passwords)
  "version": 1,                     // required
  "clients":      [ … ],          // labels with color, icon, protections
  "projects":     [ … ],
  "environments": [ … ],
  "sql_auth_accounts": [ … ],     // shared logins: name, username, optional password
  "tunnel_profiles":   [ … ],     // named SSH / proxy / Kubernetes chains
  "connections":       [ … ]      // any number of servers and databases
}

Cada seção é opcional, exceto format e version. As conexões apontam para logins compartilhados, perfis de túnel e rótulos pelo nome, de modo que um único login ou túnel possa servir a várias conexões. Os nomes são comparados sem diferenciar maiúsculas de minúsculas, e um nome também pode apontar para algo já salvo no SQLly.

Um servidor com vários bancos de dados é simplesmente várias conexões que compartilham um server e diferem em database. Vários logins no mesmo banco de dados são várias conexões que usam contas diferentes.

Verificado antes de qualquer alteração

  • Tudo ou nada - o arquivo inteiro é verificado primeiro. Se algo estiver errado, cada problema é listado com a localização dele (por exemplo connections[2] "Ops": port must be 1-65535) e nada é importado.
  • Erros de digitação contam como erro - uma chave desconhecida, como "pasword" é reportado em vez de ser ignorado em silêncio.
  • Regras do mecanismo se aplicam - um método de login que o mecanismo não suporta, um mecanismo hospedado que exige TLS com a criptografia desligada ou um certificado de cliente sem a chave dele são todos reportados.
  • Versões mais novas são recusadas - um arquivo com um version mais recente do que o seu SQLly entende avisa em vez de importar pela metade.

Clientes, projetos e ambientes

ChaveConteúdo
nameObrigatório. Mescla com um rótulo existente do mesmo nome ou cria um.
color#RGB, #RRGGBB, ou #RRGGBBAA (o # é opcional).
imageO ícone, codificado em base64 - um data:image/png;base64,… URI ou base64 puro. PNG, JPEG, GIF, WebP, BMP, ICO ou SVG, até 1 MB. O tipo é detectado a partir da própria imagem.
safetyQualquer um de is_production, only_allow_select, use_confirmation_dialog, use_outer_transaction_rollback_scope, require_ai_review_for_data_changes, allow_unconstrained_update, allow_unconstrained_delete, require_touch_id_to_connect, require_touch_id_for_non_select (cada true / false). Apenas as opções que você listar mudam.

Omitir color, image, ou um interruptor de segurança mantém o que o rótulo existente já possui.

Logins compartilhados

{ "name": "Reader", "username": "ro", "password": "…" }

Uma conexão usa uma com "authentication": { "type": "sql-login", "account": "Reader" }. Importar por cima de um login salvo com o mesmo nome e nome de usuário atualiza a senha dele no lugar.

Perfis de túnel

{ "name": "Corp bastion", "ssh": { … }, "proxy": { … }, "kube": { … } }

Os saltos usam as mesmas formas que o transport (abaixo). Uma conexão usa um com "tunnel_profile": "Corp bastion", em vez de um inline transport.

Conexões

Apenas name, engine, e server são obrigatórios. Qualquer coisa omitida recebe o mesmo padrão que o editor de conexão forneceria.

ChaveConteúdo
nameO nome mostrado no explorador.
engineEscrito de forma solta: postgresql, postgres, mssql, sql-server, mysql, mariadb, sqlite, duckdb, libsql, clickhouse, oracle, redis, valkey, neon, supabase, planetscale, cockroachdb, e os demais mecanismos que o SQLly suporta.
serverNome do host, IP, host\instance, ou o caminho do arquivo para SQLite e DuckDB.
portUsa por padrão a porta usual do mecanismo.
databaseBanco de dados a abrir (Oracle: nome do serviço, ou SID:ORCL).
environmentlocal, dev, test, staging, production, ou unset.
client, projectNomes de rótulo.
authenticationComo entrar - veja abaixo.
tlsmode (disable, require, verify-ca, verify-full), ou o estilo do SQL Server encrypt e trust_server_certificate opções. Também ca_file, client_cert_file, e client_key_file caminhos, e trust_os_roots (true também para confiar no armazenamento de certificados do sistema operacional; Redis), e direct (true para TLS direto no PostgreSQL 17).
timeout_seconds, statement_timeout_secondsTempo limite de conexão (padrão 30) e um limite opcional por instrução.
application_nameReportado ao servidor (padrão SQLLY).
safetyauto_wrap_rollback, block_all_but_select, confirm_data_changes, allow_unbounded_mutations, e production_override para esta conexão.
favoriteFavoritar a conexão.
startup_sqlSQL a ser executado logo após a conexão.
redis_key_delimiter, clickhouse_native_portExtras específicos do mecanismo para Redis e ClickHouse.
redis_sentinel, redis_sentinel_passwordSomente Redis: o grupo master do Sentinel e as sentinelas a consultar, além da senha das próprias sentinelas em texto claro (movida para o chaveiro na importação, nunca exportada).
redis_clusterSomente Redis: modo cluster (auto, standalone, cluster) e o mapa de nós.
redis_entra_userRedis com login Microsoft Entra: o nome de usuário do Redis para entrar; se ausente, entra como a ID de objeto do token.
entra_accountFixar uma conta Microsoft Entra: account_id, tenant_id, username.
route{ "type": "direct" } (padrão) ou { "type": "via-relay", "relay_device_id", "pair_id" }.
tunnel_profile ou transportUm perfil de túnel nomeado, ou inline proxy, ssh, e kube saltos.
maskinginclude e exclude listas de padrões de coluna como "*ssn*", ou { "pattern": "users.email", "scope": "table-dot-column" }.

Métodos de login

typeCampos
sql-loginusername e password, ou account nomeando um login compartilhado. Deixe a senha de fora e o SQLly solicitará na primeira conexão.
integratedWindows / Kerberos (SQL Server).
entra-browser, entra-device-codeMicrosoft Entra (SQL Server, Azure SQL).
aws-rds-iamusername, region, opcional profile.
gcp-cloud-sql-iamusername.
auth-tokenlibSQL / Turso token (deixe de fora para um servidor anônimo).
noneArquivos SQLite e DuckDB.

Saltos de túnel

  • ssh - host, port (22), username, e auth: { "type": "agent" }, { "type": "key-file", "path", "passphrase" }, ou { "type": "password", "password" } (passphrase e password podem ser omitidos; o SQLly então pergunta na primeira conexão). Um jump host opcional usa os mesmos campos. keepalive_seconds (30 quando ausente, 0 para nenhum) e keepalive_max (3) definem os keepalives SSH do túnel.
  • proxy - kind (socks5 ou http-connect), host, port, e opcional username e password.
  • kube - namespace, target_kind (pod, service, deployment), target_name, remote_port, e opcional kubeconfig e context. Não dá para combinar com SSH ou proxy.

Um exemplo completo

Dois bancos de dados em um servidor PostgreSQL acessados através de um bastião, compartilhando logins de leitura e escrita; um SQL Server com sua própria senha; e um arquivo SQLite local, com um cliente colorido e um ambiente de produção que permite apenas SELECT.

{
  "format": "sqlly-credentials",
  "version": 1,
  "clients": [
    { "name": "Acme", "color": "#1E88E5", "image": "data:image/png;base64,iVBORw0KGgo…" }
  ],
  "environments": [
    { "name": "Production", "color": "#C62828", "safety": { "only_allow_select": true } }
  ],
  "sql_auth_accounts": [
    { "name": "Reader", "username": "ro", "password": "ro-secret" },
    { "name": "Writer", "username": "rw", "password": "rw-secret" }
  ],
  "tunnel_profiles": [
    { "name": "Corp bastion",
      "ssh": { "host": "bastion.acme.com", "username": "deploy",
               "auth": { "type": "key-file", "path": "~/.ssh/id_ed25519" } } }
  ],
  "connections": [
    { "name": "Sales (read)", "engine": "postgresql", "server": "pg1.acme.internal", "database": "sales",
      "client": "Acme", "environment": "production", "tunnel_profile": "Corp bastion",
      "authentication": { "type": "sql-login", "account": "Reader" },
      "tls": { "mode": "verify-full" } },
    { "name": "Sales (write)", "engine": "postgresql", "server": "pg1.acme.internal", "database": "sales",
      "client": "Acme", "environment": "production", "tunnel_profile": "Corp bastion",
      "authentication": { "type": "sql-login", "account": "Writer" },
      "safety": { "confirm_data_changes": true } },
    { "name": "HR", "engine": "postgresql", "server": "pg1.acme.internal", "database": "hr",
      "client": "Acme", "tunnel_profile": "Corp bastion",
      "authentication": { "type": "sql-login", "account": "Reader" } },
    { "name": "Ops", "engine": "sql-server", "server": "sql01.acme.internal", "database": "ops",
      "authentication": { "type": "sql-login", "username": "ops", "password": "ops-secret" },
      "tls": { "encrypt": true, "trust_server_certificate": true }, "favorite": true },
    { "name": "Scratch", "engine": "sqlite", "server": "~/data/scratch.db" }
  ]
}