Skip to content

Document AidboxMigration execution-type and improve 2607 release notes - #38

Merged
aleksandrkislitsyn merged 3 commits into
mainfrom
docs/aidbox-migration-execution-type
Aug 6, 2026
Merged

Document AidboxMigration execution-type and improve 2607 release notes#38
aleksandrkislitsyn merged 3 commits into
mainfrom
docs/aidbox-migration-execution-type

Conversation

@aleksandrkislitsyn

Copy link
Copy Markdown
Contributor

Documents running AidboxMigration SQL outside a transaction, added in HealthSamurai/sansara#8102, and reworks the 2607 release notes.

Why

CREATE INDEX CONCURRENTLY (and other DDL PostgreSQL forbids inside a transaction block) previously could not run through any Aidbox migration path. The new execution-type parameter makes it possible, but nothing in the docs mentioned it.

Changes

  • configuration/migrations.md — new "Run SQL outside a transaction" section: the execution-type parameter, a value table (in-transaction default vs not-in-transaction), which request contexts allow it (direct POST to either API format and batch bundles work; a transaction bundle is rejected with 422), a batch Init Bundle example, and the no-rollback caveat with the query for finding invalid indexes. Also adds a row to the AidboxMigration vs POST /db/migrations comparison table.
  • tutorials/other-tutorials/how-to-run-sql-via-init-bundle.md — switched the main example to CREATE INDEX CONCURRENTLY, since a plain CREATE INDEX locks the table against writes for the duration of the build. That required the bundle type to become batch, the execution-type parameter, and a version bump to 2607. Added a step checking indisvalid, and a note that a failed batch entry warns rather than blocking startup.
  • deployment-and-maintenance/indexes/README.md — new "Applying an index" section. The page listed which indexes to create but never how to apply DDL that cannot run in a transaction. Covers $psql with Aidbox-Sql-Autocommit, SQL Console autocommit mode, and AidboxMigration.
  • api/rest-api/other/sql-endpoints.md — cross-link from the Aidbox-Sql-Autocommit header row to the migration route.
  • overview/release-notes.md — reworked the 2607 section: documentation links throughout, fuller descriptions for SMART Health Cards and batch validation, typo fixes, and formatting matched to the surrounding releases.

Note

The sansara PR description documents the parameter as runInTransaction: false (a valueBoolean), but the merged code implements execution-type as a valueCode with values in-transaction / not-in-transaction. These docs follow the code and tests in proto/migration.clj; the PR description looks stale.

Verification

bun lint passes: 11 checks, no new warnings. All new anchor links verified against their target headings.

🤖 Generated with Claude Code

Adds documentation for running AidboxMigration SQL outside a transaction
(HealthSamurai/sansara#8102), needed for statements PostgreSQL forbids
inside a transaction block such as CREATE INDEX CONCURRENTLY.

* migrations.md: new "Run SQL outside a transaction" section covering the
  execution-type parameter, which request contexts allow it (direct POST
  and batch bundles yes, transaction bundles rejected), a batch Init
  Bundle example, and the no-rollback caveat.
* how-to-run-sql-via-init-bundle.md: use CREATE INDEX CONCURRENTLY as the
  main example, since a plain CREATE INDEX blocks writes for the duration
  of the build.
* indexes/README.md: new "Applying an index" section listing the three
  routes for autocommit DDL.
* sql-endpoints.md: cross-link from Aidbox-Sql-Autocommit to the
  migration route.
* release-notes.md: rework the 2607 section with documentation links and
  fuller descriptions.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

@Aitem Aitem left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Comment thread docs/overview/release-notes.md
Comment thread docs/overview/release-notes.md
aleksandrkislitsyn and others added 2 commits August 6, 2026 17:05
* Zen seed: sansara c95e50057a removes the seed/seed-v2 engines and
  migrates default OAuth2/SMART scopes to auth module resources;
  f9bcd85aa0 drops the SeedImport resource type.
* C-CDA: sansara 32be24501 (merged in 085fb373e) removes the CCDA
  module, closing sansara#6558. The converter now ships separately.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@aleksandrkislitsyn
aleksandrkislitsyn merged commit fef571d into main Aug 6, 2026
3 of 4 checks passed
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.

2 participants