xwstorage 0.0.1.3

Convenience wrapper for exonware-xwstorage - provides 'import xwstorage' alias

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: [e-mail]

---

📦 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 (xwjson … xwaction, REF_41 §8)	CI or production images that should not miss the XW graph.
pip install exonware-xwstorage[xwdb]	XWDB - first-party engine (exonware-xwdb) for the connector driver	When using the Exonware database product through storage (see REF_40 in .docs/guides).
pip install exonware-xwstorage[xwdb_remote]	httpx for HTTP clients to xwdb-api (XWDBRemoteConfig, REF_41 §6)	When attaching to XWDB over the network instead of [xwdb] in-process.
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 (same idea as exonware.xwdb._stack; see REF_41 §8).

Stack reference: connector vs product vs *-api deploy packages — .docs/guides/REF_40_CONNECTOR_PRODUCT_API_STACK.md. Dependency direction (xwdb vs xwstorage): .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

• Start: docs/INDEX.md if present; else docs/.
• REFs: REF_22_PROJECT, REF_13_ARCH, REF_15_API, REF_51_TEST.
• Tests: docs/REF_51_TEST.md if present. Run from repo root per layout.

---

📜 License and links

Apache-2.0 - see LICENSE.

• Homepage: https://exonware.com
• Repository: https://github.com/exonware/xwstorage

⏱️ 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.3 | Updated: 11-Apr-2026

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