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

Headings (most frequently used words):

records, client, python, sdk, deleting, and, installing, api, initializing, the, writing, reading, range, of, listing, keys, scanning, sessions, ephemerals, notifications, sequence, updates,

Text of the page (most frequently used words):
client (46), the (33), key (31), oxia (21), for (16), keys (16), and (14), records (14), value (11), version (11), partition_key (10), users (10), see (9), #sequence (9), python (9), delete (9), put (8), ephemerals (7), secondary (7), record (7), reference (6), shard (6), ephemeral (6), list (6), get (6), architecture (6), notifications (5), print (5), namespace (5), are (5), session (5), sdk (5), use_index (5), options (5), write (5), use (4), events (4), with (4), index (4), range (4), deleting (4), docs (4), expected_version_id (4), metadata (4), from (4), partition (4), api (4), documentation (4), protocol (4), helm (3), node (3), updates (3), specific (3), sessions (3), when (3), range_scan (3), single (3), via (3), all (3), available (3), method (3), conditional (3), only (3), full (3), default (3), description (3), option (3), reading (3), indexes (3), grpc (3), sdks (3), 2026 (2), policies (2), https (2), pydoc (2), notification (2), change (2), both (2), streams (2), true (2), email (2), xff (2), scan (2), values (2), scanning (2), without (2), min (2), max (2), listing (2), pass (2), operation (2), version_id (2), route (2), set (2), read (2), false (2), include_value (2), equal (2), floor (2), comparison_type (2), comparisontype (2), import (2), secondary_indexes (2), server (2), monotonic (2), sequence_keys_deltas (2), expected_record_does_not_exist (2), version1 (2), will (2), expectation (2), that (2), not (2), writing (2), constructor (2), attached (2), authentication (2), 30000 (2), int (2), identity (2), str (2), client_identifier (2), localhost (2), 6648 (2), instance (2), initializing (2), github (2), installing (2), this (2), page (2), light (2), storage (2), replication (2), coordinator (2), consensus (2), maelstrom (2), tla (2), safety (2), correctness (2), physical (2), logical (2), design (2), goals (2), metrics (2), configuration (2), schema (2), cli (2), admin (2), operations (2), security (2), bare (2), metal (2), resources (2), kubernetes (2), deployment (2), java (2), versioning (2), sorting (2), namespaces (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, other, project, please, lfprojects, org, last, updated, july, complete, semantics, new, get_sequence_updates, prefix, get_notifications, feed, exposed, plain, iterators, managed, transparently, first, creates, per, heartbeats, cleaned, closes, expires, lifecycle, details, accept, returning, narrow, query, fetching, call, fans, out, every, scope, delete_range, whose, fall, within, succeed, matches, unconditional, supports, deletes, using, based, expectations, look, named, non, modes, shards, unless, higher, lower, ceiling, style, returns, closest, lookup, skips, payload, index_name, secondary_key, assigned, suffixes, bind, assert, absence, locate, related, offset, 12345, attach, entry, time, event, data, atomic, appends, suffix, requires, host, port, workers, worker, deleted, automatically, ends, version2, there, was, any, fail, has, changed, since, previous, does, already, exist, specified, parameter, none, credentials, auth, tokenauthentication, defs, deadline, each, unary, rpc, long, lived, unbounded, request_timeout_ms, random, uuid, stable, timeout, milliseconds, session_timeout_ms, type, creating, possible, several, such, you, need, create, once, created, valid, until, explicitly, closed, can, used, different, threads, latest, install, pip, scroll, top, edit, question, give, feedback, store, coordination, system, skip, content,

Text of the page (random words):
python client sdk 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 installing python client sdk client api initializing the client writing records reading records deleting records deleting a range of records listing keys scanning records sessions and ephemerals notifications and sequence updates question give us feedback edit this page on github scroll to top documentation client sdks python python client sdk installing python client sdk pip install oxia pydoc documentation is available at https oxia db github io oxia client python latest client api initializing the client to use the oxia client you need to create a client instance once created a client instance will be valid until it s explicitly closed and it can be used from different threads import oxia client oxia client localhost 6648 when creating the client it is possible to pass several options such as client oxia client localhost 6648 namespace my namespace client_identifier my client identity available client constructor options option type description default namespace str oxia namespace to use default session_timeout_ms int session timeout for ephemeral records in milliseconds 30000 client_identifier str stable client identity attached to ephemeral records random uuid request_timeout_ms int deadline for each unary rpc long lived streams are unbounded 30000 authentication oxia defs authentication credentials attached as grpc metadata see oxia auth tokenauthentication none for the full parameter list see the client constructor docs writing records write a record to oxia with the specified key and value and with the expectation that the record does not already exist key version1 client put my key value 1 expected_version_id oxia expected_record_does_not_exist write a record with the expectation that it has not changed since the previous write if there was any change the operation will fail key version2 client put my key value 2 expected_version_id version1 version_id ephemeral record deleted automatically when the client session ends client put workers worker 1 b host port ephemeral true atomic sequence key server appends a monotonic suffix requires a partition key key version client put events b event data sequence_keys_deltas 1 partition_key events attach a secondary index entry at write time client put offset 12345 b secondary_indexes partition p 17 put options option description partition_key route to a specific shard co locate related keys expected_version_id conditional write use oxia expected_record_does_not_exist to assert absence ephemeral bind the record to the client session see ephemerals sequence_keys_deltas server assigned monotonic suffixes see sequence keys secondary_indexes index_name secondary_key see secondary indexes full reference put method docs reading records reading the value of a record key value version client get my key metadata only read skips the value payload key _ version client get my key include_value false range style get returns the closest key the lookup key from oxia import comparisontype key value version client get users 50 comparison_type comparisontype floor get options option description comparison_type equal default floor ceiling lower higher non equal modes scan all shards unless partition_key is set include_value set to false for a metadata only read partition_key route to a specific shard use_index look up via a named secondary index full reference get method docs deleting records delete a single record by key supports conditional deletes using version based expectations unconditional delete client delete my key conditional delete only succeed if the version matches client delete my key expected_version_id version version_id all the options for the delete operation are available in the delete method docs deleting a range of records delete all records whose keys fall within min max client delete_range users users without partition_key the call fans out to every shard pass partition_key to scope the delete to a single shard listing keys list keys in min max without fetching values keys client list users users for key in keys print key narrow to a single shard via partition_key or query a secondary index via use_index keys client list users users partition_key users keys client list xff use_index email scanning records scan records in a key range returning keys and values for key value version in client range_scan users users print f key key value value version version with a secondary index for key value version in client range_scan xff use_index email print key list and range_scan both accept partition_key and use_index sessions and ephemerals sessions are managed transparently the first put ephemeral true creates a per shard session the client sdk heartbeats it and ephemerals are cleaned up when the client closes or the session expires see ephemerals for the lifecycle details notifications and sequence updates both streams are exposed as plain python iterators change feed for the namespace for notification in client get_notifications print notification updates for a specific sequence prefix for key in client get_sequence_updates events partition_key events print f new sequence key key see notifications and sequence keys for semantics for the complete reference see the pydoc reference last updated on july 11 2026 node js helm 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