io.vertx.ext.jdbc

Interface JDBCClient

All Superinterfaces:

SQLClient, SQLOperations

public interface JDBCClient
extends SQLClient

An asynchronous client interface for interacting with a JDBC compliant database

Author:

Nick Scavelli, Tim Fox

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DS_NAME The name of the default data source
static String	DEFAULT_PROVIDER_CLASS The default data source provider for this pool, loaded from JVM system properties with the DataSourceProvider.DEFAULT_DATA_SOURCE_PROVIDER_NAME key.

Method Summary

Modifier and Type	Method and Description
static JDBCClient	create(Vertx vertx, DataSource dataSource) Create a client using a pre-existing data source
static JDBCClient	create(Vertx vertx, DataSourceProvider dataSourceProvider) Create a client using a data source provider
static JDBCClient	create(Vertx vertx, JsonObject config) Create a JDBC client which maintains its own data source.
static JDBCClient	createShared(Vertx vertx, JsonObject config) Like createShared(io.vertx.core.Vertx, JsonObject, String) but with the default data source name
static JDBCClient	createShared(Vertx vertx, JsonObject config, String dataSourceName) Create a JDBC client which shares its data source with any other JDBC clients created with the same data source name

Methods inherited from interface io.vertx.ext.sql.SQLClient

call, callWithParams, close, close, getConnection, query, queryStream, queryStreamWithParams, queryWithParams, update, updateWithParams

Methods inherited from interface io.vertx.ext.sql.SQLOperations

querySingle, querySingleWithParams

Field Detail

DEFAULT_PROVIDER_CLASS

static final String DEFAULT_PROVIDER_CLASS

The default data source provider for this pool, loaded from JVM system properties with the DataSourceProvider.DEFAULT_DATA_SOURCE_PROVIDER_NAME key. The value can be one of:

• C3P0: C3P0DataSourceProvider
• Hikari: HikariCPDataSourceProvider
• Agroal: AgroalCPDataSourceProvider

When there is no JVM wide defined provider or the value is incorrect, C3P0DataSourceProvider is returned.

DEFAULT_DS_NAME

static final String DEFAULT_DS_NAME

The name of the default data source

See Also:

Constant Field Values

Method Detail

create

static JDBCClient create(Vertx vertx,
                         JsonObject config)

Create a JDBC client which maintains its own data source.

Parameters:

vertx - the Vert.x instance

config - the configuration

Returns:

the client

createShared

static JDBCClient createShared(Vertx vertx,
                               JsonObject config,
                               String dataSourceName)

Create a JDBC client which shares its data source with any other JDBC clients created with the same data source name

Parameters:

vertx - the Vert.x instance

config - the configuration

dataSourceName - the data source name

Returns:

the client

createShared

static JDBCClient createShared(Vertx vertx,
                               JsonObject config)

Like createShared(io.vertx.core.Vertx, JsonObject, String) but with the default data source name

Parameters:

vertx - the Vert.x instance

config - the configuration

Returns:

the client

create

static JDBCClient create(Vertx vertx,
                         DataSource dataSource)

Create a client using a pre-existing data source

Parameters:

vertx - the Vert.x instance

dataSource - the datasource

Returns:

the client

create

static JDBCClient create(Vertx vertx,
                         DataSourceProvider dataSourceProvider)

Create a client using a data source provider

Parameters:

vertx - the Vert.x instance

dataSourceProvider - the datasource provider

Returns:

the client

Since:

4.2.0