Package com.apple.foundationdb.relational.api

Interface RelationalPreparedStatement

All Superinterfaces:

AutoCloseable, PreparedStatement, Statement, Wrapper

public interface RelationalPreparedStatement
extends PreparedStatement

Extension of PreparedStatement to allow for Relational specific Prepared Statements.

Field Summary

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary

Modifier and Type	Method	Description
default void	addBatch()
default void	addBatch(String sql)
default void	cancel()
default void	clearBatch()
default void	clearParameters()
default void	clearWarnings()
default void	closeOnCompletion()
boolean	execute()
default boolean	execute(String sql)
default boolean	execute(String sql, int autoGeneratedKeys)
default boolean	execute(String sql, int[] columnIndexes)
default boolean	execute(String sql, String[] columnNames)
default int[]	executeBatch()
RelationalResultSet	executeQuery()
default ResultSet	executeQuery(String sql)
default int	executeUpdate()
default int	executeUpdate(String sql)
default int	executeUpdate(String sql, int autoGeneratedKeys)
default int	executeUpdate(String sql, int[] columnIndexes)
default int	executeUpdate(String sql, String[] columnNames)
default Connection	getConnection()
default int	getFetchDirection()
default int	getFetchSize()
default ResultSet	getGeneratedKeys()
default int	getMaxFieldSize()
default ResultSetMetaData	getMetaData()
default boolean	getMoreResults()
default boolean	getMoreResults(int current)
default ParameterMetaData	getParameterMetaData()
default int	getQueryTimeout()
RelationalResultSet	getResultSet()
default int	getResultSetConcurrency()
default int	getResultSetHoldability()
default int	getResultSetType()
default int	getUpdateCount()
default SQLWarning	getWarnings()
default boolean	isCloseOnCompletion()
default boolean	isPoolable()
default boolean	isWrapperFor(Class<?> iface)
void	setArray(String parameterName, Array x)	Sets the designated parameter to the given Array.
default void	setAsciiStream(int parameterIndex, InputStream x)
default void	setAsciiStream(int parameterIndex, InputStream x, int length)
default void	setAsciiStream(int parameterIndex, InputStream x, long length)
default void	setBigDecimal(int parameterIndex, BigDecimal x)
default void	setBinaryStream(int parameterIndex, InputStream x)
default void	setBinaryStream(int parameterIndex, InputStream x, int length)
default void	setBinaryStream(int parameterIndex, InputStream x, long length)
default void	setBlob(int parameterIndex, InputStream inputStream)
default void	setBlob(int parameterIndex, InputStream inputStream, long length)
default void	setBlob(int parameterIndex, Blob x)
void	setBoolean(String parameterName, boolean x)	Sets the designated parameter to the given Java boolean value.
default void	setByte(int parameterIndex, byte x)
void	setBytes(String parameterName, byte[] x)	Sets the designated parameter to the given Java array of bytes.
default void	setCharacterStream(int parameterIndex, Reader reader)
default void	setCharacterStream(int parameterIndex, Reader reader, int length)
default void	setCharacterStream(int parameterIndex, Reader reader, long length)
default void	setClob(int parameterIndex, Reader reader)
default void	setClob(int parameterIndex, Reader reader, long length)
default void	setClob(int parameterIndex, Clob x)
default void	setCursorName(String name)
default void	setDate(int parameterIndex, Date x)
default void	setDate(int parameterIndex, Date x, Calendar cal)
void	setDouble(String parameterName, double x)	Sets the designated parameter to the given Java double value.
default void	setEscapeProcessing(boolean enable)
default void	setFetchDirection(int direction)
default void	setFetchSize(int rows)
void	setFloat(String parameterName, float x)	Sets the designated parameter to the given Java float value.
void	setInt(String parameterName, int x)	Sets the designated parameter to the given Java int value.
void	setLong(String parameterName, long x)	Sets the designated parameter to the given Java long value.
default void	setMaxFieldSize(int max)
default void	setNCharacterStream(int parameterIndex, Reader value)
default void	setNCharacterStream(int parameterIndex, Reader value, long length)
default void	setNClob(int parameterIndex, Reader reader)
default void	setNClob(int parameterIndex, Reader reader, long length)
default void	setNClob(int parameterIndex, NClob value)
default void	setNString(int parameterIndex, String value)
default void	setNull(int parameterIndex, int sqlType, String typeName)
void	setNull(String parameterName, int sqlType)	Sets the designated parameter to SQL NULL.
default void	setObject(int parameterIndex, Object x, int targetSqlType)
default void	setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength)
void	setObject(String parameterName, Object x)	Sets the designated parameter to the given Object.
default void	setPoolable(boolean poolable)
default void	setQueryTimeout(int seconds)
default void	setRef(int parameterIndex, Ref x)
default void	setRowId(int parameterIndex, RowId x)
default void	setShort(int parameterIndex, short x)
default void	setSQLXML(int parameterIndex, SQLXML xmlObject)
void	setString(String parameterName, String x)	Sets the designated parameter to the given Java String value.
default void	setTime(int parameterIndex, Time x)
default void	setTime(int parameterIndex, Time x, Calendar cal)
default void	setTimestamp(int parameterIndex, Timestamp x)
default void	setTimestamp(int parameterIndex, Timestamp x, Calendar cal)
default void	setUnicodeStream(int parameterIndex, InputStream x, int length)	Deprecated.
default void	setURL(int parameterIndex, URL x)
void	setUUID(int parameterIndex, UUID x)	Sets the designated parameter to the given Java UUID value.
void	setUUID(String parameterName, UUID x)	Sets the designated parameter to the given Java UUID value.
default <T> T	unwrap(Class<T> iface)

