Skip to main content

aioorient

PyPI Python CI License: MIT

Async-native Python client for the OrientDB binary protocol. Typed, tested, pooled, and dependency-free. Targets OrientDB 3.0+ (v37/v38 wire protocol) on Python 3.13+.

Quickstart

import asyncio
from aioorient import Client

async def main() -> None:
    async with await Client.connect(
        "localhost", 2424, user="root", password="rootpw"
    ) as client:
        async with client.database("demo", user="admin", password="adminpw") as db:
            rows = await db.query("SELECT FROM Person WHERE age > :min", params={"min": 18})
            for row in rows:
                print(row["name"], row.rid)

asyncio.run(main())

Install

pip install aioorient

Zero runtime dependencies. An optional C extension accelerates record decoding and ships in the binary wheels; without it, a pure-Python decoder is used transparently.

Features

  • Async-only. Everything is await-ed; no sync wrapper, no blocking I/O.
  • Typed. mypy --strict clean, ships py.typed; dict[str, Any] only where OrientDB values are genuinely polymorphic.
  • Pooled by default. One Client → a server-level pool plus per-database query and batch pools, with health checks and back-pressure. No socket wrangling.
  • v38 transactions. async with db.transaction() as tx: with MVCC-enforced expected_version.
  • Streaming queries. async for row in db.query_stream(sql): pages under the hood without leaking server-side cursors.
  • Live queries. async with db.live_query(sql) as sub: with a bounded buffer and clean three-way teardown.
  • Binary v37 codec. Full document encode/decode with varint + zigzag primitives and an optional C fast path.
  • Object-graph mapper. Declarative vertices/edges, property descriptors, a chainable query DSL, atomic batches, and per-class brokers.

Documentation

Full guides live in docs/:

Object-graph mapper at a glance

from aioorient.ogm import Graph, declarative_node, String, Integer

Node = declarative_node()

class Person(Node):
    element_type = "Person"
    name = String()
    age = Integer()

async with Graph(db, bases=[Node]) as g:
    await g.init_schema()
    alice = await g.create_vertex(Person, name="Alice", age=30)
    adults = await g.query(Person).where(Person.age >= 18).order_by(Person.name).all()

See the OGM guide for the query DSL, batches, brokers, and traversals.

Gremlin traversals at a glance

OrientDB can execute TinkerPop 3 Gremlin traversals server-side; aioorient sends them over the same binary connection via db.script(language="gremlin"). The server binds g = graph.traversal(), so you write standard Gremlin directly (needs the orientdb:3.2-tp3 image):

rows = await db.script(
    "g.V().hasLabel('Person').has('age', gte(18)).valueMap('name', 'age')",
    language="gremlin",
    params={},
)
for row in rows:
    print(row.fields)

Gremlin support is experimental. See the Gremlin guide for prerequisites, result shapes, and caveats.

Development

uv sync
uv run ruff check . && uv run ruff format --check .
uv run mypy src/aioorient tests
uv run pytest -m "not integration"          # unit tier

Integration tests require Docker (the suite starts/stops OrientDB itself):

uv run pytest -m integration

See CONTRIBUTING.md for the commit conventions that drive automated releases.

License

MIT

Metadata

Release files for aioorient 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aioorient 1.0.0
File Size Uploaded Provenance Actions
aioorient-1.0.0.tar.gz 103.5 kB With provenance Details for aioorient-1.0.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for aioorient 1.0.0
File Actions
aioorient-1.0.0-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for aioorient-1.0.0-cp314-cp314-win_amd64.whl
aioorient-1.0.0-cp314-cp314-musllinux_1_2_x86_64.whl CPython 3.14 CPython 3.14 Linux musl 1.2+ x86-64 Details for aioorient-1.0.0-cp314-cp314-musllinux_1_2_x86_64.whl
aioorient-1.0.0-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.28+ x86-64, Linux glibc 2.5+ x86-64 Details for aioorient-1.0.0-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
aioorient-1.0.0-cp314-cp314-macosx_11_0_arm64.whl CPython 3.14 CPython 3.14 macOS 11.0+ ARM64 Details for aioorient-1.0.0-cp314-cp314-macosx_11_0_arm64.whl
aioorient-1.0.0-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for aioorient-1.0.0-cp313-cp313-win_amd64.whl
aioorient-1.0.0-cp313-cp313-musllinux_1_2_x86_64.whl CPython 3.13 CPython 3.13 Linux musl 1.2+ x86-64 Details for aioorient-1.0.0-cp313-cp313-musllinux_1_2_x86_64.whl
aioorient-1.0.0-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.28+ x86-64, Linux glibc 2.5+ x86-64 Details for aioorient-1.0.0-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
aioorient-1.0.0-cp313-cp313-macosx_11_0_arm64.whl CPython 3.13 CPython 3.13 macOS 11.0+ ARM64 Details for aioorient-1.0.0-cp313-cp313-macosx_11_0_arm64.whl

