Properties
Optional acquireConnectionTimeout
acquireConnectionTimeout: undefined | number
Optional additionalProperties
additionalProperties: undefined | {}
Optional asyncStackTraces
asyncStackTraces: undefined | boolean
Optional client
client: undefined | string | typeof Client
Optional columnNameCasing
columnNameCasing: undefined | "pascal" | "camel"
Optional connection
connection: undefined | string | ConnectionConfig | MariaSqlConnectionConfig | MySqlConnectionConfig | MySql2ConnectionConfig | MsSqlConnectionConfig | OracleDbConnectionConfig | PgConnectionConfig | Sqlite3ConnectionConfig | SocketConnectionConfig | SyncConnectionConfigProvider | AsyncConnectionConfigProvider
Optional debug
debug: undefined | boolean
Optional dialect
dialect: undefined | string
Optional enumNameCasing
enumNameCasing: undefined | "pascal" | "camel"
Optional excludedTables
excludedTables: undefined | string[]
Optional extends
extends: undefined | {}
Optional filename
filename: undefined | string
Optional folder
folder: undefined | string
Optional interfaceNameFormat
interfaceNameFormat: undefined | string
Optional log
log: undefined | Logger
Optional migrations
migrations: undefined | MigratorConfig
Optional pool
pool: undefined | PoolConfig
Optional postProcessResponse
postProcessResponse: undefined | ((result: any, queryContext: any) => any)
Optional schemaAsNamespace
schemaAsNamespace: undefined | boolean
Optional schemas
schemas: undefined | string[]
Optional searchPath
searchPath: undefined | string | readonly string[]
Optional seeds
seeds: undefined | SeederConfig<any>
Optional singularTableNames
singularTableNames: undefined | boolean
Optional tableNameCasing
tableNameCasing: undefined | "pascal" | "camel"
Optional tables
tables: undefined | string[]
Optional template
template: undefined | string
Optional typeMap
typeMap: undefined | {}
Optional typeOverrides
typeOverrides: undefined | {}
Optional useNullAsDefault
useNullAsDefault: undefined | boolean
Optional version
version: undefined | string
Optional wrapIdentifier
wrapIdentifier: undefined | ((value: string, origImpl: (value: string) => string, queryContext: any) => string)
The configuration file for creating new databases.
Config