¶Build and run sqld

There are several ways to build and run sqld:

• Download a prebuilt binary
• Using a prebuilt Docker image
• From source using Rust

¶Running sqld

You can simply run launch the executable with no command line arguments to run an instance of sqld. By default, sqld listens on 127.0.0.1 port 8080 and persists database data in a directory ./data.sqld.

Use the --help flag to discover how to change its runtime behavior.

¶Query sqld

You can query sqld using one of the provided client libraries.

You can also use the elyra cli to connect to the sqld instance:

elyra db shell http://127.0.0.1:8080

¶Download a prebuilt binary

The release page for this repository lists released versions of sqld along with prebuilt downloads. Each release attaches a sqld binary for:

Download the archive for your platform, extract it, and run the sqld executable.

Windows is not currently supported as a prebuilt target — sqld's replication layer depends on Unix-only file APIs. Build from source with Rust if you need to run on other platforms.

¶Using a prebuilt Docker image

Each release publishes a multi-arch sqld image (linux/amd64 and linux/arm64) to the GitHub Container Registry. Run the latest release on port 8080 with:

docker run -p 8080:8080 -d ghcr.io/kwhorne/sqlanywhere-server:latest

Or pin a specific version:

docker run -p 8080:8080 -d ghcr.io/kwhorne/sqlanywhere-server:0.5.2

The image is built for both Intel (amd64) and ARM (arm64), so Docker pulls the right variant for your host automatically. Available tags are listed on the container package page.

¶Build from source using Rust

To build from source, you must have a Rust development environment installed and available in your PATH.

Currently we only support building sqld on macOS and Linux (including WSL). Native Windows is not supported because sqld's replication layer relies on Unix-only file APIs; use WSL on Windows.

¶1. Clone this repo

Clone this repo using your preferred mechanism. You may want to use one of the sqld release tags.

Change to the sqlanywhere-server directory.

¶2. Build with cargo

cargo build

The sqld binary will be in ./target/debug/sqld.

¶3. Verify the build

Check that sqld built successfully using its --help flag:

./target/debug/sqld --help

¶4. Run sqld with all defaults

The following starts sqld, taking the following defaults:

• Local files stored in the directory ./data.sqld
• Client HTTP requests on 127.0.0.1:8080

./target/debug/sqld

8080 is the default port for the sqld HTTP service that handles client queries. With this container running, you can use the URL http://127.0.0.1:8080 or ws://127.0.0.1:8080 to configure one of the SQL Anywhere client SDKs for local development.

¶5. Run tests (optional)

cargo xtask test