Skip to content

Latest commit

 

History

History
136 lines (104 loc) · 3.24 KB

README.md

File metadata and controls

136 lines (104 loc) · 3.24 KB
Raw

oomplay

CICD license crates.io release

Playground manager for oomstore.

Supported playgrounds

  • Redis
  • Postgres
  • MySQL
  • DynamoDB
  • Cassandra
  • TiDB
  • TiDBExt
  • TiKV
  • TiKVExt
  • SQLite
  • SnowflakeExt
  • BigQueryExt
  • RedshiftExt

Postfix Ext means using the external service supplied by the user.

Usage

$ oomplay --help
oomplay 0.5.0
Playground manager for oomstore

USAGE:
    oomplay <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    init          Initialize playgrounds
    stop          Stop playgrounds
    list          List supported playgrounds
    completion    Output shell completion code

Example

$ oomplay init redis postgres
[*] 🎮 Initializing oomplay-redis ...
[*] 📡 Pinging oomplay-redis ...
[*] 🎮 Initializing oomplay-postgres ...
[*] 📡 Pinging oomplay-postgres ...
[*] 🚚 Pulling image 'redis:alpine' ...
[*] 📦 Creating container oomplay-postgres ...
[*] 🚀 Starting container oomplay-postgres ...
[*] 📡 Pinging oomplay-postgres ...
[*] 📡 Pinging oomplay-postgres ...
[*] 📡 Pinging oomplay-postgres ...
[*] 📡 Pinging oomplay-postgres ...
[*] 💫 Initializing oomplay-postgres ...
[*] 🟢 oomplay-postgres is ready. (8.376110205s)
[*] 📦 Creating container oomplay-redis ...
[*] 🚀 Starting container oomplay-redis ...
[*] 📡 Pinging oomplay-redis ...
[*] 💫 Initializing oomplay-redis ...
[*] 🟢 oomplay-redis is ready. (15.544168376s)

$ oomplay stop redis postgres
[*] 🔌 Stopping oomplay-redis ...
[*] 🔌 Stopping oomplay-postgres ...
[*] 🔴 oomplay-redis stopped.
[*] 🔴 oomplay-postgres stopped.

SnowflakeExt

SnowflakeExt playground requires the following environment variables:

SNOWFLAKE_ACCOUNT
SNOWFLAKE_USER
SNOWFLAKE_PASSWORD
SNOWFLAKE_DATABASE

BigQueryExt

BigQueryExt playground requires the following environment variables:

BIGQUERY_CREDENTIALS
BIGQUERY_DATASET_ID

RedshiftExt

RedshiftExt playground requires the following environment variables:

REDSHIFT_HOST
REDSHIFT_USER
REDSHIFT_DATABASE
REDSHIFT_PASSWORD
REDSHIFT_DEFAULT_DATABASE

Installation

On macOS

You can install oomplay with Homebrew:

brew tap oom-ai/oom-ai
brew install oomplay

From binaries

Pre-built versions of oomplay for various architectures are available at Github release page.

From source

oomplay is also published on crates.io. If you have Rust toolchains (nightly) installed you can use cargo to install it from source:

cargo install --locked oomplay

If you want the latest version, clone this repository and run cargo install --path ..