nz.co.gregs.dbvolution.databases

Class PostgresDB

java.lang.Object

nz.co.gregs.dbvolution.databases.DBDatabase

nz.co.gregs.dbvolution.databases.PostgresDB

All Implemented Interfaces:

Serializable, Cloneable, SupportsPolygonDatatype

Direct Known Subclasses:

PostgresDBOverSSL

public class PostgresDB
extends DBDatabase
implements SupportsPolygonDatatype

A DBDatabase tweaked for PostgreSQL.

Support DBvolution at Patreon

Author:

Gregory Graham

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	POSTGRES_DEFAULT_PORT The default port number used by PostgreSQL.
static String	POSTGRES_DEFAULT_USERNAME The default username used by PostgreSQL.
static long	serialVersionUID

Fields inherited from class nz.co.gregs.dbvolution.databases.DBDatabase

storedConnection

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PostgresDB() Provides a convenient constructor for DBDatabases that have configuration details hardwired or are able to automatically retrieve the details.
	PostgresDB(DataSource ds) Creates a PostgreSQL connection for the DataSource.
	PostgresDB(String hostname, int port, String databaseName, String username, String password) Creates a PostgreSQL connection to the server on the port supplied, using the username and password supplied.
	PostgresDB(String hostname, int port, String databaseName, String username, String password, String urlExtras) Creates a PostgreSQL connection to the server on the port supplied, using the username and password supplied.
	PostgresDB(String jdbcURL, String username, String password) Creates a PostgreSQL connection for the JDBC URL, username, and password.
	PostgresDB(String databaseName, String username, String password, String urlExtras) Creates a PostgreSQL connection to local computer("localhost") on the default port(5432) using the username and password supplied.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDatabaseSpecificFeatures(Statement stmnt) Used By Subclasses To Inject Datatypes, Functions, Etc Into the Database.
DBDatabase	clone() Clones the DBDatabase.
void	createDatabase(String databaseName) Create a new database/schema on this database server.
void	createUser(String username, String password) Create a new database/schema on this database server.
<TR extends DBRow> void	dropTableNoExceptions(TR tableRow) Drops a table from the database.
int	loadFromCSVFile(DBRow table, File file, String delimiter, String nullValue, String escapeCharacter, String quoteCharacter) Assumes that the database and application are on the the same machine.

Methods inherited from class nz.co.gregs.dbvolution.databases.DBDatabase

addFeatureToFixException, batchSQLStatementsWhenPossible, createForeignKeyConstraints, createIndexesOnAllFields, createTable, createTableNoExceptions, createTableNoExceptions, createTablesNoExceptions, createTablesNoExceptions, createTablesWithForeignKeysNoExceptions, createTableWithForeignKeys, delete, delete, discardConnection, doCommit, doReadOnlyTransaction, doRollback, doTransaction, doTransaction, dropAnyAssociatedDatabaseObjects, dropDatabase, dropDatabase, dropTable, equals, executeDBAction, executeDBQuery, get, get, get, get, get, getAllRows, getByExample, getByExample, getByExamples, getConnection, getConnectionFromDriverManager, getDatabaseName, getDBMigration, getDBQuery, getDBQuery, getDBQueryInsert, getDBStatement, getDBTable, getDefinition, getDriverName, getJdbcURL, getLowLevelStatement, getPassword, getRows, getSQLForCreateTable, getSQLForDBQuery, getUsername, hashCode, implement, insert, insert, isPrintSQLBeforeExecuting, preventDroppingOfDatabases, preventDroppingOfTables, print, printSQLIfRequested, removeForeignKeyConstraints, setBatchSQLStatementsWhenPossible, setDatabaseName, setDefinition, setDriverName, setExplicitCommitAction, setJdbcURL, setPassword, setPrintSQLBeforeExecuting, setUsername, supportsPooledConnections, tableExists, test, unusedConnection, update, update, willCreateBlankQuery

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

POSTGRES_DEFAULT_PORT

public static final int POSTGRES_DEFAULT_PORT

The default port number used by PostgreSQL.

See Also:

Constant Field Values

POSTGRES_DEFAULT_USERNAME

public static final String POSTGRES_DEFAULT_USERNAME

The default username used by PostgreSQL.

See Also:

Constant Field Values

Constructor Detail

PostgresDB

protected PostgresDB()

Provides a convenient constructor for DBDatabases that have configuration details hardwired or are able to automatically retrieve the details.

This constructor creates an empty DBDatabase with only the default settings, in particular with no driver, URL, username, password, or DBDefinition

Most programmers should not call this constructor directly. Instead you should define a no-parameter constructor that supplies the details for creating an instance using a more complete constructor.

