Skip to main content

Environment Variables

Boolean flags default to false when unset.

VariableTypeDefaultConfig KeysDescriptionSource
DATABASE_CONFIGURATIONstring"mysql"db.configurationThe 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
DATABASE_DEBUGGINGflagdb.debugEnable database debug mode. Config key: `db.debug`.db.ts
DATABASE_LOGGINGflagdb.loggingEnable database logging. Config key: `db.logging`.db.ts
DATABASE_MIGRATIONS_SNAPSHOT_FILEstring"./migrations/.schema-snapshot.json"db.migrations.snapshotFilecomputeddb.ts
DATABASE_MYSQL_BIG_NUMBERS_STRINGflagdb.mysql.bigNumberStringsMySQL connection setting. Config key: `db.mysql.bigNumberStrings`.db.ts
DATABASE_MYSQL_DATABASEstring"quik"db.mysql.databaseThe name of the database you want to use for your application. /db.ts
DATABASE_MYSQL_HOSTNAMEstring"localhost"db.mysql.hostnameThe address of the database server. /db.ts
DATABASE_MYSQL_PASSWORDstring""db.mysql.passwordThe password used to connect to the database server. /db.ts
DATABASE_MYSQL_PORTint3306db.mysql.portThe port on which the database server is exposed. /db.ts
DATABASE_MYSQL_SUPPORT_BIG_NUMBERSflagdb.mysql.supportBigNumbersWhen 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
DATABASE_MYSQL_TIMEZONEstring"Z"db.mysql.timezonecomputeddb.ts
DATABASE_MYSQL_USERNAMEstring"root"db.mysql.usernameThe user used to connect to the database server. /db.ts
DATABASE_POSTGRES_DATABASEstring"quik"db.postgres.databaseThe name of the database you want to use for your application. /db.ts
DATABASE_POSTGRES_HOSTNAMEstring"localhost"db.postgres.hostnameThe address of the database server. /db.ts
DATABASE_POSTGRES_PASSWORDstring"postgres"db.postgres.passwordThe password used to connect to the database server. /db.ts
DATABASE_POSTGRES_PORTint5432db.postgres.portThe port on which the database server is exposed. /db.ts
DATABASE_POSTGRES_SCHEMAstring"public"db.postgres.schemaThe name of the schema from the database you want to use for your application. /db.ts
DATABASE_POSTGRES_USERNAMEstring"postgres"db.postgres.usernameThe user used to connect to the database server. /db.ts
DATABASE_SQLITE_FILENAMEstring":memory:"db.sqlite.filenameThe SQLite database filename. /db.ts