Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kristiandupont committed Dec 20, 2024
1 parent 89a2760 commit 8a165d4
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs-src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ run();

The generated output is a record of schemas, described with the [Schema](/api/extract-pg-schema.schema.html) type.

## pglite

The `connection` parameter can either be an object like shown above or a connection string. If the connection string starts with "file:" the specified path is opened using pglite. For example, when providing `file:my/pglite/db/folder`, the folder `'my/pglite/db/folder'` is opened using pglite.

## CLI Usage

You can also use the CLI to extract the schemas from a database and write it to the console or a file in JSON format.
Expand Down

0 comments on commit 8a165d4

Please sign in to comment.