SqlConnectionInfo interface

Information for connecting to SQL database server

Properties

additionalSettings

Additional connection settings

authentication

Authentication type to use for connection. Possible values include: 'None', 'WindowsAuthentication', 'SqlAuthentication', 'ActiveDirectoryIntegrated', 'ActiveDirectoryPassword'

dataSource

Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber

encryptConnection

Whether to encrypt the connection. Default value: true.

password

Password credential.

platform

Server platform type for connection. Possible values include: 'SqlOnPrem'

trustServerCertificate

Whether to trust the server certificate. Default value: false.

type

Polymorphic Discriminator

userName

User name

Property Details

additionalSettings

Additional connection settings

additionalSettings?: string

Property Value

string

authentication

Authentication type to use for connection. Possible values include: 'None', 'WindowsAuthentication', 'SqlAuthentication', 'ActiveDirectoryIntegrated', 'ActiveDirectoryPassword'

authentication?: AuthenticationType

Property Value

dataSource

Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber

dataSource: string

Property Value

string

encryptConnection

Whether to encrypt the connection. Default value: true.

encryptConnection?: boolean

Property Value

boolean

password

Password credential.

password?: string

Property Value

string

platform

Server platform type for connection. Possible values include: 'SqlOnPrem'

platform?: "SqlOnPrem"

Property Value

"SqlOnPrem"

trustServerCertificate

Whether to trust the server certificate. Default value: false.

trustServerCertificate?: boolean

Property Value

boolean

type

Polymorphic Discriminator

type: "SqlConnectionInfo"

Property Value

"SqlConnectionInfo"

userName

User name

userName?: string

Property Value

string