Total release size: 1.2 MB

Release files / aioorient-1.0.0.tar.gz

Download URL aioorient-1.0.0.tar.gz
Size 103.5 kB
Tags Source
SHA-256 checksum
How to use checksums
323814153b38222a4d08dfc6a0063100403db6ee245accd692ac0fa1ee57d1dc
BLAKE2b-256 checksum
How to use checksums
71210649cda3ed0ae639a5aa772b7a776b64cc5967b7af69f99bb95fa4c8273d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Release files / aioorient-1.0.0-cp314-cp314-win_amd64.whl

Download URL aioorient-1.0.0-cp314-cp314-win_amd64.whl
Size 125.1 kB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
951bc51d35e96779a50a2932423c66389c396d8a1d2b747cd6c4e97e1db98e96
BLAKE2b-256 checksum
How to use checksums
53e772ca224a4c8e58eb00b83334e84c94cb396369e09ac214fd57ebc204129a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Release files / aioorient-1.0.0-cp314-cp314-musllinux_1_2_x86_64.whl

Download URL aioorient-1.0.0-cp314-cp314-musllinux_1_2_x86_64.whl
Size 151.7 kB
Tags CPython 3.14 Linux musl 1.2+ x86-64
SHA-256 checksum
How to use checksums
46f14adc2c2d1860558114bc3007c15015d98916cb1197f05c44d8b748d19471
BLAKE2b-256 checksum
How to use checksums
d9b64f44d4a2f0f36a035ffb172b1b4d160a21a25a4f5bd702ade20cc28a65c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Release files / aioorient-1.0.0-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL aioorient-1.0.0-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 152.8 kB
Tags CPython 3.14 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
4e9f367bb73cca4c08c4380e3f91d8c805c5295f87ade7759ca0397c62318a95
BLAKE2b-256 checksum
How to use checksums
7214f0629a3eb515f38a70a1715f5a9343a4152483247cf6888241fb81463d9f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Release files / aioorient-1.0.0-cp314-cp314-macosx_11_0_arm64.whl

Download URL aioorient-1.0.0-cp314-cp314-macosx_11_0_arm64.whl
Size 122.3 kB
Tags CPython 3.14 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
c741218aa3ec0e631bf321fe1367e9a02f3c62a28fabf8a588fb7e9a66dbb99a
BLAKE2b-256 checksum
How to use checksums
ed263020df7b5e591f608f881098dc537575f83fea2e194724f3ea459d210264
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Release files / aioorient-1.0.0-cp313-cp313-win_amd64.whl

Download URL aioorient-1.0.0-cp313-cp313-win_amd64.whl
Size 124.8 kB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
23f8d0a84a4c52bc1536f679c7a09a80532a6680db62d58169972f21430840e5
BLAKE2b-256 checksum
How to use checksums
1bbc943137b223e10d19f75ae364dd778993d69da1344aec6380b919b6f6109b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Release files / aioorient-1.0.0-cp313-cp313-musllinux_1_2_x86_64.whl

Download URL aioorient-1.0.0-cp313-cp313-musllinux_1_2_x86_64.whl
Size 152.0 kB
Tags CPython 3.13 Linux musl 1.2+ x86-64
SHA-256 checksum
How to use checksums
6065d079a64723b042e28e14dd09de15fddaff14d62b63275d7b6a2b70c8c175
BLAKE2b-256 checksum
How to use checksums
090f91f670b61eec0b9d5f16ea95f4c08d4287c8b43a1e706a77abfae43c2544
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Release files / aioorient-1.0.0-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL aioorient-1.0.0-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 153.0 kB
Tags CPython 3.13 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
4427109a76bb6be12470c55a11f8353da7c8b82eae32cd6855110781641c37c6
BLAKE2b-256 checksum
How to use checksums
401339a7e518afc0b359c5bf381ec864b6fd6ee8a9e6a4b4a75f79bcc4e844ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Release files / aioorient-1.0.0-cp313-cp313-macosx_11_0_arm64.whl

Download URL aioorient-1.0.0-cp313-cp313-macosx_11_0_arm64.whl
Size 122.4 kB
Tags CPython 3.13 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
e6c1293d55a6f86cd39cc8851652d94eda62ca40c739c1522b96c32b822c9e31
BLAKE2b-256 checksum
How to use checksums
8c8ddabeda4552037b01e3bf5efd4f65017bb626fb3f295ca2464c9d07148f11
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

Security for aioorient 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 9 files in this release have been uploaded with provenance metadata.

Select from 9 files

Attestation for aioorient-1.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

9 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page