Verbindungsdateiformat

funktional

Wie eine SQLly-Verbindungsdatei aufgebaut ist - Etiketten, gemeinsame Anmeldungen, Tunnelprofile und Verbindungen - mit jedem akzeptierten Schlüssel und einem vollständigen Beispiel.

Eine SQLly-Verbindungsdatei ist ein einzelnes JSON-Dokument. Es ist das Format, das sowohl Datei → Verbindungen exportieren… und Datei → Verbindungen mit Zugangsdaten exportieren… schreiben und was Datei → Verbindungen importieren… liest (siehe Verbindungen exportieren und importieren). Du kannst auch eine von Hand schreiben. Diese Seite gibt eine Übersicht über den Aufbau der Datei und was die einzelnen Teile akzeptieren.

Passwörter sind optional und im Klartext, wenn vorhanden. Jedes password, passphrase, und token Feld kann weggelassen werden: Export Connections schreibt keines von ihnen, und eine Verbindung ohne ein Feld fragt beim ersten Verbinden danach. Eine Datei, die sie enthält, ist ihrerseits ein Geheimnis. SQLly verschiebt jedes Passwort beim Import in Ihren System-Schlüsselbund und behält niemals eine Kopie der Datei; löschen Sie sie, sobald sie importiert wurde.

Layout auf einen Blick

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

Jeder Abschnitt ist optional außer format und version. Verbindungen verweisen auf gemeinsame Logins, Tunnelprofile und Labels nach Namen, sodass ein Login oder Tunnel viele Verbindungen bedienen kann. Namen werden ohne Berücksichtigung der Groß- und Kleinschreibung abgeglichen, und ein Name kann auch auf etwas zeigen, das bereits in SQLly gespeichert ist.

Ein Server mit mehreren Datenbanken ist einfach mehrere Verbindungen, die eine server teilen und sich unterscheiden in database. Mehrere Logins auf derselben Datenbank sind mehrere Verbindungen, die unterschiedliche Konten verwenden.

Geprüft, bevor sich etwas ändert

  • Alles oder nichts - die ganze Datei wird zuerst geprüft. Wenn etwas nicht stimmt, wird jedes Problem mit seiner Fundstelle aufgelistet (zum Beispiel connections[2] "Ops": port must be 1-65535) und nichts wird importiert.
  • Tippfehler sind Fehler - ein unbekannter Schlüssel wie "pasword" wird gemeldet, anstatt stillschweigend ignoriert zu werden.
  • Es gelten Engine-Regeln - Eine Anmeldemethode, die die Engine nicht unterstützt, eine gehostete Engine, die TLS mit deaktivierter Verschlüsselung erfordert, oder ein Client-Zertifikat ohne seinen Schlüssel werden alle gemeldet.
  • Neuere Versionen werden abgelehnt - eine Datei mit einer version neuer ist, als dein SQLly versteht, wird das gemeldet, statt halb zu importieren.

Kunden, Projekte & Umgebungen

SchlüsselWas sie enthält
nameErforderlich. Wird mit einem bestehenden Label desselben Namens zusammengeführt oder erstellt ein neues.
color#RGB, #RRGGBB, oder #RRGGBBAA (das # ist optional).
imageDas Symbol, base64-kodiert – ein data:image/png;base64,… URI oder reines Base64. PNG, JPEG, GIF, WebP, BMP, ICO oder SVG, bis zu 1 MB. Der Typ wird aus dem Bild selbst erkannt.
safetyJedes von 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 (jedes true / false). Nur die aufgeführten Schalter ändern sich.

Das Weglassen von color, image, oder ein Sicherheitsschalter behält, was das vorhandene Label schon hat.

Geteilte Logins

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

Eine Verbindung verwendet einen mit "authentication": { "type": "sql-login", "account": "Reader" }. Das Importieren über einen gespeicherten Login mit demselben Namen und Benutzernamen aktualisiert dessen Passwort direkt.

Tunnelprofile

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

Die Hops verwenden dieselben Formen wie das transport einer Verbindung (unten). Eine Verbindung verwendet einen mit "tunnel_profile": "Corp bastion"anstatt eines Inline. transport.

Verbindungen

Nur name, engine, und server sind erforderlich. Alles, was ausgelassen wird, erhält denselben Standard, den der Verbindungseditor vergeben würde.

