Skip to content

@tsdrivers/mssql / MssqlConfig

Interface: MssqlConfig ​

Defined in: projects/ts-mssql/core/types.ts:97

Properties ​

authentication? ​

optional authentication: object

Defined in: projects/ts-mssql/core/types.ts:101

options? ​

optional options: object

options.clientId? ​

optional clientId: string

options.clientSecret? ​

optional clientSecret: string

options.domain? ​

optional domain: string

options.password? ​

optional password: string

options.tenantId? ​

optional tenantId: string

options.token? ​

optional token: string

options.userName? ​

optional userName: string

type ​

type: "windows" | "default" | "ntlm" | "azure-active-directory-password" | "azure-active-directory-access-token" | "azure-active-directory-default" | "azure-active-directory-service-principal-secret"


database? ​

optional database: string

Defined in: projects/ts-mssql/core/types.ts:100


options? ​

optional options: object

Defined in: projects/ts-mssql/core/types.ts:122

appName? ​

optional appName: string

connectTimeout? ​

optional connectTimeout: number

encrypt? ​

optional encrypt: boolean

instanceName? ​

optional instanceName: string

packetSize? ​

optional packetSize: number

requestTimeout? ​

optional requestTimeout: number

trustServerCertificate? ​

optional trustServerCertificate: boolean


pool? ​

optional pool: object

Defined in: projects/ts-mssql/core/types.ts:131

idleTimeoutMillis? ​

optional idleTimeoutMillis: number

max? ​

optional max: number

min? ​

optional min: number


port? ​

optional port: number

Defined in: projects/ts-mssql/core/types.ts:99


server ​

server: string

Defined in: projects/ts-mssql/core/types.ts:98


tokenProvider()? ​

optional tokenProvider: () => Promise<string>

Defined in: projects/ts-mssql/core/types.ts:121

Async function that returns an Azure AD access token. Used with azure-active-directory-default and service-principal-secret types.

Returns ​

Promise<string>