Meta tags:
description=Oxia: Scalable Metadata and Index storage;

Headings (most frequently used words):

oxia, client, list, admin, cluster, delete, range, cli, reference, global, flags, running, data, operations, administration, utilities, advanced, debugging, standalone, server, coordinator, put, get, scan, notifications, sequence, updates, namespaces, nodes, split, shard, health, perf, config, create, schema, wal, pebble,

Text of the page (most frequently used words):
oxia (63), the (46), key (35), #client (29), default (23), for (20), wal (19), flag (19), address (18), data (17), purpose (17), admin (16), and (15), cluster (15), keys (14), namespace (12), internal (12), coordinator (12), shard (11), file (11), version (11), range (11), raft (11), bind (11), false (10), partition (10), notifications (10), pebble (9), server (9), metadata (9), list (9), sequence (9), flags (8), node (8), max (8), delete (8), metrics (8), addr (8), configuration (7), from (7), index (7), storage (7), service (7), split (7), public (7), include (7), min (7), tls (7), schema (6), operations (6), cli (6), subcommand (6), log (6), directory (6), dir (6), write (6), request (6), timeout (6), value (6), size (6), read (6), namespaces (6), record (6), configmap (6), provider (6), retention (6), architecture (6), run (5), json (5), when (5), per (5), grpc (5), port (5), secondary (5), routing (5), override (5), peer (5), status (5), auth (5), reference (5), subcommands (4), each (4), scan (4), common (4), single (4), get (4), config (4), 6648 (4), health (4), name (4), kubernetes (4), nodes (4), stream (4), values (4), hex (4), every (4), this (4), put (4), replication (4), cache (4), time (4), sorting (4), protocol (4), see (3), level (3), perf (3), ahead (3), debugging (3), yaml (3), 100 (3), localhost (3), 6649 (3), with (3), updates (3), using (3), end (3), exclusive (3), start (3), inclusive (3), not (3), 8080 (3), path (3), sconfig (3), security (3), fsync (3), true (3), standalone (3), deployment (3), running (3), page (3), documentation (3), 2026 (2), use (2), other (2), policies (2), has (2), its (2), own (2), help (2), entries (2), these (2), commands (2), operate (2), usually (2), advanced (2), emit (2), create (2), 30s (2), 1000 (2), batch (2), linger (2), random (2), bytes (2), payload (2), number (2), set (2), rate (2), built (2), check (2), target (2), host (2), probes (2), utilities (2), point (2), required (2), enumerate (2), specific (2), 6651 (2), groups (2), they (2), connect (2), administration (2), prefix (2), events (2), follow (2), print (2), instead (2), whose (2), are (2), users (2), cas (2), only (2), current (2), matches (2), expected (2), comparison (2), equal (2), one (2), deltas (2), stdin (2), that (2), traffic (2), group (2), k8s (2), factor (2), cconfig (2), etc (2), instance (2), skip (2), shared (2), block (2), undelivered (2), writes (2), sync (2), database (2), hierarchical (2), how (2), long (2), enable (2), shards (2), pprof (2), profile (2), info (2), global (2), light (2), consensus (2), maelstrom (2), tla (2), safety (2), correctness (2), physical (2), logical (2), design (2), goals (2), api (2), bare (2), metal (2), resources (2), helm (2), python (2), java (2), sdks (2), versioning (2), indexes (2), ephemerals (2), consistency (2), model (2), features (2), migrating (2), etcd (2), getting (2), started (2), what (2), blog (2), ctrl (2), copyright, 2023, series, projects, llc, website, terms, trademark, policy, project, please, https, lfprojects, org, last, updated, july, introspection, tooling, forwarded, upstream, details, sstable, remotecat, manifest, lsm, find, blob, dump, cut, given, throughput, test, truncate, root, introspect, directly, disk, state, should, offline, against, stopped, pipe, into, validator, ide, helper, completion, validation, editing, maximum, batched, requests, side, batching, 5ms, distinct, working, cardinality, 128, percentage, reads, mix, percent, total, ops, load, generator, useful, smoke, testing, without, pulling, separate, benchmark, tool, probe, 10s, exit, code, non, zero, failure, suitable, readiness, liveness, explicit, hash, defaults, midpoint, manually, trigger, reserved, operational, tuning, automatic, splitting, also, available, their, addresses, configured, operator, facing, routes, holding, new, beyond, ones, both, primary, space, fall, returned, via, higher, lower, ceiling, floor, type, object, output, more, applied, counters, appended, route, operation, succeed, std, bin, insert, update, records, all, endpoint, oxiaadmin, comma, separated, peers, bootstrapping, bootstrap, clusters, memory, active, instances, can, standby, high, availability, endpoints, respectively, exposes, insecure, verify, trusted, cert, params, currently, oidc, notification, needs, join, sort, mode, natural, retain, feed, enabled, keep, after, commit, durability, prometheus, process, good, local, development, production, there, external, crash, loses, been, 127, 6060, profiler, logs, format, logging, error, warn, debug, apply, omitted, tables, below, binary, executable, operating, managing, enumerates, user, visible, append, any, command, same, information, shell, scroll, top, edit, github, question, give, feedback, store, coordination, system, content,

