Upgrade AskDB

Maintain

Move your app to a newer AskDB release. Upgrade the packages in one step, apply the notes of each release you cross, oldest first, and check the result. Upgrade notes by release lists what each release asks of your app.

Before you upgrade

1. Check your Node version. Every AskDB package needs Node 22.23.4 or newer, since 1.0.0-beta.44.
2. Find the releases you cross. Upgrade notes by release has a section for each release, named after its askdb version, and the line under its heading names the other packages’ versions in it. Read every section between your current versions and the new ones.
3. Upgrade the AskDB packages your app already lists, in one step, so they all come from the same release. Betas and release candidates publish under npm’s latest tag. Name each askdb and @askdb/* package in your package.json, and no others. For example, for an app that lists @askdb/client and @askdb/core:

npm

npm install @askdb/client@latest @askdb/core@latest

pnpm

pnpm add @askdb/client@latest @askdb/core@latest

yarn

yarn add @askdb/client@latest @askdb/core@latest

Then apply each release’s notes, oldest first, and finish with Check the upgrade.

Check the upgrade

1. Load your config. Run your app or an askdb command once. A config that sets a removed key fails to load and names each key’s replacement.
2. Ask one question on each path that calls ask() or bind(), with the tenant scopes you use in production.
3. If you use RAG, run askdb rag query against the new index, or check that Studio no longer marks the index as stale.

If something fails, Fix common errors lists the common errors and their fixes.

Read next

Upgrade notes by releaseWhat each release asks of your app, newest first.Configuration referenceThe ai and rag blocks, and every deprecated key.Fix common errorsCommon errors and how to fix them.