mirror of
https://github.com/typeorm/typeorm.git
synced 2025-12-08 21:26:23 +00:00
docs: fix connection options description (#10935)
This commit is contained in:
parent
54bed9d56d
commit
2844cbc7c8
@ -103,7 +103,7 @@ Different RDBMS-es have their own specific options.
|
||||
|
||||
## `mysql` / `mariadb` data source options
|
||||
|
||||
- `url` - Connection url where perform connection to. Please note that other data source options will override parameters set from url.
|
||||
- `url` - Connection url where the connection is performed. Please note that other data source options will override parameters set from url.
|
||||
|
||||
- `host` - Database host.
|
||||
|
||||
@ -164,7 +164,7 @@ Different RDBMS-es have their own specific options.
|
||||
|
||||
## `postgres` / `cockroachdb` data source options
|
||||
|
||||
- `url` - Connection url where perform connection to. Please note that other data source options will override parameters set from url.
|
||||
- `url` - Connection url where the connection is performed. Please note that other data source options will override parameters set from url.
|
||||
|
||||
- `host` - Database host.
|
||||
|
||||
@ -244,7 +244,7 @@ Different RDBMS-es have their own specific options.
|
||||
## `mssql` data source options
|
||||
Based on [tedious](https://tediousjs.github.io/node-mssql/) MSSQL implementation. See [SqlServerConnectionOptions.ts](..\src\driver\sqlserver\SqlServerConnectionOptions.ts) for details on exposed attributes.
|
||||
|
||||
- `url` - Connection url where perform connection to. Please note that other data source options will override parameters set from url.
|
||||
- `url` - Connection url where the connection is performed. Please note that other data source options will override parameters set from url.
|
||||
|
||||
- `host` - Database host.
|
||||
|
||||
@ -398,7 +398,7 @@ Based on [tedious](https://tediousjs.github.io/node-mssql/) MSSQL implementation
|
||||
|
||||
## `mongodb` data source options
|
||||
|
||||
- `url` - Connection url where perform connection to. Please note that other data source options will override parameters set from url.
|
||||
- `url` - Connection url where the connection is performed. Please note that other data source options will override parameters set from url.
|
||||
|
||||
- `host` - Database host.
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
*/
|
||||
export interface AuroraMysqlConnectionCredentialsOptions {
|
||||
/**
|
||||
* Connection url where perform connection to.
|
||||
* Connection url where the connection is performed.
|
||||
*/
|
||||
readonly url?: string
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ import { TlsOptions } from "tls"
|
||||
*/
|
||||
export interface CockroachConnectionCredentialsOptions {
|
||||
/**
|
||||
* Connection url where perform connection to.
|
||||
* Connection url where the connection is performed.
|
||||
*/
|
||||
readonly url?: string
|
||||
|
||||
|
||||
@ -46,7 +46,7 @@ export interface CockroachConnectionOptions
|
||||
readonly master: CockroachConnectionCredentialsOptions
|
||||
|
||||
/**
|
||||
* List of read-from severs (slaves).
|
||||
* List of read-from servers (slaves).
|
||||
*/
|
||||
readonly slaves: CockroachConnectionCredentialsOptions[]
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ export interface MongoConnectionOptions extends BaseDataSourceOptions {
|
||||
readonly type: "mongodb"
|
||||
|
||||
/**
|
||||
* Connection url where perform connection to.
|
||||
* Connection url where the connection is performed.
|
||||
*/
|
||||
readonly url?: string
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
*/
|
||||
export interface MysqlConnectionCredentialsOptions {
|
||||
/**
|
||||
* Connection url where perform connection to.
|
||||
* Connection url where the connection is performed.
|
||||
*/
|
||||
readonly url?: string
|
||||
|
||||
|
||||
@ -119,7 +119,7 @@ export interface MysqlConnectionOptions
|
||||
readonly master: MysqlConnectionCredentialsOptions
|
||||
|
||||
/**
|
||||
* List of read-from severs (slaves).
|
||||
* List of read-from servers (slaves).
|
||||
*/
|
||||
readonly slaves: MysqlConnectionCredentialsOptions[]
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
*/
|
||||
export interface OracleConnectionCredentialsOptions {
|
||||
/**
|
||||
* Connection url where perform connection to.
|
||||
* Connection url where the connection is performed.
|
||||
*/
|
||||
readonly url?: string
|
||||
|
||||
|
||||
@ -54,7 +54,7 @@ export interface OracleConnectionOptions
|
||||
readonly master: OracleConnectionCredentialsOptions
|
||||
|
||||
/**
|
||||
* List of read-from severs (slaves).
|
||||
* List of read-from servers (slaves).
|
||||
*/
|
||||
readonly slaves: OracleConnectionCredentialsOptions[]
|
||||
}
|
||||
|
||||
@ -5,7 +5,7 @@ import { TlsOptions } from "tls"
|
||||
*/
|
||||
export interface PostgresConnectionCredentialsOptions {
|
||||
/**
|
||||
* Connection url where perform connection to.
|
||||
* Connection url where the connection is performed.
|
||||
*/
|
||||
readonly url?: string
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@ export interface PostgresConnectionOptions
|
||||
readonly master: PostgresConnectionCredentialsOptions
|
||||
|
||||
/**
|
||||
* List of read-from severs (slaves).
|
||||
* List of read-from servers (slaves).
|
||||
*/
|
||||
readonly slaves: PostgresConnectionCredentialsOptions[]
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
*/
|
||||
export interface SpannerConnectionCredentialsOptions {
|
||||
/**
|
||||
* Connection url where perform connection to.
|
||||
* Connection url where the connection is performed.
|
||||
*/
|
||||
readonly instanceId?: string
|
||||
|
||||
|
||||
@ -116,7 +116,7 @@ export interface SpannerConnectionOptions
|
||||
readonly master: SpannerConnectionCredentialsOptions
|
||||
|
||||
/**
|
||||
* List of read-from severs (slaves).
|
||||
* List of read-from servers (slaves).
|
||||
*/
|
||||
readonly slaves: SpannerConnectionCredentialsOptions[]
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ export type SqlServerConnectionCredentialsAuthenticationOptions =
|
||||
*/
|
||||
export interface SqlServerConnectionCredentialsOptions {
|
||||
/**
|
||||
* Connection url where perform connection to.
|
||||
* Connection url where the connection is performed.
|
||||
*/
|
||||
readonly url?: string
|
||||
|
||||
|
||||
@ -302,7 +302,7 @@ export interface SqlServerConnectionOptions
|
||||
readonly master: SqlServerConnectionCredentialsOptions
|
||||
|
||||
/**
|
||||
* List of read-from severs (slaves).
|
||||
* List of read-from servers (slaves).
|
||||
*/
|
||||
readonly slaves: SqlServerConnectionCredentialsOptions[]
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user