Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SqlConnectOptions

Connect options for configuring SqlConnection or Pool.

Hierarchy

  • any
    • SqlConnectOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns SqlConnectOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns SqlConnectOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns SqlConnectOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): SqlConnectOptions

  • Parameters

    • enabledSecureTransportProtocols: string

    Returns SqlConnectOptions

addNonProxyHost

  • Parameters

    • nonProxyHosts: string

    Returns SqlConnectOptions

getActivityLogDataFormat

  • getActivityLogDataFormat(): any

  • Returns any

getApplicationLayerProtocols

  • getApplicationLayerProtocols(): string[]

  • Returns string[]

getCachePreparedStatements

  • getCachePreparedStatements(): boolean

  • Set whether prepared statements cache should be enabled.

    Returns boolean

getConnectTimeout

  • getConnectTimeout(): number

  • Returns number

getCrlPaths

  • getCrlPaths(): string[]

  • Returns string[]

getCrlValues

  • getCrlValues(): Buffer[]

  • Returns Buffer[]

getDatabase

  • getDatabase(): string

  • Specify the default database for the connection.

    Returns string

getEnabledCipherSuites

  • getEnabledCipherSuites(): string[]

  • Returns string[]

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string[]

  • Returns string[]

getHost

  • getHost(): string

  • Specify the host for connecting to the server.

    Returns string

getHostnameVerificationAlgorithm

  • getHostnameVerificationAlgorithm(): string

  • Returns string

getIdleTimeout

  • getIdleTimeout(): number

  • Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any

  • Returns any

getJdkSslEngineOptions

  • getJdkSslEngineOptions(): JdkSSLEngineOptions

  • Returns JdkSSLEngineOptions

getKeyStoreOptions

  • getKeyStoreOptions(): JksOptions

  • Returns JksOptions

getLocalAddress

  • getLocalAddress(): string

  • Returns string

getLogActivity

  • getLogActivity(): boolean

  • Returns boolean

getMetricsName

  • getMetricsName(): string

  • Returns string

getNonProxyHosts

  • getNonProxyHosts(): string[]

  • Returns string[]

getOpenSslEngineOptions

  • getOpenSslEngineOptions(): OpenSSLEngineOptions

  • Returns OpenSSLEngineOptions

getPassword

  • getPassword(): string

  • Specify the user password to be used for the authentication.

    Returns string

getPemKeyCertOptions

  • getPemKeyCertOptions(): PemKeyCertOptions

  • Returns PemKeyCertOptions

getPemTrustOptions

  • getPemTrustOptions(): PemTrustOptions

  • Returns PemTrustOptions

getPfxKeyCertOptions

  • getPfxKeyCertOptions(): PfxOptions

  • Returns PfxOptions

getPfxTrustOptions

  • getPfxTrustOptions(): PfxOptions

  • Returns PfxOptions

getPort

  • getPort(): number

  • Specify the port for connecting to the server.

    Returns number

getPreparedStatementCacheMaxSize

  • getPreparedStatementCacheMaxSize(): number

  • Set the maximum number of prepared statements that the connection will cache.

    Returns number

getProperties

  • getProperties(): {}

  • Set properties for this client, which will be sent to server at the connection start.

    Returns {}

    • [key: string]: string

getProxyOptions

  • getProxyOptions(): ProxyOptions

  • Returns ProxyOptions

getReadIdleTimeout

  • getReadIdleTimeout(): number

  • Returns number

getReceiveBufferSize

  • getReceiveBufferSize(): number

  • Returns number

getReconnectAttempts

  • getReconnectAttempts(): number

  • Returns number

getReconnectInterval

  • getReconnectInterval(): number

  • Returns number

getSendBufferSize

  • getSendBufferSize(): number

  • Returns number

getSoLinger

  • getSoLinger(): number

  • Returns number

getSslEngineOptions

  • getSslEngineOptions(): any

  • Returns any

getSslHandshakeTimeout

  • getSslHandshakeTimeout(): number

  • Returns number

getSslHandshakeTimeoutUnit

  • getSslHandshakeTimeoutUnit(): any

  • Returns any

getTcpUserTimeout

  • getTcpUserTimeout(): number

  • Returns number

getTracingPolicy

  • getTracingPolicy(): TracingPolicy

  • Set the tracing policy for the client behavior when Vert.x has tracing enabled.

    Returns TracingPolicy

getTrafficClass

  • getTrafficClass(): number

  • Returns number

getTrustOptions

  • getTrustOptions(): any

  • Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions

  • Returns JksOptions

getUser

  • getUser(): string

  • Specify the user account to be used for the authentication.

    Returns string

getWriteIdleTimeout

  • getWriteIdleTimeout(): number

  • Returns number

isRegisterWriteHandler

  • isRegisterWriteHandler(): boolean

  • Returns boolean

isReuseAddress

  • isReuseAddress(): boolean

  • Returns boolean

isReusePort

  • isReusePort(): boolean

  • Returns boolean

isSsl

  • isSsl(): boolean

  • Returns boolean

isTcpCork

  • isTcpCork(): boolean

  • Returns boolean

