Skip to content

Commit 129045d

Browse files
committed
docs: SessionStore Protocol points to delete_session_via_store, not delete_session
delete_session() is the pre-existing sync disk-path helper that os.remove()s the local JSONL and never touches a SessionStore. The async store-backed counterpart that actually calls store.delete() is delete_session_via_store(). A user following the old wording would call delete_session() expecting their adapter's data to be removed and only the local file would go.
1 parent d1680b9 commit 129045d

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/claude_agent_sdk/types.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1173,8 +1173,9 @@ class SessionStore(Protocol):
11731173
The subprocess still writes to local disk (set ``CLAUDE_CONFIG_DIR=/tmp``
11741174
for an ephemeral local copy); the adapter receives a secondary copy.
11751175
1176-
The SDK never deletes from your store unless you call ``delete_session()``
1177-
with :meth:`delete` implemented. Retention is the adapter's responsibility —
1176+
The SDK never deletes from your store unless you call
1177+
``delete_session_via_store()`` with :meth:`delete` implemented. Retention is
1178+
the adapter's responsibility —
11781179
implement TTL, object-storage lifecycle policies, or scheduled cleanup
11791180
according to your compliance requirements (e.g. ZDR/HIPAA retention
11801181
windows). Local-disk transcripts under ``CLAUDE_CONFIG_DIR`` are swept by

0 commit comments

Comments
 (0)