ReadySet Server

The readyset-server command starts the ReadySet Server.

This command is used only when running the ReadySet Server and Adapter as separate processes on separate machines. To run the ReadySet Server and Adapter as a single process, use the readyset command with the --standalone option.

Usage

Start the ReadySet Server:

readyset-server [OPTIONS]

Start the ReadySet Adapter:

readyset [OPTIONS, excluding --standalone]

View help:

readyset-server --help

Options

`--address`, `-a`

The IP address/hostname and port that the ReadySet Server listens on.

Env variable: LISTEN_ADDRESS

`--authority`

The external authority for a distributed ReadySet deployment. The authority handles node discovery, leader election, and consensus and manages internal state and metrics.

Possible values: "consul"

Default: "consul"

Env variable: AUTHORITY

`--authority-address`

The IP address/hostname and port of the external authority.

Env variable: AUTHORITY_ADDRESS

`--cannot-become-leader`

When running multiple ReadySet Servers, prevent this Server from ever being elected as leader.

`--db-dir`

The path to the directory where ReadySet stores replicated table data.

Default: Current working directory

Env variable: DB_DIR

`--deployment`

A unique identifier for the ReadySet deployment.

Env variable: DEPLOYMENT

`--disable-telemetry`

Don't sent anonymous telemetry data to ReadySet.

Env variable: DISABLE_TELEMETRY

`--disable-upstream-ssl-verification`

Disable verification of SSL certificates supplied by the upstream database on connections to replicate data and proxy queries (Postgres only, ignored for MySQL).

Env variable: DISABLE_UPSTREAM_SSL_VERIFICATION

💡

If invalid certificates are trusted, any certificate for any site will be trusted. Use this option with caution.

`--durability`

The durability of the tables that ReadySet replicates from the upstream database as the basis for caching query results.

Possible values:

"persistent": Store replicated tables on disk (at the location specified by --db-dir). Do not delete the data when the ReadySet Server is stopped. Suitable for production deployments.
"ephemeral": Store replicated tables on disk (at the location specified by --db-dir). Delete the data when the ReadySet Server is stopped. Suitable for testing only.
"memory": Store replicated tables entirely in memory. Suitable for testing only.

Default: "persistent"

`--eviction-policy`

When possible, ReadySet stores only certain results sets for a query in memory. For example, if a query is parameterized on user IDs, ReadySet would only cache the results of that query for the active subset of users, since they are the ones issuing requests. This is referred to as "partial materialization".

The --eviction-policy option determines the strategy for evicting cache entries from partial materializations once the overall memory limit (see --memory-limit) has been surpassed.

Possible values: "random", "lru", "generational"

Default: "random"

`--external-address`

The IP address/hostname to advertise to ReadySet instances running in the same deployment. This also defines the IP address/hostname of the Prometheus endpoint for ReadySet metrics (opens in a new tab).

Default: Address from --address

Env variable: EXTERNAL_ADDRESS

`--external-port`, `-p`

The port to advertise to ReadySet instances running in the same deployment. This also defines the port of the Prometheus endpoint for ReadySet metrics (opens in a new tab).

Default: 6033

`--forbid-full-materialization`

ReadySet must sometimes store the entire result set for a query in memory, for example, when there is no WHERE filter or when the WHERE filter is not parameterized (by the user or by ReadySet). This is referred to as "full materialization".

The --forbid-full-materialization option prevents ReadySet from caching queries that would be fully materialized.

Env variable: FORBID_FULL_MATERIALIZATION

💡

Consider passing this option when ReadySet Adapters use the "inrequestpath" or "async" query caching mode. In both cases, queries are cached by ReadySet automatically, and if too many queries are fully materialized, you can exhaust memory, especially because cache entries of fully materialized queries will never get evicted (i.e., the --eviction-policy applies only to partially materialized queries).

`--help`, `-h`

Print help information.

`--log-format`

Format to use when emitting log events. See the docs for the tracing library (opens in a new tab) for details.

Possible values: "compact", "full", "pretty", "json"

Default: "full"

Env variable: LOG_FORMAT

`--log-level`

The severity level(s) (opens in a new tab) to include in ReadySet logs. Messages at the specified and more severe levels are included. For example, when set to INFO, messages at the INFO, WARN, and ERROR levels are included.

Possible values, from most to least severe:

ERROR: Used for hazardous situations that require special handling, where normal operation cannot proceed as expected.
WARN: Used for potentially hazardous situations that may require special handling.
INFO: Used for information messages that do not require action.
DEBUG: Used for lower priority information.
TRACE: Used for very low priority, often extremely verbose information.

The TRACE level is not available for official releases of ReadySet, or for binaries built with the --release flag. Also, --log-level can be set to a comma-separated list of directives for debugging during development. For the directive syntax, see the docs for the tracing library.

Default: INFO

Env variable: LOG_LEVEL

`--memory-limit`, `-m`

The amount of memory, in bytes, available to the ReadySet Server.

This memory limit accounts for all memory use, including partial materializations (i.e., queries for which ReadySet stores only part of the result set), full materializations (i.e., queries for which ReadySet stores the entire result set), and other parts of the ReadySet process (e.g., RocksDB).

Once memory usage surpasses this limit, ReadySet starts evicting cache entries from partial materializations based on the --eviction-policy.

Default: 0 (unlimited)

Env variable: READYSET_MEMORY_LIMIT

💡

For production deployments, start by setting this to 60-80% of the machine's total memory. Then run the system under load, observe, and increase or decrease as needed.