Methods inherited from interface java.sql.PreparedStatement

executeLargeUpdate, setArray, setBoolean, setBytes, setDouble, setFloat, setInt, setLong, setNull, setObject, setObject, setObject, setString

Methods inherited from interface java.sql.Statement

close, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, getLargeMaxRows, getLargeUpdateCount, getMaxRows, isClosed, isSimpleIdentifier, setLargeMaxRows, setMaxRows

Method Details

executeQuery

RelationalResultSet executeQuery()
                          throws SQLException

Specified by:

executeQuery in interface PreparedStatement

Throws:

SQLException

execute

boolean execute()
         throws SQLException

Specified by:

execute in interface PreparedStatement

Throws:

SQLException

getResultSet

RelationalResultSet getResultSet()
                          throws SQLException

Specified by:

getResultSet in interface Statement

Throws:

SQLException

setBoolean

void setBoolean(String parameterName,
 boolean x)
         throws SQLException

Sets the designated parameter to the given Java boolean value.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setInt

void setInt(String parameterName,
 int x)
     throws SQLException

Sets the designated parameter to the given Java int value.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setLong

void setLong(String parameterName,
 long x)
      throws SQLException

Sets the designated parameter to the given Java long value.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setFloat

void setFloat(String parameterName,
 float x)
       throws SQLException

Sets the designated parameter to the given Java float value.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setDouble

void setDouble(String parameterName,
 double x)
        throws SQLException

Sets the designated parameter to the given Java double value.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setString

void setString(String parameterName,
 String x)
        throws SQLException

Sets the designated parameter to the given Java String value.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setBytes

void setBytes(String parameterName,
 byte[] x)
       throws SQLException

Sets the designated parameter to the given Java array of bytes.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setArray

void setArray(String parameterName,
 Array x)
       throws SQLException

Sets the designated parameter to the given Array.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setObject

void setObject(String parameterName,
 Object x)
        throws SQLException

Sets the designated parameter to the given Object.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setUUID

void setUUID(int parameterIndex,
 UUID x)
      throws SQLException

Sets the designated parameter to the given Java UUID value.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setUUID

void setUUID(String parameterName,
 UUID x)
      throws SQLException

Sets the designated parameter to the given Java UUID value.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

SQLException - if parameterName does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

setNull

void setNull(String parameterName,
 int sqlType)
      throws SQLException

Sets the designated parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Parameters:

parameterName - the name of the parameter

sqlType - the SQL type code defined in java.sql.Types

Throws:

SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

executeUpdate

default int executeUpdate()
                   throws SQLException

Specified by:

executeUpdate in interface PreparedStatement

