Getting started

1 · Start the server

The server ships as a single container. It bundles the MySQL-compatible kernel, the Rapid in-memory column store, and the ML and agent runtimes — nothing else to install.

$ docker run -d -p 3306:3306 \
    -e MYSQL_ROOT_PASSWORD=secret shannonbase:latest

2 · Connect with any MySQL client

ShannonBase speaks the MySQL protocol on port 3306. Your driver, your ORM, your dump files all work unchanged.

$ mysql -h 127.0.0.1 -u root -p

3 · Mirror a table into Rapid

Two statements put a table in the column store. From then on the optimizer decides, per query, which engine answers.

mysql> ALTER TABLE lineitem SECONDARY_ENGINE = RAPID;
mysql> ALTER TABLE lineitem SECONDARY_LOAD;

4 · Query as usual

Analytical queries get routed to the in-memory column store automatically.

mysql> SELECT sum(l_quantity) FROM lineitem;