isTcpFastOpen

  • isTcpFastOpen(): boolean

  • Returns boolean

isTcpKeepAlive

  • isTcpKeepAlive(): boolean

  • Returns boolean

isTcpNoDelay

  • isTcpNoDelay(): boolean

  • Returns boolean

isTcpQuickAck

  • isTcpQuickAck(): boolean

  • Returns boolean

isTrustAll

  • isTrustAll(): boolean

  • Returns boolean

isUseAlpn

  • isUseAlpn(): boolean

  • Returns boolean

isUsingDomainSocket

  • isUsingDomainSocket(): boolean

  • Returns boolean

setActivityLogDataFormat

  • Parameters

    • activityLogDataFormat: any

    Returns SqlConnectOptions

setApplicationLayerProtocols

  • setApplicationLayerProtocols(applicationLayerProtocols: string[]): SqlConnectOptions

  • Parameters

    • applicationLayerProtocols: string[]

    Returns SqlConnectOptions

setCachePreparedStatements

  • Set whether prepared statements cache should be enabled.

    Parameters

    • cachePreparedStatements: boolean

    Returns SqlConnectOptions

setConnectTimeout

  • Parameters

    • connectTimeout: number

    Returns SqlConnectOptions

setDatabase

  • Specify the default database for the connection.

    Parameters

    • database: string

    Returns SqlConnectOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): SqlConnectOptions

  • Parameters

    • enabledSecureTransportProtocols: string[]

    Returns SqlConnectOptions

setHost

  • Specify the host for connecting to the server.

    Parameters

    • host: string

    Returns SqlConnectOptions

setHostnameVerificationAlgorithm

  • setHostnameVerificationAlgorithm(hostnameVerificationAlgorithm: string): SqlConnectOptions

  • Parameters

    • hostnameVerificationAlgorithm: string

    Returns SqlConnectOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns SqlConnectOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns SqlConnectOptions

setJdkSslEngineOptions

  • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): SqlConnectOptions

  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns SqlConnectOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns SqlConnectOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns SqlConnectOptions

setLocalAddress

  • Parameters

    • localAddress: string

    Returns SqlConnectOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns SqlConnectOptions

setMetricsName

  • Parameters

    • metricsName: string

    Returns SqlConnectOptions

setNonProxyHosts

  • Parameters

    • nonProxyHosts: string[]

    Returns SqlConnectOptions

setOpenSslEngineOptions

  • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): SqlConnectOptions

  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns SqlConnectOptions

setPassword

  • Specify the user password to be used for the authentication.

    Parameters

    • password: string

    Returns SqlConnectOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns SqlConnectOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns SqlConnectOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns SqlConnectOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns SqlConnectOptions

setPort

  • Specify the port for connecting to the server.

    Parameters

    • port: number

    Returns SqlConnectOptions

setPreparedStatementCacheMaxSize

  • setPreparedStatementCacheMaxSize(preparedStatementCacheMaxSize: number): SqlConnectOptions

  • Set the maximum number of prepared statements that the connection will cache.

    Parameters

    • preparedStatementCacheMaxSize: number

    Returns SqlConnectOptions

setPreparedStatementCacheSqlLimit

  • setPreparedStatementCacheSqlLimit(preparedStatementCacheSqlLimit: number): SqlConnectOptions

  • Set the maximum length of prepared statement SQL string that the connection will cache.

    This is an helper setting the SqlConnectOptions.

    Parameters

    • preparedStatementCacheSqlLimit: number

    Returns SqlConnectOptions

setProperties

  • Set properties for this client, which will be sent to server at the connection start.

    Parameters

    • properties: {}
      • [key: string]: string

    Returns SqlConnectOptions

setProxyOptions

  • Parameters

    • proxyOptions: ProxyOptions

    Returns SqlConnectOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns SqlConnectOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns SqlConnectOptions

setReconnectAttempts

  • Parameters

    • reconnectAttempts: number

    Returns SqlConnectOptions

setReconnectInterval

  • Parameters

    • reconnectInterval: number

    Returns SqlConnectOptions

setRegisterWriteHandler

  • Parameters

    • registerWriteHandler: boolean

    Returns SqlConnectOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns SqlConnectOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns SqlConnectOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns SqlConnectOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns SqlConnectOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns SqlConnectOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns SqlConnectOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns SqlConnectOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns SqlConnectOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns SqlConnectOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns SqlConnectOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns SqlConnectOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns SqlConnectOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns SqlConnectOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns SqlConnectOptions

setTracingPolicy

  • Set the tracing policy for the client behavior when Vert.x has tracing enabled.

    Parameters

    • tracingPolicy: TracingPolicy

    Returns SqlConnectOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns SqlConnectOptions

setTrustAll

  • Parameters

    • trustAll: boolean

    Returns SqlConnectOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns SqlConnectOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns SqlConnectOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns SqlConnectOptions

setUser

  • Specify the user account to be used for the authentication.

    Parameters

    • user: string

    Returns SqlConnectOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns SqlConnectOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc