Convex Database Management in VS Code

Overview

Convex is a backend-as-a-service platform built around a document database, with schemas inferred from your data rather than declared up front, and access normally happening through generated TypeScript functions instead of SQL. DBCode connects directly to a deployment’s HTTP API so you can browse and edit that data alongside your other databases.

DBCode connects the same way to both deployment shapes:

• Convex Cloud: managed deployments at https://<name>.convex.cloud
• Self-hosted Convex: deployments you run yourself, typically at a plain http://host:3210 address

Connecting

To connect to Convex in DBCode:

1. Open the DBCode extension and select Add Connection.
2. Select Convex as the database type.
3. Enter the Deployment URL: https://<name>.convex.cloud for Convex Cloud, or your self-hosted deployment’s address.
4. Enter the Admin Key, found in the Convex dashboard under Settings, then Deploy Key, or select a Command authentication profile instead of storing the key directly.
5. Save the connection and open it from the DB Explorer.

Convex has no databases or schemas of its own, so DBCode shows a single database named for the deployment, with your tables listed underneath it.

Working with Convex

• Browse tables and documents in the DB Explorer.
• Open a table to load its documents into the grid.
• Insert, update, and delete documents, and edit cells inline.
• Clear a table with Truncate.
• Connect read-only when you only need to look.

Every document carries _id and _creationTime alongside its own fields, and column types are inferred by sampling recent documents.

For more information about Convex, check out Convex.