Allows to setup cache options.
CLI settings.
Connection timeout in ms (default: 15000).
Database name to connect to.
Once you set domain, driver will connect to SQL Server using domain login.
Drops the schema each time connection is being established. Be careful with this option and don't use this in production - otherwise you'll lose all production data. This option is useful during debug and development.
Entities to be loaded for this connection. Accepts both entity classes and directories where from entities need to be loaded. Directories support glob patterns.
Prefix to use on all tables (collections) of this connection in the database.
Extra connection options to be passed to the underlying driver.
todo: deprecate this and move all database-specific types into hts own connection options object.
Database host.
Logger instance used to log queries and events in the ORM.
Logging options.
Maximum number of milliseconds query should be executed before logger log a warning.
Migrations to be loaded for this connection. Accepts both migration classes and directories where from migrations need to be loaded. Directories support glob patterns.
Indicates if migrations should be auto run on every application launch. Alternative to it, you can use CLI and run migrations:run command.
Migrations table name, in case of different name from "migrations". Accepts single string name.
Connection name. If connection name is not given then it will be called "default". Different connections must have different names.
Naming strategy to be used to name tables and columns in the database.
Extra options
Database password.
An optional object/dictionary with the any of the properties
Database host port.
Replication setup.
Request timeout in ms (default: 15000). NOTE: msnodesqlv8 driver doesn't support timeouts < 1 second.
Database schema.
Stream recordsets/rows instead of returning them all at once as an argument of callback (default: false). You can also enable streaming for each request independently (request.stream = true). Always set to true if you plan to work with large amount of rows.
Subscribers to be loaded for this connection. Accepts both subscriber classes and directories where from subscribers need to be loaded. Directories support glob patterns.
Indicates if database schema should be auto created on every application launch. Be careful with this option and don't use this in production - otherwise you can lose production data. This option is useful during debug and development. Alternative to it, you can use CLI and run schema:sync command.
Note that for MongoDB database it does not create schema, because MongoDB is schemaless. Instead, it syncs just by creating indices.
Database type.
Connection url where perform connection to.
Database username.
Generated using TypeDoc
Microsoft Sql Server specific connection options.