langgraph-checkpoint-dmdb 0.1.0__tar.gz

langgraph_checkpoint_dmdb-0.1.0/.gitignore

@@ -0,0 +1,142 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+#owner
+.idea/
+*.DS_Store

langgraph_checkpoint_dmdb-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Theodore Ni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

langgraph_checkpoint_dmdb-0.1.0/Makefile

@@ -0,0 +1,27 @@
+.PHONY: test test-integration test-watch lint format build
+
+TEST ?= .
+PYTHON_FILES ?= .
+MYPY_CACHE ?= .mypy_cache
+
+test:
+	uv run pytest --ignore=langgraph-tests -m "not integration" $(TEST)
+	cd langgraph-tests && PYTHONPATH=.. uv run --project .. pytest tests
+
+test-integration:
+	uv run pytest --ignore=langgraph-tests -m integration $(TEST)
+
+test-watch:
+	uv run ptw $(TEST)
+
+lint:
+	uv run ruff check $(PYTHON_FILES)
+	uv run ruff format $(PYTHON_FILES) --check
+	uv run mypy langgraph --cache-dir $(MYPY_CACHE)
+
+format:
+	uv run ruff format $(PYTHON_FILES)
+	uv run ruff check --select I --fix $(PYTHON_FILES)
+
+build:
+	uv build

