/*
* Copyright (C) 2017 Julien Viet
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package io.vertx.pgclient;
import io.vertx.core.impl.VertxInternal;
import io.vertx.pgclient.impl.PgPoolImpl;
import io.vertx.sqlclient.PoolOptions;
import io.vertx.sqlclient.Pool;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Vertx;
import io.vertx.core.VertxOptions;
A pool
of PostgreSQL connections
. Author: Julien Viet
/**
* A {@link Pool pool} of {@link PgConnection PostgreSQL connections}.
*
* @author <a href="mailto:julien@julienviet.com">Julien Viet</a>
*/
@VertxGen
public interface PgPool extends Pool {
Like pool(PoolOptions)
with a default poolOptions
. /**
* Like {@link #pool(PoolOptions)} with a default {@code poolOptions}.
*/
static PgPool pool() {
return pool(PgConnectOptions.fromEnv(), new PoolOptions());
}
Like pool(PgConnectOptions, PoolOptions)
with connectOptions
build from the environment variables. /**
* Like {@link #pool(PgConnectOptions, PoolOptions)} with {@code connectOptions} build from the environment variables.
*/
static PgPool pool(PoolOptions poolOptions) {
return pool(PgConnectOptions.fromEnv(), poolOptions);
}
Like pool(String, PoolOptions)
with a default poolOptions
. /**
* Like {@link #pool(String, PoolOptions)} with a default {@code poolOptions}.
*/
static PgPool pool(String connectionUri) {
return pool(connectionUri, new PoolOptions());
}
/**
* Like {@link #pool(PgConnectOptions, PoolOptions)} with {@code connectOptions} build from {@code connectionUri}.
*/
static PgPool pool(String connectionUri, PoolOptions poolOptions) {
return pool(PgConnectOptions.fromUri(connectionUri), poolOptions);
}
Like pool(Vertx, String, PoolOptions)
with a default poolOptions
. /**
* Like {@link #pool(Vertx, String,PoolOptions)} with a default {@code poolOptions}.
*/
static PgPool pool(Vertx vertx, String connectionUri) {
return pool(vertx, PgConnectOptions.fromUri(connectionUri), new PoolOptions());
}
Like pool(Vertx, PgConnectOptions, PoolOptions)
with connectOptions
build from the environment variables. /**
* Like {@link #pool(Vertx, PgConnectOptions, PoolOptions)} with {@code connectOptions} build from the environment variables.
*/
static PgPool pool(Vertx vertx, PoolOptions poolOptions) {
return pool(vertx, PgConnectOptions.fromEnv(), poolOptions);
}
/**
* Like {@link #pool(Vertx, PgConnectOptions, PoolOptions)} with {@code connectOptions} build from {@code connectionUri}.
*/
static PgPool pool(Vertx vertx, String connectionUri, PoolOptions poolOptions) {
return pool(vertx, PgConnectOptions.fromUri(connectionUri), poolOptions);
}
Create a connection pool to the database configured with the given connectOptions
and poolOptions
. Params: - poolOptions – the options for creating the pool
Returns: the connection pool
/**
* Create a connection pool to the database configured with the given {@code connectOptions} and {@code poolOptions}.
*
* @param poolOptions the options for creating the pool
* @return the connection pool
*/
static PgPool pool(PgConnectOptions connectOptions, PoolOptions poolOptions) {
if (Vertx.currentContext() != null) {
throw new IllegalStateException("Running in a Vertx context => use PgPool#pool(Vertx, PgConnectOptions, PoolOptions) instead");
}
VertxOptions vertxOptions = new VertxOptions();
if (connectOptions.isUsingDomainSocket()) {
vertxOptions.setPreferNativeTransport(true);
}
VertxInternal vertx = (VertxInternal) Vertx.vertx(vertxOptions);
return PgPoolImpl.create(vertx.getOrCreateContext(), true, connectOptions, poolOptions);
}
Like pool(PgConnectOptions, PoolOptions)
with a specific Vertx
instance. /**
* Like {@link #pool(PgConnectOptions, PoolOptions)} with a specific {@link Vertx} instance.
*/
static PgPool pool(Vertx vertx, PgConnectOptions connectOptions, PoolOptions poolOptions) {
return PgPoolImpl.create(((VertxInternal)vertx).getOrCreateContext(), false, connectOptions, poolOptions);
}
}