Skip to content

feat!: add support for new Netlify Database primitive #8212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pieh merged 17 commits into from
Apr 28, 2026
Merged

feat!: add support for new Netlify Database primitive #8212

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
fbad04f
tmp: use unreleased @netlify/dev package to validate
pieh Apr 27, 2026
094bee2
feat!: remove db extension commands and unflag database primitive com…
pieh Apr 27, 2026
4d36191
test: adjust spawnAsync mocking
pieh Apr 27, 2026
44c9561
test: update snapshot for --help
pieh Apr 27, 2026
2361208
tmp: update unreleased @netlify/dev
pieh Apr 27, 2026
6f18dd1
fix: preserve honoring --skipGitignore
pieh Apr 27, 2026
0c65e7e
test: allow e2e tests to use local tarball versions of dependencies
pieh Apr 27, 2026
32092b7
docs: update cli command reference
pieh Apr 27, 2026
019d487
fix: don't try to reject already resolved promise in spawnAsync
pieh Apr 27, 2026
a2175bc
test: remove debug console.log
pieh Apr 27, 2026
1d2313a
docs: fix generating subcommands docs
pieh Apr 27, 2026
d2f3f3f
docs: don't generate top-level status:hooks docs into dabatase status
pieh Apr 27, 2026
3661009
fix: use published @netlify/dev
pieh Apr 27, 2026
d8d60f4
Merge remote-tracking branch 'origin/main' into feat/unflag-database
pieh Apr 27, 2026
27240cc
Merge branch 'main' into feat/unflag-database
pieh Apr 28, 2026
692b167
Merge branch 'main' into feat/unflag-database
pieh Apr 28, 2026
0cf185e
Merge branch 'main' into feat/unflag-database
pieh Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added netlify-dev-4.17.4-unflag-database.0.tgz
View file
Open in desktop
Binary file not shown.
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
"@netlify/build": "35.13.3",
"@netlify/build-info": "10.5.1",
"@netlify/config": "24.5.0",
"@netlify/dev": "4.17.3",
"@netlify/dev": "file:netlify-dev-4.17.4-unflag-database.0.tgz",
Comment thread
pieh marked this conversation as resolved.
Outdated
"@netlify/dev-utils": "4.4.3",
"@netlify/edge-bundler": "14.10.1",
"@netlify/edge-functions": "3.0.6",
Expand Down
336 changes: 134 additions & 202 deletions src/commands/database/database.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,211 +1,143 @@
import { Option } from 'commander'
import inquirer from 'inquirer'

import BaseCommand from '../base-command.js'
import type { DatabaseBoilerplateType, DatabaseInitOptions } from './legacy/db-init.js'
import type { MigrationNewOptions } from './db-migration-new.js'
import type { MigrationPullOptions } from './db-migration-pull.js'
import type { MigrationsResetOptions } from './db-migrations-reset.js'
import type { DatabaseStatusOptions } from './db-status.js'

const supportedBoilerplates = new Set<DatabaseBoilerplateType>(['drizzle'])

