Skip to content

Latest commit

 

History

History
214 lines (143 loc) · 5.06 KB

BUILD-RUN.md

File metadata and controls

214 lines (143 loc) · 5.06 KB
Raw

Build and run sqld

There are four ways to build and run sqld:

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 sqlite3 CLI to query the SQLite 3 compatible database file managed by sqld.

sqlite3 ./data.sqld/data

Be sure to stop sqld before using sqlite3 like this.

Download a prebuilt binary

The sqld releases page for this repository lists released versions of sqld along with downloads for macOS and Linux.

Build and install with Homebrew

The sqld formulae for Homebrew works with macOS, Linux (including WSL).

1. Add the tap libsql/sqld to Homebrew

brew tap libsql/sqld

2. Install the formulae sqld

brew install sqld

This builds and installs the binary sqld into $HOMEBREW_PREFIX/bin/sqld, which should be in your PATH.

3. Verify that sqld works

sqld --help

Using a prebuilt Docker image

The sqld release process publishes a Docker image to the GitHub Container Registry. The URL is https://ghcr.io/libsql/sqld. You can run the latest image locally on port 8080 with the following:

docker run -p 8080:8080 -d ghcr.io/libsql/sqld:latest

Or you can run a specific version using one of the sqld container release tags in the following form for version X.Y.Z:

docker run -p 8080:8080 -d ghcr.io/libsql/sqld:vX.Y.Z

Build from source using Docker / Podman

To build sqld with Docker, you must have a Docker installed and running on your machine with its CLI in your shell PATH.

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 sqld directory.

2. Build with Docker

Run the following to build a Docker image named "libsql/sqld" tagged with version "latest".

docker build -t libsql/sqld:latest .

3. Verify the build

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

docker container run \
  --rm \
  -i \
  libsql/sqld \
  /bin/sqld --help

4. Create a data volume

The following will create a volume named sqld-data that sqld uses to persist database files.

docker volume create sqld-data

5. Run sqld in a container

The following uses the built image to create and run a new container named sqld, attaching the sqld-data volume to it, and exposing its port 8080 locally:

docker container run \
  -d \
  --name sqld \
  -v sqld-data:/var/lib/sqld \
  -p 127.0.0.1:8080:8080 \
  libsql/sqld:latest

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 libSQL client SDKs for local development.

6. Configure sqld with environment variables

In the sqld output using --help from step 3, you saw the names of command line flags along with the names of environment variables (look for "env:") used to configure the way sqld works.

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). We are working native Windows build instructions.

1. Setup

Install dependencies:

./scripts/install-deps.sh

2. Clone this repo

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

Change to the sqld directory.

3. Build with cargo

cargo build

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

4. Verify the build

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

./target/debug/sqld --help

5. 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 libSQL client SDKs for local development.

6. Run tests (optional)

make test