Skip to content

docs: document LSD_CHECKPOINT_DELETE env var #3682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Connor Braa (cwlbraa) wants to merge 5 commits into
base: main
Choose a base branch
from
+20 −0
Open

docs: document LSD_CHECKPOINT_DELETE env var #3682

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8f7a553
docs: document LSD_CHECKPOINT_DELETE env var
cwlbraa Apr 22, 2026
b7a3c70
docs: note langgraph-api>=0.7.103 for LSD_CHECKPOINT_DELETE
cwlbraa Apr 22, 2026
ffdfb69
docs: reword LSD_CHECKPOINT_DELETE to drop "wrapper" terminology
cwlbraa Apr 22, 2026
cb7822c
docs: note LSD_CHECKPOINT_DELETE is postgres-only and future default
cwlbraa Apr 22, 2026
bd43554
docs: clarify "deferred deletes" will be the future default
cwlbraa Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/langsmith/env-var.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,26 @@ When [`BG_JOB_ISOLATED_LOOPS`](#bg_job_isolated_loops) is enabled, the pool is n

Defaults to `150` connections.

## `LSD_CHECKPOINT_DELETE`

JSON-valued configuration for deferred checkpoint deletion. When enabled, thread delete and prune operations enqueue checkpoints for background deletion instead of deleting synchronously, moving the I/O off the request hot path. Available in `langgraph-api>=0.7.103`.

<Note>
Only supported with the default PostgreSQL checkpointer backend. Deferred deletes will become the default in a future release.
</Note>

Accepted fields:

- `enabled` (boolean, default `false`): When `true`, thread delete and prune operations enqueue checkpoints into `checkpoint_delete_queue` and return immediately, and the background worker drains the queue.
Copy link
Copy Markdown
Contributor

@longquanzheng Quanzheng Long (longquanzheng) Apr 22, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it safe to flip back from true to false? if not maybe worth documenting it to avoid mistakes.

- `enabledWorkerOnly` (boolean, default `false`): Runs only the background drain worker without enqueuing new entries. Use this to finish draining the queue after rolling `enabled` back to `false`.
- `pollIntervalMs` (integer, default `5000`): How often the worker polls the queue, in milliseconds.
- `batchSize` (integer, default `25`): Number of checkpoint entries the worker dequeues per transaction. Smaller values spread I/O over more time at the cost of longer drain latency.
- `batchSleepMs` (integer, default `500`): How long the worker sleeps between batches when the queue is non-empty, in milliseconds.

Example: `LSD_CHECKPOINT_DELETE='{"enabled":true,"batchSize":10,"pollIntervalMs":1000}'`.

Defaults to disabled (synchronous checkpoint deletion).

## `LS_DEFAULT_CHECKPOINTER_BACKEND`

Sets the default [checkpointer backend](/langsmith/configure-checkpointer) for agent servers that don't specify one in `langgraph.json`. Accepted values: `"default"` (PostgreSQL), `"mongo"`, `"custom"`.
Expand Down
Loading