Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OracleConnectOptions

Hierarchy

  • any
    • OracleConnectOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns OracleConnectOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns OracleConnectOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns OracleConnectOptions

addEnabledSecureTransportProtocol

  • Parameters

    • enabledSecureTransportProtocols: string

    Returns OracleConnectOptions

addNonProxyHost

  • Parameters

    • nonProxyHosts: string

    Returns OracleConnectOptions

getActivityLogDataFormat

  • getActivityLogDataFormat(): any

  • Returns any

getApplicationLayerProtocols

  • getApplicationLayerProtocols(): string[]

  • Returns string[]

getCachePreparedStatements

  • getCachePreparedStatements(): boolean

  • Returns boolean

getConnectTimeout

  • getConnectTimeout(): number

  • Returns number

getCrlPaths

  • getCrlPaths(): string[]

  • Returns string[]

getCrlValues

  • getCrlValues(): Buffer[]

  • Returns Buffer[]

getDatabase

  • getDatabase(): string

  • Set the database name. If set, the client will build an Oracle connection URL in the EZConnect format using the database value as service name.

    Returns string

getEnabledCipherSuites

  • getEnabledCipherSuites(): string[]

  • Returns string[]

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string[]

  • Returns string[]

getHost

  • getHost(): string

  • Returns string

getHostnameVerificationAlgorithm

  • getHostnameVerificationAlgorithm(): string

  • Returns string

getIdleTimeout

  • getIdleTimeout(): number

  • Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any

  • Returns any

getInstanceName

  • getInstanceName(): string

  • Set the Oracle instance name.

    Returns string

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

  • 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

  • Returns number

getPreparedStatementCacheMaxSize

  • getPreparedStatementCacheMaxSize(): number

  • Returns number

getPreparedStatementCacheSqlFilter

  • getPreparedStatementCacheSqlFilter(): any

  • Returns any

getProperties

  • getProperties(): {}

  • 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

getServerMode

  • Set the server connection mode.

    Returns ServerMode

getServiceId

  • getServiceId(): string

  • Set the Oracle service identifier (SID). If set, the client will build an Oracle connection URL using SID instead of the EZConnect format.

    Returns string

getServiceName

  • getServiceName(): string

  • Set the Oracle service name. If set, the client will build an Oracle connection URL in the EZConnect format.

    Returns string

getSoLinger

  • getSoLinger(): number

  • Returns number

getSocketAddress

  • getSocketAddress(): SocketAddress

  • Returns SocketAddress

getSslEngineOptions

  • getSslEngineOptions(): any

  • Returns any

getSslHandshakeTimeout

  • getSslHandshakeTimeout(): number

  • Returns number

getSslHandshakeTimeoutUnit

  • getSslHandshakeTimeoutUnit(): any

  • Returns any

getTcpUserTimeout

  • getTcpUserTimeout(): number

  • Returns number

getTnsAdmin

  • getTnsAdmin(): string

  • Set the path of the directory that contains the tnsnames.ora file.

    Returns string

getTnsAlias

  • getTnsAlias(): string

  • Set the name of an alias configured in the tnsnames.ora file.

    Returns string

getTracingPolicy

  • getTracingPolicy(): TracingPolicy

  • Returns TracingPolicy

getTrafficClass

  • getTrafficClass(): number

  • Returns number

getTrustOptions

  • getTrustOptions(): any

  • Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions

  • Returns JksOptions

getUser

  • getUser(): string

  • 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 OracleConnectOptions

setApplicationLayerProtocols

  • Parameters

    • applicationLayerProtocols: string[]

    Returns OracleConnectOptions

setCachePreparedStatements

  • Parameters

    • cachePreparedStatements: boolean

    Returns OracleConnectOptions

setConnectTimeout

  • Parameters

    • connectTimeout: number

    Returns OracleConnectOptions

setDatabase

  • Set the database name. If set, the client will build an Oracle connection URL in the EZConnect format using the database value as service name.

    Parameters

    • database: string

    Returns OracleConnectOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): OracleConnectOptions

  • Parameters

    • enabledSecureTransportProtocols: string[]

    Returns OracleConnectOptions

setHost

  • Parameters

    • host: string

    Returns OracleConnectOptions

setHostnameVerificationAlgorithm

  • Parameters

    • hostnameVerificationAlgorithm: string

    Returns OracleConnectOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns OracleConnectOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns OracleConnectOptions

setInstanceName

  • Set the Oracle instance name.

    Parameters

    • instanceName: string

    Returns OracleConnectOptions

setJdkSslEngineOptions

  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns OracleConnectOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns OracleConnectOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns OracleConnectOptions

setLocalAddress

  • Parameters

    • localAddress: string

    Returns OracleConnectOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns OracleConnectOptions

setMetricsName

  • Parameters

    • metricsName: string

    Returns OracleConnectOptions

setNonProxyHosts

  • Parameters

    • nonProxyHosts: string[]

    Returns OracleConnectOptions

setOpenSslEngineOptions

  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns OracleConnectOptions

setPassword

  • Parameters

    • password: string

    Returns OracleConnectOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns OracleConnectOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns OracleConnectOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns OracleConnectOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns OracleConnectOptions

setPort

  • Parameters

    • port: number

    Returns OracleConnectOptions

setPreparedStatementCacheMaxSize

  • Parameters

    • preparedStatementCacheMaxSize: number

    Returns OracleConnectOptions

setPreparedStatementCacheSqlLimit

  • Parameters

    • preparedStatementCacheSqlLimit: number

    Returns OracleConnectOptions

setProperties

  • Parameters

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

    Returns OracleConnectOptions

setProxyOptions

  • Parameters

    • proxyOptions: ProxyOptions

    Returns OracleConnectOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns OracleConnectOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns OracleConnectOptions

setReconnectAttempts

  • Parameters

    • reconnectAttempts: number

    Returns OracleConnectOptions

setReconnectInterval

  • Parameters

    • reconnectInterval: number

    Returns OracleConnectOptions

setRegisterWriteHandler

  • Parameters

    • registerWriteHandler: boolean

    Returns OracleConnectOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns OracleConnectOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns OracleConnectOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns OracleConnectOptions

setServerMode

  • Set the server connection mode.

    Parameters

    Returns OracleConnectOptions

setServiceId

  • Set the Oracle service identifier (SID). If set, the client will build an Oracle connection URL using SID instead of the EZConnect format.

    Parameters

    • serviceId: string

    Returns OracleConnectOptions

setServiceName

  • Set the Oracle service name. If set, the client will build an Oracle connection URL in the EZConnect format.

    Parameters

    • serviceName: string

    Returns OracleConnectOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns OracleConnectOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns OracleConnectOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns OracleConnectOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns OracleConnectOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns OracleConnectOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns OracleConnectOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns OracleConnectOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns OracleConnectOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns OracleConnectOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns OracleConnectOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns OracleConnectOptions

setTnsAdmin

  • Set the path of the directory that contains the tnsnames.ora file.

    Parameters

    • tnsAdmin: string

    Returns OracleConnectOptions

setTnsAlias

  • Set the name of an alias configured in the tnsnames.ora file.

    Parameters

    • tnsAlias: string

    Returns OracleConnectOptions

setTracingPolicy

  • Parameters

    • tracingPolicy: TracingPolicy

    Returns OracleConnectOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns OracleConnectOptions

setTrustAll

  • Parameters

    • trustAll: boolean

    Returns OracleConnectOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns OracleConnectOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns OracleConnectOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns OracleConnectOptions

setUser

  • Parameters

    • user: string

    Returns OracleConnectOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns OracleConnectOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc