接続ファイルの形式

実装済み

SQLly の接続ファイルの構成(ラベル、共有ログイン、トンネルプロファイル、接続)を、受け付けるすべてのキーと完全な例とともに説明します。

SQLly の接続ファイルは 1 つの JSON ドキュメントです。次の両方が使用するのは、このファイルです ファイル → 接続をエクスポート… そして ファイル → 接続をエクスポート (認証情報付き)… が書き出すものであり、 ファイル → 接続をインポート… 読み取り(参照: 接続のエクスポートとインポート)。手動で作成することもできます。このページでは、ファイルの構成と、各部分に指定できる内容の概要を説明します。

パスワードは任意で、設定した場合は平文で保存されます。 すべての password, passphrase、そして token フィールドは省略できます。接続のエクスポートではそれらは一切書き出されず、パスワードのない接続は最初の接続時に入力を求めます。パスワードを含むファイルはそれ自体が機密です。SQLlyはインポート時にすべてのパスワードをシステムのキーチェーンに移し、ファイルのコピーは保持しないので、インポートしたら削除してください。

レイアウトの概要

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

次を除き、すべてのセクションは省略可能です format そして version。接続は、共有ログイン、トンネルプロファイル、ラベルを参照します 名前で、そのため、1 つのログインまたはトンネルで多数の接続を賄えます。名前は大文字と小文字を区別せずに照合され、名前は SQLly に保存済みのものを指すこともできます。

複数のデータベースを持つ 1 つのサーバーは、単に複数の接続が共有する server と異なる database。同じデータベースへの複数のログインは、異なるアカウントを使う複数の接続です。

変更を加える前にチェック

  • 全部か、何もなしか - ファイル全体が最初にチェックされます。何か問題があれば、すべての問題がその場所とともに一覧表示されます(たとえば connections[2] "Ops": port must be 1-65535)であり、何もインポートされません。
  • タイプミスはエラーです - 次のような未知のキー "pasword" は黙って無視されるのではなく、報告されます。
  • エンジンのルールも適用されます - エンジンが対応していないサインイン方法、暗号化をオフにした状態で TLS を要求するホスト型エンジン、キーのないクライアント証明書は、いずれも報告されます。
  • 新しいバージョンは拒否されます - 次を持つファイル version SQLly が理解できるより新しい形式の場合は、中途半端にインポートせず、その旨を伝えます。

クライアント、プロジェクト、環境

キー保持するもの
name必須。同じ名前の既存のラベルとマージするか、新しく作成します。
color#RGB, #RRGGBB、または #RRGGBBAA (この # は省略可能です)。
imageアイコンをベース64 エンコードしたもので、 data:image/png;base64,… URI、またはプレフィックスなしの base64。PNG、JPEG、GIF、WebP、BMP、ICO、SVG、最大 1 MB。形式は画像自体から検出されます。
safety次のいずれか 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 (各 true / false)。変更されるのは、指定したスイッチだけです。

省略する color, image、または安全スイッチが、既存のラベルが既に持っている内容をそのまま維持します。

共有ログイン

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

接続は、共有ログインを次の形で使います "authentication": { "type": "sql-login", "account": "Reader" }。同じ名前とユーザー名で保存済みのログインの上にインポートすると、そのパスワードがその場で更新されます。

トンネルプロファイル

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

ホップは、接続の transport (下記)。接続では、次の内容のものを使用します: "tunnel_profile": "Corp bastion"、インラインの代わりに transport.

接続

のみ name, engine、そして server は必須です。省略したものは、接続エディターが与えるのと同じ既定値になります。

キー保持するもの
nameエクスプローラーに表示されている名前。
engineゆるい書き方: postgresql, postgres, mssql, sql-server, mysql, mariadb, sqlite, duckdb, libsql, clickhouse, oracle, redis, valkey, neon, supabase, planetscale, cockroachdb、そして SQLly がサポートするその他のエンジン。
serverホスト名、IP、 host\instance、または SQLite と DuckDB のファイルパス。
portデフォルトはエンジンの通常のポートです。
database開くデータベース (Oracle: サービス名、または SID:ORCL).
environmentlocal, dev, test, staging, production、または unset.
client, projectラベル名。
authenticationサインイン方法は以下を参照してください。
tlsmode (disable, require, verify-ca, verify-full)、または SQL Server 形式の encrypt そして trust_server_certificate スイッチ。また ca_file, client_cert_file、そして client_key_file パスと trust_os_roots (true OS の証明書ストアも信頼するようになります。Redis)、および direct (true PostgreSQL 17の直接TLS用)。
timeout_seconds, statement_timeout_seconds接続タイムアウト(デフォルト 30)と、任意のステートメントごとの制限。
application_nameサーバーに報告される(デフォルト SQLLY).
safetyauto_wrap_rollback, block_all_but_select, confirm_data_changes, allow_unbounded_mutations、そして production_override この 1 つの接続用。
favorite接続にスターを付けます。
startup_sql接続直後に実行する SQL
redis_key_delimiter, clickhouse_native_portRedis と ClickHouse 向けのエンジン固有の追加機能。
redis_sentinel, redis_sentinel_passwordRedis のみ:問い合わせ先の Sentinel マスターグループとセンチネル、およびセンチネル自身のパスワード(平文。インポート時にキーチェーンへ移され、エクスポートはされません)。
redis_clusterRedis のみ:クラスターモード(auto, standalone, cluster) およびノードマップ。
redis_entra_userMicrosoft Entra サインインでの Redis: サインインに使う Redis ユーザー名。省略するとトークンのオブジェクト ID でサインインします。
entra_accountMicrosoft Entra アカウントを固定します: account_id, tenant_id, username.
route{ "type": "direct" } (デフォルト)または { "type": "via-relay", "relay_device_id", "pair_id" }.
tunnel_profile または transport名前付きトンネルプロファイル、またはインラインで指定 proxy, ssh、そして kube の各ホップです。
maskinginclude そして exclude 次のような列パターンのリスト "*ssn*"、または { "pattern": "users.email", "scope": "table-dot-column" }.

サインイン方法

typeフィールド
sql-loginusername そして password、または account 共有ログインを指定します。パスワードを省略すると、SQLly は初回接続時に尋ねます。
integratedWindows / Kerberos(SQL Server)。
entra-browser, entra-device-codeMicrosoft Entra(SQL Server、Azure SQL)。
aws-rds-iamusername, region、任意 profile.
gcp-cloud-sql-iamusername.
auth-tokenlibSQL / Turso token (匿名サーバーでは省略してください)
noneSQLite と DuckDB ファイル。

トンネルホップ

  • ssh - host, port (22), username、そして auth: { "type": "agent" }, { "type": "key-file", "path", "passphrase" }、または { "type": "password", "password" } (passphrase そして password 省略できます。その場合、SQLly は初回接続時に尋ねます)。オプションの jump ホストにも同じフィールドがあります。 keepalive_seconds (指定なしの場合は 30、0 で無効)および keepalive_max (3) トンネルの SSH キープアライブを設定します。
  • proxy - kind (socks5 または http-connect), host, port、および任意の username そして password.
  • kube - namespace, target_kind (pod, service, deployment), target_name, remote_port、および任意の kubeconfig そして context。SSH やプロキシとは併用できません。

完全な例

踏み台サーバー経由で接続する 1 台の PostgreSQL サーバー上の 2 つのデータベース(読み取り用と書き込み用のログインを共有)、独自のパスワードを持つ SQL Server、ローカルの SQLite ファイル。色分けされたクライアントと、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" }
  ]
}