Throws:

SQLException

setByte

default void setByte(int parameterIndex,
 byte x)
              throws SQLException

Specified by:

setByte in interface PreparedStatement

Throws:

SQLException

setShort

default void setShort(int parameterIndex,
 short x)
               throws SQLException

Specified by:

setShort in interface PreparedStatement

Throws:

SQLException

setBigDecimal

default void setBigDecimal(int parameterIndex,
 BigDecimal x)
                    throws SQLException

Specified by:

setBigDecimal in interface PreparedStatement

Throws:

SQLException

setDate

default void setDate(int parameterIndex,
 Date x)
              throws SQLException

Specified by:

setDate in interface PreparedStatement

Throws:

SQLException

setTime

default void setTime(int parameterIndex,
 Time x)
              throws SQLException

Specified by:

setTime in interface PreparedStatement

Throws:

SQLException

setTimestamp

default void setTimestamp(int parameterIndex,
 Timestamp x)
                   throws SQLException

Specified by:

setTimestamp in interface PreparedStatement

Throws:

SQLException

setAsciiStream

default void setAsciiStream(int parameterIndex,
 InputStream x,
 int length)
                     throws SQLException

Specified by:

setAsciiStream in interface PreparedStatement

Throws:

SQLException

setUnicodeStream

@Deprecated
default void setUnicodeStream(int parameterIndex,
 InputStream x,
 int length)
                       throws SQLException

Deprecated.

Specified by:

setUnicodeStream in interface PreparedStatement

Throws:

SQLException

setBinaryStream

default void setBinaryStream(int parameterIndex,
 InputStream x,
 int length)
                      throws SQLException

Specified by:

setBinaryStream in interface PreparedStatement

Throws:

SQLException

clearParameters

default void clearParameters()
                      throws SQLException

Specified by:

clearParameters in interface PreparedStatement

Throws:

SQLException

setObject

default void setObject(int parameterIndex,
 Object x,
 int targetSqlType)
                throws SQLException

Specified by:

setObject in interface PreparedStatement

Throws:

SQLException

addBatch

default void addBatch()
               throws SQLException

Specified by:

addBatch in interface PreparedStatement

Throws:

SQLException

setCharacterStream

default void setCharacterStream(int parameterIndex,
 Reader reader,
 int length)
                         throws SQLException

Specified by:

setCharacterStream in interface PreparedStatement

Throws:

SQLException

setRef

default void setRef(int parameterIndex,
 Ref x)
             throws SQLException

Specified by:

setRef in interface PreparedStatement

Throws:

SQLException

setBlob

default void setBlob(int parameterIndex,
 Blob x)
              throws SQLException

Specified by:

setBlob in interface PreparedStatement

Throws:

SQLException

setClob

default void setClob(int parameterIndex,
 Clob x)
              throws SQLException

Specified by:

setClob in interface PreparedStatement

Throws:

SQLException

getMetaData

default ResultSetMetaData getMetaData()
                               throws SQLException

Specified by:

getMetaData in interface PreparedStatement

Throws:

SQLException

setDate

default void setDate(int parameterIndex,
 Date x,
 Calendar cal)
              throws SQLException

Specified by:

setDate in interface PreparedStatement

Throws:

SQLException

setTime

default void setTime(int parameterIndex,
 Time x,
 Calendar cal)
              throws SQLException

Specified by:

setTime in interface PreparedStatement

Throws:

SQLException

setTimestamp

default void setTimestamp(int parameterIndex,
 Timestamp x,
 Calendar cal)
                   throws SQLException

Specified by:

setTimestamp in interface PreparedStatement

Throws:

SQLException

setNull

default void setNull(int parameterIndex,
 int sqlType,
 String typeName)
              throws SQLException

Specified by:

setNull in interface PreparedStatement

Throws:

SQLException

setURL

default void setURL(int parameterIndex,
 URL x)
             throws SQLException

Specified by:

setURL in interface PreparedStatement

Throws:

SQLException

getParameterMetaData

default ParameterMetaData getParameterMetaData()
                                        throws SQLException

Specified by:

getParameterMetaData in interface PreparedStatement

Throws:

SQLException

