Skip to content
This repository has been archived by the owner on Nov 6, 2024. It is now read-only.

Commit

Permalink
Merge pull request #31 from mountainash/docs/two-cmds-not-one
Browse files Browse the repository at this point in the history
docs(readabilty): added line return to `$ drizzle-kit introspect:pg`
  • Loading branch information
AndriiSherman authored Apr 15, 2023
2 parents c87713d + 1863c24 commit 263732f
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,11 @@ To easily migrate from previous folder structure to new you need to run `up` com
`--breakpoints` [optional default=false] whether to execute each statement in the migrations individually\

```shell
$ drizzle-kit generate:pg
## runs generate command with drizzle.config.json
$ drizzle-kit generate:pg
## runs generate command with drizzle.config.json

$ drizzle-kit generate:pg --config=./custom.config.json
## runs generate command with custom.config.json
## runs generate command with custom.config.json

$ drizzle-kit generate:pg --schema=./src/schema.ts
## runs generate command and outputs results to ./drizzle
Expand All @@ -151,14 +151,14 @@ $ drizzle-kit generate:pg --schema=./src/schema.ts --out=./migrations/

```shell
$ drizzle-kit generate:pg --custom
## runs generate command and outputs an empty migration for custom SQL
```
## runs generate command and outputs an empty migration for custom SQL
```

### Introspect existing database and generate typescript schema

---

**`$ drizzle-kit introspect:pg`**
**`$ drizzle-kit introspect:pg`** \
**`$ drizzle-kit introspect:mysql`**

```shell
Expand All @@ -174,7 +174,7 @@ drizzle-kit introspect:pg --out=migrations/ --host=0.0.0.0 --port=5432 --user=po
---

**`$ drizzle-kit up:pg`** \
**`$ drizzle-kit up:mysql`**\
**`$ drizzle-kit up:mysql`** \
**`$ drizzle-kit up:sqlite`**

`--out` [optional] migrations folder\
Expand All @@ -184,7 +184,7 @@ drizzle-kit introspect:pg --out=migrations/ --host=0.0.0.0 --port=5432 --user=po
## migrations folder is taken from drizzle.config.json
drizzle-kit up:mysql

drizzle-kit up:mysql --out=migrations/
drizzle-kit up:mysql --out=migrations/
```

![](media/up_mysql.gif)
Expand All @@ -193,7 +193,7 @@ drizzle-kit up:mysql --out=migrations/

---

**`$ drizzle-kit drop`** \
**`$ drizzle-kit drop`**

`--out` [optional] migrations folder\
`--config` [optional default=drizzle.config.json] config file path
Expand All @@ -204,8 +204,8 @@ drizzle-kit up:mysql --out=migrations/

---

**`$ drizzle-kit check:pg`**\
**`$ drizzle-kit check:mysql`**\
**`$ drizzle-kit check:pg`** \
**`$ drizzle-kit check:mysql`** \
**`$ drizzle-kit check:sqlite`**

`--out` [optional] migration folder\
Expand All @@ -215,5 +215,5 @@ drizzle-kit up:mysql --out=migrations/
## migrations folder is taken from drizzle.config.json
drizzle-kit check:pg

drizzle-kit check:pg --out=migrations/
drizzle-kit check:pg --out=migrations/
```

0 comments on commit 263732f

Please sign in to comment.