Skip to main content

Universal data storage and connector platform — SQL/NoSQL/graph/vector backends; database products integrate over HTTP, not as a declared Python dependency

Project description

xwstorage

One API over embedded engines, SQL, NoSQL, graph, and vector backends, with entity-aware persistence (xwentity), xwquery, and optional server/UI layers. Built on xwsystem, xwentity, xwdata, xwnode, and xwquery. Status and roadmap: REF_22_PROJECT.

Longer write-up: README_LONG.md.

Company: eXonware.com · Author: eXonware Backend Team · Email: connect@exonware.com

Status Python License


📦 Install

Install What you get When to use
pip install exonware-xwstorage Lite - core abstraction Smallest install.
pip install exonware-xwstorage[lazy] Lazy - connectors load when first used Development.
pip install exonware-xwstorage[full] Full - common connectors plus the same first-party [stack] pins (xwjsonxwaction, REF_41 §8) CI or production images that should not miss the XW graph.
pip install exonware-xwstorage[stack] xwjson, xwnode, xwdata, xwschema, xwentity, xwmodels, xwquery, xwaction (REF_41 §8) Monorepo / enterprise hosts that want the full XW stack next to storage without guessing transitives.

Depends on xwsystem; other stack packages as you use features. Extras only change dependencies.

After [stack] or [full], you can import exonware.xwstorage.stack at process startup to eagerly import xwjson through xwaction (see REF_41 §8).

Remote database / engine: use exonware.xwstorage.connectors.XWDBRemoteConfig and an HTTP client against your engine’s API — exonware-xwdb is not a pip dependency of exonware-xwstorage.

Stack reference: connector vs product vs *-api deploy packages — .docs/guides/REF_40_CONNECTOR_PRODUCT_API_STACK.md. Dependency directions: .docs/guides/REF_41_DEPENDENCY_DIRECTIONS.md.


🚀 Quick start

from exonware.xwstorage import get_storage_facade

storage = get_storage_facade(backend="embedded")  # or postgres, mongodb, neo4j, etc.
storage.connect()
storage.put("key", value)
data = storage.get("key")
storage.query("SELECT * FROM entities WHERE ...")
storage.disconnect()

Entity-aware persistence, xwquery, and transactions: docs/ and REF_15_API.


✨ What you get

Area Contents
Backends Pluggable embedded, PostgreSQL, MongoDB, Neo4j, vector stores, and more; transactions, indexing, WAL where supported.
ACID (file-backed) EmbeddedStorageEngine with WAL and recovery - see REF_15_API (Transactions / file-backed ACID).
Integration xwentity, xwdata, xwnode, xwquery.
Server (optional) xwstorage-server - REST/GraphQL, auth, multi-tenant patterns.
Frontend (optional) UI for schema, query, and data browsing (xwui).

Architecture: REF_13_ARCH. Connectors: docs/connectors/ when present.


🌐 Ecosystem functional contributions

xwstorage focuses on persistence; the surrounding XW libraries provide the contract, query, and domain layers it needs. You can run xwstorage standalone with the backends and connectors you already use. Bringing in more XW libraries is optional and mostly beneficial for enterprise and mission-critical environments where you want full infrastructure ownership.

Supporting XW lib What it provides to xwstorage Functional requirement it satisfies
XWSystem Core runtime contracts, serializer/caching/security utilities, and shared infrastructure primitives. Stable engine internals and consistent operational behavior across storage backends.
XWEntity Entity-aware persistence hooks and model lifecycle integration points. Domain-driven persistence instead of raw key/value-only storage usage.
XWData Data conversion and multi-format payload handling for ingest/export flows. Interoperable data pipelines across formats and storage engines.
XWNode Graph/structure-aware node strategies and path semantics integration. Complex structured data handling beyond flat relational rows.
XWQuery Unified query execution model across supported backends and in-memory data. One query surface for heterogeneous storage engines.
XWSchema Validation and schema contract support for persisted objects and evolution paths. Safer schema-on-write/schema-on-read workflows and migration reliability.
XWStorage-API Thin HTTP server wrapper over xwstorage API surfaces. Service exposure requirement (remote access, API-first deployment).

Competitive edge: xwstorage is not just a connector set; it is a storage control plane with consistent contracts across engine types, query styles, and deployment modes.


📖 Docs and tests


📜 License and links

Apache-2.0 - see LICENSE.

⏱️ Async Support

  • xwstorage includes asynchronous execution paths in production code.
  • Source validation: 117 async def definitions and 66 await usages under src/.
  • Use async APIs for I/O-heavy or concurrent workloads to improve throughput and responsiveness.

Version: 0.0.1.5 | Updated: 11-Apr-2026

Built with ❤️ by eXonware.com - Revolutionizing Python Development Since 2025

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

exonware_xwstorage-0.0.1.5.tar.gz (191.7 kB view details)

Uploaded Source

Built Distribution

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

exonware_xwstorage-0.0.1.5-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

Details for the file exonware_xwstorage-0.0.1.5.tar.gz.

File metadata

  • Download URL: exonware_xwstorage-0.0.1.5.tar.gz
  • Upload date:
  • Size: 191.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for exonware_xwstorage-0.0.1.5.tar.gz
Algorithm Hash digest
SHA256 c0d978bf976399cd57f506874f6e3b402725661ca701c4da8d650d937f1e236c
MD5 464fd69e34a59330844308556ea2864a
BLAKE2b-256 f6f12ea65b9e7dace1a07a8d29786aacf1deeeb5eba14e0d449ad648cd0dfd06

See more details on using hashes here.

File details

Details for the file exonware_xwstorage-0.0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for exonware_xwstorage-0.0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9c47d10c65621fd2734ae3b7f4afcfee87f557f87ed13df504fedbf1639bdfc9
MD5 028d1530999e7009c56116cf0d80b19a
BLAKE2b-256 a0d74aaf29aa0153eeb2ffff0b1f64340e59f8690f21867070c20c82806acd3b

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