Reference
Command Reference

Readyset Command Reference

This section provides a reference for all built-in commands from Readyset

CREATE

CACHE

Create a new cache entry for a specific SELECT Statement or QueryID

Command : CREATE CACHE FROM [select_statement | QueryID]

DROP

CACHE

Drop a cache entry based on a CacheID from SHOW CACHES.

Command : DROP CACHE {CacheID}

ALL CACHES

Drop all cache entries.

Command : DROP ALL CACHES

PROXIED QUERIES

Clear the list of proxied queries show at SHOW PROXIED QUERIES.

Command : DROP ALL PROXIED QUERIES

EXPLAIN

CACHES

List all CREATE CACHE statements that have been executed, for the purpose of exporting them.

Command : EXPLAIN CACHES

CREATE CACHE

Display information about how Readyset will interpret a specific query. Including if the query is supported or not.

Command : EXPLAIN CREATE CACHE FROM select_statement

DOMAINS

List domain shard replicas and what worker they're running on.

Command : EXPLAIN DOMAINS

GRAPHVIZ

Print a graphviz representation of the current query graph to stdout.

Command : EXPLAIN [SIMPLIFIED] GRAPHVIZ [FOR CACHE CacheID]

MATERIALIZATIONS

List and give information about all materializations in the graph.

Command : EXPLAIN MATERIALIZATIONS

LAST STATEMENT

Provides metadata about the last statement that was executed.

Command : EXPLAIN LAST STATEMENT

SHOW

PROXIED QUERIES

Display a list of proxied queries to upstream. Optionally, users can filter only SUPPORTED queries.

Command : SHOW PROXIED [SUPPORTED] QUERIES

CACHES

Display a list of cached queries.

Command : SHOW CACHES

READYSET STATUS

Display current Readyset server status

Command : SHOW READYSET STATUS

READYSET STATUS ADAPTER

Display current Readyset adapter status.

Command : SHOW READYSET STATUS ADAPTER

READYSET MIGRATION STATUS

Display the migration status for a specific ID.

Command : SHOW MIGRATION STATUS {ID}

READYSET VERSION

Display information about the current Readyset version.

Command : SHOW READYSET VERSION

READYSET TABLES

Display the list of replicated tables and their statuses. Optionally, users can include the ALL keyword to include the non-replicated tables from the upstream.

Command : SHOW READYSET [ALL] TABLES

CONNECTIONS

Display a list of client connections.

Command : SHOW CONNECTIONS