setRowId

default void setRowId(int parameterIndex,
 RowId x)
               throws SQLException

Specified by:

setRowId in interface PreparedStatement

Throws:

SQLException

setNString

default void setNString(int parameterIndex,
 String value)
                 throws SQLException

Specified by:

setNString in interface PreparedStatement

Throws:

SQLException

setNCharacterStream

default void setNCharacterStream(int parameterIndex,
 Reader value,
 long length)
                          throws SQLException

Specified by:

setNCharacterStream in interface PreparedStatement

Throws:

SQLException

setNClob

default void setNClob(int parameterIndex,
 NClob value)
               throws SQLException

Specified by:

setNClob in interface PreparedStatement

Throws:

SQLException

setClob

default void setClob(int parameterIndex,
 Reader reader,
 long length)
              throws SQLException

Specified by:

setClob in interface PreparedStatement

Throws:

SQLException

setBlob

default void setBlob(int parameterIndex,
 InputStream inputStream,
 long length)
              throws SQLException

Specified by:

setBlob in interface PreparedStatement

Throws:

SQLException

setNClob

default void setNClob(int parameterIndex,
 Reader reader,
 long length)
               throws SQLException

Specified by:

setNClob in interface PreparedStatement

Throws:

SQLException

setSQLXML

default void setSQLXML(int parameterIndex,
 SQLXML xmlObject)
                throws SQLException

Specified by:

setSQLXML in interface PreparedStatement

Throws:

SQLException

setObject

default void setObject(int parameterIndex,
 Object x,
 int targetSqlType,
 int scaleOrLength)
                throws SQLException

Specified by:

setObject in interface PreparedStatement

Throws:

SQLException

setAsciiStream

default void setAsciiStream(int parameterIndex,
 InputStream x,
 long length)
                     throws SQLException

Specified by:

setAsciiStream in interface PreparedStatement

Throws:

SQLException

setBinaryStream

default void setBinaryStream(int parameterIndex,
 InputStream x,
 long length)
                      throws SQLException

Specified by:

setBinaryStream in interface PreparedStatement

Throws:

SQLException

setCharacterStream

default void setCharacterStream(int parameterIndex,
 Reader reader,
 long length)
                         throws SQLException

Specified by:

setCharacterStream in interface PreparedStatement

Throws:

SQLException

setAsciiStream

default void setAsciiStream(int parameterIndex,
 InputStream x)
                     throws SQLException

Specified by:

setAsciiStream in interface PreparedStatement

Throws:

SQLException

setBinaryStream

default void setBinaryStream(int parameterIndex,
 InputStream x)
                      throws SQLException

Specified by:

setBinaryStream in interface PreparedStatement

Throws:

SQLException

setCharacterStream

default void setCharacterStream(int parameterIndex,
 Reader reader)
                         throws SQLException

Specified by:

setCharacterStream in interface PreparedStatement

Throws:

SQLException

setNCharacterStream

default void setNCharacterStream(int parameterIndex,
 Reader value)
                          throws SQLException

Specified by:

setNCharacterStream in interface PreparedStatement

Throws:

SQLException

setClob

default void setClob(int parameterIndex,
 Reader reader)
              throws SQLException

Specified by:

setClob in interface PreparedStatement

Throws:

SQLException

setBlob

default void setBlob(int parameterIndex,
 InputStream inputStream)
              throws SQLException

Specified by:

setBlob in interface PreparedStatement

Throws:

SQLException

setNClob

default void setNClob(int parameterIndex,
 Reader reader)
               throws SQLException

Specified by:

setNClob in interface PreparedStatement

Throws:

SQLException

executeQuery

default ResultSet executeQuery(String sql)
                        throws SQLException

Specified by:

executeQuery in interface Statement

Throws:

SQLException

executeUpdate

default int executeUpdate(String sql)
                   throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

getMaxFieldSize

default int getMaxFieldSize()
                     throws SQLException

Specified by:

getMaxFieldSize in interface Statement

Throws:

SQLException

setMaxFieldSize

default void setMaxFieldSize(int max)
                      throws SQLException

Specified by:

setMaxFieldSize in interface Statement

Throws:

SQLException

