Skip to main content

LivenDB Python client

Project description

@livendb/liven-client (Python)

PyPI version License: MIT

Python client SDK for LivenDB — communicates over the native TCP wire protocol using msgpack frames.

from liven_py import LivenClient, Pipeline, Filter

client = LivenClient.connect("127.0.0.1:43121")
client.insert("users", "u1", {"name": "Alice", "role": "admin"})
user = client.get("users", "u1")
print(user[0].field("name"))
# → Alice

results = client.run(
    Pipeline.from_stream("users")
        .filter(Filter.field("role").eq("admin"))
        .limit(10)
)
client.close()

Installation

pip install livendb-liven-client

Requires Python 3.9+.

Quick Start

1. Connect

from liven_py import LivenClient

# Default port is 43121
client = LivenClient.connect("localhost")

# With authentication key
client = LivenClient.connect("localhost:43121?auth_key=your-api-key")

2. CRUD Operations

# Insert
client.insert("events", "e1", {"type": "click", "value": 42})

# Upsert (insert or replace)
client.upsert("events", "e1", {"type": "click", "value": 99})

# Update (merge)
client.update("users", "u1", {"last_login": 1234567890})

# Get by key
record = client.get("users", "u1")

# Delete
client.delete("events", "e1")

# Clear all records from a stream
client.clear("sessions")

# Drop an entire stream
client.drop_stream("old_data")

3. Batch Operations

client.insert_many("events", [
    ("e1", {"type": "click"}),
    ("e2", {"type": "view"}),
])

4. Pipeline Queries

from liven_py import Pipeline, Filter

results = client.run(
    Pipeline.from_stream("orders")
        .filter(Filter.field("amount").gte(100))
        .filter(Filter.field("status").eq("completed"))
        .sort("amount", descending=True)
        .limit(10)
)

5. Shorthand Pipeline Methods

client.filter("events", Filter.field("type").eq("click"))
client.limit("events", 50)
client.count("events")
client.sort("orders", "total", descending=True)
client.page("events", 1, 25)
client.page_cursor("feed", "cursor_abc", 25)
client.map("users", ["name", "email"])
client.window("pageviews", 60000, "count")
client.group("events", "type", ["count", "sum(value)"])
client.distinct("visitors", "ip_address")
client.vector_filter("documents", "embedding", [1, 0, -1], 0.75)

6. Joins

client.enrich("orders", "users", "user_id")
client.correlate("events", "sessions", "session_id", 5000)
client.chain("reviews", "orders", "order_id")
client.sequence("events", [
    Filter.field("type").eq("login"),
    Filter.field("type").eq("purchase"),
], 300000)

7. Pipeline Mutations

client.run_update(
    Pipeline.from_stream("events").filter(Filter.field("status").eq("pending")),
    {"status": "processed"}
)
client.run_delete(
    Pipeline.from_stream("events").filter(Filter.field("type").eq("temp"))
)

8. Live Subscriptions

client.run_listen(
    Pipeline.from_stream("alerts").filter(Filter.field("priority").eq("critical"))
)

9. Metadata

streams = client.streams()
status = client.status()

10. Raw DSL

results = client.query('from("users") | count()')

Development

# Install dependencies
pip install -e .

# Run the demo
python examples/demo.py
python examples/demo.py --key your-api-key

# Run tests
python -m pytest

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

liven_client-0.0.1.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

liven_client-0.0.1-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file liven_client-0.0.1.tar.gz.

File metadata

  • Download URL: liven_client-0.0.1.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for liven_client-0.0.1.tar.gz
Algorithm Hash digest
SHA256 0a2ca1995d20545b37895a31767eac344d84275085ba87a8b558b537308ca5b0
MD5 28046f1204de4975f45f64d57f1ea128
BLAKE2b-256 7b5a1b07c5f479b0d965bf2e6dab03cf1aed9e44ca7d4969bb1fd6cf19b49669

See more details on using hashes here.

File details

Details for the file liven_client-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: liven_client-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for liven_client-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 41232a0c625e6d056b7e8e0bc52cb27477330c302f44071fb81a7bcc3f3c1f45
MD5 3b6381f57e0eb5dfb25078b72928912e
BLAKE2b-256 2c4a88ec710c8bcce82b5dc681d542e4a4bebe8f706462931e178569ba5a4e1a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page