langgraph_checkpoint_dmdb-0.1.0/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: langgraph-checkpoint-dmdb
+Version: 0.1.0
+Summary: DM Database checkpoint and Store persistence for LangGraph.
+Project-URL: Repository, https://gitee.com/maxbanana/langgraph-checkpoint-dmdb
+Author-email: Theodore Ni <dev@ted.bio>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: dmpython==2.5.32
+Requires-Dist: langgraph-checkpoint<2.2,>=2.1.1
+Requires-Dist: typing-extensions>=4.12.2
+Description-Content-Type: text/markdown
+
+# LangGraph Checkpoint DMDB
+
+[LangGraph](https://github.com/langchain-ai/langgraph) checkpoint and Store persistence for DM Database, using `dmPython`.
+
+## Compatibility
+
+- `langgraph-checkpoint>=2.1.1,<2.2`
+- `dmpython==2.5.32`
+- Python 3.9+
+
+The package provides:
+
+- `DMDBSaver`: complete checkpoint history and time travel.
+- `ShallowDMDBSaver`: latest-checkpoint-only persistence.
+- `AsyncDMDBSaver` and `AsyncShallowDMDBSaver`: async graph APIs backed by isolated worker-thread connections.
+- `DMDBStore` and `AsyncDMDBStore`: LangGraph Store CRUD, batch, JSON filtering, pagination, and namespace listing.
+
+## Installation
+
+```bash
+pip install langgraph-checkpoint-dmdb
+```
+
+## Usage
+
+For a long-lived compiled graph:
+
+```python
+from langgraph.checkpoint.dmdb import DMDBSaver
+
+saver = DMDBSaver.from_conn_string(
+    "dmdb://sysdba:password@localhost:5236/NLP_KNOWLEDGEBASE"
+)
+saver.setup()
+graph = builder.compile(checkpointer=saver)
+
+config = {"configurable": {"thread_id": "conversation-1"}}
+for event in graph.stream(inputs, config=config):
+    ...
+```
+
+Applications that already have structured database configuration should avoid constructing a URI:
+
+```python
+saver = DMDBSaver.from_conn_params(
+    host=db.host,
+    port=int(db.port),
+    user=db.username,
+    password=db.password,
+    schema=db.database,
+)
+saver.setup()
+graph = builder.compile(checkpointer=saver)
+```
+
+Short-lived scripts may use the Saver as a context manager:
+
+```python
+with DMDBSaver.from_conn_string(DMDB_URI) as saver:
+    saver.setup()
+    graph = builder.compile(checkpointer=saver)
+    result = graph.invoke(inputs, config=config)
+```
+
+`from_conn_string()` and `from_conn_params()` create a connection factory. Each checkpoint operation owns a new dmPython connection and closes it afterward, so a Saver can be shared by concurrent synchronous graph executions without sharing a connection.
+
+Do not return a graph from inside the `with` block and use it after the block exits; the Saver is closed on context exit.
+
+## Async Checkpointing
+
+dmPython has no native async API. The async savers run each database operation with `asyncio.to_thread()` and obtain a fresh connection from the factory, so connections are never shared between worker threads:
+
+```python
+from langgraph.checkpoint.dmdb import AsyncDMDBSaver
+
+async with AsyncDMDBSaver.from_conn_params(
+    host=db.host,
+    port=int(db.port),
+    user=db.username,
+    password=db.password,
+    schema=db.database,
+) as saver:
+    await saver.setup()
+    graph = builder.compile(checkpointer=saver)
+    result = await graph.ainvoke(inputs, config=config)
+```
+
+Async savers require a connection factory. Passing one shared dmPython connection is rejected because `dmPython.threadsafety == 1`.
+
+## Shallow Saver
+
+```python
+from langgraph.checkpoint.dmdb import ShallowDMDBSaver
+
+saver = ShallowDMDBSaver.from_conn_string(DMDB_URI)
+saver.setup()
+graph = builder.compile(checkpointer=saver)
+```
+
+The shallow saver retains only the latest checkpoint per thread and namespace. Do not use shallow and full savers for the same thread/namespace because shallow writes intentionally prune that history.
+
+## LangGraph Store
+
+```python
+from langgraph.store.dmdb import DMDBStore
+
+store = DMDBStore.from_conn_params(
+    host=db.host,
+    port=int(db.port),
+    user=db.username,
+    password=db.password,
+    schema=db.database,
+)
+store.setup()
+store.put(("users", user_id), "preferences", {"language": "zh-CN"})
+items = store.search(("users", user_id), filter={"language": "zh-CN"})
+graph = builder.compile(checkpointer=saver, store=store)
+```
+
+`AsyncDMDBStore` exposes the corresponding `aget`, `aput`, `adelete`, `asearch`, `alist_namespaces`, and `abatch` APIs.
+
+## Connection URI
+
+Supported schemes are `dmdb://` and `dm://`:
+
+```text
+dmdb://user:password@host:5236/schema
+```
+
+The path is treated as the DM schema. The Saver validates it and executes `SET SCHEMA` after connecting. Usernames and passwords containing URI-special characters must be percent encoded. `from_conn_params()` does not require URI encoding.
+
+If dmPython raises `DatabaseError: [CODE:-70089] Encryption module failed to load` in Linux, add the wheel's bundled `dmssl` directory to `LD_LIBRARY_PATH` before starting Python. The exact site-packages path depends on the runtime image; see the dmPython 2.5.32 package metadata for its supported SSL setup.
+
+## Transactions and concurrency
+
+- dmPython connections use `autoCommit=False`.
+- `put`, `put_writes`, and `delete_thread` commit atomically and roll back on error.
+- Factory-backed Savers create an independent connection per operation.
+- A directly supplied dmPython connection remains owned by the caller and is restricted to its creating thread.
+- `setup()` is idempotent and must be called before first use.
+- DM `MERGE` source parameters are explicitly cast to their target SQL types. BLOB/write batches execute row-by-row inside one transaction because dmPython/DM otherwise cache the first inferred bind length and can raise `-70005 String truncated` for later values.
+
+## Driver Limitations
+
+- Async APIs use worker threads rather than a native async DM protocol.
+- Async classes cannot accept a single direct dmPython connection.
+- Store JSON filtering and namespace matching run in Python to avoid DM-version-specific JSON functions.
+- Store semantic `query` and vector indexing are not implemented; the MySQL 2.0.17 Store also did not implement semantic indexing.
+
+## Tests
+
+Unit and LangGraph integration tests do not require a DM instance:
+
+```bash
+uv run pytest -m "not integration"
+```
+
+Real DM integration requires `dmPython` and these environment variables:
+
+```text
+DM_HOST
+DM_PORT
+DM_USER
+DM_PASSWORD
+DM_SCHEMA
+```
+
+Run it with:
+
+```bash
+uv run pytest -m integration
+```
+
+## Design
+
+The implementation plan and release gates are documented in [docs/dmdb-compatibility-plan.md](docs/dmdb-compatibility-plan.md). The complete MySQL-to-DMDB feature mapping is in [docs/mysql-feature-parity.md](docs/mysql-feature-parity.md).
+
+This project derives serialization behavior and tests from `langgraph-checkpoint-mysql` 2.0.17. The original MIT copyright notice is retained in [LICENSE](LICENSE).

langgraph_checkpoint_dmdb-0.1.0/README.md

@@ -0,0 +1,178 @@
+# LangGraph Checkpoint DMDB
+
+[LangGraph](https://github.com/langchain-ai/langgraph) checkpoint and Store persistence for DM Database, using `dmPython`.
+
+## Compatibility
+
+- `langgraph-checkpoint>=2.1.1,<2.2`
+- `dmpython==2.5.32`
+- Python 3.9+
+
+The package provides:
+
+- `DMDBSaver`: complete checkpoint history and time travel.
+- `ShallowDMDBSaver`: latest-checkpoint-only persistence.
+- `AsyncDMDBSaver` and `AsyncShallowDMDBSaver`: async graph APIs backed by isolated worker-thread connections.
+- `DMDBStore` and `AsyncDMDBStore`: LangGraph Store CRUD, batch, JSON filtering, pagination, and namespace listing.
+
+## Installation
+
+```bash
+pip install langgraph-checkpoint-dmdb
+```
+
+## Usage
+
+For a long-lived compiled graph:
+
+```python
+from langgraph.checkpoint.dmdb import DMDBSaver
+
+saver = DMDBSaver.from_conn_string(
+    "dmdb://sysdba:password@localhost:5236/NLP_KNOWLEDGEBASE"
+)
+saver.setup()
+graph = builder.compile(checkpointer=saver)
+
+config = {"configurable": {"thread_id": "conversation-1"}}
+for event in graph.stream(inputs, config=config):
+    ...
+```
+
+Applications that already have structured database configuration should avoid constructing a URI:
+
+```python
+saver = DMDBSaver.from_conn_params(
+    host=db.host,
+    port=int(db.port),
+    user=db.username,
+    password=db.password,
+    schema=db.database,
+)
+saver.setup()
+graph = builder.compile(checkpointer=saver)
+```
+
+Short-lived scripts may use the Saver as a context manager:
+
+```python
+with DMDBSaver.from_conn_string(DMDB_URI) as saver:
+    saver.setup()
+    graph = builder.compile(checkpointer=saver)
+    result = graph.invoke(inputs, config=config)
+```
+
+`from_conn_string()` and `from_conn_params()` create a connection factory. Each checkpoint operation owns a new dmPython connection and closes it afterward, so a Saver can be shared by concurrent synchronous graph executions without sharing a connection.
+
+Do not return a graph from inside the `with` block and use it after the block exits; the Saver is closed on context exit.
+
+## Async Checkpointing
+
+dmPython has no native async API. The async savers run each database operation with `asyncio.to_thread()` and obtain a fresh connection from the factory, so connections are never shared between worker threads:
+
+```python
+from langgraph.checkpoint.dmdb import AsyncDMDBSaver
+
+async with AsyncDMDBSaver.from_conn_params(
+    host=db.host,
+    port=int(db.port),
+    user=db.username,
+    password=db.password,
+    schema=db.database,
+) as saver:
+    await saver.setup()
+    graph = builder.compile(checkpointer=saver)
+    result = await graph.ainvoke(inputs, config=config)
+```
+
+Async savers require a connection factory. Passing one shared dmPython connection is rejected because `dmPython.threadsafety == 1`.
+
+## Shallow Saver
+
+```python
+from langgraph.checkpoint.dmdb import ShallowDMDBSaver
+
+saver = ShallowDMDBSaver.from_conn_string(DMDB_URI)
+saver.setup()
+graph = builder.compile(checkpointer=saver)
+```
+
+The shallow saver retains only the latest checkpoint per thread and namespace. Do not use shallow and full savers for the same thread/namespace because shallow writes intentionally prune that history.
+
+## LangGraph Store
+
+```python
+from langgraph.store.dmdb import DMDBStore
+
+store = DMDBStore.from_conn_params(
+    host=db.host,
+    port=int(db.port),
+    user=db.username,
+    password=db.password,
+    schema=db.database,
+)
+store.setup()
+store.put(("users", user_id), "preferences", {"language": "zh-CN"})
+items = store.search(("users", user_id), filter={"language": "zh-CN"})
+graph = builder.compile(checkpointer=saver, store=store)
+```
+
+`AsyncDMDBStore` exposes the corresponding `aget`, `aput`, `adelete`, `asearch`, `alist_namespaces`, and `abatch` APIs.
+
+## Connection URI
+
+Supported schemes are `dmdb://` and `dm://`:
+
+```text
+dmdb://user:password@host:5236/schema
+```
+
+The path is treated as the DM schema. The Saver validates it and executes `SET SCHEMA` after connecting. Usernames and passwords containing URI-special characters must be percent encoded. `from_conn_params()` does not require URI encoding.
+
+If dmPython raises `DatabaseError: [CODE:-70089] Encryption module failed to load` in Linux, add the wheel's bundled `dmssl` directory to `LD_LIBRARY_PATH` before starting Python. The exact site-packages path depends on the runtime image; see the dmPython 2.5.32 package metadata for its supported SSL setup.
+
+## Transactions and concurrency
+
+- dmPython connections use `autoCommit=False`.
+- `put`, `put_writes`, and `delete_thread` commit atomically and roll back on error.
+- Factory-backed Savers create an independent connection per operation.
+- A directly supplied dmPython connection remains owned by the caller and is restricted to its creating thread.
+- `setup()` is idempotent and must be called before first use.
+- DM `MERGE` source parameters are explicitly cast to their target SQL types. BLOB/write batches execute row-by-row inside one transaction because dmPython/DM otherwise cache the first inferred bind length and can raise `-70005 String truncated` for later values.
+
+## Driver Limitations
+
+- Async APIs use worker threads rather than a native async DM protocol.
+- Async classes cannot accept a single direct dmPython connection.
+- Store JSON filtering and namespace matching run in Python to avoid DM-version-specific JSON functions.
+- Store semantic `query` and vector indexing are not implemented; the MySQL 2.0.17 Store also did not implement semantic indexing.
+
+## Tests
+
+Unit and LangGraph integration tests do not require a DM instance:
+
+```bash
+uv run pytest -m "not integration"
+```
+
+Real DM integration requires `dmPython` and these environment variables:
+
+```text
+DM_HOST
+DM_PORT
+DM_USER
+DM_PASSWORD
+DM_SCHEMA
+```
+
+Run it with:
+
+```bash
+uv run pytest -m integration
+```
+
+## Design
+
+The implementation plan and release gates are documented in [docs/dmdb-compatibility-plan.md](docs/dmdb-compatibility-plan.md). The complete MySQL-to-DMDB feature mapping is in [docs/mysql-feature-parity.md](docs/mysql-feature-parity.md).
+
+This project derives serialization behavior and tests from `langgraph-checkpoint-mysql` 2.0.17. The original MIT copyright notice is retained in [LICENSE](LICENSE).