`--memory-check-every`

The frequency, in seconds, at which to check memory usage by ReadySet. Once usage surpasses the limit set in --memory-limit, ReadySet starts evicting cache entries for partial materializations based on the --eviction-policy.

Default: 1

Env variable: MEMORY_CHECK_EVERY

`--no-readers`

Do not run reader nodes on this instance. Reader nodes are the part of the dataflow graph that serve cached results for a query.

`--persistence-threads`

Number of background threads used by RocksDB, the storage engine for ReadySet's snapshot of upstream database tables.

Default: 6

`--prometheus-metrics`

Output ReadySet metrics to the Prometheus endpoint at <metrics address>/metrics. The metrics address is defined by --external-address and --external-port.

Env variable: PROMETHEUS_METRICS

`--quorum`, `-q`

For a distributed ReadySet deployment with multiple ReadySet Server instances, the number of ReadySet Server instances. ReadySet will wait until this number is reached before accepting requests.

Default: 1

Env variable: NORIA_QUORUM

`--reader-only`

Run only reader nodes on this instance. Reader nodes are the part of the dataflow graph that serve cached results for a query.

`--replication-pool-size`

The number of connections to the upstream database for snapshotting and replication.

Default: 50

⚠️

This can be set as high as the number of tables you want ReadySet to snapshot/replicate. However, more connections will increase both the load on your upstream database and memory usage by ReadySet.

`--replication-tables`

By default, ReadySet attempts to snapshot and replicate all tables in the database specified in --upstream-db-url. However, if the queries you want to cache in ReadySet access only a subset of tables in the database, you can use this option to narrow the scope accordingly. Filtering out tables that will not be used in caches will speed up the snapshotting process.

This option accepts a comma-separated list of <schema>.<table> (specific table in a schema) or <schema>.* (all tables in a schema) for Postgres and <database>.<table> for MySQL.

Env variable: REPLICATION_TABLES

`--snapshot-report-interval-secs`

The time, in seconds, between logging the snapshotting progress and estimated time remaining for each table.

Default: 30

`--ssl-root-cert`

Path to the PEM or DER root certificate that the upstream database connection will trust.

Default: System root store

Env variable: SSL_ROOT_CERT

`--tracing-host`

When using open telemetry, the IP address/hostname and port of the telemetry server to send traces/spans to.

Env variable: TRACING_HOST

`--tracing-sample-percent`

The percent of traces to send to the open telemetry server.

To use this option, you must set --tracing-host.

Possible values: Between 0.0 and 100.0

Default: 0.01

Env variable: TRACING_SAMPLE_PERCENT

`--upstream-db-url`

The URL for connecting ReadySet to to the upstream database. This connection URL includes the username and password for ReadySet to authenticate with as well as the database to snapshot/replicate.

Env variable: UPSTREAM_DB_URL

!!! tip

By default, ReadySet attempts to snapshot and replicate all tables in the database specified in --upstream-db-url. However, if the queries you want to cache in ReadySet access only a subset of tables in the database, you can use the --replication-tables option to narrow the scope accordingly. Filtering out tables that will not be used in caches will speed up the snapshotting process.

`--version`, `V`

Print ReadySet version information.

`--volume-id`

The volume associated with a ReadySet Server.

For a distributed ReadySet deployment with multiple ReadySet Servers, snapshotted tables are scheduled, round-robin, onto volumes associated with Server instances. If a Server restarts, the Server must know which volume contains its portion of the snapshot.

Env variable: VOLUME_ID

Examples

These examples focus on a distributed ReadySet deployment (i.e., ReadySet Server and Adapter running as distinct processes and separate machines). For running a standard ReadySet deployment, see the readyset examples.

Start ReadySet

Start an instance of Consul to serve as the external authority for node discovery, leader election, and consensus, and to manage internal state and metrics.
Start the ReadySet Server:

readyset-server \
--deployment="<deployment name>" \
--upstream-db-url="postgresql://<db user>:<db password>@<db address>:5432/<database>" \
--query-caching="<caching mode>" \
--username=<readyset user> \
--password=<readyset password> \
--address=<readyset server address> \
--authority-address=<consul address> \
>> logs/readyset.log 2>&1 &

Start one of more ReadySet Adapters:

readyset \
--deployment="<deployment name>" \
--database-type=postgresql \
--username=<readyset user> \
--password=<readyset password> \
--address=<readyset adapter address> \
--authority-address=<consul address>
>> logs/readyset.log 2>&1 &

Print version information

readyset-server --version

readyset-server
release-version: beta-2023-01-18
commit_id:       de35883e248180c7e3f2f7913c0d1c2b371e53ec
platform:        aarch64-apple-darwin
rustc_version:   rustc 1.64.0-nightly (fe3342816 2022-08-01)
profile:         release
opt_level:       3

ReadySet Telemetry

ReadySet Server

Usage

Options

--address, -a

--authority

--authority-address

--cannot-become-leader

--db-dir

--deployment

--disable-telemetry

--disable-upstream-ssl-verification

--durability

--eviction-policy

--external-address

--external-port, -p

--forbid-full-materialization

--help, -h

--log-format

--log-level

--memory-limit, -m

--memory-check-every

--no-readers

--persistence-threads

--prometheus-metrics

--quorum, -q

--reader-only

--replication-pool-size

--replication-tables

--snapshot-report-interval-secs

--ssl-root-cert

--tracing-host

--tracing-sample-percent

--upstream-db-url

--version, V

--volume-id