Storine v0.3.0

Reference

Configuration reference

Every command-line option, environment variable and connection-string parameter of every Storine program, on one page.

storage-server#

storage-server [data_dir] [bind_addr] [options]
storage-server gen-ca <dir>
storage-server gen-cert <ca-dir> <out-dir> <name>[,<name>...]
storage-server gen-key <key-file>
Argument or optionDefaultMeaning
data_dir./server_dataThe data directory
bind_addr127.0.0.1:7878The address to listen on
--max-connections N100,000Connection ceiling
--node-id NCluster node id, 1–65,535
--peers 1=host:port[@region/zone],...Founding members, this node included
--joinWait to be added to a cluster
--rangesRange-cluster node
--zones FILEPlacement rules
--records agentServe the typed demo store
--onceStart, report, exit
-h, --help; -V, --versionHelp; version
Environment variableDefaultMeaning
STORAGE_AUTH_TOKENSnone: loopback onlytoken:role,...; roles read, write, admin; tokens of 16+ characters
STORAGE_CLUSTER_TOKENNode-to-node token, 16+ characters. Required for an authenticated cluster
STORAGE_TLS_CERT, STORAGE_TLS_KEYPEM certificate chain and PKCS#8 Ed25519 key: TLS on
STORAGE_TLS_CAthe node's own certificateCertificates trusted for peers
STORAGE_RATE_LIMITnonerps:burst per connection
STORAGE_MAX_CONNECTIONS100,000As --max-connections
STORAGE_BACKUP_ROOTnone: remote backups offWhere remote backups go
STORAGE_ENCRYPTION_KEYSnone: encryption offKey file
STORAGE_ENCRYPTION_ACTIVE_KEYthe highest key idSealing key, or none to decrypt
STORAGE_ENCRYPTION_ALLOW_PLAINTEXToff1: accept plaintext while encrypting
STORAGE_WAL_ARCHIVEnoneWAL archive folder for point-in-time recovery
STORAGE_WAL_ARCHIVE_RETAIN7dArchive retention: Nd, Nh or Nm
STORAGE_EXPECTED_DOCUMENTS0: grow as neededAbout how many documents the database will hold, at most 1,000,000,000 (_ or , may group digits). The index is sized for them at start. On a range cluster, set the whole cluster's count on every node; each sizes for its share
STORINE_REACTORthe platform's bestpoll to use poll
STORINE_THREADSthe CPU countAnalytics parallelism
STORINE_SIMDthe CPU's bestportable for the portable kernels

Details: running a server.

Connection strings (clients)#

storine://[token@]host:port[,host:port...][?timeout_ms=5000&follower_reads=1]
storines://...                                         TLS
ParameterDefaultMeaning
token@noneAuthentication token
several hostsSeeds of a cluster. The client finds the leader
timeout_ms5,000Request timeout
follower_reads01: reads may go to followers and be slightly behind
tls_caPEM file of certificates to trust. Turns TLS on
tls_server_namethe host connected toThe name the server's certificate must carry

Each client also takes these as options, plus a pool size. Details: clients.

storage-cli#

Environment variableMeaning
STORAGE_TOKENToken for remote commands
STORAGE_TLS_CAPEM certificates to trust: TLS on
STORAGE_TLS_SERVER_NAMEExpected certificate name. Default: the address

Commands: command-line tool.

storine-console#

Option or variableDefaultMeaning
--listen ADDR127.0.0.1:7880Where to serve
--allow-host HOST:PORTAnother Host header to answer to. Repeatable
storine://...The server or cluster
STORAGE_TOKEN, STORAGE_TLS_CA, STORAGE_TLS_SERVER_NAMEAs for storage-cli
STORINE_CONSOLE_KEYrandom per runA fixed console key, 16+ letters, digits, - or _

Details: the web console.

storine-sql#

storine-sql (--data DIR | --storine URL) [options]
Option or variableDefaultMeaning
--data DIRServe an embedded database in DIR
--storine URLServe in front of a running server or cluster
--pg ADDR, --no-pg127.0.0.1:5432PostgreSQL endpoint
--mysql ADDR, --no-mysql127.0.0.1:3306MySQL endpoint
--mssql ADDR, --no-mssql127.0.0.1:1433SQL Server endpoint
--user NAME:PASSWORD (repeatable), STORINE_SQL_USERSnone: every client trustedUsers
--database NAMEstorineThe default database
--tls-cert FILE --tls-key FILEa generated certificate for localhostTLS certificate
--no-tls, --require-tlsTurn TLS off; refuse clients without it
--max-connections N1,024Open connections. A client silent for 30 s before logging in is closed
--oidc-issuer URL, --oidc-audience AUD, --oidc-jwks FILE, --oidc-user-claim CLAIMSQL Server access-token logins
--kerberos-keytab FILE, --kerberos-keep-realmSQL Server Kerberos logins
STORINE_SQL_LOG=1offLog every statement

Details: SQL gateway.

Install scripts#

VariableDefaultMeaning
STORINE_VERSIONthe latest releaseVersion to install
STORINE_INSTALL_DIR~/.local/bin, /usr/local/bin as root, %LOCALAPPDATA%\Programs\Storine\binInstall folder

Embedded engine#

EngineConfig fields are listed in embedding the engine.

Placement rules#

The --zones file format is in placement across regions.