HikariCPConnectionPool

HikariCPConnectionPool 2.0.0

Bundle: org.apache.nifi | nifi-dbcp-service-nar
Description: Provides Database Connection Pooling Service based on HikariCP. Connections can be asked from pool and returned after usage.
Tags: connection, database, dbcp, hikari, jdbc, pooling, store
Input Requirement
Supports Sensitive Dynamic Properties: true

Properties

Database Connection URL
A database connection URL used to connect to a database. May contain database system name, host, port, database name and some parameters. The exact syntax of a database connection URL is specified by your DBMS.

Display Name

Database Connection URL

Description

A database connection URL used to connect to a database. May contain database system name, host, port, database name and some parameters. The exact syntax of a database connection URL is specified by your DBMS.

API Name

hikaricp-connection-url

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Database Driver Class Name
The fully-qualified class name of the JDBC driver. Example: com.mysql.jdbc.Driver

Display Name

Database Driver Class Name

Description

The fully-qualified class name of the JDBC driver. Example: com.mysql.jdbc.Driver

API Name

hikaricp-driver-classname

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Database Driver Location(s)
Comma-separated list of files/folders and/or URLs containing the driver JAR and its dependencies (if any). For example '/var/tmp/mariadb-java-client-1.1.7.jar'

Display Name

Database Driver Location(s)

Description

Comma-separated list of files/folders and/or URLs containing the driver JAR and its dependencies (if any). For example '/var/tmp/mariadb-java-client-1.1.7.jar'

API Name

hikaricp-driver-locations

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Kerberos User Service
Specifies the Kerberos User Controller Service that should be used for authenticating with Kerberos

Display Name

Kerberos User Service

Description

Specifies the Kerberos User Controller Service that should be used for authenticating with Kerberos

API Name

hikaricp-kerberos-user-service

Service Interface

org.apache.nifi.kerberos.KerberosUserService

Service Implementations

org.apache.nifi.kerberos.KerberosKeytabUserService

org.apache.nifi.kerberos.KerberosPasswordUserService

org.apache.nifi.kerberos.KerberosTicketCacheUserService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Max Connection Lifetime
The maximum lifetime of a connection. After this time is exceeded the connection will fail the next activation, passivation or validation test. A value of zero or less means the connection has an infinite lifetime.

Display Name

Max Connection Lifetime

Description

The maximum lifetime of a connection. After this time is exceeded the connection will fail the next activation, passivation or validation test. A value of zero or less means the connection has an infinite lifetime.

API Name

hikaricp-max-conn-lifetime

Default Value

-1

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Max Total Connections
This property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections. Basically this value will determine the maximum number of actual connections to the database backend. A reasonable value for this is best determined by your execution environment. When the pool reaches this size, and no idle connections are available, the service will block for up to connectionTimeout milliseconds before timing out.

Display Name

Max Total Connections

Description

This property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections. Basically this value will determine the maximum number of actual connections to the database backend. A reasonable value for this is best determined by your execution environment. When the pool reaches this size, and no idle connections are available, the service will block for up to connectionTimeout milliseconds before timing out.

API Name

hikaricp-max-total-conns

Default Value

10

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Max Wait Time
The maximum amount of time that the pool will wait (when there are no available connections) for a connection to be returned before failing, or 0 <time units> to wait indefinitely.

Display Name

Max Wait Time

Description

The maximum amount of time that the pool will wait (when there are no available connections) for a connection to be returned before failing, or 0 <time units> to wait indefinitely.

API Name

hikaricp-max-wait-time

Default Value

500 millis

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Minimum Idle Connections
This property controls the minimum number of idle connections that HikariCP tries to maintain in the pool. If the idle connections dip below this value and total connections in the pool are less than 'Max Total Connections', HikariCP will make a best effort to add additional connections quickly and efficiently. It is recommended that this property to be set equal to 'Max Total Connections'.

Display Name

Minimum Idle Connections

Description

This property controls the minimum number of idle connections that HikariCP tries to maintain in the pool. If the idle connections dip below this value and total connections in the pool are less than 'Max Total Connections', HikariCP will make a best effort to add additional connections quickly and efficiently. It is recommended that this property to be set equal to 'Max Total Connections'.

API Name

hikaricp-min-idle-conns

Default Value

10

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Password
The password for the database user

Display Name

Password

Description

The password for the database user

API Name

hikaricp-password

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

true

Required

false
Database User
Database user name

Display Name

Database User

Description

Database user name

API Name

hikaricp-username

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Validation Query
Validation Query used to validate connections before returning them. When connection is invalid, it gets dropped and new valid connection will be returned. NOTE: Using validation might have some performance penalty.

Display Name

Validation Query

Description

Validation Query used to validate connections before returning them. When connection is invalid, it gets dropped and new valid connection will be returned. NOTE: Using validation might have some performance penalty.

API Name

hikaricp-validation-query

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dynamic Properties

JDBC property name
Specifies a property name and value to be set on the JDBC connection(s). If Expression Language is used, evaluation will be performed upon the controller service being enabled. Note that no flow file input (attributes, e.g.) is available for use in Expression Language constructs for these properties.

Name

JDBC property name

Description

Specifies a property name and value to be set on the JDBC connection(s). If Expression Language is used, evaluation will be performed upon the controller service being enabled. Note that no flow file input (attributes, e.g.) is available for use in Expression Language constructs for these properties.

Value

JDBC property value

Expression Language Scope

ENVIRONMENT

Restrictions

Required Permission	Explanation
reference remote resources	Database Driver Location can reference resources over HTTP