Format de fichier de connexion

fonctionnel

Comment un fichier de connexion SQLly est organisé - étiquettes, identifiants partagés, profils de tunnel et connexions - avec chaque clé qu'il accepte et un exemple complet.

Un fichier de connexion SQLly est un seul document JSON. C'est ce que Fichier → Exporter les connexions… et Fichier → Exporter Conn avec identifiants… écrit et ce que Fichier → Importer les connexions… lit (voir Exporter et importer des connexions). Vous pouvez également en écrire un à la main. Cette page est un aperçu de la manière dont le fichier est structuré et de ce que chaque partie accepte.

Les mots de passe sont facultatifs et en texte clair lorsqu'ils sont présents. Chaque password, passphrase, et token champ peut être omis : Export Connections n'écrit aucun d'entre eux, et une connexion sans champ le demande lors de la première connexion. Un fichier qui les contient est un secret en soi. SQLly déplace chaque mot de passe dans votre trousseau système à l'importation et ne conserve jamais de copie du fichier, supprimez-le une fois qu'il a été importé.

La mise en page en un coup d'œil

{
  "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
}

Chaque section est facultative sauf format et version. Les connexions pointent vers les logins partagés, les profils de tunnel et les étiquettes par nom, donc un seul identifiant ou tunnel peut servir à de nombreuses connexions. Les noms sont comparés sans tenir compte de la casse, et un nom peut également pointer vers quelque chose déjà enregistré dans SQLly.

Un serveur avec plusieurs bases de données n’est rien d’autre que plusieurs connexions qui partagent un server et diffèrent par database. Plusieurs identifiants sur la même base de données correspondent à plusieurs connexions qui utilisent des comptes différents.

Vérifié avant tout changement

  • Tout ou rien - tout le fichier est vérifié en premier. Si quelque chose ne va pas, chaque problème est listé avec son emplacement (par exemple connections[2] "Ops": port must be 1-65535) et rien n'est importé.
  • Les fautes de frappe sont des erreurs - une clé inconnue telle que "pasword" est signalé plutôt que discrètement ignoré.
  • Les règles du moteur s'appliquent - une méthode de connexion que le moteur ne prend pas en charge, un moteur hébergé qui nécessite TLS avec le chiffrement désactivé, ou un certificat client sans sa clé sont tous signalés.
  • Les versions plus récentes sont refusées - un fichier avec un version plus récent que ce que votre SQLly comprend le signale, au lieu d'importer à moitié.

Clients, projets et environnements

CléCe qu'elle contient
nameObligatoire. Fusionne avec un label existant du même nom, ou en crée un.
color#RGB, #RRGGBB, ou #RRGGBBAA (le # est optionnel).
imageL'icône, encodée en base64 - un data:image/png;base64,… URI ou base64 brut. PNG, JPEG, GIF, WebP, BMP, ICO ou SVG, jusqu’à 1 Mo. Le type est détecté à partir de l’image elle-même.
safetyN'importe lequel 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 (chacun true / false). Seuls les interrupteurs que vous listez changent.

Ne pas inclure color, image, ou un interrupteur de sécurité conserve ce que l'étiquette existante a déjà.

Identifiants partagés

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

Une connexion en utilise un avec "authentication": { "type": "sql-login", "account": "Reader" }. Importer sur un login enregistré portant le même nom et le même nom d'utilisateur met à jour son mot de passe sur place.

Profils de tunnel

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

Les sauts utilisent les mêmes formes que le transport d'une connexion (ci-dessous). Une connexion utilise un avec "tunnel_profile": "Corp bastion", au lieu d'un transport.

Connexions

Seulement name, engine, et server sont requis. Tout ce qui est laissé de côté reçoit la même valeur par défaut que celle que l'éditeur de connexion lui attribuerait.

