Module io.helidon.dbclient.jdbc
Package io.helidon.dbclient.jdbc

Interface ConnectionPool

All Known Implementing Classes:
HikariConnectionPool
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface ConnectionPool
JDBC Configuration parameters.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    ConnectionPool.Builder
    Fluent API builder for ConnectionPool.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ConnectionPool.Builder
    builder()
    Create a fluent API builder for a JDBC Connection pool based on URL, username and password.
    Connection
    connection()
    Return a connection from the pool.
    static ConnectionPool
    create(Config config)
    Create a JDBC connection pool from provided configuration.
    default String
    dbType()
    The type of this database - if better details than "jdbc" is available, return it.

  • Method Details

    • create

      static ConnectionPool create(Config config)
      Create a JDBC connection pool from provided configuration.
      Optional configuration parameters
      key default value description
      url   JDBC URL of the database - this property is required when only configuration is used. Example: jdbc:mysql://127.0.0.1:3306/pokemon?useSSL=false
      username   Username used to connect to the database
      password   Password used to connect to the database
      Parameters:
      config - configuration of connection pool
      Returns:
      a new instance configured from the provided config

    • builder

      static ConnectionPool.Builder builder()
      Create a fluent API builder for a JDBC Connection pool based on URL, username and password.
      Returns:
      a new builder

    • connection

      Connection connection()
      Return a connection from the pool. The call to Connection.close() should return that connection to the pool. The connection pool should handle capacity issues and timeouts using unchecked exceptions thrown by this method.
      Returns:
      a connection read to execute statements

    • dbType

      default String dbType()
      The type of this database - if better details than "jdbc" is available, return it. This could be "jdbc:mysql" etc.
      Returns:
      type of this database