development.md
Prior to running ReadySet, you may need to install the following dependencies: clang libclang-dev libssl-dev liblz4-dev build-essential
macOS:
brew install lz4
brew install [email protected]
Ubuntu:
sudo apt update && sudo apt install -y build-essential libssl-dev pkg-config llvm clang liblz4-dev cmake
ReadySet is written entirely in Rust. If you don’t already have Rust installed, you can install it via rustup (select the version specified in the rust-toolchain.toml file):
curl https://sh.rustup.rs -sSf | sh
To streamline local development, all runtime dependencies (Consul, MySQL, Postgres) can be run with:
cp docker-compose.override.yml.example docker-compose.override.yml
docker-compose up -d
ReadySet runs alongside a backing MySQL or Postgres database and uses Consul for leader election. You’ll need to pass in your database’s connection string when running the ReadySet server and adapter, and have a Consul instance running.
Note: Consul persists data per deployment. Using the same deployment name will carry over any previously installed queries into a new deployment.
First, compile and run ReadySet server.
cargo run --bin readyset-server --release -- --upstream-db-url <upstream-url> --deployment <deployment name>
If using the databases supplied by the docker-compose environment in this repository, replace <upstream-url> with the URL of the database corresponding to your database engine:
mysql://root:[email protected]/readysetpostgresql://root:[email protected]/readysetIf running with an existing external database, replace <upstream-url> with the connection string for that database.
Then, run the adapter binary. The adapter will communicate with servers that have the same deployment name.
MySQL
cargo run --bin readyset --release -- --database-type mysql --upstream-db-url mysql://root:[email protected]/readyset --allow-unauthenticated-connections
--address 0.0.0.0:3307 --deployment <deployment name> --prometheus-metrics
Postgres
cargo run --bin readyset --release -- --database-type postgresql --upstream-db-url postgresql://postgres:[email protected]/readyset --allow-unauthenticated-connections
--address 0.0.0.0:5433 --deployment <deployment name> --prometheus-metrics
The adapter listens for connections at the address specified in the address flag.
The prometheus-metrics flag exposes an HTTP endpoint in the adapter to allow querying of metrics. This can be reached with an HTTP GET request to <adapter-address>:6034/metrics (e.g., curl -X GET 127.0.0.1:6034/metrics).
To run tests for the project, run the following command:
cargo test --skip integration_serial
Certain tests cannot be run in parallel with others, and these tests are typically in files postfixed with _serial. Running the entire set of tests for a package, i.e. cargo test -p readyset-server may fail if serial tests are included.
Running tests may require increasing file descriptor limits. You can do so by running ulimit -Sn 65535.
When running ReadySet in a performance-critical setting, make sure you compile with the --release flag.