Package com.apple.foundationdb.relational.api

Interface RelationalConnection

All Superinterfaces:

AutoCloseable, Connection, Wrapper

public interface RelationalConnection
extends Connection

A connection to a Relational database.

This functions very much like a Connection, but contains some overloaded methods to support RelationalStatement.

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

Modifier and Type	Method	Description
default void	abort(Executor executor)
default void	clearWarnings()
default Blob	createBlob()
default Clob	createClob()
default ExpressionFactory	createExpressionBuilderFactory()
default NClob	createNClob()
default SQLXML	createSQLXML()
RelationalStatement	createStatement()	Create a RelationalStatement which can be executed using this DatabaseConnection.
default Statement	createStatement(int resultSetType, int resultSetConcurrency)
default Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
default StatementBuilderFactory	createStatementBuilderFactory()
default String	getCatalog()
default Properties	getClientInfo()
default String	getClientInfo(String name)
default int	getHoldability()
default int	getNetworkTimeout()
Options	getOptions()
URI	getPath()
default Map<String,Class<?>>	getTypeMap()
default SQLWarning	getWarnings()
default boolean	isReadOnly()
default boolean	isValid(int timeout)
default boolean	isWrapperFor(Class<?> iface)
default String	nativeSQL(String sql)
default CallableStatement	prepareCall(String sql)
default CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency)
default CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
RelationalPreparedStatement	prepareStatement(String sql)	Creates a RelationalPreparedStatement object for sending parameterized SQL statements to the database.
default PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
default PreparedStatement	prepareStatement(String sql, int[] columnIndexes)
default PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
default PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
default PreparedStatement	prepareStatement(String sql, String[] columnNames)
default void	releaseSavepoint(Savepoint savepoint)
default void	rollback(Savepoint savepoint)
default void	setCatalog(String catalog)
default void	setClientInfo(String name, String value)
default void	setClientInfo(Properties properties)
default void	setHoldability(int holdability)
default void	setNetworkTimeout(Executor executor, int milliseconds)
void	setOption(Options.Name name, Object value)
default void	setReadOnly(boolean readOnly)
default Savepoint	setSavepoint()
default Savepoint	setSavepoint(String name)
default void	setTypeMap(Map<String,Class<?>> map)
default <T> T	unwrap(Class<T> iface)

Methods inherited from interface java.sql.Connection

beginRequest, close, commit, createArrayOf, createStruct, endRequest, getAutoCommit, getMetaData, getSchema, getTransactionIsolation, isClosed, rollback, setAutoCommit, setSchema, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid, setTransactionIsolation

Method Details

createStatement

RelationalStatement createStatement()
                             throws SQLException

Create a RelationalStatement which can be executed using this DatabaseConnection. If this connection instance is closed, this RelationalStatement becomes invalid and should be discarded. Using a RelationalStatement object after it's backing Connection is closed is a programmer error. Note that this override specializes the createStatement return to make it a RelationalStatement rather than a plain JDBC Statement. This change is non-additive as are the other methods in this extension to the JDBC Connection Interface; it is a change made to make usage of the API go down easier. The supposition is that the bulk of usage will be concerned with RelationalStatement rather than plain Statement and so we skirt the need for a Statement#unwrap to get access to the Relational facility. We may come back to redo this convenience later if this API 'anomaly' on the JDBC API proves a thorn.

Specified by:

createStatement in interface Connection

Returns:

A new statement entity to manipulate the database with.

Throws:

SQLException - if something goes wrong while creating a statement.

prepareStatement

RelationalPreparedStatement prepareStatement(String sql)
                                      throws SQLException

Creates a RelationalPreparedStatement object for sending parameterized SQL statements to the database.

A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Specified by:

prepareStatement in interface Connection

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

Returns:

a new default RelationalPreparedStatement object containing the pre-compiled SQL statement

Throws:

SQLException - if a database access error occurs or this method is called on a closed connection

getOptions

@Nonnull
Options getOptions()

setOption

void setOption(Options.Name name,
 Object value)
        throws SQLException

Throws:

SQLException

