Config Keys

This list is generated from module default configuration files.

Key	Default	Environment	Description	Source
db.configuration	"mysql"	DATABASE_CONFIGURATION	The default database configuration to be used in the application. The framework can support multiple database configurations that can be accessed at runtime as needed. If you don't want to use a database connection, set this value to empty. /	db.ts
db.mysql	—	—	For the other database connection types supported by the framework we can set the database connection parameters like the object below. /	db.ts
db.mysql.engine	"mysql2",	—	The database engine you want to use to connect to a database server. /	db.ts
db.mysql.hostname	"localhost"	DATABASE_MYSQL_HOSTNAME	The address of the database server. /	db.ts
db.mysql.port	3306	DATABASE_MYSQL_PORT	The port on which the database server is exposed. /	db.ts
db.mysql.username	"root"	DATABASE_MYSQL_USERNAME	The user used to connect to the database server. /	db.ts
db.mysql.password	""	DATABASE_MYSQL_PASSWORD	The password used to connect to the database server. /	db.ts
db.mysql.database	"quik"	DATABASE_MYSQL_DATABASE	The name of the database you want to use for your application. /	db.ts
db.mysql.supportBigNumbers	—	DATABASE_MYSQL_SUPPORT_BIG_NUMBERS	When using the `mysql` engine, the bigint numbers are treated as integers by default. If you don't want to expose these numbers as integers, set this flag to `true`. /	db.ts
db.mysql.bigNumberStrings	—	DATABASE_MYSQL_BIG_NUMBERS_STRING	MySQL connection configuration.	db.ts
db.mysql.timezone	"Z"	DATABASE_MYSQL_TIMEZONE	When working with timestamps and date columns, you might want to store the data in the same timezone in the whole application. As a recommendation we suggest to keep it in UTC (or Z). /	db.ts
db.postgres	—	—	For the other database connection types supported by the framework we can set the database connection parameters like the object below. /	db.ts
db.postgres.engine	"postgres",	—	The database engine you want to use to connect to a database server. /	db.ts
db.postgres.hostname	"localhost"	DATABASE_POSTGRES_HOSTNAME	The address of the database server. /	db.ts
db.postgres.port	5432	DATABASE_POSTGRES_PORT	The port on which the database server is exposed. /	db.ts
db.postgres.username	"postgres"	DATABASE_POSTGRES_USERNAME	The user used to connect to the database server. /	db.ts
db.postgres.password	"postgres"	DATABASE_POSTGRES_PASSWORD	The password used to connect to the database server. /	db.ts
db.postgres.database	"quik"	DATABASE_POSTGRES_DATABASE	The name of the database you want to use for your application. /	db.ts
db.postgres.schema	"public"	DATABASE_POSTGRES_SCHEMA	The name of the schema from the database you want to use for your application. /	db.ts
db.sqlite	—	—	For tests or lightweight development we can use a SQLite database. /	db.ts
db.sqlite.engine	"better-sqlite3",	—	The database engine used by Knex. /	db.ts
db.sqlite.filename	":memory:"	DATABASE_SQLITE_FILENAME	The SQLite database filename. /	db.ts
db.logging	—	DATABASE_LOGGING	Enable database logging. Boolean flag (defaults to false when unset).	db.ts
db.debug	—	DATABASE_DEBUGGING	Enable database debug mode. Boolean flag (defaults to false when unset).	db.ts
db.migrations	—	—	Configuration value.	db.ts
db.migrations.enabled	false,	—	Configuration value.	db.ts
db.migrations.table	"_qMigration",	—	Configuration value.	db.ts
db.migrations.snapshotFile	"./migrations/.schema-snapshot.json"	DATABASE_MIGRATIONS_SNAPSHOT_FILE	Path to the schema snapshot file `migration:generate` reads/writes to detect changes in registered `@Model()` classes. Covers every registered model, not just one module's. /	db.ts