com.simba.dsi.core.utilities
Class StmtPropertyKey

java.lang.Object
  extended by com.simba.dsi.core.utilities.StmtPropertyKey

public class StmtPropertyKey
extends java.lang.Object

Constants of statement property keys supported by DSI.


Field Summary
static int DSI_STMT_ADVANCED_CURSOR_TYPES
          An INT16 bitmask indicating which advanced cursor types are supported by the DSI directly.
static int DSI_STMT_ALL
          All statement properties; used to cache values for all driver properties.
static int DSI_STMT_MAX_LENGTH
          A UINT64 value that specifies the maximum amount of data that the driver returns from a character or binary column.
static int DSI_STMT_MAX_LENGTH_MAX_LIMIT
          A UINT64 value corresponding to the maximum limit of the DSI_STMT_MAX_LENGTH property that the driver supports.
static int DSI_STMT_MAX_LENGTH_MIN_LIMIT
          A UINT64 value corresponding to the minimum limit of the DSI_STMT_MAX_LENGTH property that the driver supports.
static int DSI_STMT_MAX_ROWS
          A UINT64 value corresponding to the maximum number of rows to return to the application for a SELECT statement.
static int DSI_STMT_MAX_ROWS_MAX_LIMIT
          A UINT64 value corresponding to the maximum limit of the DSI_STMT_MAX_ROWS property that the driver supports.
static int DSI_STMT_MAX_ROWS_MIN_LIMIT
          A UINT64 value corresponding to the minimum limit of the DSI_STMT_MAX_ROWS property that the driver supports.
static int DSI_STMT_NOSCAN
          A UINT64 value that indicates whether the driver should scan SQL strings for escape sequences.
static int DSI_STMT_QUERY_TIMEOUT
          A UINT64 value corresponding to the number of seconds to wait for an SQL statement to execute before returning to the application.
static int DSI_STMT_QUERY_TIMEOUT_MAX_LIMIT
          A UINT64 value corresponding to the maximum limit of the DSI_STMT_QUERY_TIMEOUT property that the driver supports.
static int DSI_STMT_QUERY_TIMEOUT_MIN_LIMIT
          A UINT64 value corresponding to the minimum limit of the DSI_STMT_QUERY_TIMEOUT property that the driver supports.
static int DSI_STMT_RETRIEVE_DATA
          A UINT64 value indicating if data should be fetched when moving the cursor.
static int DSI_STMT_ROWSET_SIZE
          A UINT64 value indicating the number of rows that are to be fetched to the client application.
static int DSI_STMT_ROWSET_SIZE_MAX_LIMIT
          A UINT64 value corresponding to the maximum limit of the DSI_STMT_ROWSET_SIZE property that the driver supports.
static int DSI_STMT_ROWSET_SIZE_MIN_LIMIT
          A UINT64 value corresponding to the minimum limit of the DSI_STMT_ROWSET_SIZE property that the driver supports.
 
Constructor Summary
StmtPropertyKey()
           
 
Method Summary
static java.util.Set<java.lang.Integer> keySet()
          Get an unmodifiable set containing all of the StmtPropertyKey literals.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DSI_STMT_ALL

public static final int DSI_STMT_ALL
All statement properties; used to cache values for all driver properties.

See Also:
Constant Field Values

DSI_STMT_MAX_LENGTH

public static final int DSI_STMT_MAX_LENGTH
A UINT64 value that specifies the maximum amount of data that the driver returns from a character or binary column. If the maximum amount specified by this property is less than the length of the available data, data retrieval truncates the data and returns a success indicator. If the maximum amount specified by this property is 0 (the default), the driver attempts to return all available data.

See Also:
Constant Field Values

DSI_STMT_MAX_ROWS

public static final int DSI_STMT_MAX_ROWS
A UINT64 value corresponding to the maximum number of rows to return to the application for a SELECT statement. If the maximum amount specified by this property equals 0 (the default), the driver returns all rows.

See Also:
Constant Field Values

DSI_STMT_QUERY_TIMEOUT

public static final int DSI_STMT_QUERY_TIMEOUT
A UINT64 value corresponding to the number of seconds to wait for an SQL statement to execute before returning to the application. If the timeout period is equal to 0 (default), there is no timeout.

See Also:
Constant Field Values

DSI_STMT_ADVANCED_CURSOR_TYPES

