Browse a development database
Inspect tables and records during local development.
Drizzle ORM · Command
drizzle-kit studio
Starts a local Drizzle Studio server connected through the credentials in drizzle.config.ts. It defaults to 127.0.0.1:4983 and supports host, port, and verbose CLI options.
How it works
The command launches a local Drizzle Studio server using database credentials from drizzle.config.ts. It normally listens at 127.0.0.1:4983, while CLI options can change the host or port; verbose mode logs each SQL statement.
Syntax
npx drizzle-kit studio [--host=<host>] [--port=<port>] [--verbose]Parameters
| Name | Type | Description |
|---|---|---|
--host | CLI option | Selects the network interface or hostname on which the Studio server listens. |
--port | CLI option | Selects the TCP port on which the Studio server listens. |
--verbose | boolean flag | Enables logging for every SQL statement. |
Returns
A locally hosted Drizzle Studio server for browsing the configured database.
Key points
- Running the command starts the local Drizzle Studio server.
- Provide the database connection details in drizzle.config.ts before launching Studio.
- Without host or port options, Studio listens on 127.0.0.1:4983.
- Use the host and port CLI options when the default listener is unsuitable.
- Add --verbose to log every SQL statement issued while Studio runs.
Common mistakes
- Safari and Brave may prevent localhost access; the page recommends installing mkcert, running mkcert -install, and restarting Studio.
- Do not treat this command as a remote VPS deployment mechanism; the documented hosted version is intended for local development.
Example: Start Studio with custom network settings
npx drizzle-kit studio --port=3000 --host=0.0.0.0Starts Drizzle Studio on port 3000 and listens on all network interfaces.
When to use it
Choose a host and port
Run Studio where the default listener is unavailable.
Trace SQL statements
Diagnose database activity while using Studio.
Interview questions
QWhat does drizzle-kit studio do, and what configuration does it require?
It starts a server for Drizzle Studio and reads the database connection credentials from drizzle.config.ts. The default address is 127.0.0.1:4983.
Follow-up: How can you expose it on a different interface and port? Supply --host and --port, such as --host=0.0.0.0 --port=3000.
QHow do you customize where Studio listens?
Use --port to change the listening port and --host to change the listening host. For example, npx drizzle-kit studio --port=3000 changes the port.
Follow-up: How would you make SQL activity visible? Add the --verbose flag to log every SQL statement.
QHow can you enable SQL statement logging?
The command can log every SQL statement when invoked with --verbose. This is useful when inspecting the SQL generated or executed during local database browsing.
Follow-up: What browser-specific issue is documented? Safari and Brave block localhost by default, so mkcert setup may be required.
Related
Drizzle Studiodrizzle.config.tsDrizzle Kit overview