Skip to content

Versioning and stability

Reference · Versioning

AskDB publishes two sets of packages. The 1.0 set shares one version and follows semantic versioning. The 0.x set keeps room to change. This page lists which package is in which set, what a version bump means for each, and which npm dist-tag to install from.

SetPackagesVersion nowShares one version
1.0 setaskdb, @askdb/ai, @askdb/client, @askdb/config, @askdb/core, @askdb/http-api, @askdb/introspect, @askdb/mysql, @askdb/postgres, @askdb/prisma, @askdb/sqlite, @askdb/sqlserver1.0.0-rc.NYes. Every release publishes all 12 at the same version, even a package that didn’t change.
0.x set@askdb/studio, @askdb/enrich, @askdb/rag0.2.0-rc.NNo. Each package moves on its own.

Keep every AskDB package in your app on the same release, and upgrade them in one step. Upgrade AskDB shows the command.

Change1.0 set0.x set
Breaking changeMajor, for all 12 (2.0.0)Minor (0.3.0)
New featureMinor, for all 12Minor
FixPatch, for all 12Patch

A breaking change is any of these:

  • An export is removed or renamed, or a package’s exports map closes a path that worked.
  • The Node floor (engines.node, >=22.23.4 today) goes up.
  • An accepted input or a default changes, so code that worked before fails or behaves differently.
  • The schema artifact format changes incompatibly. From 1.0.0 on, that ships as a new format version, such as Schema v3. Until then, Schema v2 can still change in a release candidate (see Release candidates).

A minor release of the package that owns one can change it (ADR 0030).

PackageExperimental surface
@askdb/configThe studio and rag blocks of defineConfig(), with the types and environment variables that feed them
askdbThe askdb studio, askdb enrich, askdb bundle and askdb rag commands
askdbThe --rag-store, --pgvector-env and --studio-execute flags of askdb init, and the rag and studio sections it writes
@askdb/configThe @askdb/config/scaffold entry point: the scaffold planner and the package-manager helpers that askdb init and Studio’s setup wizard share
@askdb/clientThe @askdb/client/charts entry point: classifyResult(), planChart() and validateChartSpec(), which plan a chart from a query’s question, masked SQL and column kinds, never its rows
  • 1.0.0-rc.1 freezes the public API of the 1.0 set. Later release candidates fix bugs.
  • The schema artifact format is the exception. Schema v2 can still change before 1.0.0 stable. Such a change ships in a release candidate with an upgrade note.
  • A fix that asks something of your app gets its own section in Upgrade notes by release.
  • 1.0.0 follows the last release candidate. The 0.x set becomes 0.2.0 at the same time.
Dist-tagPoints at
latestThe newest release. Until 1.0.0, that is the newest release candidate.
beta, rcNot published. The stale beta tag was removed.

From 1.0.0 on, a prerelease publishes under its own tag (such as beta), and latest stays on the newest stable release.