toggle menu
Spring Boot Kotlin API
3.5.0-M2
jvm
switch theme
search in API
spring-boot
/
org.springframework.boot.jdbc.metadata
/
HikariDataSourcePoolMetadata
Hikari
Data
Source
Pool
Metadata
open
class
HikariDataSourcePoolMetadata
:
AbstractDataSourcePoolMetadata
<
T
>
DataSourcePoolMetadata
for a Hikari
DataSource
.
Author
Stephane Nicoll
Since
2.0.0
Members
Constructors
Hikari
Data
Source
Pool
Metadata
Link copied to clipboard
constructor
(
dataSource
:
HikariDataSource
)
Functions
get
Active
Link copied to clipboard
open
fun
getActive
(
)
:
Integer
Return the current number of active connections that have been allocated from the data source or
null
if that information is not available.
get
Default
Auto
Commit
Link copied to clipboard
open
fun
getDefaultAutoCommit
(
)
:
Boolean
The default auto-commit state of connections created by this pool.
get
Idle
Link copied to clipboard
open
fun
getIdle
(
)
:
Integer
Return the number of established but idle connections.
get
Max
Link copied to clipboard
open
fun
getMax
(
)
:
Integer
Return the maximum number of active connections that can be allocated at the same time or
-1
if there is no limit.
get
Min
Link copied to clipboard
open
fun
getMin
(
)
:
Integer
Return the minimum number of idle connections in the pool or
null
if that information is not available.
get
Usage
Link copied to clipboard
open
fun
getUsage
(
)
:
Float
Return the usage of the pool as value between 0 and 1 (or -1 if the pool is not limited).
get
Validation
Query
Link copied to clipboard
open
fun
getValidationQuery
(
)
:
String
Return the query to use to validate that a connection is valid or
null
if that information is not available.