export const createDatabaseCommand = (program: BaseCommand) => {
if (process.env.EXPERIMENTAL_NETLIFY_DB_ENABLED !== '1') {
const dbCommand = program
.command('db')
.alias('database')
.description(`Provision a production ready Postgres database with a single command`)
.addExamples(['netlify db status', 'netlify db init', 'netlify db init --help'])

dbCommand
.command('init')
.description(`Initialize a new database for the current site`)
.option(
'--assume-no',
'Non-interactive setup. Does not initialize any third-party tools/boilerplate. Ideal for CI environments or AI tools.',
false,
)
.addOption(
new Option('--boilerplate <tool>', 'Type of boilerplate to add to your project.').choices(
Array.from(supportedBoilerplates).sort(),
),
)
.option('--no-boilerplate', "Don't add any boilerplate to your project.")
.option('-o, --overwrite', 'Overwrites existing files that would be created when setting up boilerplate')
.action(async (_options: Record<string, unknown>, command: BaseCommand) => {
const { init } = await import('./legacy/db-init.js')

// Only prompt for drizzle if the user did not specify a boilerplate option, and if we're in
// interactive mode
if (_options.boilerplate === undefined && !_options.assumeNo) {
const answers = await inquirer.prompt<{ useDrizzle: boolean }>([
{
type: 'confirm',
name: 'useDrizzle',
message: 'Set up Drizzle boilerplate?',
},
])
if (answers.useDrizzle) {
command.setOptionValue('boilerplate', 'drizzle')
}
}

const options = _options as DatabaseInitOptions
if (options.assumeNo) {
options.boilerplate = false
options.overwrite = false
}

await init(options, command)
})
.addExamples([`netlify db init --assume-no`, `netlify db init --boilerplate=drizzle --overwrite`])

dbCommand
.command('status')
.description(`Check the status of the database`)
.action(async (options, command) => {
const { status } = await import('./legacy/db-status.js')
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
await status(options, command)
})
}

if (process.env.EXPERIMENTAL_NETLIFY_DB_ENABLED === '1') {
const dbCommand = program
.command('database')
.alias('db')
.description(`Provision a production ready Postgres database with a single command`)
.addExamples([
'netlify database status',
'netlify database migrations apply',
'netlify database migrations pull',
'netlify database migrations new',
'netlify database reset',
])

dbCommand
.command('status')
.description('Check the status of the database, including applied and pending migrations')
.option('-b, --branch <branch>', 'Netlify branch name to query; defaults to the local development database')
.option(
'--show-credentials',
'Include the full connection string (including username and password) in the output',
false,
)
.option('--json', 'Output result as JSON')
.action(async (options: DatabaseStatusOptions, command: BaseCommand) => {
const { statusDb } = await import('./db-status.js')
await statusDb(options, command)
})
.addExamples([
'netlify database status',
'netlify database status --show-credentials',
'netlify database status --json',
'netlify database status --branch my-feature-branch',
])

dbCommand
.command('init')
.description('Interactive setup: install the package, scaffold a starter migration, and verify the database')
.option('-y, --yes', 'Non-interactive mode. Accepts the defaults for every prompt.', false)
.action(async (options: { yes?: boolean }, command: BaseCommand) => {
const { initDatabase } = await import('./db-init.js')
await initDatabase(options, command)
})
.addExamples(['netlify database init', 'netlify database init --yes'])

dbCommand
.command('connect')
.description('Connect to the database')
.option('-q, --query <sql>', 'Execute a single query and exit')
.option(
'--json',
'Output query results as JSON. When used without --query, prints the connection details as JSON instead.',
)
.action(async (options: { query?: string; json?: boolean }, command: BaseCommand) => {
const { connect } = await import('./db-connect.js')
await connect(options, command)
})
.addExamples([
'netlify database connect',
'netlify database connect --query "SELECT * FROM users"',
'netlify database connect --json --query "SELECT * FROM users"',
'netlify database connect --json',
])

dbCommand
.command('reset')
.description('Reset the local development database, removing all data and tables')
.option('--json', 'Output result as JSON')
.action(async (options: { json?: boolean }, command: BaseCommand) => {
const { reset } = await import('./db-reset.js')
await reset(options, command)
})

const migrationsCommand = dbCommand.command('migrations').description('Manage database migrations')

migrationsCommand
.command('apply')
.description('Apply database migrations to the local development database')
.option('--to <name>', 'Target migration name or prefix to apply up to (applies all if omitted)')
.option('--json', 'Output result as JSON')
.action(async (options: { to?: string; json?: boolean }, command: BaseCommand) => {
const { migrate } = await import('./db-migrate.js')
await migrate(options, command)
})

migrationsCommand
.command('new')
.description('Create a new migration')
.option('-d, --description <description>', 'Purpose of the migration (used to generate the file name)')
.addOption(
new Option('-s, --scheme <scheme>', 'Numbering scheme for migration prefixes').choices([
'sequential',
'timestamp',
]),
)
.option('--json', 'Output result as JSON')
.action(async (options: MigrationNewOptions, command: BaseCommand) => {
const { migrationNew } = await import('./db-migration-new.js')
await migrationNew(options, command)
})
.addExamples([
'netlify database migrations new',
'netlify database migrations new --description "add users table" --scheme sequential',
])

migrationsCommand
.command('pull')
.description('Pull migrations and overwrite local migration files')
.option(
'-b, --branch [branch]',
"Pull migrations for a specific branch (defaults to 'production'; pass --branch with no value to use local git branch)",
)
.option('--force', 'Skip confirmation prompt', false)
.option('--json', 'Output result as JSON')
.action(async (options: MigrationPullOptions, command: BaseCommand) => {
const { migrationPull } = await import('./db-migration-pull.js')
await migrationPull(options, command)
})
.addExamples([
'netlify database migrations pull',
'netlify database migrations pull --branch staging',
'netlify database migrations pull --branch',
'netlify database migrations pull --force',
])

migrationsCommand
.command('reset')
.description('Delete local migration files that have not been applied yet')
.option('-b, --branch <branch>', 'Target a remote preview branch instead of the local development database')
.option('--json', 'Output result as JSON')
.action(async (options: MigrationsResetOptions, command: BaseCommand) => {
const { migrationsReset } = await import('./db-migrations-reset.js')
await migrationsReset(options, command)
})
.addExamples([
'netlify database migrations reset',
'netlify database migrations reset --branch my-feature-branch',
])
}
const dbCommand = program
.command('database')
.alias('db')
.description(`Provision a production ready Postgres database with a single command`)
.addExamples([
'netlify database status',
'netlify database migrations apply',
'netlify database migrations pull',
'netlify database migrations new',
'netlify database reset',
])

dbCommand
.command('status')
.description('Check the status of the database, including applied and pending migrations')
.option('-b, --branch <branch>', 'Netlify branch name to query; defaults to the local development database')
.option(
'--show-credentials',
'Include the full connection string (including username and password) in the output',
false,
)
.option('--json', 'Output result as JSON')
.action(async (options: DatabaseStatusOptions, command: BaseCommand) => {
const { statusDb } = await import('./db-status.js')
await statusDb(options, command)
})
.addExamples([
'netlify database status',
'netlify database status --show-credentials',
'netlify database status --json',
'netlify database status --branch my-feature-branch',
])

dbCommand
.command('init')
.description('Interactive setup: install the package, scaffold a starter migration, and verify the database')
.option('-y, --yes', 'Non-interactive mode. Accepts the defaults for every prompt.', false)
.action(async (options: { yes?: boolean }, command: BaseCommand) => {
const { initDatabase } = await import('./db-init.js')
await initDatabase(options, command)
})
.addExamples(['netlify database init', 'netlify database init --yes'])

dbCommand
.command('connect')
.description('Connect to the database')
.option('-q, --query <sql>', 'Execute a single query and exit')
.option(
'--json',
'Output query results as JSON. When used without --query, prints the connection details as JSON instead.',
)
.action(async (options: { query?: string; json?: boolean }, command: BaseCommand) => {
const { connect } = await import('./db-connect.js')
await connect(options, command)
})
.addExamples([
'netlify database connect',
'netlify database connect --query "SELECT * FROM users"',
'netlify database connect --json --query "SELECT * FROM users"',
'netlify database connect --json',
])

dbCommand
.command('reset')
.description('Reset the local development database, removing all data and tables')
.option('--json', 'Output result as JSON')
.action(async (options: { json?: boolean }, command: BaseCommand) => {
const { reset } = await import('./db-reset.js')
await reset(options, command)
})

const migrationsCommand = dbCommand.command('migrations').description('Manage database migrations')

migrationsCommand
.command('apply')
.description('Apply database migrations to the local development database')
.option('--to <name>', 'Target migration name or prefix to apply up to (applies all if omitted)')
.option('--json', 'Output result as JSON')
.action(async (options: { to?: string; json?: boolean }, command: BaseCommand) => {
const { migrate } = await import('./db-migrate.js')
await migrate(options, command)
})

migrationsCommand
.command('new')
.description('Create a new migration')
.option('-d, --description <description>', 'Purpose of the migration (used to generate the file name)')
.addOption(
new Option('-s, --scheme <scheme>', 'Numbering scheme for migration prefixes').choices([
'sequential',
'timestamp',
]),
)
.option('--json', 'Output result as JSON')
.action(async (options: MigrationNewOptions, command: BaseCommand) => {
const { migrationNew } = await import('./db-migration-new.js')
await migrationNew(options, command)
})
.addExamples([
'netlify database migrations new',
'netlify database migrations new --description "add users table" --scheme sequential',
])

migrationsCommand
.command('pull')
.description('Pull migrations and overwrite local migration files')
.option(
'-b, --branch [branch]',
"Pull migrations for a specific branch (defaults to 'production'; pass --branch with no value to use local git branch)",
)
.option('--force', 'Skip confirmation prompt', false)
.option('--json', 'Output result as JSON')
.action(async (options: MigrationPullOptions, command: BaseCommand) => {
const { migrationPull } = await import('./db-migration-pull.js')
await migrationPull(options, command)
})
.addExamples([
'netlify database migrations pull',
'netlify database migrations pull --branch staging',
'netlify database migrations pull --branch',
'netlify database migrations pull --force',
])

migrationsCommand
.command('reset')
.description('Delete local migration files that have not been applied yet')
.option('-b, --branch <branch>', 'Target a remote preview branch instead of the local development database')
.option('--json', 'Output result as JSON')
.action(async (options: MigrationsResetOptions, command: BaseCommand) => {
const { migrationsReset } = await import('./db-migrations-reset.js')
await migrationsReset(options, command)
})
.addExamples(['netlify database migrations reset', 'netlify database migrations reset --branch my-feature-branch'])
}
Loading
Loading