archive-gh-me/typeorm
1
0
Fork 0
mirror of https://github.com/typeorm/typeorm.git synced 2025-12-08 21:26:23 +00:00
Code Issues Projects Releases Wiki Activity

docs: add note about using YugabyteDB to docs (#11521)

Browse Source
This commit is contained in:
Mike Guida 2025-06-11 13:36:23 -06:00 committed by GitHub
parent 86f12c9226
commit 42913b95d7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/data-source/2-data-source-options.md
View File

@ -152,6 +152,10 @@ Different RDBMS-es have their own specific options.
## `postgres` / `cockroachdb` data source options
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.
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.
- `url` - Connection url where the connection is performed. Please note that other data source options will override parameters set from url.
- `host` - Database host.