db/mongodb
MongoDB connection with a startup ping and a Compose service; hands over to Mongoose when present.
Provides: database, database:document, database:mongodb
Requires: runtime:node, config:env
Conflicts with: database
Options
| Prompt | Flag | Type | Default |
|---|---|---|---|
db.name | --db-name | input | "{{ project.slug }}" |
Files it writes
src/db/client.ts|js(when!provides('orm'))docker-compose.yml(whenhas('infra/docker-compose'))
Dependencies
mongodb@^6.20.0(when!provides('orm'))
Environment
| Variable | Required | Description |
|---|---|---|
MONGODB_URI | yes | MongoDB connection string, including the database name |
What it contributes to other files
| File | Slot | Line |
|---|---|---|
src/config/env.ts|js | env-schema | MONGODB_URI: z.string().min(1), |
src/index.ts|js | imports | import { connectDatabase } from './db/client.js'; |
src/index.ts|js | bootstrap | await connectDatabase(); |
Use it
atarashi new my-app --add db/mongodb
atarashi add db/mongodb
Version 1.0.0. Format reference: Authoring blueprints.
Part of the atarashi documentation, written and maintained by Gautam Suthar.