Skip to content

docs: DataJoint 2.2 — Instance API & Thread-Safe Mode#154

Open
dimitri-yatsenko wants to merge 10 commits intomainfrom
docs/v2.2-thread-safe
Open

docs: DataJoint 2.2 — Instance API & Thread-Safe Mode#154
dimitri-yatsenko wants to merge 10 commits intomainfrom
docs/v2.2-thread-safe

Conversation

@dimitri-yatsenko
Copy link
Member

@dimitri-yatsenko dimitri-yatsenko commented Feb 19, 2026

Summary

  • Adds documentation for DataJoint 2.2's dj.Instance API and thread-safe mode (DJ_THREAD_SAFE=true)
  • Bumps documented version from 2.1 to 2.2
  • Documents the backend parameter for MySQL/PostgreSQL selection
  • Fixes Docker Compose for full tutorial execution (minio, store directories)
  • Updates GitHub Actions workflow to reference pre/v2.2 branch

New pages

  • What's New in 2.2 (explanation/whats-new-22.md) — Feature overview and rationale
  • Use Isolated Instances (how-to/use-instances.md) — Task-oriented guide
  • Thread-Safe Mode spec (reference/specs/thread-safe-mode.md) — Architecture, config flow, global state audit
  • Instances tutorial (tutorials/advanced/instances.ipynb) — Step-by-step notebook

Updated pages

  • Configuration Reference — Instance API and thread-safe mode sections
  • Configure Database — Instance-based connections section
  • First Pipeline tutorial — "Alternative: Using Instances" note
  • Docker Compose — Added minio dependency, store directory creation, zarr/matplotlib/faker deps
  • GitHub Actions workflow — Updated datajoint-python checkout to pre/v2.2

Test plan

  • All 23 tutorials pass against PostgreSQL (MODE=EXECUTE_PG)
  • CI linkcheck passes (all internal links valid)
  • CI spellcheck passes
  • instances.ipynb tutorial executes correctly
  • 06-object-storage.ipynb passes (minio + store directory fix)

🤖 Generated with Claude Code

dimitri-yatsenko and others added 6 commits February 19, 2026 10:39
New pages:
- explanation/whats-new-22.md: What's New in 2.2 overview
- how-to/use-instances.md: Task-oriented guide for dj.Instance
- reference/specs/thread-safe-mode.md: Thread-safe mode specification
- tutorials/advanced/instances.ipynb: Step-by-step Instance tutorial

Updated pages:
- reference/configuration.md: Instance API and thread-safe mode sections
- how-to/configure-database.md: Instance-based connections section
- tutorials/basics/01-first-pipeline.ipynb: Instance alternative note
- mkdocs.yaml: Bump version to 2.2, add nav entries

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Publishing workflow now checks out datajoint-python at pre/v2.2
  instead of master (until merged)
- EXECUTE_PG mode sets DJ_HOST=postgres (correct Docker service name)
- Added zarr, matplotlib, faker to pip install for notebook execution

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Lychee linkcheck runs against source files, not built site URLs.
Links to notebooks need the .ipynb extension to be resolvable.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The 06-object-storage tutorial fails because datajoint.json configures
a local store at /tmp/datajoint-tutorials which doesn't exist in the
Docker container. Create it before executing notebooks. Also add minio
as a dependency so it's ready if needed.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add backend parameter to the Instance API table, document default ports
per backend, and show usage examples for MySQL, PostgreSQL, and custom
port configurations.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
All 23/23 notebooks pass against PostgreSQL. Updated execution
outputs with current timestamps and connection info.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
dimitri-yatsenko and others added 4 commits February 19, 2026 14:43
Replace relative date strings ('-35y', '-4y') and date_of_birth() with
fixed date() bounds so that Faker generates identical dates regardless
of when the notebook is executed.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments