org.teiid.jdbc
Interface TeiidStatement

All Superinterfaces:
java.sql.Statement, java.sql.Wrapper
All Known Implementing Classes:
CallableStatementImpl, PreparedStatementImpl, StatementImpl

public interface TeiidStatement
extends java.sql.Statement

This interface provides methods in addition to the standard JDBC methods.


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
 java.util.Collection<Annotation> getAnnotations()
          Deprecated. use show statement
 java.lang.String getDebugLog()
          Deprecated. use show statement
 java.lang.String getExecutionProperty(java.lang.String name)
          Deprecated. use show statement
 PlanNode getPlanDescription()
          Obtain the query plan object representation from the last command executed on this Statement, if a query plan was requested in the command.
 java.lang.String getRequestIdentifier()
          Get ID for last execution which can be used for matching up executions on the client side with executions in the server logs.
 void setExecutionProperty(java.lang.String name, java.lang.String value)
          Deprecated. use set statement
 void setPayload(java.io.Serializable payload)
          Set the per-statement security payload.
 
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
 
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
 

Method Detail

getExecutionProperty

java.lang.String getExecutionProperty(java.lang.String name)
Deprecated. use show statement

Get the execution property value.

Parameters:
name - Execution property name
Returns:
Execution property value or null if not set

setExecutionProperty

void setExecutionProperty(java.lang.String name,
                          java.lang.String value)
Deprecated. use set statement

Set the execution property value.

Parameters:
name - Execution property name
value - Execution property value

getPlanDescription

PlanNode getPlanDescription()
Obtain the query plan object representation from the last command executed on this Statement, if a query plan was requested in the command. If no plan was requested, this method will return null.

Returns:
PlanNode representing the root of the query plan

getDebugLog

java.lang.String getDebugLog()
Deprecated. use show statement

Obtain the query planner debug log from the last command executed on this Statement, if it was requested with SHOWPLAN DEBUG. If no debug output was requested, this method will return null.

Returns:
Debug log or null if no log exists

getAnnotations

java.util.Collection<Annotation> getAnnotations()
Deprecated. use show statement

Get collection of annotations from the query planner from the last command executed on the Statement

Returns:
Collection of Annotations, may return null

getRequestIdentifier

java.lang.String getRequestIdentifier()
Get ID for last execution which can be used for matching up executions on the client side with executions in the server logs.

Returns:
String identifier for the last execution

setPayload

void setPayload(java.io.Serializable payload)
Set the per-statement security payload. This optional payload will accompany each request to the data source(s) so that the connector will have access to it.

To remove an existing payload from a statement, call this method with a null argument.

Parameters:
payload - The payload that is to accompany requests executed from this statement.
Since:
4.2


Copyright © 2011. All Rights Reserved.