ClientConfiguration

The configuration object passed to new SqbClient(config). See Creating a Client for the full guide, including the dialect/driver resolution rules.

interface ClientConfiguration {
  dialect?: string;
  driver?: string;
  name?: string;
  host?: string;
  port?: number;
  user?: string;
  password?: string;
  database?: string;
  schema?: string;
  driverOptions?: any;
  pool?: PoolConfiguration;
  defaults?: ClientDefaults;
}

Field	Type	Description
dialect	string	SQL dialect to resolve a registered Adapter for. One of dialect/driver is required.
driver	string	Driver package name to resolve a registered Adapter for. One of dialect/driver is required.
name	string	An arbitrary connection name.
host	string	Database server address.
port	number	Database listener port.
user	string	Database username.
password	string	Database password.
database	string	Database name.
schema	string	Database schema to use — see Schemas.
driverOptions	any	Extra options passed straight through to the underlying driver.
pool	PoolConfiguration	Connection pool tuning.
defaults	ClientDefaults	Default values applied to every query executed through this client.