Files & sync
Keep your SQLly world in plain files, then choose if and how those files travel with you.
SQLly keeps its data in plain files on your disk. Sync simply carries those files between devices, and only after you choose to turn it on.
Files first, sync second
The order matters. Because everything is an ordinary file in one folder, syncing
is not a feature SQLly has to invent, it is a property of where the files live.
That has a pleasant consequence: you are not limited to what we built. Point any
file-sync tool you already trust at the folder, keep it in a private Git repo, or
copy it to a new machine with cp, and your setup arrives intact.
The two pages in this section follow that order. Everything is a file is how SQLly works today: where the folder is on each platform and what each file holds. Read it before you back up, sync, or hand-edit anything. iCloud Drive sync is the built-in option for Macs: off until you turn it on, it carries connections, snippets, queries and settings between your Macs and never their passwords. On Windows and Linux, the file-based approach does the same job with a tool of your choosing.
- Everything is a file
- Connections, history, snippets, cards, and rules live as plain files you can back up, inspect, and keep.
- iCloud Drive sync
- Opt in to keep connections, snippets, queries and settings the same on every Mac through your own iCloud Drive. Passwords stay in each Mac's keychain.
Where the secrets go
| Platform | Credential store |
|---|---|
| macOS | The login Keychain |
| Windows | Windows Credential Manager |
| Linux | The Secret Service (GNOME Keyring, KWallet, or another provider on your desktop) |
Saved connection passwords are stored there under the service name
SQLLY.sql-auth, so you can find, inspect, or delete them with your
platform's own keychain tool.
Moving to a new machine
- Quit SQLly on both machines.
- Copy the
SQLLYfolder from the old machine to the same place on the new one, see Everything is a file for the path on each platform. - Start SQLly. Your connections, their clients, projects, and environments, and your settings are all there.
- Connections that use a saved password cannot sign in until you enter the password once with Edit Connection..., because the new machine's keychain does not have it yet. Connection Health lists them as The saved SQL account has no password in the system keyring.
To bring the passwords along in one step instead, use File › Export Conn w/ Creds... on the old machine and File › Import Connections... on the new one. Import puts each password straight into the new machine's keychain. The file holds passwords in clear text, so read Export & import connections before you send one anywhere.
Using your own sync tool
- SQLly reads
connections.jsonwhen it starts. It does not watch the file, so a change your sync tool brings in while SQLly is running is not picked up, and the next change you make in the app saves its own copy over it. Quit SQLly on one machine before syncing changes onto another. - Files are replaced whole. SQLly writes
connections.jsonto a temporary file and renames it into place, so a sync tool never picks up a half-written file. - A damaged file is left alone. If
connections.jsonis not valid JSON - say, a conflict marker from a sync tool - SQLly starts with an empty list and does not save over the file, so you can repair it and restart. - Two Mac editions, two folders. The Mac App Store edition keeps its own settings and connections, separate from the direct download. See macOS & the Mac App Store.
Local-only is the default state, not a mode you have to select. Until you turn something on, nothing about your setup leaves the machine it is on.