Skip to content

Commit 42913b9

Browse files
authored
docs: add note about using YugabyteDB to docs (#11521)
1 parent 86f12c9 commit 42913b9

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/docs/data-source/2-data-source-options.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,10 @@ Different RDBMS-es have their own specific options.
152152

153153
## `postgres` / `cockroachdb` data source options
154154

155+
PostgreSQL and CockroachDB are supported as TypeORM drivers. Databases that are PostgreSQL-compatible can also be used with TypeORM via the `postgres` data source option.
156+
157+
To use YugabyteDB, refer to [their ORM docs](https://docs.yugabyte.com/stable/drivers-orms/nodejs/typeorm/) to get started. Note that because some postgres features are [not supported](https://docs.yugabyte.com/stable/develop/postgresql-compatibility/#unsupported-postgresql-features) by YugabyteDB, some TypeORM functionality may be limited.
158+
155159
- `url` - Connection url where the connection is performed. Please note that other data source options will override parameters set from url.
156160

157161
- `host` - Database host.

0 commit comments

Comments
 (0)