SchlüsselWas sie enthält
nameDer im Explorer angezeigte Name.
engineLocker geschrieben: postgresql, postgres, mssql, sql-server, mysql, mariadb, sqlite, duckdb, libsql, clickhouse, oracle, redis, valkey, neon, supabase, planetscale, cockroachdb, und die restlichen Engines, die SQLly unterstützt.
serverHostname, IP, host\instanceoder der Dateipfad für SQLite und DuckDB.
portStandard ist der übliche Port der Engine.
databaseZu öffnende Datenbank (Oracle: Dienstname, oder SID:ORCL).
environmentlocal, dev, test, staging, production, oder unset.
client, projectLabel-Namen.
authenticationWie du dich anmeldest - siehe unten.
tlsmode (disable, require, verify-ca, verify-full), oder im SQL Server-Stil encrypt und trust_server_certificate Schalter. Außerdem ca_file, client_cert_file, und client_key_file Pfade, und trust_os_roots (true auch dem Zertifikatsspeicher des Betriebssystems zu vertrauen; Redis), und direct (true für direktes TLS mit PostgreSQL 17).
timeout_seconds, statement_timeout_secondsVerbindungs-Timeout (Standard 30) und ein optionales Limit pro Anweisung.
application_nameDem Server gemeldet (Standard SQLLY).
safetyauto_wrap_rollback, block_all_but_select, confirm_data_changes, allow_unbounded_mutations, und production_override für diese eine Verbindung.
favoriteVerbindung mit Stern markieren.
startup_sqlSQL, das direkt nach dem Verbinden ausgeführt wird.
redis_key_delimiter, clickhouse_native_portEngine-spezifische Extras für Redis und ClickHouse.
redis_sentinel, redis_sentinel_passwordNur Redis: die Sentinel-Mastergruppe und abzufragende Sentinels sowie das Passwort der Sentinels im Klartext (beim Import in den Schlüsselbund verschoben, nie exportiert).
redis_clusterNur Redis: Cluster-Modus (auto, standalone, cluster) und die Knotenkarte.
redis_entra_userRedis mit Microsoft Entra-Anmeldung: der Redis-Benutzername zum Anmelden; wenn nicht vorhanden, erfolgt die Anmeldung als Objekt-ID des Tokens.
entra_accountMicrosoft Entra-Konto anheften: account_id, tenant_id, username.
route{ "type": "direct" } (Standard) oder { "type": "via-relay", "relay_device_id", "pair_id" }.
tunnel_profile oder transportEin benanntes Tunnelprofil oder Inline proxy, ssh, und kube Hops.
maskinginclude und exclude Listen von Spaltenmustern wie "*ssn*", oder { "pattern": "users.email", "scope": "table-dot-column" }.

Anmeldemethoden

typeFelder
sql-loginusername und password, oder account Eine gemeinsame Anmeldung benennen. Lass das Passwort weg und SQLly fragt beim ersten Verbinden danach.
integratedWindows / Kerberos (SQL Server).
entra-browser, entra-device-codeMicrosoft Entra (SQL Server, Azure SQL).
aws-rds-iamusername, region, optional profile.
gcp-cloud-sql-iamusername.
auth-tokenlibSQL / Turso token (lass es bei einem anonymen Server weg).
noneSQLite- und DuckDB-Dateien.

Tunnel-Hops

  • ssh - host, port (22), username, und auth: { "type": "agent" }, { "type": "key-file", "path", "passphrase" }, oder { "type": "password", "password" } (passphrase und password können weggelassen werden; SQLly fragt dann beim ersten Verbinden). Ein optionaler jump Host verwendet dieselben Felder. keepalive_seconds (30 wenn nicht angegeben, 0 für keine) und keepalive_max (3) setzen die SSH-Keepalives des Tunnels.
  • proxy - kind (socks5 oder http-connect), host, port, und optional username und password.
  • kube - namespace, target_kind (pod, service, deployment), target_name, remote_port, und optional kubeconfig und context. Es kann nicht mit SSH oder einem Proxy kombiniert werden.

Ein vollständiges Beispiel

Zwei Datenbanken auf einem PostgreSQL-Server, erreicht über einen Bastion-Host, die Lese- und Schreib-Logins teilen; ein SQL Server mit eigenem Passwort; und eine lokale SQLite-Datei, mit einem farbigen Client und einer Produktionsumgebung, die nur SELECT zulässt.

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