ru.yandex.qatools.embed.postgresql

Class EmbeddedPostgres

java.lang.Object

ru.yandex.qatools.embed.postgresql.EmbeddedPostgres

All Implemented Interfaces:

AutoCloseable

public class EmbeddedPostgres
extends Object
implements AutoCloseable

Helper class simplifying the start up configuration for embedded postgres

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DB_NAME
static String	DEFAULT_HOST
static String	DEFAULT_PASSWORD
static String	DEFAULT_USER

Constructor Summary

Constructors

Constructor and Description
EmbeddedPostgres()
EmbeddedPostgres(de.flapdoodle.embed.process.distribution.IVersion version)
EmbeddedPostgres(de.flapdoodle.embed.process.distribution.IVersion version, String dataDir)
EmbeddedPostgres(String dataDir)

Method Summary

Modifier and Type	Method and Description
static de.flapdoodle.embed.process.config.IRuntimeConfig	cachedRuntimeConfig(Path cachedPath) Initializes runtime configuration for cached directory.
void	close()
static de.flapdoodle.embed.process.config.IRuntimeConfig	defaultRuntimeConfig() Initializes the default runtime configuration using the temporary directory.
Optional<PostgresConfig>	getConfig() Returns the configuration of started process
Optional<String>	getConnectionUrl() Returns the connection url for the running postgres instance
Optional<PostgresProcess>	getProcess() Returns the process if started
String	start()
String	start(de.flapdoodle.embed.process.config.IRuntimeConfig runtimeConfig)
String	start(de.flapdoodle.embed.process.config.IRuntimeConfig runtimeConfig, String host, int port, String dbName, String user, String password, List<String> additionalParams) Starts up the embedded postgres
String	start(de.flapdoodle.embed.process.config.IRuntimeConfig runtimeConfig, String host, int port, String dbName, String user, String password, List<String> additionalInitDbParams, List<String> additionalPostgresParams) Starts up the embedded postgres
String	start(String host, int port, String dbName)
String	start(String host, int port, String dbName, String user, String password)
String	start(String host, int port, String dbName, String user, String password, List<String> additionalParams)
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_USER

public static final String DEFAULT_USER

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

See Also:

Constant Field Values

DEFAULT_DB_NAME

public static final String DEFAULT_DB_NAME

See Also:

Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

Constructor Detail

EmbeddedPostgres

public EmbeddedPostgres()

EmbeddedPostgres

public EmbeddedPostgres(de.flapdoodle.embed.process.distribution.IVersion version)

EmbeddedPostgres

public EmbeddedPostgres(String dataDir)

EmbeddedPostgres

public EmbeddedPostgres(de.flapdoodle.embed.process.distribution.IVersion version,
                        String dataDir)

Method Detail

defaultRuntimeConfig

public static de.flapdoodle.embed.process.config.IRuntimeConfig defaultRuntimeConfig()

Initializes the default runtime configuration using the temporary directory.

Returns:

runtime configuration required for postgres to start.

cachedRuntimeConfig

public static de.flapdoodle.embed.process.config.IRuntimeConfig cachedRuntimeConfig(Path cachedPath)

Initializes runtime configuration for cached directory. If a provided directory is empty, postgres will be extracted into it.

Parameters:

cachedPath - path where postgres is supposed to be extracted

Returns:

runtime configuration required for postgres to start

start

public String start()
             throws IOException

Throws:

IOException

start

public String start(String host,
                    int port,
                    String dbName)
             throws IOException

Throws:

IOException

start

public String start(String host,
                    int port,
                    String dbName,
                    String user,
                    String password)
             throws IOException

Throws:

IOException

start

public String start(String host,
                    int port,
                    String dbName,
                    String user,
                    String password,
                    List<String> additionalParams)
             throws IOException

Throws:

IOException

start

public String start(de.flapdoodle.embed.process.config.IRuntimeConfig runtimeConfig)
             throws IOException

Throws:

IOException

start

public String start(de.flapdoodle.embed.process.config.IRuntimeConfig runtimeConfig,
                    String host,
                    int port,
                    String dbName,
                    String user,
                    String password,
                    List<String> additionalParams)
             throws IOException

Starts up the embedded postgres

Parameters:

runtimeConfig - required runtime configuration

host - host to bind to

port - port to bind to

dbName - name of the database to initialize

user - username to connect

password - password for the provided username

additionalParams - additional database init params (if required)

Returns:

connection url for the initialized postgres instance

Throws:

IOException - if an I/O error occurs during the process startup

start

public String start(de.flapdoodle.embed.process.config.IRuntimeConfig runtimeConfig,
                    String host,
                    int port,
                    String dbName,
                    String user,
                    String password,
                    List<String> additionalInitDbParams,
                    List<String> additionalPostgresParams)
             throws IOException

Starts up the embedded postgres

Parameters:

runtimeConfig - required runtime configuration

host - host to bind to

port - port to bind to

dbName - name of the database to initialize

user - username to connect

password - password for the provided username

additionalInitDbParams - additional database init params (if required)

additionalPostgresParams - additional postgresql params (if required)

Returns:

connection url for the initialized postgres instance

Throws:

IOException - if an I/O error occurs during the process startup

getConfig

public Optional<PostgresConfig> getConfig()

Returns the configuration of started process

Returns:

empty if process has not been started yet

getProcess

public Optional<PostgresProcess> getProcess()

Returns the process if started

Returns:

empty if process has not been started yet

getConnectionUrl

public Optional<String> getConnectionUrl()

Returns the connection url for the running postgres instance

Returns:

empty if process has not been started yet

stop

public void stop()

close

public void close()

Specified by:

close in interface AutoCloseable