@@ -2,56 +2,54 @@
22
33[](https://github.com/fabianlindfors/reshape/actions/workflows/test.yaml) [](https://github.com/fabianlindfors/reshape/releases)
44
5−> Also check out [ReshapeDB](https://reshapedb.com), a new database built from the ground up to make zero-downtime schema and data migrations as simple and safe as possible. If you'd like to chat about it, please [reach out](contact@reshapedb.com)!
6−
75Reshape is an easy-to-use, zero-downtime schema migration tool for Postgres. It automatically handles complex migrations that would normally require downtime or manual multi-step changes. During a migration, Reshape ensures both the old and new schema are available at the same time, allowing you to gradually roll out your application. It will also perform all changes without excessive locking, avoiding downtime caused by blocking other queries. For a more thorough introduction to Reshape, check out the [introductory blog post](https://fabianlindfors.se/blog/schema-migrations-in-postgres-using-reshape/).
86
97Designed for Postgres 12 and later.
108
9+*Note: Reshape is **experimental** and should not be used in production. It can (and probably will) break your application.*
10+
1111- [How it works](#how-it-works)
1212- [Getting started](#getting-started)
13− - [Installation](#installation)
14− - [Creating your first migration](#creating-your-first-migration)
15− - [Preparing your application](#preparing-your-application)
16− - [Running your migration](#running-your-migration)
17− - [Using during development](#using-during-development)
13+ - [Installation](#installation)
14+ - [Creating your first migration](#creating-your-first-migration)
15+ - [Preparing your application](#preparing-your-application)
16+ - [Running your migration](#running-your-migration)
17+ - [Using during development](#using-during-development)
1818- [Writing migrations](#writing-migrations)
19− - [Basics](#basics)
20− - [Tables](#tables)
21− - [Create table](#create-table)
22− - [Rename table](#rename-table)
23− - [Remove table](#remove-table)
24− - [Add foreign key](#add-foreign-key)
25− - [Remove foreign key](#remove-foreign-key)
26− - [Columns](#columns)
27− - [Add column](#add-column)
28− - [Alter column](#alter-column)
29− - [Remove column](#remove-column)
30− - [Indices](#indices)
31− - [Add index](#add-index)
32− - [Remove index](#remove-index)
33− - [Enums](#enums)
34− - [Create enum](#create-enum)
35− - [Remove enum](#remove-enum)
36− - [Custom](#custom)
37− - [Complex changes across tables](#complex-changes-across-tables)
19+ - [Basics](#basics)
20+ - [Tables](#tables)
21+ - [Create table](#create-table)
22+ - [Rename table](#rename-table)
23+ - [Remove table](#remove-table)
24+ - [Add foreign key](#add-foreign-key)
25+ - [Columns](#columns)
26+ - [Add column](#add-column)
27+ - [Alter column](#alter-column)
28+ - [Remove column](#remove-column)
29+ - [Indices](#indices)
30+ - [Add index](#add-index)
31+ - [Remove index](#remove-index)
32+ - [Enums](#enums)
33+ - [Create enum](#create-enum)
34+ - [Remove enum](#remove-enum)
3835- [Commands and options](#commands-and-options)
39− - [`reshape migration start`](#reshape-migration-start)
40− - [`reshape migration complete`](#reshape-migration-complete)
41− - [`reshape migration abort`](#reshape-migration-abort)
42− - [`reshape schema-query`](#reshape-schema-query)
43− - [Connection options](#connection-options)
36+ - [`reshape migrate`](#reshape-migrate)
37+ - [`reshape complete`](#reshape-complete)
38+ - [`reshape abort`](#reshape-abort)
39+ - [`reshape generate-schema-query`](#reshape-generate-schema-query)
40+ - [Connection options](#connection-options)
4441- [License](#license)
4542
43+
4644## How it works
4745
4846Reshape works by creating views that encapsulate the underlying tables, which your application will interact with. During a migration, Reshape will automatically create a new set of views and set up triggers to translate inserts and updates between the old and new schema. This means that every deployment is a three-phase process:
4947
50−1. **Start migration** (`reshape migration start`): Sets up views and triggers to ensure both the new and old schema are usable at the same time.
48+1. **Start migration** (`reshape migrate`): Sets up views and triggers to ensure both the new and old schema are usable at the same time.
51492. **Roll out application**: Your application can be gradually rolled out without downtime. The existing deployment will continue using the old schema whilst the new deployment uses the new schema.
52−3. **Complete migration** (`reshape migration complete`): Removes the old schema and any intermediate data and triggers.
50+3. **Complete migration** (`reshape complete`): Removes the old schema and any intermediate data and triggers.
5351
54−If the application deployment fails, you should run `reshape migration abort` which will roll back any changes made by `reshape migration start` without losing data.
52+If the application deployment fails, you should run `reshape abort` which will roll back any changes made by `reshape migrate` without losing data.
5553
5654## Getting started
5755
@@ -63,7 +61,7 @@ Binaries are available for macOS and Linux under [Releases](https://github.com/f
6361
6462#### Cargo
6563
66−Reshape can be installed using [Cargo](https://doc.rust-lang.org/cargo/) (requires Rust 1.58 or later):
64+Reshape can be installed using [Cargo](https://doc.rust-lang.org/cargo/):
6765
6866```shell
6967cargo install reshape
@@ -71,10 +69,10 @@ cargo install reshape
7169
7270#### Docker
7371
74−Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
72+Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
7573
7674```shell
77−docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migration start
75+docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migrate
7876```
7977
8078### Creating your first migration
@@ -103,14 +101,9 @@ This is the equivalent of running `CREATE TABLE users (id INTEGER GENERATED ALWA
103101
104102### Preparing your application
105103
106−Reshape relies on your application using a specific schema. When establishing the connection to Postgres in your application, you need to run a query to select the most recent schema. The simplest way to do this is to use one of the helper libraries:
104+Reshape relies on your application using a specific schema. When establishing the connection to Postgres in your application, you need to run a query to select the most recent schema. This query can be generated using: `reshape generate-schema-query`.
107105
108−- [Rust](https://github.com/fabianlindfors/reshape-helper)
109−- [Ruby (and Rails)](https://github.com/fabianlindfors/reshape-ruby)
110−- [Python (and Django)](https://github.com/fabianlindfors/reshape-python)
111−- [Go](https://github.com/leourbina/reshape-helper)
112−
113−If your application is not using one of the languages with an available helper library, you can instead generate the query with the command: `reshape schema-query`. To pass it along to your application, you can for example use an environment variable in your run script: `RESHAPE_SCHEMA_QUERY=$(reshape schema-query)`. Then in your application:
106+To pass it along to your application, you can for example use an environment variable in your run script: `RESHAPE_SCHEMA_QUERY=$(reshape generate-schema-query)`. Then in your application:
114107
115108```python
116109# Example for Python
@@ -123,16 +116,16 @@ db.execute(reshape_schema_query)
123116To create your new `users` table, run:
124117
125118```bash
126−reshape migration start --complete
119+reshape migrate
127120```
128121
129−We use the `--complete` flag to automatically complete the migration. During a production deployment, you should first run `reshape migration start` followed by `reshape migration complete` once your application has been fully rolled out.
122+As this is the first migration, Reshape will automatically complete it. For subsequent migrations, you will need to first run `reshape migrate`, roll out your application and then complete the migration using `reshape complete`.
130123
131124If nothing else is specified, Reshape will try to connect to a Postgres database running on `localhost` using `postgres` as both username and password. See [Connection options](#connection-options) for details on how to change the connection settings.
132125
133126### Using during development
134127
135−When adding new migrations during development, we recommend running `reshape migration start` but skipping `reshape migration complete`. This way, the new migrations can be iterated on by updating the migration file and running `reshape migration abort` followed by `reshape migration start`.
128+When adding new migrations during development, we recommend running `reshape migrate` but skipping `reshape complete`. This way, the new migrations can be iterated on by updating the migration file and running `reshape abort` followed by `reshape migrate`.
136129
137130## Writing migrations
138131
@@ -167,9 +160,9 @@ Every action has a `type`. The supported types are detailed below.
167160
168161#### Create table
169162
170−The `create_table` action will create a new table with the specified columns, indices and constraints. You can optionally provide an `up` option to backfill values from an existing table.
163+The `create_table` action will create a new table with the specified columns, indices and constraints.
171164
172−_Example: create a `customers` table with a few columns and a primary key_
165+*Example: create a `customers` table with a few columns and a primary key*
173166
174167```toml
175168[[actions]]
@@ -187,13 +180,13 @@ primary_key = ["id"]
187180 type = "TEXT"
188181
189182 # Columns default to nullable
190− nullable = false
183+ nullable = false
191184
192185 # default can be any valid SQL value, in this case a string literal
193− default = "'PLACEHOLDER'"
186+ default = "'PLACEHOLDER'"
194187```
195188
196−_Example: create `users` and `items` tables with a foreign key between them_
189+*Example: create `users` and `items` tables with a foreign key between them*
197190
198191```toml
199192[[actions]]
@@ -226,34 +219,11 @@ primary_key = ["id"]
226219 referenced_columns = ["id"]
227220```
228221
229−_Example: create `profiles` table based on existing `users` table_
230−
231−```toml
232−[[actions]]
233−type = "create_table"
234−name = "profiles"
235−primary_key = ["user_id"]
236−
237− [[actions.columns]]
238− name = "user_id"
239− type = "INTEGER"
240−
241− [[actions.columns]]
242− name = "user_email"
243− type = "TEXT"
244−
245− # Backfill from `users` table and copy `users.email` to `user_email` column
246− # This will perform an upsert based on the primary key to avoid duplicate rows
247− [actions.up]
248− table = "users"
249− values = { user_id = "id", user_email = "email" }
250−```
251−
252222#### Rename table
253223
254224The `rename_table` action will change the name of an existing table.
255225
256−_Example: change name of `users` table to `customers`_
226+*Example: change name of `users` table to `customers`*
257227
258228```toml
259229[[actions]]
@@ -266,7 +236,7 @@ new_name = "customers"
266236
267237The `remove_table` action will remove an existing table.
268238
269−_Example: remove `users` table_
239+*Example: remove `users` table*
270240
271241```toml
272242[[actions]]
@@ -278,7 +248,7 @@ table = "users"
278248
279249The `add_foreign_key` action will add a foreign key between two existing tables. The migration will fail if the existing column values aren't valid references.
280250
281−_Example: create foreign key from `items` to `users` table_
251+*Example: create foreign key from `items` to `users` table*
282252
283253```toml
284254[[actions]]
@@ -291,26 +261,13 @@ table = "items"
291261 referenced_columns = ["id"]
292262```
293263
294−#### Remove foreign key
295−
296−The `remove_foreign_key` action will remove an existing foreign key. The foreign key will only be removed once the migration is completed, which means that your new application must continue to adhere to the foreign key constraint.
297−
298−_Example: remove foreign key `items_user_id_fkey` from `users` table_
299−
300−```toml
301−[[actions]]
302−type = "remove_foreign_key"
303−table = "items"
304−foreign_key = "items_user_id_fkey"
305−```
306−
307264### Columns
308265
309266#### Add column
310267
311−The `add_column` action will add a new column to an existing table. You can optionally provide an `up` setting. This should be an SQL expression which will be run for all existing rows to backfill the new column. `up` may also reference another table to perform cross-table migrations (see ["Complex changes across tables"](#complex-changes-across-tables)).
268+The `add_column` action will add a new column to an existing table. You can optionally provide an `up` setting. This should be an SQL expression which will be run for all existing rows to backfill the new column.
312269
313−_Example: add a new column `reference` to table `products`_
270+*Example: add a new column `reference` to table `products`*
314271
315272```toml
316273[[actions]]
@@ -324,7 +281,7 @@ table = "products"
324281 default = "10"
325282```
326283
327−_Example: replace an existing `name` column with two new columns, `first_name` and `last_name`_
284+*Example: replace an existing `name` column with two new columns, `first_name` and `last_name`*
328285
329286```toml
330287[[actions]]
@@ -360,48 +317,14 @@ column = "name"
360317down = "first_name || ' ' || last_name"
361318```
362319
363−_Example: extract nested value from unstructured JSON `data` column to new `name` column_
364−
365−```toml
366−[[actions]]
367−type = "add_column"
368−table = "users"
369−
370−# #>> '{}' converts the JSON string value to TEXT
371−up = "data['path']['to']['value'] #>> '{}'"
372−
373− [actions.column]
374− name = "name"
375− type = "TEXT"
376−```
377−
378−_Example: duplicate `email` column from `users` to `profiles` table_
379−
380−```toml
381−# `profiles` has `user_id` column which maps to `users.id`
382−[[actions]]
383−type = "add_column"
384−table = "profiles"
385−
386− [actions.column]
387− name = "email"
388− type = "TEXT"
389− nullable = false
390−
391− # When `users` is updated in the old schema, we write the email value to `profiles`
392− [actions.up]
393− table = "users"
394− value = "email"
395− where = "user_id = id"
396−```
397320
398321#### Alter column
399322
400323The `alter_column` action enables many different changes to an existing column, for example renaming, changing type and changing existing values.
401324
402−When performing more complex changes than a rename, `up` and `down` should be provided. These should be SQL expressions which determine how to transform between the new and old version of the column. Inside those expressions, you can reference the current column value by the column name.
325+When performing more complex changes than a rename, `up` and `down` must be provided. These should be SQL expressions which determine how to transform between the new and old version of the column. Inside those expressions, you can reference the current column value by the column name.
403326
404−_Example: rename `last_name` column on `users` table to `family_name`_
327+*Example: rename `last_name` column on `users` table to `family_name`*
405328
406329```toml
407330[[actions]]
@@ -413,7 +336,7 @@ column = "last_name"
413336 name = "family_name"
414337```
415338
416−_Example: change the type of `reference` column from `INTEGER` to `TEXT`_
339+*Example: change the type of `reference` column from `INTEGER` to `TEXT`*
417340
418341```toml
419342[[actions]]
@@ -428,7 +351,7 @@ down = "CAST(reference AS INTEGER)" # Converts from text value to integer
428351 type = "TEXT" # Previous type was 'INTEGER'
429352```
430353
431−_Example: increment all values of an `index` column by one_
354+*Example: increment all values of an `index` column by one*
432355
433356```toml
434357[[actions]]
@@ -443,22 +366,7 @@ down = "index - 1" # Decrement to revert for old schema
443366 name = "index"
444367```
445368
446−_Example: make `name` column not nullable_
447−
448−```toml
449−[[actions]]
450−type = "alter_column"
451−table = "users"
452−column = "name"
453−
454−# Use "N/A" for any rows that currently have a NULL name
455−up = "COALESCE(name, 'N/A')"
456−
457− [actions.changes]
458− nullable = false
459−```
460−
461−_Example: change default value of `created_at` column to current time_
369+*Example: change default value of `created_at` column to current time*
462370
463371```toml
464372[[actions]]
@@ -472,11 +380,11 @@ column = "created_at"
472380
473381#### Remove column
474382
475−The `remove_column` action will remove an existing column from a table. You can optionally provide a `down` setting. This should be an SQL expression which will be used to determine values for the old schema when inserting or updating rows using the new schema. `down` may also reference another table to perform cross-table migrations (see ["Complex changes across tables"](#complex-changes-across-tables)) . The `down` setting must be provided when the removed column is `NOT NULL` or doesn't have a default value.
383+The `remove_column` action will remove an existing column from a table. You can optionally provide a `down` setting. This should be an SQL expression which will be used to determine values for the old schema when inserting or updating rows using the new schema. The `down` setting must be provided when the removed column is `NOT NULL` or doesn't have a default value.
476384
477385Any indices that cover the column will be removed.
478386
479−_Example: remove column `name` from table `users`_
387+*Example: remove column `name` from table `users`*
480388
481389```toml
482390[[actions]]
@@ -488,34 +396,18 @@ column = "name"
488396down = "'N/A'"
489397```
490398
491−_Example: remove `email` column from `users` table and use column from `profiles` table instead_
492−
493−```toml
494−[[actions]]
495−type = "remove_column"
496−table = "users"
497−column = "email"
498−
499− # Our application will use the `profiles.email` column instead
500− # For backwards compatibility, we will write back to the removed `email` column whenever `profiles` is changed
501− [actions.down]
502− table = "profiles"
503− value = "profiles.email"
504− where = "users.id = profiles.user_id"
505−```
506−
507399### Indices
508400
509401#### Add index
510402
511403The `add_index` action will add a new index to an existing table.
512404
513−_Example: create a `users` table with a unique index on the `name` column_
405+*Example: create a `users` table with a unique index on the `name` column*
514406
515407```toml
516408[[actions]]
517409type = "create_table"
518−name = "users"
410+table = "users"
519411primary_key = "id"
520412
521413 [[actions.columns]]
@@ -539,7 +431,7 @@ table = "users"
539431 unique = true
540432```
541433
542−_Example: add GIN index to `data` column on `products` table_
434+*Example: add GIN index to `data` column on `products` table*
543435
544436```toml
545437[[actions]]
@@ -558,7 +450,7 @@ table = "products"
558450
559451The `remove_index` action will remove an existing index. The index won't actually be removed until the migration is completed.
560452
561−_Example: remove the `name_idx` index_
453+*Example: remove the `name_idx` index*
562454
563455```toml
564456[[actions]]
@@ -572,7 +464,7 @@ index = "name_idx"
572464
573465The `create_enum` action will create a new [enum type](https://www.postgresql.org/docs/current/datatype-enum.html) with the specified values.
574466
575−_Example: add a new `mood` enum type with three possible values_
467+*Example: add a new `mood` enum type with three possible values*
576468
577469```toml
578470[[actions]]
@@ -585,7 +477,7 @@ values = ["happy", "ok", "sad"]
585477
586478The `remove_enum` action will remove an existing [enum type](https://www.postgresql.org/docs/current/datatype-enum.html). Make sure all usages of the enum has been removed before running the migration. The enum will only be removed once the migration is completed.
587479
588−_Example: remove the `mood` enum type_
480+*Example: remove the `mood` enum type*
589481
590482```toml
591483[[actions]]
@@ -593,178 +485,61 @@ type = "remove_enum"
593485enum = "mood"
594486```
595487
596−### Custom
597−
598−The `custom` action lets you create a migration which runs custom SQL. It should be used with great care as it provides no guarantees of zero-downtime and will simply run whatever SQL is provided. Use other actions whenever possible as they are explicitly designed for zero downtime.
599−
600−There are three optional settings available which all accept SQL queries. All queries need to be idempotent, for example by using `IF NOT EXISTS` wherever available.
601−
602−- `start`: run when a migration is started using `reshape migration start`
603−- `complete`: run when a migration is completed using `reshape migration complete`
604−- `abort`: run when a migration is aborted using `reshape migration abort`
605−
606−_Example: enable PostGIS and pg_stat_statements extensions_
607−
608−```toml
609−[[actions]]
610−type = "custom"
611−
612−start = """
613− CREATE EXTENSION IF NOT EXISTS postgis;
614− CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
615−"""
616−
617−abort = """
618− DROP EXTENSION IF EXISTS postgis;
619− DROP EXTENSION IF EXISTS pg_stat_statements;
620−"""
621−```
622−
623−### Complex changes across tables
624−
625−The `up` and `down` options available when creating tables, adding columns and removing columns can also perform more complex changes that span tables.
626−
627−_Example: move `email` column from `users` to `profiles` table_
628−
629−```toml
630−[[actions]]
631−type = "add_column"
632−table = "profiles"
633−
634− [actions.column]
635− name = "email"
636− type = "TEXT"
637− nullable = false
638−
639− # When `users` is updated in the old schema, we write the email value to `profiles`
640− [actions.up]
641− table = "users"
642− value = "users.email"
643− where = "profiles.user_id = users.id"
644−
645−[[actions]]
646−type = "remove_column"
647−table = "users"
648−column = "email"
649−
650− # When `profiles` is changed in the new schema, we write the email address back to the removed column
651− [actions.down]
652− table = "profiles"
653− value = "profiles.email"
654− where = "users.id = profiles.user_id"
655−```
656−
657−_Example: turn a 1:N relationship between `users` and `accounts` into N:M and change the format of the associated `role`_
658−
659−```toml
660−# Add `user_account_connections` as a junction table
661−[[actions]]
662−type = "create_table"
663−name = "user_account_connections"
664−primary_key = ["account_id", "user_id"]
665−
666− [[actions.columns]]
667− name = "account_id"
668− type = "INTEGER"
669−
670− [[actions.columns]]
671− name = "user_id"
672− type = "INTEGER"
673−
674− # `role` is currently stored directly on the `users` table but is part of the relationship
675− [[actions.columns]]
676− name = "role"
677− type = "TEXT"
678− nullable = false
679−
680− # Backfill the new table from `users` and uppercase the `role`
681− [actions.up]
682− table = "users"
683− values = { user_id = "id", account_id = "account_id", role = "UPPER(account_role)" }
684− where = "user_account_connections.user_id = users.id"
685−
686−[[actions]]
687−type = "remove_column"
688−table = "users"
689−column = "account_id"
690−
691− # When `user_account_connections` is updated, we write the `account_id` back to `users`
692− [actions.down]
693− table = "user_account_connections"
694− value = "user_account_connections.account_id"
695− where = "users.id = user_account_connections.user_id"
696−
697−[[actions]]
698−type = "remove_column"
699−table = "users"
700−column = "account_role"
701−
702− # When `user_account_connections` is updated, we write the lowercase role back to `users`
703− [actions.down]
704− table = "user_account_connections"
705− value = "LOWER(user_account_connections.role)"
706− where = "users.id = user_account_connections.user_id"
707−```
708−
709488## Commands and options
710489
711−### `reshape migration start`
490+### `reshape migrate`
712491
713−Starts a new migration, applying all migrations under `migrations/` that haven't yet been applied. After the command has completed, both the old and new schema will be usable at the same time. When you have rolled out the new version of your application which uses the new schema, you should run `reshape migration complete`.
492+Starts a new migration, applying all migrations under `migrations/` that haven't yet been applied. After the command has completed, both the old and new schema will be usable at the same time. When you have rolled out the new version of your application which uses the new schema, you should run `reshape complete`.
714493
715494#### Options
716495
717−_See also [Connection options](#connection-options)_
496+*See also [Connection options](#connection-options)*
718497
719−| Option | Default | Description |
720−| ------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- |
721−| `--complete`, `-c` | `false` | Automatically complete migration after applying it. |
722−| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
498+| Option | Default | Description |
499+| ------ | ------- | ----------- |
500+| `--complete`, `-c` | `false` | Automatically complete migration after applying it. |
501+| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
723502
724−### `reshape migration complete`
503+### `reshape complete`
725504
726−Completes migrations previously started with `reshape migration complete`.
505+Completes migrations previously started with `reshape complete`.
727506
728507#### Options
729508
730509See [Connection options](#connection-options)
731510
732−### `reshape migration abort`
511+### `reshape abort`
733512
734−Aborts any migrations which haven't yet been completed.
513+Aborts any migrations which haven't yet been completed.
735514
736515#### Options
737516
738517See [Connection options](#connection-options)
739518
740−### `reshape schema-query`
519+### `reshape generate-schema-query`
741520
742521Generates the SQL query you need to run in your application before using the database. This command does not require a database connection. Instead it will generate the query based on the latest migration in the `migrations/` directory (or the directories specified by `--dirs`).
743522
744−If your application is written in Rust, we recommend using the [Rust helper library](https://github.com/fabianlindfors/reshape-helper/) instead.
745−
746523The query should look something like `SET search_path TO migration_1_initial_migration`.
747524
748525#### Options
749526
750−| Option | Default | Description |
751−| -------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
527+| Option | Default | Description |
528+| ------ | ------- | ----------- |
752529| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
753530
754531### Connection options
755532
756−The options below can be used with all commands that communicate with Postgres. Use either a [connection URL](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) or specify each connection option individually.
757−
758−All options can also be set using environment variables instead of flags. If a `.env` file exists, then variables will be automatically loaded from there.
533+The options below can be used with all commands that communicate with Postgres. Use either a connection URL or specify each connection option individually.
759534
760−| Option | Default | Environment variable | Description |
761−| ------------ | ----------- | -------------------- | ------------------------------------------- |
762−| `--url` | | `DB_URL` | URL to your Postgres database |
763−| `--host` | `localhost` | `DB_HOST` | Hostname to use when connecting to Postgres |
764−| `--port` | `5432` | `DB_PORT` | Port which Postgres is listening on |
765−| `--database` | `postgres` | `DB_NAME` | Database name |
766−| `--username` | `postgres` | `DB_USERNAME` | Postgres username |
767−| `--password` | `postgres` | `DB_PASSWORD` | Postgres password |
535+| Option | Default | Description |
536+| ------ | ------- | ----------- |
537+| `--url` | | URI to connect to your Postgres database.<br>Can also be provided with the environment variable `DATABASE_URL`. |
538+| `--host` | `localhost` | Hostname to use when connecting to Postgres |
539+| `--port` | `5432` | Port which Postgres is listening on |
540+| `--database` | `postgres` | Database name |
541+| `--username` | `postgres` | Postgres username |
542+| `--password` | `postgres` | Postgres password |
768543
769544## License
770545