DBDatabase encapsulates the knowledge of the database, in particular the syntax of the database in the DBDefinition and the connection details from a DataSource.

See Also:

DBDefinition

PostgresDB

public PostgresDB(DataSource ds)

Creates a PostgreSQL connection for the DataSource.

Parameters:

ds - ds

PostgresDB

public PostgresDB(String jdbcURL,
          String username,
          String password)

Creates a PostgreSQL connection for the JDBC URL, username, and password.

Parameters:

jdbcURL - jdbcURL

username - username

password - password

PostgresDB

public PostgresDB(String hostname,
          int port,
          String databaseName,
          String username,
          String password)

Creates a PostgreSQL connection to the server on the port supplied, using the username and password supplied.

Parameters:

hostname - hostname

port - port

databaseName - databaseName

username - username

password - password

PostgresDB

public PostgresDB(String hostname,
          int port,
          String databaseName,
          String username,
          String password,
          String urlExtras)

Creates a PostgreSQL connection to the server on the port supplied, using the username and password supplied.

Extra parameters to be added to the JDBC URL can be included in the urlExtras parameter.

Parameters:

hostname - hostname

password - password

databaseName - databaseName

port - port

username - username

urlExtras - urlExtras

PostgresDB

public PostgresDB(String databaseName,
          String username,
          String password,
          String urlExtras)

Creates a PostgreSQL connection to local computer("localhost") on the default port(5432) using the username and password supplied.

Extra parameters to be added to the JDBC URL can be included in the urlExtras parameter.

Parameters:

databaseName - databaseName

username - username

password - password

urlExtras - urlExtras

Method Detail

clone

public DBDatabase clone()
                 throws CloneNotSupportedException

Description copied from class: DBDatabase

Clones the DBDatabase.

Support DBvolution at Patreon

Overrides:

clone in class DBDatabase

Returns:

a clone of the DBDatabase.

Throws:

CloneNotSupportedException - not likely

loadFromCSVFile

public int loadFromCSVFile(DBRow table,
                  File file,
                  String delimiter,
                  String nullValue,
                  String escapeCharacter,
                  String quoteCharacter)
                    throws SQLException

Assumes that the database and application are on the the same machine.

Parameters:

table - the table to be loaded

file - the file to load data from

delimiter - the separator between the values of each row

nullValue - the string that represents NULL in this file.

escapeCharacter - the character that escapes special values

quoteCharacter - the character the surrounds strings.

Support DBvolution at Patreon

Returns:

either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing 1 Database exceptions may be thrown

Throws:

SQLException - database exceptions may be thrown.

createDatabase

public void createDatabase(String databaseName)
                    throws SQLException

Create a new database/schema on this database server.

Generally requires all sorts of privileges and is best performed by database administrator (DBA).

Parameters:

databaseName - the name of the new database

Throws:

SQLException - database exceptions may be thrown

createUser

public void createUser(String username,
              String password)
                throws SQLException

Create a new database/schema on this database server.

Generally requires all sorts of privileges and is best performed by database administrator (DBA).

Parameters:

username - The user to be created

password - the password the user will use.

Throws:

SQLException - database exceptions may be throwns.

dropTableNoExceptions

public <TR extends DBRow> void dropTableNoExceptions(TR tableRow)
                           throws AccidentalDroppingOfTableException,
                                  AutoCommitActionDuringTransactionException

Description copied from class: DBDatabase

Drops a table from the database.

The easy way to drop a table that might not exist. Will still throw a AutoCommitActionDuringTransactionException if you use it during a transaction or AccidentalDroppingOfTableException if dropping tables is being prevented by DBvolution.

An even worse idea than DBDatabase.dropTable(nz.co.gregs.dbvolution.DBRow)

In General NEVER USE THIS METHOD.

Seriously NEVER USE THIS METHOD.

Your DBA will murder you.

Overrides:

dropTableNoExceptions in class DBDatabase

Type Parameters:

TR - DBRow type

Parameters:

tableRow - tableRow

Throws:

AccidentalDroppingOfTableException

AutoCommitActionDuringTransactionException

addDatabaseSpecificFeatures

protected void addDatabaseSpecificFeatures(Statement stmnt)
                                    throws SQLException

Description copied from class: DBDatabase

Used By Subclasses To Inject Datatypes, Functions, Etc Into the Database.

Specified by:

addDatabaseSpecificFeatures in class DBDatabase

Parameters:

stmnt - the statement to use when adding features, DO NOT CLOSE THIS STATEMENT.

Throws:

SQLException - database exceptions may occur

See Also:

PostgresDB, H2DB, SQLiteDB, OracleDB, MSSQLServerDB, MySQLDB