Installation
Downloads
Download the SQL Flow CLI, agent and log broker for Windows or Linux, check the release version, and verify each file's checksum.
The Downloads page has every SQL Flow executable you run on your own machines: the CLI, the agent and the log broker, for Windows and Linux. Open it from Downloads in the navigation, or from Downloads at the top of the Agents page.
What you can download
The page shows one card for each product:
| Product | What the card says it does | Windows x64 | Linux x64 |
|---|---|---|---|
| SQL Flow CLI | Manage connections, pipelines and agents from your terminal. | sqlflow.exe | sqlflow |
| Agent | Capture changes and apply them to your targets. | SqlFlow.Agent.exe | SqlFlow.Agent |
| Log broker | Give agents access to approved database log folders. | SqlFlow.LogBroker.exe | SqlFlow.LogBroker |
Each card has a Windows x64 and a Linux x64 button, so you can download the file for another machine. Beside each button is the exact version of that executable, as Version followed by the number. Each product is a single executable with no installer.
A button stays disabled when the control plane has no release of that executable, and its version reads Not published or Version unavailable. Select Refresh to load the list again.
Set up an agent or a log broker
- Open Downloads and, on the Agent or Log broker card, select the button for the host's operating system.
- Verify the checksum.
- Copy the file to the host. A log broker goes in a permanent folder on the database host, because its service runs the file from where you install it.
- Select Set up agent or Set up broker on the card. This opens the same panel as Add agent and Add broker on the Agents page: it creates the join code and prints the install command.
- Continue with Install an agent or Install a broker.
Set up the CLI
Open Downloads and, on the SQL Flow CLI card, select Windows x64 or Linux x64.
Copy the file to a folder on your
PATH. On Linux, make it executable:chmod +x sqlflowUnder Get started with the CLI, choose Windows x64 or Linux x64. The card shows the commands that set the control plane's address and your email, prompt for your password without echoing it, and list your agents. Run them from the folder that holds the file.
The commands appear only when downloads are configured and you open the web app at the control plane's https:// address. See CLI overview and authentication for every option.
Verify a download
Details under each button lists the executable's File name, its Release and its SHA-256 checksum. Compare the checksum with the file you downloaded before you run it, especially after you copy the file between machines.
(Get-FileHash -Path .\SqlFlow.Agent.exe -Algorithm SHA256).HashUse the name of the file you downloaded. The output must match the checksum under Details, ignoring letter case. If it doesn't, delete the file and download it again.
A download link is valid for 15 minutes. If the release changed since the page loaded, the download stops with This download changed since the page loaded. Refresh the downloads and try again.
Release versions
The version beside each button is the release your control plane offers. The control plane accepts agents and brokers only within a version window, so install the release shown here. To upgrade, download the new release from this page and follow Upgrades and restarts.
Air-gapped deployments
A control plane serves downloads only when downloads are configured on it. An air-gapped control plane can serve them from storage inside your network, once you place the release files in that storage. Without downloads configured, copy the executables to your hosts yourself.
On a control plane without downloads configured, the Downloads page and the Add agent and Add broker panels say Downloads are not available on this control plane yet. Contact your administrator. The panels still create the join code and print the install command. Get started with the CLI shows The control plane address is unavailable. Refresh the downloads to load the CLI commands. instead of the commands; set up the CLI from CLI overview and authentication.