public static final int DSI_STMT_ADVANCED_CURSOR_TYPES
An INT16 bitmask indicating which advanced cursor types are supported by the DSI directly. We assume that the DSI always supports forward-only cursors.

This value does not directly correspond to an ODBC attribute/getinfo value. It also does not directly map to a bitmask of supported ODBC cursor types. An ODBC static cursor may be emulated using a DSI forward-only cursor and caching.

See Also:
Constant Field Values

DSI_STMT_RETRIEVE_DATA

public static final int DSI_STMT_RETRIEVE_DATA
A UINT64 value indicating if data should be fetched when moving the cursor.

By setting DSI_STMT_RETRIEVE_DATA to DSI_RD_OFF, an application can verify that a row exists or retrieve a bookmark for the row without incurring the overhead of retrieving rows.

Possible values are: DSI_RD_ON - SQLFetchScroll and, in ODBC 3.x, SQLFetch retrieve data after it positions the cursor to the specified location. DSI_RD_OFF - SQLFetchScroll and, in ODBC 3.x, SQLFetch do not retrieve data after it positions the cursor. default: DSI_RD_ON

See Also:
Constant Field Values

DSI_STMT_ROWSET_SIZE

public static final int DSI_STMT_ROWSET_SIZE
A UINT64 value indicating the number of rows that are to be fetched to the client application.

This value is to be used as an optimization hint by the DSII to possibly implement pre-fetching of data.

default: 1

See Also:
Constant Field Values

DSI_STMT_MAX_LENGTH_MAX_LIMIT

public static final int DSI_STMT_MAX_LENGTH_MAX_LIMIT
A UINT64 value corresponding to the maximum limit of the DSI_STMT_MAX_LENGTH property that the driver supports.

See Also:
Constant Field Values

DSI_STMT_MAX_LENGTH_MIN_LIMIT

public static final int DSI_STMT_MAX_LENGTH_MIN_LIMIT
A UINT64 value corresponding to the minimum limit of the DSI_STMT_MAX_LENGTH property that the driver supports.

See Also:
Constant Field Values

DSI_STMT_MAX_ROWS_MAX_LIMIT

public static final int DSI_STMT_MAX_ROWS_MAX_LIMIT
A UINT64 value corresponding to the maximum limit of the DSI_STMT_MAX_ROWS property that the driver supports.

See Also:
Constant Field Values

DSI_STMT_MAX_ROWS_MIN_LIMIT

public static final int DSI_STMT_MAX_ROWS_MIN_LIMIT
A UINT64 value corresponding to the minimum limit of the DSI_STMT_MAX_ROWS property that the driver supports.

See Also:
Constant Field Values

DSI_STMT_QUERY_TIMEOUT_MAX_LIMIT

public static final int DSI_STMT_QUERY_TIMEOUT_MAX_LIMIT
A UINT64 value corresponding to the maximum limit of the DSI_STMT_QUERY_TIMEOUT property that the driver supports.

See Also:
Constant Field Values

DSI_STMT_QUERY_TIMEOUT_MIN_LIMIT

public static final int DSI_STMT_QUERY_TIMEOUT_MIN_LIMIT
A UINT64 value corresponding to the minimum limit of the DSI_STMT_QUERY_TIMEOUT property that the driver supports.

See Also:
Constant Field Values

DSI_STMT_ROWSET_SIZE_MAX_LIMIT

public static final int DSI_STMT_ROWSET_SIZE_MAX_LIMIT
A UINT64 value corresponding to the maximum limit of the DSI_STMT_ROWSET_SIZE property that the driver supports.

See Also:
Constant Field Values

DSI_STMT_ROWSET_SIZE_MIN_LIMIT

public static final int DSI_STMT_ROWSET_SIZE_MIN_LIMIT
A UINT64 value corresponding to the minimum limit of the DSI_STMT_ROWSET_SIZE property that the driver supports.

See Also:
Constant Field Values

DSI_STMT_NOSCAN

public static final int DSI_STMT_NOSCAN
A UINT64 value that indicates whether the driver should scan SQL strings for escape sequences.

See Also:
Constant Field Values
Constructor Detail

StmtPropertyKey

public StmtPropertyKey()
Method Detail

keySet

public static java.util.Set<java.lang.Integer> keySet()
Get an unmodifiable set containing all of the StmtPropertyKey literals.

Returns:
an unmodifiable set containing all of the StmtPropertyKey literals.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.