getPath

URI getPath()

createStatement

default Statement createStatement(int resultSetType,
 int resultSetConcurrency)
                           throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

default Statement createStatement(int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                           throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 int autoGeneratedKeys)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 int[] columnIndexes)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 String[] columnNames)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

default CallableStatement prepareCall(String sql)
                               throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareCall

default CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency)
                               throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareCall

default CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                               throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

nativeSQL

default String nativeSQL(String sql)
                  throws SQLException

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

abort

default void abort(Executor executor)
            throws SQLException

Specified by:

abort in interface Connection

Throws:

SQLException

setNetworkTimeout

default void setNetworkTimeout(Executor executor,
 int milliseconds)
                        throws SQLException

Specified by:

setNetworkTimeout in interface Connection

Throws:

SQLException

getNetworkTimeout

default int getNetworkTimeout()
                       throws SQLException

Specified by:

getNetworkTimeout in interface Connection

Throws:

SQLException

setReadOnly

default void setReadOnly(boolean readOnly)
                  throws SQLException

Specified by:

setReadOnly in interface Connection

Throws:

SQLException

isReadOnly

default boolean isReadOnly()
                    throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

setCatalog

default void setCatalog(String catalog)
                 throws SQLException

Specified by:

setCatalog in interface Connection

Throws:

SQLException

getCatalog

default String getCatalog()
                   throws SQLException

Specified by:

getCatalog in interface Connection

Throws:

SQLException

getWarnings

default SQLWarning getWarnings()
                        throws SQLException

Specified by:

getWarnings in interface Connection

Throws:

SQLException

clearWarnings

default void clearWarnings()
                    throws SQLException

Specified by:

clearWarnings in interface Connection

Throws:

SQLException

getTypeMap

default Map<String,Class<?>> getTypeMap()
                                 throws SQLException

Specified by:

getTypeMap in interface Connection

Throws:

SQLException

setTypeMap

default void setTypeMap(Map<String,Class<?>> map)
                 throws SQLException

Specified by:

setTypeMap in interface Connection

Throws:

SQLException

setHoldability

default void setHoldability(int holdability)
                     throws SQLException

Specified by:

setHoldability in interface Connection

Throws:

SQLException

getHoldability

default int getHoldability()
                    throws SQLException

Specified by:

getHoldability in interface Connection

Throws:

SQLException

setSavepoint

default Savepoint setSavepoint()
                        throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setSavepoint

default Savepoint setSavepoint(String name)
                        throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

rollback

default void rollback(Savepoint savepoint)
               throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

releaseSavepoint

default void releaseSavepoint(Savepoint savepoint)
                       throws SQLException

Specified by:

releaseSavepoint in interface Connection

Throws:

SQLException

createClob

default Clob createClob()
                 throws SQLException

Specified by:

createClob in interface Connection

Throws:

SQLException

createBlob

default Blob createBlob()
                 throws SQLException

Specified by:

createBlob in interface Connection

Throws:

SQLException

createNClob

default NClob createNClob()
                   throws SQLException

Specified by:

createNClob in interface Connection

Throws:

SQLException

createSQLXML

default SQLXML createSQLXML()
                     throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

isValid

default boolean isValid(int timeout)
                 throws SQLException

Specified by:

isValid in interface Connection

Throws:

SQLException

setClientInfo

default void setClientInfo(String name,
 String value)
                    throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

setClientInfo

default void setClientInfo(Properties properties)
                    throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

getClientInfo

default String getClientInfo(String name)
                      throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

getClientInfo

default Properties getClientInfo()
                          throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

unwrap

default <T> T unwrap(Class<T> iface)
              throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

default boolean isWrapperFor(Class<?> iface)
                      throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

createStatementBuilderFactory

@Nonnull
default StatementBuilderFactory createStatementBuilderFactory()
                                                       throws SQLException

Throws:

SQLException

createExpressionBuilderFactory

@Nonnull
default ExpressionFactory createExpressionBuilderFactory()
                                                  throws SQLException

Throws:

SQLException