Package de.softwareforge.testing.postgres.embedded

Class EmbeddedPostgres

java.lang.Object

de.softwareforge.testing.postgres.embedded.EmbeddedPostgres

All Implemented Interfaces:

AutoCloseable

public final class EmbeddedPostgres
extends Object
implements AutoCloseable

Manages a single, embedded Postgres instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddedPostgres.Builder
static interface	EmbeddedPostgres.BuilderCustomizer	Callback interface to customize a builder in progress.

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_PG_STARTUP_WAIT

Method Summary

Modifier and Type	Method	Description
static EmbeddedPostgres.Builder	builder()	Returns a new builder.
static EmbeddedPostgres.Builder	builderWithDefaults()	Returns a builder with default EmbeddedPostgres.Builder.withDefaults() configuration already applied.
void	close()	Closing an EmbeddedPostgres instance shuts down the connected database instance.
DataSource	createDataSource(String user, String databaseName)	Creates a DataSource with a specific user and database name.
DatabaseInfo	createDefaultDatabaseInfo()	Creates a DatabaseInfo object describing the default database (normally
DataSource	createDefaultDataSource()	Creates a DataSource object that connects to the default databases (normally
DataSource	createTemplateDataSource()	Creates a DataSource object that connects to the template database (normally
static EmbeddedPostgres	defaultInstance()	Returns an instance that has been started and configured.
boolean	equals(Object o)
int	getPort()	Returns the TCP port for this Postgres instance.
int	hashCode()
String	instanceId()	Returns the instance id for this postgres instance.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_PG_STARTUP_WAIT

public static final Duration DEFAULT_PG_STARTUP_WAIT

Method Details

defaultInstance

public static EmbeddedPostgres defaultInstance()
                                        throws IOException

Returns an instance that has been started and configured. The EmbeddedPostgres.Builder.withDefaults() configuration has been applied.

Throws:

IOException

builderWithDefaults

public static EmbeddedPostgres.Builder builderWithDefaults()

Returns a builder with default EmbeddedPostgres.Builder.withDefaults() configuration already applied.

builder

public static EmbeddedPostgres.Builder builder()

Returns a new builder.

createDefaultDatabaseInfo

public DatabaseInfo createDefaultDatabaseInfo()

Creates a DatabaseInfo object describing the default database (normally

postgres

).

createTemplateDataSource

public DataSource createTemplateDataSource()
                                    throws SQLException

Creates a DataSource object that connects to the template database (normally

template1

). Any modification to this database will be visible in new database created with

CREATE DATABASE...

.

Throws:

SQLException

createDefaultDataSource

public DataSource createDefaultDataSource()
                                   throws SQLException

Creates a DataSource object that connects to the default databases (normally

postgres

).

Throws:

SQLException

createDataSource

public DataSource createDataSource(String user,
 String databaseName)
                            throws SQLException

Creates a DataSource with a specific user and database name. Creating the DataSource does not also create the database or the user itself. Those must be creates e.g. with a DatabasePreparer.

Throws:

SQLException

getPort

public int getPort()

Returns the TCP port for this Postgres instance.

instanceId

public String instanceId()

Returns the instance id for this postgres instance.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

close

public void close()
           throws IOException

Closing an EmbeddedPostgres instance shuts down the connected database instance.

Specified by:

close in interface AutoCloseable

Throws:

IOException