CléCe qu'elle contient
nameLe nom affiché dans l'explorateur.
engineÉcrit de manière approximative : postgresql, postgres, mssql, sql-server, mysql, mariadb, sqlite, duckdb, libsql, clickhouse, oracle, redis, valkey, neon, supabase, planetscale, cockroachdb, et le reste des moteurs que SQLly prend en charge.
serverNom d'hôte, IP, host\instance, ou le chemin de fichier pour SQLite et DuckDB.
portPar défaut, utilise le port habituel du moteur.
databaseBase de données à ouvrir (Oracle : nom de service, ou SID:ORCL).
environmentlocal, dev, test, staging, production, ou unset.
client, projectNoms des étiquettes.
authenticationComment se connecter - voir ci-dessous.
tlsmode (disable, require, verify-ca, verify-full), ou le style SQL Server encrypt et trust_server_certificate commutateurs. Également ca_file, client_cert_file, et client_key_file chemins, et trust_os_roots (true pour également faire confiance au magasin de certificats du système d'exploitation ; Redis), et direct (true pour PostgreSQL 17 en TLS direct).
timeout_seconds, statement_timeout_secondsDélai de connexion (par défaut 30) et une limite facultative par instruction.
application_nameSignalé au serveur (par défaut SQLLY).
safetyauto_wrap_rollback, block_all_but_select, confirm_data_changes, allow_unbounded_mutations, et production_override pour cette connexion.
favoriteMettre une étoile sur la connexion.
startup_sqlSQL à exécuter juste après la connexion.
redis_key_delimiter, clickhouse_native_portExtras spécifiques au moteur pour Redis et ClickHouse.
redis_sentinel, redis_sentinel_passwordUniquement Redis : le groupe maître Sentinel et les sentinelles à interroger, ainsi que le mot de passe des sentinelles en clair (déplacé dans le trousseau à l'importation, jamais exporté).
redis_clusterUniquement Redis : mode cluster (auto, standalone, cluster) et la carte des nœuds.
redis_entra_userRedis avec connexion Microsoft Entra : le nom d'utilisateur Redis sous lequel se connecter ; en son absence, connexion avec l'ID d'objet du jeton.
entra_accountÉpingler un compte Microsoft Entra : account_id, tenant_id, username.
route{ "type": "direct" } (par défaut) ou { "type": "via-relay", "relay_device_id", "pair_id" }.
tunnel_profile ou transportUn profil de tunnel nommé, ou défini en ligne proxy, ssh, et kube sauts.
maskinginclude et exclude listes de motifs de colonnes tels que "*ssn*", ou { "pattern": "users.email", "scope": "table-dot-column" }.

Méthodes de connexion

typeChamps
sql-loginusername et password, ou account nommant un login partagé. Omettez le mot de passe et SQLly le demande lors de la première connexion.
integratedWindows / Kerberos (SQL Server).
entra-browser, entra-device-codeMicrosoft Entra (SQL Server, Azure SQL).
aws-rds-iamusername, region, optionnel profile.
gcp-cloud-sql-iamusername.
auth-tokenlibSQL / Turso token (omettez-le pour un serveur anonyme).
noneFichiers SQLite et DuckDB.

Sauts de tunnel

  • ssh - host, port (22), username, et auth: { "type": "agent" }, { "type": "key-file", "path", "passphrase" }, ou { "type": "password", "password" } (passphrase et password peuvent être omis ; SQLly demande alors lors de la première connexion). Un hôte optionnel jump prend les mêmes champs. keepalive_seconds (30 lorsqu'il est absent, 0 pour aucun) et keepalive_max (3) définissent les keepalives SSH du tunnel.
  • proxy - kind (socks5 ou http-connect), host, port, et optionnel username et password.
  • kube - namespace, target_kind (pod, service, deployment), target_name, remote_port, et optionnel kubeconfig et context. Il ne peut pas être combiné avec SSH ou un proxy.

Un exemple complet

Deux bases de données sur un même serveur PostgreSQL accessibles via un bastion, qui partagent des identifiants de lecture et d’écriture ; un SQL Server avec son propre mot de passe ; et un fichier SQLite local, avec un client coloré et un environnement de production qui n’autorise que 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" }
  ]
}