chore: Deprecate extra in favor of driver options (#6772)

**What**
Deprecate databse_extra in favor of database_driver_options

Co-authored-by: Sebastian Rindom <7554214+srindom@users.noreply.github.com>
This commit is contained in:
Adrien de Peretti
2024-03-21 14:45:11 +00:00
committed by GitHub
co-authored by Sebastian Rindom
parent 56481e683d
commit 1ef9c78cea
8 changed files with 64 additions and 14 deletions
@@ -355,6 +355,41 @@ export type ProjectConfigOptions = {
}
}
/**
* An object that includes additional configurations to pass to the database connection for v2. You can pass any configuration. One defined configuration to pass is
* `ssl` which enables support for TLS/SSL connections.
*
* This is useful for production databases, which can be supported by setting the `rejectUnauthorized` attribute of `ssl` object to `false`.
* During development, its recommended not to pass this option.
*
* @example
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* database_driver_options:
* process.env.NODE_ENV !== "development"
* ? { connection: { ssl: { rejectUnauthorized: false } } }
* : {},
* // ...
* },
* // ...
* }
* ```
*/
database_driver_options?: Record<string, unknown> & {
connection?: {
/**
* Configure support for TLS/SSL connection
*/
ssl?: {
/**
* Whether to fail connection if the server certificate is verified against the list of supplied CAs and the hostname and no match is found.
*/
rejectUnauthorized?: false
}
}
}
/**
* Used to specify the URL to connect to Redis. This is only used for scheduled jobs. If you omit this configuration, scheduled jobs won't work.
*
+3 -1
View File
@@ -254,7 +254,9 @@ export interface ModuleServiceInitializeOptions {
user?: string
password?: string
database?: string
driverOptions?: Record<string, unknown>
driverOptions?: Record<string, unknown> & {
connection?: Record<string, unknown>
}
debug?: boolean
pool?: Record<string, unknown>
}