Text of the page (random words):
cli reference oxia skip to content oxia metadata store and coordination system documentation blog ctrl k ctrl k documentation what is oxia getting started migrating from zk etcd features consistency model ephemerals namespaces notifications key sorting partition keys secondary indexes sequence keys versioning client sdks go java node js python deployment kubernetes helm resources bare metal security admin operations reference cli configuration schema grpc api metrics architecture design goals logical architecture physical architecture correctness protocol safety tla maelstrom consensus coordinator oxia replication protocol storage blog light what is oxia getting started migrating from zk etcd features consistency model ephemerals namespaces notifications key sorting partition keys secondary indexes sequence keys versioning client sdks go java node js python deployment kubernetes helm resources bare metal security admin operations reference cli configuration schema grpc api metrics architecture design goals logical architecture physical architecture correctness protocol safety tla maelstrom consensus coordinator oxia replication protocol storage light on this page global flags running a cluster oxia standalone oxia server oxia coordinator data operations oxia client put oxia client get oxia client delete oxia client delete range oxia client list oxia client range scan oxia client notifications oxia client sequence updates cluster administration oxia admin list namespaces oxia admin list nodes oxia admin split shard utilities oxia health oxia perf oxia config create schema advanced debugging oxia wal oxia pebble question give us feedback edit this page on github scroll to top documentation reference cli cli reference the oxia binary is a single executable with subcommands for running a cluster operating on data managing the cluster and debugging this page enumerates every user visible subcommand and flag append help to any command for the same information at the shell global flags these apply to every subcommand and are omitted from the tables below flag default purpose l log level info logging level debug info warn error j log json false emit logs in json format profile false enable the built in pprof profiler profile bind address 127 0 0 1 6060 pprof bind address running a cluster oxia standalone single process single node oxia instance good for local development and ci not a production deployment replication factor is 1 there is no external coordinator and a crash loses data that has not been fsync d oxia standalone flag default purpose p public addr 0 0 0 0 6648 public service bind address client traffic m metrics addr 0 0 0 0 8080 prometheus metrics bind address s shards 1 number of shards in the default namespace data dir data db pebble database directory wal dir data wal write ahead log directory wal sync data true fsync wal writes for durability wal retention time 1h how long to keep wal entries after commit notifications enabled true enable the notifications feed notifications retention time 1h how long to retain undelivered notifications db cache size mb 100 shared pebble block cache size key sorting hierarchical key sort mode hierarchical or natural see key sorting oxia server run a storage node needs an oxia coordinator to join a cluster oxia server sconfig etc oxia server yaml flag default purpose sconfig server config file path p public addr 0 0 0 0 6648 public client bind address i internal addr 0 0 0 0 6649 internal coordinator peer bind address m metrics addr 0 0 0 0 8080 metrics bind address data dir data db pebble database directory wal dir data wal write ahead log directory wal sync data true fsync wal writes wal retention time 1h wal retention notifications retention time 1h undelivered notification retention db cache size mb 100 shared pebble block cache size auth provider name auth provider currently oidc auth provider params auth provider configuration json see security tls internal tls peer tls tls for public internal and peer endpoints respectively each group exposes cert file key file min version max version trusted ca file insecure skip verify client auth oxia coordinator run the coordinator one active instance per cluster other instances can run in standby using the raft metadata provider for high availability oxia coordinator cconfig etc oxia cluster yaml metadata configmap flag default purpose cconfig cluster configuration file namespaces replication factor server list sconfig server configuration file metadata file cluster status provider file configmap raft or memory file clusters status path data cluster status json cluster status path when metadata file k8s namespace kubernetes namespace for the status configmap k8s configmap name configmap name when metadata configmap raft address raft bind address when metadata raft raft data dir data raft raft data directory raft bootstrap nodes comma separated list of peers for bootstrapping the raft group a admin addr 0 0 0 0 6651 admin service bind address oxiaadmin grpc service i internal addr 0 0 0 0 6649 internal bind address coordinator server m metrics addr 0 0 0 0 8080 metrics bind address tls peer tls tls for the admin endpoint and for peer raft traffic data operations oxia client groups the subcommands that read and write records they all connect to a storage node on its public port common flags for every oxia client subcommand flag default purpose a service address localhost 6648 storage node address n namespace default namespace to operate on request timeout 30s per request timeout oxia client put insert or update a record oxia client put my key my value oxia client put my key c payload bin read value from stdin flag default purpose c std in false read the value from stdin e expected version 1 if set succeed only when the current version matches cas p partition key route the operation using this key instead of the record key d sequence keys deltas one or more deltas applied to the sequence counters appended to the key oxia client get read a record oxia client get my key v include the version metadata flag default purpose v include version false include the version object in the output t comparison type equal key comparison equal floor ceiling lower higher p partition key routing override index read via a secondary index hex false print the value as hex oxia client delete delete a record flag default purpose e expected version 1 cas delete only if the current version matches p partition key routing override oxia client delete range delete every record whose key is in key min key max oxia client delete range s users e users flag default purpose s key min range start inclusive e key max range end exclusive p partition key routing override oxia client list stream the keys whose values fall in key min key max values are not returned flag default purpose s key min range start inclusive e key max range end exclusive p partition key routing override index list from a secondary index instead of the primary key space internal keys false include oxia s own internal keys oxia client range scan stream both keys and values in key min key max flag default purpose s key min range start inclusive e key max range end exclusive p partition key routing override index scan using a secondary index internal keys false include internal keys v include version false include the version with each record hex false print values as hex oxia client notifications follow the notifications stream for the namespace no flags beyond the common ones oxia client sequence updates follow the stream of new sequence keys for a prefix oxia client sequence updates events partition key events flag default purpose p partition key required routes to the shard holding the sequence prefix cluster administration oxia admin groups the operator facing commands they connect to the coordinator s admin port common flag flag default purpose admin address localhost 6651 coordinator admin address oxia admin list namespaces enumerate configured namespaces no subcommand specific flags oxia admin list nodes enumerate storage nodes with their public and internal addresses and metadata no subcommand specific flags oxia admin split shard manually trigger a shard split usually reserved for operational tuning automatic splitting is also available flag default purpose namespace default namespace of the shard to split shard 1 shard id to split required split point explicit hash split point defaults to the shard s midpoint utilities oxia health probes a server s grpc health check exit code is non zero on failure suitable for kubernetes readiness liveness probes flag default purpose host target host port 6649 target port internal port by default service grpc health check service name timeout 10s probe timeout oxia perf built in load generator useful for smoke testing a cluster without pulling in the separate benchmark tool flag default purpose a service address localhost 6648 storage node address n namespace default namespace r rate 100 total request rate ops s p read write percent 80 percentage of reads in the mix s value size 128 value size in bytes keys cardinality 1000 number of distinct keys in the working set random payload false use random bytes for each write batch linger 5ms client side batching linger max requests per batch 1000 maximum operations per batched request request timeout 30s per request timeout oxia config create schema emit the json schema for the cluster configuration file pipe into a validator or ide helper to get completion and validation when editing config yaml advanced debugging these commands operate directly on on disk state and should usually be run offline against a stopped node oxia wal introspect the write ahead log of a single shard common flags flag default purpose wal dir data wal wal root directory namespace default namespace shard shard id subcommands scan dump entries truncate cut the log at a given index perf wal level throughput test oxia pebble pebble db introspection tooling forwarded from the upstream pebble cli subcommands blob db find lsm manifest remotecat sstable wal each has its own flags run oxia pebble subcommand help for details last updated on july 11 2026 admin operations configuration schema copyright 2023 2026 oxia a series of lf projects llc for website terms of use trademark policy and other project policies please see https lfprojects org policies