@@ -2,56 +2,50 @@
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)!
5+Reshape 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.
66
7−Reshape 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/).
7+Reshape is designed for Postgres 12 and later.
88
9−Designed for Postgres 12 and later.
9+*Note: Reshape is **experimental** and should not be used in production. It can (and probably will) break your application.*
1010
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+ - [Columns](#columns)
25+ - [Add column](#add-column)
26+ - [Alter column](#alter-column)
27+ - [Remove column](#remove-column)
28+ - [Indices](#indices)
29+ - [Add index](#add-index)
30+ - [Remove index](#remove-index)
3831- [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)
32+ - [`reshape migrate`](#reshape-migrate)
33+ - [`reshape complete`](#reshape-complete)
34+ - [`reshape abort`](#reshape-abort)
35+ - [`reshape generate-schema-query`](#reshape-generate-schema-query)
36+ - [Connection options](#connection-options)
4437- [License](#license)
4538
39+
4640## How it works
4741
4842Reshape 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:
4943
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.
44+1. **Start migration** (`reshape migrate`): Sets up views and triggers to ensure both the new and old schema are usable at the same time.
51452. **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.
46+3. **Complete migration** (`reshape complete`): Removes the old schema and any intermediate data and triggers.
5347
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.
48+If the application deployment fails, you should run `reshape abort` which will roll back any changes made by `reshape migrate` without losing data.
5549
5650## Getting started
5751
@@ -63,7 +57,7 @@ Binaries are available for macOS and Linux under [Releases](https://github.com/f
6357
6458#### Cargo
6559
66−Reshape can be installed using [Cargo](https://doc.rust-lang.org/cargo/) (requires Rust 1.58 or later):
60+Reshape can be installed using [Cargo](https://doc.rust-lang.org/cargo/):
6761
6862```shell
6963cargo install reshape
@@ -71,10 +65,10 @@ cargo install reshape
7165
7266#### Docker
7367
74−Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
68+Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
7569
7670```shell
77−docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migration start
71+docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migrate
7872```
7973
8074### Creating your first migration
@@ -103,14 +97,9 @@ This is the equivalent of running `CREATE TABLE users (id INTEGER GENERATED ALWA
10397
10498### Preparing your application
10599
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:
107−
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)
100+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`.
112101
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:
102+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:
114103
115104```python
116105# Example for Python
@@ -123,16 +112,16 @@ db.execute(reshape_schema_query)
123112To create your new `users` table, run:
124113
125114```bash
126−reshape migration start --complete
115+reshape migrate
127116```
128117
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.
118+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`.
130119
131120If 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.
132121
133122### Using during development
134123
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`.
124+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`.
136125
137126## Writing migrations
138127
@@ -167,9 +156,9 @@ Every action has a `type`. The supported types are detailed below.
167156
168157#### Create table
169158
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.
159+The `create_table` action will create a new table with the specified columns, indices and constraints.
171160
172−_Example: create a `customers` table with a few columns and a primary key_
161+*Example: create a `customers` table with a few columns and a primary key*
173162
174163```toml
175164[[actions]]
@@ -187,13 +176,13 @@ primary_key = ["id"]
187176 type = "TEXT"
188177
189178 # Columns default to nullable
190− nullable = false
179+ nullable = false
191180
192181 # default can be any valid SQL value, in this case a string literal
193− default = "'PLACEHOLDER'"
182+ default = "'PLACEHOLDER'"
194183```
195184
196−_Example: create `users` and `items` tables with a foreign key between them_
185+*Example: create `users` and `items` tables with a foreign key between them*
197186
198187```toml
199188[[actions]]
@@ -226,34 +215,11 @@ primary_key = ["id"]
226215 referenced_columns = ["id"]
227216```
228217
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−
252218#### Rename table
253219
254220The `rename_table` action will change the name of an existing table.
255221
256−_Example: change name of `users` table to `customers`_
222+*Example: change name of `users` table to `customers`*
257223
258224```toml
259225[[actions]]
@@ -266,7 +232,7 @@ new_name = "customers"
266232
267233The `remove_table` action will remove an existing table.
268234
269−_Example: remove `users` table_
235+*Example: remove `users` table*
270236
271237```toml
272238[[actions]]
@@ -274,43 +240,13 @@ type = "remove_table"
274240table = "users"
275241```
276242
277−#### Add foreign key
278−
279−The `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.
280−
281−_Example: create foreign key from `items` to `users` table_
282−
283−```toml
284−[[actions]]
285−type = "add_foreign_key"
286−table = "items"
287−
288− [actions.foreign_key]
289− columns = ["user_id"]
290− referenced_table = "users"
291− referenced_columns = ["id"]
292−```
293−
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−
307243### Columns
308244
309245#### Add column
310246
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)).
247+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.
312248
313−_Example: add a new column `reference` to table `products`_
249+*Example: add a new column `reference` to table `products`*
314250
315251```toml
316252[[actions]]
@@ -324,7 +260,7 @@ table = "products"
324260 default = "10"
325261```
326262
327−_Example: replace an existing `name` column with two new columns, `first_name` and `last_name`_
263+*Example: replace an existing `name` column with two new columns, `first_name` and `last_name`*
328264
329265```toml
330266[[actions]]
@@ -360,48 +296,14 @@ column = "name"
360296down = "first_name || ' ' || last_name"
361297```
362298
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−```
397299
398300#### Alter column
399301
400302The `alter_column` action enables many different changes to an existing column, for example renaming, changing type and changing existing values.
401303
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.
304+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.
403305
404−_Example: rename `last_name` column on `users` table to `family_name`_
306+*Example: rename `last_name` column on `users` table to `family_name`*
405307
406308```toml
407309[[actions]]
@@ -413,7 +315,7 @@ column = "last_name"
413315 name = "family_name"
414316```
415317
416−_Example: change the type of `reference` column from `INTEGER` to `TEXT`_
318+*Example: change the type of `reference` column from `INTEGER` to `TEXT`*
417319
418320```toml
419321[[actions]]
@@ -428,7 +330,7 @@ down = "CAST(reference AS INTEGER)" # Converts from text value to integer
428330 type = "TEXT" # Previous type was 'INTEGER'
429331```
430332
431−_Example: increment all values of an `index` column by one_
333+*Example: increment all values of an `index` column by one*
432334
433335```toml
434336[[actions]]
@@ -443,22 +345,7 @@ down = "index - 1" # Decrement to revert for old schema
443345 name = "index"
444346```
445347
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_
348+*Example: change default value of `created_at` column to current time*
462349
463350```toml
464351[[actions]]
@@ -472,11 +359,9 @@ column = "created_at"
472359
473360#### Remove column
474361
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.
476−
477−Any indices that cover the column will be removed.
362+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.
478363
479−_Example: remove column `name` from table `users`_
364+*Example: remove column `name` from table `users`*
480365
481366```toml
482367[[actions]]
@@ -488,34 +373,18 @@ column = "name"
488373down = "'N/A'"
489374```
490375
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−
507376### Indices
508377
509378#### Add index
510379
511380The `add_index` action will add a new index to an existing table.
512381
513−_Example: create a `users` table with a unique index on the `name` column_
382+*Example: create a `users` table with a unique index on the `name` column*
514383
515384```toml
516385[[actions]]
517386type = "create_table"
518−name = "users"
387+table = "users"
519388primary_key = "id"
520389
521390 [[actions.columns]]
@@ -539,7 +408,7 @@ table = "users"
539408 unique = true
540409```
541410
542−_Example: add GIN index to `data` column on `products` table_
411+*Example: add GIN index to `data` column on `products` table*
543412
544413```toml
545414[[actions]]
@@ -558,7 +427,7 @@ table = "products"
558427
559428The `remove_index` action will remove an existing index. The index won't actually be removed until the migration is completed.
560429
561−_Example: remove the `name_idx` index_
430+*Example: remove the `name_idx` index*
562431
563432```toml
564433[[actions]]
@@ -566,205 +435,61 @@ type = "remove_index"
566435index = "name_idx"
567436```
568437
569−### Enums
570−
571−#### Create enum
572−
573−The `create_enum` action will create a new [enum type](https://www.postgresql.org/docs/current/datatype-enum.html) with the specified values.
574−
575−_Example: add a new `mood` enum type with three possible values_
576−
577−```toml
578−[[actions]]
579−type = "create_enum"
580−name = "mood"
581−values = ["happy", "ok", "sad"]
582−```
583−
584−#### Remove enum
585−
586−The `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.
587−
588−_Example: remove the `mood` enum type_
589−
590−```toml
591−[[actions]]
592−type = "remove_enum"
593−enum = "mood"
594−```
595−
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−
709438## Commands and options
710439
711−### `reshape migration start`
440+### `reshape migrate`
712441
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`.
442+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`.
714443
715444#### Options
716445
717−_See also [Connection options](#connection-options)_
446+*See also [Connection options](#connection-options)*
718447
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`. |
448+| Option | Default | Description |
449+| ------ | ------- | ----------- |
450+| `--complete`, `-c` | `false` | Automatically complete migration after applying it. |
451+| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
723452
724−### `reshape migration complete`
453+### `reshape complete`
725454
726−Completes migrations previously started with `reshape migration complete`.
455+Completes migrations previously started with `reshape complete`.
727456
728457#### Options
729458
730459See [Connection options](#connection-options)
731460
732−### `reshape migration abort`
461+### `reshape abort`
733462
734−Aborts any migrations which haven't yet been completed.
463+Aborts any migrations which haven't yet been completed.
735464
736465#### Options
737466
738467See [Connection options](#connection-options)
739468
740−### `reshape schema-query`
469+### `reshape generate-schema-query`
741470
742471Generates 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`).
743472
744−If your application is written in Rust, we recommend using the [Rust helper library](https://github.com/fabianlindfors/reshape-helper/) instead.
745−
746473The query should look something like `SET search_path TO migration_1_initial_migration`.
747474
748475#### Options
749476
750−| Option | Default | Description |
751−| -------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
477+| Option | Default | Description |
478+| ------ | ------- | ----------- |
752479| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
753480
754481### Connection options
755482
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.
483+The options below can be used with all commands that communicate with Postgres. Use either a connection URL or specify each connection option individually.
759484
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 |
485+| Option | Default | Description |
486+| ------ | ------- | ----------- |
487+| `--url` | | URI to connect to your Postgres database.<br>Can also be provided with the environment variable `DATABASE_URL`. |
488+| `--host` | `localhost` | Hostname to use when connecting to Postgres |
489+| `--port` | `5432` | Port which Postgres is listening on |
490+| `--database` | `postgres` | Database name |
491+| `--username` | `postgres` | Postgres username |
492+| `--password` | `postgres` | Postgres password |
768493
769494## License
770495