setEscapeProcessing

default void setEscapeProcessing(boolean enable)
                          throws SQLException

Specified by:

setEscapeProcessing in interface Statement

Throws:

SQLException

getQueryTimeout

default int getQueryTimeout()
                     throws SQLException

Specified by:

getQueryTimeout in interface Statement

Throws:

SQLException

setQueryTimeout

default void setQueryTimeout(int seconds)
                      throws SQLException

Specified by:

setQueryTimeout in interface Statement

Throws:

SQLException

cancel

default void cancel()
             throws SQLException

Specified by:

cancel in interface Statement

Throws:

SQLException

getWarnings

default SQLWarning getWarnings()
                        throws SQLException

Specified by:

getWarnings in interface Statement

Throws:

SQLException

clearWarnings

default void clearWarnings()
                    throws SQLException

Specified by:

clearWarnings in interface Statement

Throws:

SQLException

setCursorName

default void setCursorName(String name)
                    throws SQLException

Specified by:

setCursorName in interface Statement

Throws:

SQLException

execute

default boolean execute(String sql)
                 throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

getUpdateCount

default int getUpdateCount()
                    throws SQLException

Specified by:

getUpdateCount in interface Statement

Throws:

SQLException

getMoreResults

default boolean getMoreResults()
                        throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

setFetchDirection

default void setFetchDirection(int direction)
                        throws SQLException

Specified by:

setFetchDirection in interface Statement

Throws:

SQLException

getFetchDirection

default int getFetchDirection()
                       throws SQLException

Specified by:

getFetchDirection in interface Statement

Throws:

SQLException

setFetchSize

default void setFetchSize(int rows)
                   throws SQLException

Specified by:

setFetchSize in interface Statement

Throws:

SQLException

getFetchSize

default int getFetchSize()
                  throws SQLException

Specified by:

getFetchSize in interface Statement

Throws:

SQLException

getResultSetConcurrency

default int getResultSetConcurrency()
                             throws SQLException

Specified by:

getResultSetConcurrency in interface Statement

Throws:

SQLException

getResultSetType

default int getResultSetType()
                      throws SQLException

Specified by:

getResultSetType in interface Statement

Throws:

SQLException

addBatch

default void addBatch(String sql)
               throws SQLException

Specified by:

addBatch in interface Statement

Throws:

SQLException

clearBatch

default void clearBatch()
                 throws SQLException

Specified by:

clearBatch in interface Statement

Throws:

SQLException

executeBatch

default int[] executeBatch()
                    throws SQLException

Specified by:

executeBatch in interface Statement

Throws:

SQLException

getConnection

default Connection getConnection()
                          throws SQLException

Specified by:

getConnection in interface Statement

Throws:

SQLException

getMoreResults

default boolean getMoreResults(int current)
                        throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

getGeneratedKeys

default ResultSet getGeneratedKeys()
                            throws SQLException

Specified by:

getGeneratedKeys in interface Statement

Throws:

SQLException

executeUpdate

default int executeUpdate(String sql,
 int autoGeneratedKeys)
                   throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

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

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

default int executeUpdate(String sql,
 String[] columnNames)
                   throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

execute

default boolean execute(String sql,
 int autoGeneratedKeys)
                 throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

execute

default boolean execute(String sql,
 int[] columnIndexes)
                 throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

execute

default boolean execute(String sql,
 String[] columnNames)
                 throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

getResultSetHoldability

default int getResultSetHoldability()
                             throws SQLException

Specified by:

getResultSetHoldability in interface Statement

Throws:

SQLException

setPoolable

default void setPoolable(boolean poolable)
                  throws SQLException

Specified by:

setPoolable in interface Statement

Throws:

SQLException

isPoolable

default boolean isPoolable()
                    throws SQLException

Specified by:

isPoolable in interface Statement

Throws:

SQLException

closeOnCompletion

default void closeOnCompletion()
                        throws SQLException

Specified by:

closeOnCompletion in interface Statement

Throws:

SQLException

isCloseOnCompletion

default boolean isCloseOnCompletion()
                             throws SQLException

Specified by:

isCloseOnCompletion in interface Statement

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