Skip to content

Commit 907bd42

Browse files
committed
docs(getting-started): your-first-project says PostgreSQL and MySQL need their client installed
The package table and the paragraph under it said the runtime brings the database drivers and that pointing OS_DATABASE_URL at Postgres, MySQL or MongoDB needs no code changes. SQLite and MongoDB do work as installed; pg and mysql2 are optional peers of driver-sql the project installs itself, and without them the boot is refused. Claude-Session: https://claude.ai/code/session_011TdZ8GjixNZFLz1xJD9zzK Co-authored-by: Claude <noreply@anthropic.com>
1 parent 2da7d02 commit 907bd42

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

‎content/docs/getting-started/your-first-project.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -242,16 +242,20 @@ framework surface you install:
242242
| Package | What it does |
243243
|:---|:---|
244244
| `@objectstack/spec` | The protocol: `defineStack`, `ObjectSchema`, `Field.*` builders, all Zod schemas. Your metadata imports only this. |
245-
| `@objectstack/runtime` | The kernel that interprets metadata at runtime. Brings the database drivers with it — you do not install one separately. |
245+
| `@objectstack/runtime` | The kernel that interprets metadata at runtime. Brings the database drivers with it — SQLite and MongoDB work as installed; PostgreSQL and MySQL also need their client package (below). |
246246
| `@objectstack/plugin-hono-server` | The HTTP server that mounts the generated REST API. |
247247
| `@objectstack/connector-rest` · `-openapi` · `-mcp` | The three generic connector executors — register the `rest` / `openapi` / `mcp` provider factories so declarative `connectors:` entries materialize ([ADR-0097](/docs/automation/flows)). |
248248
| `@objectstack/cli` *(dev)* | The `os` / `objectstack` CLI: `dev`, `validate`, `build`, `start`. |
249249
| `@objectstack/verify` *(dev)* | The test harness: `bootStack` boots this app's own stack in-process, on an in-memory database and with no server port, and returns the handle a test asserts through. `npm test` runs the starter test `note.test.ts` with it. |
250250

251251
No driver package is listed because none is installed directly: `@objectstack/runtime`
252-
depends on `driver-sql`, `driver-sqlite-wasm` and `driver-memory`, and the CLI carries
253-
them too. `objectstack dev` resolves **SQLite** by default; point `OS_DATABASE_URL` at
254-
Postgres / MySQL / MongoDB for production — [no code changes](/docs/data-modeling/drivers).
252+
depends on `driver-sql`, `driver-sqlite-wasm` and `driver-memory` and installs
253+
`driver-mongodb` as an optional dependency, and the CLI carries them too.
254+
`objectstack dev` resolves **SQLite** by default, which needs nothing more. For
255+
production, MongoDB needs only `OS_DATABASE_URL` pointed at it. Postgres and MySQL need
256+
one install first: their database client (`npm install pg`, or `npm install mysql2`) is
257+
an optional peer of `driver-sql` that your project adds itself, and without it the boot
258+
is refused. No code changes either way — see [Drivers](/docs/data-modeling/drivers).
255259

256260
## 3. Run it
257261

0 commit comments

Comments
 (0)