Database.Dpi

FFI raw bindings to ODPI-C

import Database.Dpi

conf :: OracleConfig
conf = defaultOracle "username" "password" "localhost:1521/dbname"


main :: IO ()
main = do
  withContext $ \cxt ->
    withPool cxt conf return $ \pool ->
      withPoolConnection pool $ \conn ->
        withStatement conn False "SELECT SYSDATE FROM DUAL" $ \st -> do
          r <- executeStatement st ModeExecDefault
          f <- fetch st
          mapM (getQueryValue st) [1..r] >>= print

Context Interface

Context handles are the top level handles created by the library and are used for all error handling as well as creating pools and standalone connections to the database. The first call to ODPI-C by any application must be createContext which will create the context as well as validate the version used by the application. Context handles are destroyed by using the function destroyContext.

createContext :: IO PtrContext

Creates a new context for interaction with the library. This is the first function that must be called and it must have completed successfully before any other functions can be called, including in other threads.

destroyContext :: PtrContext -> IO Bool

Destroys the context that was earlier created with the function createContext.

withContext :: (PtrContext -> IO a) -> IO a

With Context, PtrContext will be destroyed after run

Information from Context

getClientVersion :: PtrContext -> IO Data_VersionInfo

Return information about the version of the Oracle Client that is being used.

Connection Interface

Connection handles are used to represent connections to the database. These can be standalone connections created by calling the function createConnection. They can be closed by calling the function closeConnection or releasing the last reference to the connection by calling the function releaseConnection. Connection handles are used to create all handles other than session pools and context handles.

data OracleConfig

Oracle Configuration

Constructors

OracleConfig

Fields

• username :: ByteString

  the name of the user used for authenticating the user

• password :: ByteString

  the password to use for authenticating the user

• connstr :: ByteString

  the connect string identifying the database to which a connection is to be established

• connectionCreateMode :: CreateMode

Instances

Show OracleConfig

Methods

showsPrec :: Int -> OracleConfig -> ShowS

show :: OracleConfig -> String

showList :: [OracleConfig] -> ShowS

defaultOracle :: ByteString -> ByteString -> ByteString -> OracleConfig

Default Configuration

type SQL = String

SQL String

createConnection

Arguments

:: PtrContext

Context

-> OracleConfig

-> (Data_ConnCreateParams -> IO Data_ConnCreateParams)

custom Data_ConnCreateParams

-> IO PtrConn

a reference to the connection that is created. If a value is returned, a call to releaseConnection must be made in order to release the reference. This should be done after the error information has been retrieved.

Creates a standalone connection to a database or acquires a connection from a session pool and returns a reference to the connection.

closeConnection :: ConnCloseMode -> PtrConn -> IO Bool

Closes the connection and makes it unusable for further activity. close connection, but not release resource, plese use releaseConnection to release and close connection

releaseConnection :: PtrConn -> IO Bool

Releases a reference to the connection. A count of the references to the connection is maintained and when this count reaches zero, the memory associated with the connection is freed and the connection is closed or released back to the session pool if that has not already taken place using the function closeConnection.

commitConnection :: PtrConn -> IO Bool

Commits the current active transaction.

rollbackConnection :: PtrConn -> IO Bool

Rolls back the current active transaction.

pingConnection :: PtrConn -> IO Bool

Pings the database to verify that the connection is still alive.

withConnection

Arguments

:: PtrContext

Context

-> OracleConfig

-> (Data_ConnCreateParams -> IO Data_ConnCreateParams)

custom Data_ConnCreateParams

-> (PtrConn -> IO a)

action use connection

-> IO a

with connection

Transaction Interface

beginDistributedTransaction

Arguments

:: PtrConn

Connection

-> Int64

the identifier of the format of the XID. A value of -1 indicates that the entire XID is null.

-> ByteString

the global transaction id of the XID as a byte string. The maximum length permitted is 64 bytes.

-> ByteString

the branch id of the XID as a byte string. The maximum length permitted is 64 bytes.

-> IO Bool

Begins a distributed transaction using the specified transaction id (XID) made up of the formatId, transactionId and branchId.

prepareDistributedTransaction :: PtrConn -> IO Bool

Prepares a distributed transaction for commit. This function should only be called after beginTransaction is called and before commitConnection is called.

Information from Connection

getCurrentSchema :: PtrConn -> IO ByteString

Returns the current schema that is being used by the connection.

setCurrentSchema :: PtrConn -> ByteString -> IO Bool

Sets the current schema to be used on the connection. This has the same effect as the SQL statement ALTER SESSION SET CURRENT_SCHEMA. The value be changed when the next call requiring a round trip to the server is performed. If the new schema name does not exist, the same error is returned as when the alter session statement is executed. The new schema name is placed before database objects in statement that you execute that do not already have a schema.

getEdition :: PtrConn -> IO ByteString

Returns the edition that is being used by the connection.

getExternalName :: PtrConn -> IO ByteString

Returns the external name that is being used by the connection. This value is used when logging distributed transactions.

setExternalName :: PtrConn -> ByteString -> IO Bool

Sets the external name that is being used by the connection. This value is used when logging distributed transactions.

getInternalName :: PtrConn -> IO ByteString

Returns the internal name that is being used by the connection. This value is used when logging distributed transactions.

setInternalName :: PtrConn -> ByteString -> IO Bool

Sets the internal name that is being used by the connection. This value is used when logging distributed transactions.

getLTXID :: PtrConn -> IO ByteString

Returns the logical transaction id for the connection. This value is used in Transaction Guard to determine if the last failed call was completed and if the transaction was committed using the procedure call dbms_app_cont.get_ltxid_outcome().

getServerVersion :: PtrConn -> IO (ByteString, Data_VersionInfo)

Returns the version information of the Oracle Database to which the connection has been made.

getObjectType :: PtrConn -> ByteString -> IO PtrObjectType

Looks up an object type by name in the database and returns a reference to it. The reference should be released as soon as it is no longer needed.

getEncodingInfo :: PtrConn -> IO Data_EncodingInfo

Returns the encoding information used by the connection. This will be equivalent to the values passed when the standalone connection or session pool was created, or the values retrieved from the environment variables NLS_LANG and NLS_NCHAR.

getStmtCacheSize :: PtrConn -> IO Int

Returns the size of the statement cache, in number of statements.

setStmtCacheSize :: PtrConn -> Int -> IO Bool

Sets the size of the statement cache.

setClientInfo :: PtrConn -> ByteString -> IO Bool

Sets the client info attribute on the connection. This is one of the end-to-end tracing attributes that can be tracked in database views, shown in audit trails and seen in tools such as Enterprise Manager.

setClientIdentifier :: PtrConn -> ByteString -> IO Bool

Sets the client identifier attribute on the connection. This is one of the end-to-end tracing attributes that can be tracked in database views, shown in audit trails and seen in tools such as Enterprise Manager.

setAction :: PtrConn -> ByteString -> IO Bool

Sets the action attribute on the connection. This is one of the end-to-end tracing attributes that can be tracked in database views, shown in audit trails and seen in tools such as Enterprise Manager.

setDbOp :: PtrConn -> ByteString -> IO Bool

Sets the database operation attribute on the connection. This is one of the end-to-end tracing attributes that can be tracked in database views, shown in audit trails and seen in tools such as Enterprise Manager.

setModule :: PtrConn -> ByteString -> IO Bool

Sets the module attribute on the connection. This is one of the end-to-end tracing attributes that can be tracked in database views, shown in audit trails and seen in tools such as Enterprise Manager.

getHandler :: PtrConn -> IO (Ptr ())

Returns the OCI service context handle in use by the connection.

Connection Management

connectionAddRef :: PtrConn -> IO Bool

Adds a reference to the connection. This is intended for situations where a reference to the connection needs to be maintained independently of the reference returned when the connection was created.

breakException :: PtrConn -> IO Bool

Performs an immediate (asynchronous) termination of any currently executing function on the server associated with the connection.

changePassword

Arguments

:: PtrConn

Connection

-> ByteString

the name of the user whose password is to be changed

-> ByteString

the old password of the user whose password is to be changed

-> ByteString

the new password of the user whose password is to be changed

-> IO Bool

Changes the password of the specified user.

shutdownDatabase

Arguments

:: PtrConn

a reference to the connection to the database which is to be shut down. The connection needs to have been established at least with authorization mode set to ModeAuthSysdba or ModeAuthSysoper.

-> ShutdownMode

-> IO Bool

Shuts down the database. This function must be called twice for the database to be shut down successfully. After calling this function the first time, the SQL statements “alter database close normal” and “alter database dismount” must be executed. Once that is complete this function should be called again with the mode ModeShutdownFinal in order to complete the orderly shutdown of the database.

startupDatabase

Arguments

:: PtrConn

a reference to the connection to the database which is to be started up. A connection like this can only be created with the authorization mode set to ModeAuthPrelim along with one of ModeAuthSysdba or ModeAuthSysoper.

-> StartupMode

one of the values from the enumeration StartupMode

-> IO Bool

Starts up a database.

ConnectionPool Interace

Pool handles are used to represent session pools. They are created using the function createPool and can be closed by calling the function closePool or releasing the last reference to the pool by calling the function releasePool. Pools can be used to create connections by calling the function acquiredConnection.

acquiredConnection :: PtrPool -> IO PtrConn

Acquires a connection from the pool and returns a reference to it. This reference should be released as soon as it is no longer needed.

poolAddRef :: PtrPool -> IO Bool

Adds a reference to the pool. This is intended for situations where a reference to the pool needs to be maintained independently of the reference returned when the pool was created.

createPool

Arguments

:: PtrContext

Context

-> OracleConfig

-> (Data_PoolCreateParams -> IO Data_PoolCreateParams)

-> IO PtrPool

Creates a session pool which creates and maintains a group of stateless sessions to the database. The main benefit of session pooling is performance since making a connection to the database is a time-consuming activity, especially when the database is remote.

closePool :: PtrPool -> PoolCloseMode -> IO Bool

Closes the pool and makes it unusable for further activity.

releasePool :: PtrPool -> IO Bool

Releases a reference to the pool. A count of the references to the pool is maintained and when this count reaches zero, the memory associated with the pool is freed and the session pool is closed if that has not already taken place using the function closePool.

withPool

Arguments

:: PtrContext

Context

-> OracleConfig

-> (Data_PoolCreateParams -> IO Data_PoolCreateParams)

-> (PtrPool -> IO a)

action use connection

-> IO a

with pool

withPoolConnection :: PtrPool -> (PtrConn -> IO a) -> IO a

with pool provide a connection will released after action

getPoolBusyCount :: PtrPool -> IO Int

Returns the number of sessions in the pool that are busy.

getPoolEncodingInfo :: PtrPool -> IO Data_EncodingInfo

Returns the encoding information used by the pool. This will be equivalent to the values passed when the pool was created, or the values retrieved from the environment variables NLS_LANG and NLS_NCHAR.

getPoolMode :: PtrPool -> IO PoolGetMode

Returns the mode used for acquiring or getting connections from the pool.

getPoolMaxLifetimeSession :: PtrPool -> IO Int

Returns the maximum lifetime of all sessions in the pool, in seconds. Sessions in the pool are terminated when this value has been reached, but only when another session is released back to the pool.

getPoolOpenCount :: PtrPool -> IO Int

Returns the number of sessions in the pool that are open.

getPoolStmtCacheSize :: PtrPool -> IO Int

Returns the default size of the statement cache for sessions in the pool, in number of statements.

getPoolTimeout :: PtrPool -> IO Int

Returns the amount of time, in seconds, after which idle sessions in the pool are terminated, but only when another session is released back to the pool.

getPoolWaitTimeout :: PtrPool -> IO Int

Returns the amount of time (in milliseconds) that the caller will wait for a session to become available in the pool before returning an error.

@since ODPI-C 2.4.0

setPoolGetMode :: PtrPool -> PoolGetMode -> IO Bool

Sets the mode used for acquiring or getting connections from the pool.

setPoolMaxLifetimeSession :: PtrPool -> Int -> IO Bool

Sets the maximum lifetime of all sessions in the pool, in seconds. Sessions in the pool are terminated when this value has been reached, but only when another session is released back to the pool.

setPoolStmtCacheSize :: PtrPool -> Int -> IO Bool

Sets the default size of the statement cache for sessions in the pool.

setPoolTimeout :: PtrPool -> Int -> IO Bool

Sets the amount of time, in seconds, after which idle sessions in the pool are terminated, but only when another session is released back to the pool.

setPoolWaitTimeout :: PtrPool -> Int -> IO Bool

Sets the amount of time (in milliseconds) that the caller should wait for a session to be available in the pool before returning with an error.

@since ODPI-C 2.4.0

Statement Interface

Statement handles are used to represent statements of all types (queries, DML, DDL and PL/SQL). They are created by calling the function prepareStatement. They are also created implicitly when a variable of type OracleTypeStmt is created. Statement handles can be closed by calling the function closeStatement or by releasing the last reference to the statement by calling the function releaseStatement.

prepareStatement

Arguments

:: PtrConn

Connection

-> Bool

a boolean indicating if the statement is scrollable or not. If it is scrollable, scrollStatement can be used to reposition the cursor; otherwise, rows are retrieved in order from the statement until the rows are exhausted. This value is ignored for statements that do not refer to a query.

-> SQL

SQL String, not allow to use multi lines or semicolon as end of sql. use normalize use normalize sql ByteString.

-> IO PtrStmt

Returns a reference to a statement prepared for execution. The reference should be released as soon as it is no longer needed.

closeStatement :: PtrStmt -> IO Bool

Closes the statement and makes it unusable for further work immediately, rather than when the reference count reaches zero.

releaseStatement :: PtrStmt -> IO Bool

Releases a reference to the statement. A count of the references to the statement is maintained and when this count reaches zero, the memory associated with the statement is freed and the statement is closed if that has not already taken place using the function closeStatement.

withStatement

Arguments

:: PtrConn

Connection

-> Bool

a boolean indicating if the statement is scrollable or not. If it is scrollable, scrollStatement can be used to reposition the cursor; otherwise, rows are retrieved in order from the statement until the rows are exhausted. This value is ignored for statements that do not refer to a query.

-> SQL

SQL String, not allow to use multi lines or semicolon as end of sql. use normalize use normalize sql ByteString.

-> (PtrStmt -> IO a)

-> IO a

with statement provide a prepared statement will released after action

scrollStatement :: PtrStmt -> FetchMode -> Int -> Int -> IO Bool

Scrolls the statement to the position in the cursor specified by the mode and offset.

statementAddRef :: PtrStmt -> IO Bool

Adds a reference to the statement. This is intended for situations where a reference to the statement needs to be maintained independently of the reference returned when the statement was created.

Statement Bind Vars

bindByName

Arguments

:: PtrStmt

Statement

-> ByteString

a byte string in the encoding used for CHAR data giving the name of the placeholder which is to be bound.

-> PtrVar

a reference to the variable which is to be bound.

-> IO Bool

Binds a variable to a named placeholder in the statement. A reference to the variable is retained by the library and is released when the statement itself is released or a new variable is bound to the same name.

bindByPosition

Arguments

:: PtrStmt

Statement

-> Int

the position which is to be bound. The position of a placeholder is determined by its location in the statement. Placeholders are numbered from left to right, starting from 1, and duplicate names do not count as additional placeholders.

-> PtrVar

a reference to the variable which is to be bound.

-> IO Bool

Binds a variable to a placeholder in the statement by position. A reference to the variable is retained by the library and is released when the statement itself is released or a new variable is bound to the same position.

bindValueByName

Arguments

:: PtrStmt

Statement

-> ByteString

a byte string in the encoding used for CHAR data giving the name of the placeholder which is to be bound.

-> DataValue

Value Once the statement has been executed, this new variable will be released.

-> IO Bool

Binds a value to a named placeholder in the statement without the need to create a variable directly. One is created implicitly and released when the statement is released or a new value is bound to the same name.

bindValueByPosition

Arguments

:: PtrStmt

Statement

-> Int

the position which is to be bound. The position of a placeholder is determined by its location in the statement. Placeholders are numbered from left to right, starting from 1, and duplicate names do not count as additional placeholders.

-> DataValue

Value Once the statement has been executed, this new variable will be released.

-> IO Bool

Binds a value to a placeholder in the statement without the need to create a variable directly. One is created implicitly and released when the statement is released or a new value is bound to the same position.

define

Arguments

:: PtrStmt

Statement

-> Int

the position which is to be defined. The first position is 1.

-> PtrVar

a reference to the variable which is to be used for fetching rows from the statement at the given position.

-> IO Bool

Defines the variable that will be used to fetch rows from the statement. A reference to the variable will be retained until the next define is performed on the same position or the statement is closed.

defineValue

Arguments

:: PtrStmt

Statement

-> Int

the position which is to be defined. The first position is 1.

-> OracleTypeNum

the type of Oracle data that is to be used.

-> NativeTypeNum

the type of native C data that is to be used.

-> Int

the maximum size of the buffer used for transferring data to/from Oracle. This value is only used for variables transferred as byte strings. Size is either in characters or bytes depending on the value of the sizeIsBytes parameter. If the value is in characters, internally the value will be multipled by the maximum number of bytes for each character and that value used instead when determining the necessary buffer size.

-> Bool

boolean value indicating if the size parameter refers to characters or bytes. This flag is only used if the variable refers to character data.

-> PtrObjectType

a reference to the object type of the object that is being bound or fetched. This value is only used if the Oracle type is OracleTypeObject.

-> IO Bool

Defines the type of data that will be used to fetch rows from the statement. This is intended for use with the function getQueryValue, when the default data type derived from the column metadata needs to be overridden by the application. Internally, a variable is created with the specified data type and size.

getBindCount :: PtrStmt -> IO Int

Returns the number of bind variables in the prepared statement. In SQL statements this is the total number of bind variables whereas in PL/SQL statements this is the count of the unique bind variables.

getBindNames :: PtrStmt -> IO [ByteString]

Returns the names of the unique bind variables in the prepared statement.

getStatementInfo :: PtrStmt -> IO Data_StmtInfo

Returns information about the statement.

getFetchArraySize :: PtrStmt -> IO Int

Gets the array size used for performing fetches.

setFetchArraySize :: PtrStmt -> Int -> IO Bool

Sets the array size used for performing fetches. All variables defined for fetching must have this many (or more) elements allocated for them. The higher this value is the less network round trips are required to fetch rows from the database but more memory is also required. A value of zero will reset the array size to the default value of DPI_DEFAULT_FETCH_ARRAY_SIZE.

getImplicitResult :: PtrStmt -> IO (Maybe PtrStmt)

Returns the next implicit result available from the last execution of the statement. Implicit results are only available when both the client and server are 12.1 or higher.

getNumberQueryColumns :: PtrStmt -> IO Int

Returns the number of columns that are being queried.

getQueryInfo

Arguments

:: PtrStmt

Statement

-> Int

the position of the column whose metadata is to be retrieved. The first position is 1.

-> IO Data_QueryInfo

Returns information about the column that is being queried.

getQueryValue

Arguments

:: PtrStmt

Statement

-> Int

the position of the column whose metadata is to be retrieved. The first position is 1.

-> IO DataValue

Returns the value of the column at the given position for the currently fetched row, without needing to provide a variable. If the data type of the column needs to be overridden, the function defineValue can be called to specify a different type after executing the statement but before fetching any data.

Execute Statement

executeStatement :: PtrStmt -> ExecMode -> IO Int

Executes the statement using the bound values. For queries this makes available metadata which can be acquired using the function getQueryInfo. For non-queries, out and in-out variables are populated with their values.

executeMany :: PtrStmt -> ExecMode -> Int -> IO Bool

fetch :: PtrStmt -> IO (Maybe PageOffset)

Fetches a single row from the statement. If the statement does not refer to a query an error is returned. All columns that have not been defined prior to this call are implicitly defined using the metadata made available when the statement was executed.

type PageOffset = Int64

type PageLimit = Int64

type Page = (PageOffset, PageLimit)

type FetchRows a = PtrStmt -> Page -> IO a

fetchRows

Arguments

:: PtrStmt

Statement

-> Int

the maximum number of rows to fetch. If the number of rows available exceeds this value only this number will be fetched.

-> IO (Bool, [DataValue])

Returns the number of rows that are available in the buffers defined for the query. If no rows are currently available in the buffers, an internal fetch takes place in order to populate them, if rows are available. If the statement does not refer to a query an error is returned. All columns that have not been defined prior to this call are implicitly defined using the metadata made available when the statement was executed.

getRowCount :: PtrStmt -> IO Int

Returns the number of rows affected by the last DML statement that was executed or the number of rows currently fetched from a query. In all other cases 0 is returned.

getRowCounts :: PtrStmt -> IO [Int]

Returns an array of row counts affected by the last invocation of executeMany with the array DML rowcounts mode enabled. This feature is only available if both client and server are at 12.1.

getSubscrQueryId :: PtrStmt -> IO Word64

Returns the id of the query that was just registered on the subscription by calling executeStatement on a statement prepared by calling prepareStatement.

getBatchErrorCount :: PtrStmt -> IO Int

getBatchErrors :: PtrStmt -> IO [Data_ErrorInfo]

Lob Interface

LOB handles are used to represent large objects (CLOB, BLOB, NCLOB, BFILE). Both persistent and temporary large objects can be represented. LOB handles can be created by calling the function newTempLob or are created implicitly when a variable of type OracleTypeClob, OracleTypeNclob, OracleTypeBlob or OracleTypeBfile is created and are destroyed when the last reference is released by calling the function releaseLob. They are used for reading and writing data to the database in smaller pieces than is contained in the large object.

lobAddRef :: PtrLob -> IO Bool

Adds a reference to the LOB. This is intended for situations where a reference to the LOB needs to be maintained independently of the reference returned when the LOB was created.

newTempLob :: PtrConn -> OracleTypeNum -> IO PtrLob

Returns a reference to a new temporary LOB which may subsequently be written and bound to a statement. The reference should be released as soon as it is no longer needed.

closeLob :: PtrLob -> IO Bool

close lob

releaseLob :: PtrLob -> IO Bool

Releases a reference to the LOB. A count of the references to the LOB is maintained and when this count reaches zero, the memory associated with the LOB is freed. The LOB is also closed unless that has already taken place using the function closeLob.

trimLob :: PtrLob -> Int64 -> IO Bool

Trims the data in the LOB so that it only contains the specified amount of data.

closeLobResource :: PtrLob -> IO Bool

Closes the LOB resource. This should be done when a batch of writes has been completed so that the indexes associated with the LOB can be updated. It should only be performed if a call to function openLobResource has been performed.

openLobResource :: PtrLob -> IO Bool

Opens the LOB resource for writing. This will improve performance when writing to the LOB in chunks and there are functional or extensible indexes associated with the LOB. If this function is not called, the LOB resource will be opened and closed for each write that is performed. A call to the function closeLobResource should be done before performing a call to the function commitConnection.

isLobResourceOpen :: PtrLob -> IO Bool

Returns a boolean value indicating if the LOB resource has been opened by making a call to the function openLobResource (1) or not (0).

copyLob :: PtrLob -> IO PtrLob

Creates an independent copy of a LOB and returns a reference to the newly created LOB. This reference should be released as soon as it is no longer needed.

flushLob :: PtrLob -> IO Bool

Flush or write all buffers for this LOB to the server.

getLobBufferSize :: PtrLob -> Word64 -> IO Word64

Returns the size of the buffer needed to hold the number of characters specified for a buffer of the type associated with the LOB. If the LOB does not refer to a character LOB the value is returned unchanged.

getLobChunkSize :: PtrLob -> IO Int64

Returns the chunk size of the internal LOB. Reading and writing to the LOB in multiples of this size will improve performance.

getLobDirectoryAndFileName :: PtrLob -> IO (FilePath, String)

Returns the directory alias name and file name for a BFILE type LOB.

setLobDirectoryAndFileName :: PtrLob -> (FilePath, String) -> IO Bool

Sets the directory alias name and file name for a BFILE type LOB.

lobFileExists :: PtrLob -> IO Bool

Returns a boolean value indicating if the file referenced by the BFILE type LOB exists (1) or not (0).

getLobSize :: PtrLob -> IO Int64

Returns the size of the data stored in the LOB. For character LOBs the size is in characters; for binary LOBs the size is in bytes.

setLobFromBytes :: PtrLob -> ByteString -> IO Bool

Replaces all of the data in the LOB with the contents of the provided buffer. The LOB will first be cleared and then the provided data will be written.

type BufferSize = Int64

readLobBytes :: PtrLob -> Page -> BufferSize -> IO ByteString

Reads data from the LOB at the specified offset into the provided buffer.

writeLobBytes :: PtrLob -> PageOffset -> ByteString -> IO Bool

Write data to the LOB at the specified offset using the provided buffer as the source. If multiple calls to this function are planned, the LOB should first be opened using the function openLob.

Object Interface

Object handles are used to represent instances of the types created by the SQL command CREATE OR REPLACE TYPE. They are created by calling the function createObject or calling the function copyObject or implicitly by creating a variable of the type OracleTypeObject. The are destroyed when the last reference is released by calling the function releaseObject.

createObject :: PtrObjectType -> IO PtrObject

Creates an object of the specified type and returns a reference to it. This reference should be released as soon as it is no longer needed.

releaseObject :: PtrObject -> IO Bool

Releases a reference to the object. A count of the references to the object is maintained and when this count reaches zero, the memory associated with the object is freed.

objectAddRef :: PtrObject -> IO Bool

Adds a reference to the object. This is intended for situations where a reference to the object needs to be maintained independently of the reference returned when the object was created.

objectAppendElement :: PtrObject -> NativeTypeNum -> PtrData -> IO Bool

Sets the value of the element found at the specified index.

copyObject :: PtrObject -> IO PtrObject

Creates an independent copy of an object and returns a reference to the newly created object. This reference should be released as soon as it is no longer needed.

trimObject :: PtrObject -> Int -> IO Bool

Trims a number of elements from the end of a collection.

objectDeleteElementByIndex :: PtrObject -> Int -> IO Bool

Deletes an element from the collection. Note that the position ordinals of the remaining elements are not changed. The delete operation creates holes in the collection.

setObjectAttributeValue :: PtrObject -> PtrObjectAttr -> DataValue -> IO Bool

Sets the value of one of the object’s attributes.

getObjectAttributeValue :: PtrObject -> PtrObjectAttr -> NativeTypeNum -> OracleTypeNum -> IO DataValue

Returns the value of one of the object’s attributes.

getObjectElementExistsByIndex :: PtrObject -> Int -> IO Bool

setObjectElementValueByIndex :: PtrObject -> Int -> DataValue -> IO Bool

Sets the value of the element found at the specified index.

getObjectElementValueByIndex :: PtrObject -> Int -> NativeTypeNum -> OracleTypeNum -> IO DataValue

Returns the value of the element found at the specified index.

getObjectFirstIndex :: PtrObject -> IO (Maybe Int)

Returns the first index used in a collection.

getObjectLastIndex :: PtrObject -> IO (Maybe Int)

Returns the last index used in a collection.

getObjectNextIndex :: PtrObject -> Int -> IO (Maybe Int)

Returns the next index used in a collection following the specified index.

getObjectPrevIndex :: PtrObject -> Int -> IO (Maybe Int)

Returns the previous index used in a collection preceding the specified index.

getObjectSize :: PtrObject -> IO Int

Returns the number of elements in a collection.

ObjectAttr

Object attribute handles are used to represent the attributes of types such as those created by the SQL command CREATE OR REPLACE TYPE. They are created by calling the function getObjectTypeAttributes and are destroyed when the last reference is released by calling the function releaseObjectAttr.

getObjectAttrInfo :: PtrObjectAttr -> IO Data_ObjectAttrInfo

Returns information about the attribute.

objectAttrAddRef :: PtrObjectAttr -> IO Bool

Adds a reference to the attribute. This is intended for situations where a reference to the attribute needs to be maintained independently of the reference returned when the attribute was created.

releaseObjectAttr :: PtrObjectAttr -> IO Bool

Releases a reference to the attribute. A count of the references to the attribute is maintained and when this count reaches zero, the memory associated with the attribute is freed.

ObjectType

Object type handles are used to represent types such as those created by the SQL command CREATE OR REPLACE TYPE. They are created using the function getObjectType or implicitly when fetching from a column containing objects by calling the function getQueryInfo. Object types are also retrieved when used as attributes in another object by calling the function getObjectAttrInfo or as the element type of a collection by calling the function getObjectTypeInfo. They are destroyed when the last reference is released by calling the function releaseObjectType.

objectTypeAddRef :: PtrObjectType -> IO Bool

Adds a reference to the object type. This is intended for situations where a reference to the object type needs to be maintained independently of the reference returned when the object type was created.

releaseObjectType :: PtrObjectType -> IO Bool

Releases a reference to the object type. A count of the references to the object type is maintained and when this count reaches zero, the memory associated with the object type is freed.

getObjectTypeAttributes :: PtrObjectType -> Int -> IO PtrObjectAttr

Returns the list of attributes that belong to the object type.

getObjectTypeInfo :: PtrObjectType -> IO Data_ObjectTypeInfo

Returns information about the object type.

Rowid Interface

Rowid handles are used to represent the unique identifier of a row in the database. They cannot be created or set directly but are created implicitly when a variable of type OracleTypeRowid is created. They are destroyed when the last reference is released by a call to the function releaseRowid.

rowidAddRef :: PtrRowid -> IO Bool

Adds a reference to the rowid. This is intended for situations where a reference to the rowid needs to be maintained independently of the reference returned when the rowid was created.

releaseRowid :: PtrRowid -> IO Bool

Releases a reference to the rowid. A count of the references to the rowid is maintained and when this count reaches zero, the memory associated with the rowid is freed.

rowidGetStringValue :: PtrRowid -> IO ByteString

Returns the sting (base64) representation of the rowid.

Data Interface

All of these functions are used for getting and setting the various members of the dpiData structure. The members of the structure can be manipulated directly but some languages (such as Go) do not have the ability to manipulate structures containing unions or the ability to process macros. For this reason, none of these functions perform any error checking. They are assumed to be replacements for direct manipulation of the various members of the structure.

getBool :: PtrData -> IO Bool

Returns the value of the data when the native type is NativeTypeBoolean.

setBool :: PtrData -> Bool -> IO ()

Sets the value of the data when the native type is NativeTypeBoolean.

getBytes :: PtrData -> IO ByteString

Returns a pointer to the value of the data when the native type is NativeTypeBytes.

setBytes :: PtrData -> ByteString -> IO ()

Sets the value of the data when the native type is NativeTypeBytes. Do not use this function when setting data for variables. Instead, use the function setVarFromBytes.

getDouble :: PtrData -> IO Double

Returns the value of the data when the native type is NativeTypeDouble.

setDouble :: PtrData -> Double -> IO ()

Sets the value of the data when the native type is NativeTypeDouble.

getFloat :: PtrData -> IO Float

Returns the value of the data when the native type is NativeTypeFloat.

setFloat :: PtrData -> Float -> IO ()

Sets the value of the data when the native type is NativeTypeFloat.

getInt64 :: PtrData -> IO Int64

Returns the value of the data when the native type is NativeTypeInt64.

setInt64 :: PtrData -> Int64 -> IO ()

Sets the value of the data when the native type is NativeTypeInt64.

getUint64 :: PtrData -> IO Word64

Returns the value of the data when the native type is NativeTypeUint64.

setUint64 :: PtrData -> Word64 -> IO ()

Sets the value of the data when the native type is NativeTypeUint64.

getIntervalDs :: PtrData -> IO Data_IntervalDS

Returns the value of the data when the native type is NativeTypeIntervalDs.

setIntervalDs :: PtrData -> Data_IntervalDS -> IO ()

Sets the value of the data when the native type is NativeTypeIntervalDs.

getIntervalYm :: PtrData -> IO Data_IntervalYM

Returns the value of the data when the native type is NativeTypeIntervalYm.

setIntervalYm :: PtrData -> Data_IntervalYM -> IO ()

Sets the value of the data when the native type is NativeTypeIntervalYm.

getLob :: PtrData -> IO (Ptr DPI_Lob)

Returns the value of the data when the native type is NativeTypeLob.

setLob :: PtrData -> Ptr DPI_Lob -> IO ()

Sets the value of the data when the native type is NativeTypeLob.

getObject :: PtrData -> IO (Ptr DPI_Object)

Returns the value of the data when the native type is NativeTypeObject.

setObject :: PtrData -> Ptr DPI_Object -> IO ()

Sets the value of the data when the native type is NativeTypeObject.

getStmt :: PtrData -> IO (Ptr DPI_Stmt)

Returns the value of the data when the native type is NativeTypeStmt.

setStmt :: PtrData -> Ptr DPI_Stmt -> IO ()

Sets the value of the data when the native type is NativeTypeStmt.

getTimestamp :: PtrData -> IO Data_Timestamp

Returns the value of the data when the native type is NativeTypeTimestamp.

setTimestamp :: PtrData -> Data_Timestamp -> IO ()

Sets the value of the data when the native type is NativeTypeTimestamp.

Var Interface

Variable handles are used to represent memory areas used for transferring data to and from the database. They are created by calling the function newVar. They are destroyed when the last reference to the variable is released by calling the function releaseVar. They are bound to statements by calling the function bindByName or the function bindByPosition. They can also be used for fetching data from the database by calling the function define.

newVar

Arguments

:: PtrConn

Connection

-> OracleTypeNum

the type of Oracle data that is to be used.

-> NativeTypeNum

the type of native C data that is to be used.

-> Int

the maximum number of rows that can be fetched or bound at one time from the database, or the maximum number of elements that can be stored in a PL/SQL array.

-> Int

the maximum size of the buffer used for transferring data to/from Oracle. This value is only used for variables transferred as byte strings. Size is either in characters or bytes depending on the value of the sizeIsBytes parameter. If the value is in characters, internally the value will be multipled by the maximum number of bytes for each character and that value used instead when determining the necessary buffer size.

-> Bool

boolean value indicating if the size parameter refers to characters or bytes. This flag is only used if the variable refers to character data.

-> Bool

boolean value indicating if the variable refers to a PL/SQL array or simply to buffers used for binding or fetching data.

-> PtrObjectType

a reference to the object type of the object that is being bound or fetched. This value is only used if the Oracle type is OracleTypeObject.

-> IO (PtrVar, [PtrData])

Returns a reference to a new variable which can be used for binding data to a statement or providing a buffer for querying data from the database. The reference should be released as soon as it is no longer needed.

varAddRef :: PtrVar -> IO Bool

Adds a reference to the variable. This is intended for situations where a reference to the variable needs to be maintained independently of the reference returned when the variable was created.

releaseVar :: PtrVar -> IO Bool

Releases a reference to the variable. A count of the references to the variable is maintained and when this count reaches zero, the memory associated with the variable is freed.

copyVar :: PtrVar -> Int -> PtrVar -> Int -> IO Bool

Copies the data from one variable to another variable.

getVarData :: PtrVar -> IO [Data]

Returns a pointer to an array of dpiData structures used for transferring data to and from the database. These structures are allocated by the variable itself and are made available when the variable is first created using the function newVar. If a DML returning statement is executed, however, the number of allocated elements can change in addition to the memory location.

getVarReturnedData :: PtrVar -> Int -> IO [Data]

Returns a pointer to an array of dpiData structures used for transferring data to and from the database. These structures are allocated by the variable itself when a DML returning statement is executed and the variable is bound.

@since ODPI-C 2.4.0

getVarElementsSize :: PtrVar -> IO Int

Returns the number of elements in a PL/SQL index-by table if the variable was created as an array by the function newVar. If the variable is one of the output bind variables of a DML returning statement, however, the value returned will correspond to the number of rows returned by the DML returning statement. In all other cases, the value returned will be the number of elements the variable was created with.

getVarSizeInBytes :: PtrVar -> IO Int

Returns the size of the buffer used for one element of the array used for fetching/binding Oracle data

setVarFromBytes :: PtrVar -> Int -> ByteString -> IO Bool

Sets the variable value to the specified byte string. In the case of the variable’s Oracle type being OracleTypeNumber, the byte string is converted to an Oracle number during the call to this function.

setVarFromLob :: PtrVar -> Int -> PtrLob -> IO Bool

Sets the variable value to the specified LOB.

setVarFromObject :: PtrVar -> Int -> PtrObject -> IO Bool

Sets the variable value to the specified object.

setVarFromRowid :: PtrVar -> Int -> PtrRowid -> IO Bool

Sets the variable value to the specified rowid.

setVarFromStatement :: PtrVar -> Int -> PtrStmt -> IO Bool

Sets the variable value to the specified statement.

setVarNumberOfElements :: PtrVar -> Int -> IO Bool

Sets the number of elements in a PL/SQL index-by table.

DeqOptions Interface

deqOptions Dequeue option handles are used to represent the options specified when dequeuing messages using advanced queueing. They are created by calling the function newDeqOptions and are destroyed by releasing the last reference by calling the function releaseDeqOptions.

newDeqOptions :: PtrConn -> IO PtrDeqOptions

Returns a reference to a new set of dequeue options, used in dequeuing objects from a queue. The reference should be released as soon as it is no longer needed.

deqObject

Arguments

:: PtrConn

a reference to the connection from which the message is to be dequeued

-> ByteString

the name of the queue from which the message is to be dequeued

-> PtrDeqOptions

a reference to the dequeue options that should be used when dequeuing the message from the queue.

-> PtrMsgProps

a reference to the message properties that will be populated with information from the message that is dequeued.

-> PtrObject

a reference to the object which will be populated with the message that is dequeued.

-> IO (Maybe ByteString)

a pointer to a byte string which will be populated with the id of the message that is dequeued

Dequeues a message from a queue.

releaseDeqOptions :: PtrDeqOptions -> IO Bool

Releases a reference to the dequeue options. A count of the references to the dequeue options is maintained and when this count reaches zero, the memory associated with the options is freed.

deqOptionsAddRef :: PtrDeqOptions -> IO Bool

Adds a reference to the dequeue options. This is intended for situations where a reference to the dequeue options needs to be maintained independently of the reference returned when the handle was created.

getDeqOptionsCondition :: PtrDeqOptions -> IO ByteString

Returns the condition that must be satisfied in order for a message to be dequeued. See function setDeqOptionsCondition for more information.

setDeqOptionsCondition :: PtrDeqOptions -> ByteString -> IO Bool

Sets the condition which must be true for messages to be dequeued. The condition must be a valid boolean expression similar to the where clause of a SQL query. The expression can include conditions on message properties, user data properties and PL/SQL or SQL functions. User data properties must be prefixed with tab.user_data as a qualifier to indicate the specific column of the queue table that stores the message payload.

getDeqOptionsConsumerName :: PtrDeqOptions -> IO ByteString

Returns the name of the consumer that is dequeuing messages. See function setDeqOptionsConsumerName for more information.

setDeqOptionsConsumerName :: PtrDeqOptions -> ByteString -> IO Bool

Sets the name of the consumer which will be dequeuing messages. This value should only be set if the queue is set up for multiple consumers.

getDeqOptionsCorrelation :: PtrDeqOptions -> IO ByteString

Returns the correlation of the message to be dequeued. See function setDeqOptionsCorrelation for more information.

setDeqOptionsCorrelation :: PtrDeqOptions -> ByteString -> IO Bool

Sets the correlation of the message to be dequeued. Special pattern matching characters such as the percent sign (%) and the underscore (_) can be used. If multiple messages satisfy the pattern, the order of dequeuing is undetermined.

getDeqOptionsMode :: PtrDeqOptions -> IO DeqMode

Returns the mode that is to be used when dequeuing messages.

setDeqOptionsMode :: PtrDeqOptions -> DeqMode -> IO Bool

Sets the mode that is to be used when dequeuing messages.

getDeqOptionsMsgId :: PtrDeqOptions -> IO ByteString

Returns the identifier of the specific message that is to be dequeued.

setDeqOptionsMsgId :: PtrDeqOptions -> ByteString -> IO Bool

Sets the identifier of the specific message to be dequeued.

getDeqOptionsNavigation :: PtrDeqOptions -> IO DeqNavigation

Returns the position of the message that is to be dequeued.

setDeqOptionsNavigation :: PtrDeqOptions -> DeqNavigation -> IO Bool

Sets the position in the queue of the message that is to be dequeued.

getDeqOptionsTransformation :: PtrDeqOptions -> IO ByteString

Returns the transformation of the message to be dequeued. See function setDeqOptionsTransformation for more information.

setDeqOptionsTransformation :: PtrDeqOptions -> ByteString -> IO Bool

Sets the transformation of the message to be dequeued. The transformation is applied after the message is dequeued but before it is returned to the application. It must be created using DBMS_TRANSFORM.

getDeqOptionsVisibility :: PtrDeqOptions -> IO Visibility

Returns whether the message being dequeued is part of the current transaction or constitutes a transaction on its own.

setDeqOptionsVisibility :: PtrDeqOptions -> Visibility -> IO Bool

Sets whether the message being dequeued is part of the current transaction or constitutes a transaction on its own.

getDeqOptionsWait :: PtrDeqOptions -> IO Int

Returns the time to wait, in seconds, for a message matching the search criteria. See function setDeqOptionsWait for more information.

setDeqOptionsWait :: PtrDeqOptions -> Int -> IO Bool

Set the time to wait, in seconds, for a message matching the search criteria.

setDeqOptionsDeliveryMode :: PtrDeqOptions -> MessageDeliveryMode -> IO Bool

Sets the message delivery mode that is to be used when dequeuing messages.

EnqOptions Interface

Enqueue option handles are used to represent the options specified when enqueuing messages using advanced queueing. They are created by calling the function newEnqOptions and are destroyed by releasing the last reference by calling the function releaseEnqOptions.

newEnqOptions :: PtrConn -> IO PtrEnqOptions

Returns a reference to a new set of enqueue options, used in enqueuing objects into a queue. The reference should be released as soon as it is no longer needed.

enqObject

Arguments

:: PtrConn

a reference to the connection from which the message is to be enqueued

-> ByteString

the name of the queue from which the message is to be enqueued

-> PtrEnqOptions

a reference to the enqueue options that should be used when enqueued the message from the queue.

-> PtrMsgProps

a reference to the message properties that will be populated with information from the message that is enqueued.

-> PtrObject

a reference to the object which will be populated with the message that is enqueued.

-> IO (Maybe ByteString)

a pointer to a byte string which will be populated with the id of the message that is enqueued

Enqueues a message to a queue.

enqOptionsAddRef :: PtrEnqOptions -> IO Bool

Adds a reference to the enqueue options. This is intended for situations where a reference to the enqueue options needs to be maintained independently of the reference returned when the handle was created.

releaseEnqOptions :: PtrEnqOptions -> IO Bool

Releases a reference to the enqueue options. A count of the references to the enqueue options is maintained and when this count reaches zero, the memory associated with the options is freed.

getEnqOptionsTransformation :: PtrEnqOptions -> IO ByteString

Returns the transformation of the message to be enqueued. See function setEnqOptionsTransformation for more information.

setEnqOptionsTransformation :: PtrEnqOptions -> ByteString -> IO Bool

Sets the transformation of the message to be enqueued. The transformation is applied after the message is enqueued but before it is returned to the application. It must be created using DBMS_TRANSFORM.

getEnqOptionsVisibility :: PtrEnqOptions -> IO Visibility

Returns whether the message being enqueued is part of the current transaction or constitutes a transaction on its own.

setEnqOptionsVisibility :: PtrEnqOptions -> Visibility -> IO Bool

Sets whether the message being enqueued is part of the current transaction or constitutes a transaction on its own.

setEnqOptionsDeliveryMode :: PtrEnqOptions -> MessageDeliveryMode -> IO Bool

Sets the message delivery mode that is to be used when enqueuing messages.

MsgProps Interface

msg Message properties handles are used to represent the properties of messages that are enqueued and dequeued using advanced queuing. They are created by calling the function newMsgProps and are destroyed by releasing the last reference by calling the function releaseMsgProps.

newMsgProps :: PtrConn -> IO PtrMsgProps

Returns a reference to a new set of message properties, used in enqueuing and dequeuing objects in a queue. The reference should be released as soon as it is no longer needed.

msgPropsAddRef :: PtrMsgProps -> IO Bool

Adds a reference to the message properties. This is intended for situations where a reference to the message properties needs to be maintained independently of the reference returned when the handle was created.

releaseMsgProps :: PtrMsgProps -> IO Bool

Releases a reference to the message properties. A count of the references to the message properties is maintained and when this count reaches zero, the memory associated with the properties is freed.

getMsgPropsCorrelation :: PtrMsgProps -> IO ByteString

Returns the correlation supplied by the producer when the message was enqueued.

setMsgPropsCorrelation :: PtrMsgProps -> ByteString -> IO Bool

Sets the correlation of the message to be dequeued. Special pattern matching characters such as the percent sign (%) and the underscore (_) can be used. If multiple messages satisfy the pattern, the order of dequeuing is undetermined.

getMsgPropsNumAttempts :: PtrMsgProps -> IO Int

Returns the number of attempts that have been made to dequeue a message.

getMsgPropsDelay :: PtrMsgProps -> IO Int

Returns the number of seconds the enqueued message will be delayed.

setMsgPropsDelay :: PtrMsgProps -> Int -> IO Bool

Sets the number of seconds to delay the message before it can be dequeued. Messages enqueued with a delay are put into the MsgStateWaiting state. When the delay expires the message is put into the MsgStateReady state. Dequeuing directly by message id overrides this delay specification. Note that delay processing requires the queue monitor to be started.

getMsgPropsDeliveryMode :: PtrMsgProps -> IO MessageDeliveryMode

Returns the mode that was used to deliver the message.

getMsgPropsEnqTime :: PtrMsgProps -> IO Data_Timestamp

Returns the time that the message was enqueued.

getMsgPropsExceptionQ :: PtrMsgProps -> IO ByteString

Returns the name of the queue to which the message is moved if it cannot be processed successfully. See function setMsgPropsExceptionQ for more information.

setMsgPropsExceptionQ :: PtrMsgProps -> ByteString -> IO Bool

Sets the name of the queue to which the message is moved if it cannot be processed successfully. Messages are moved if the number of unsuccessful dequeue attempts has reached the maximum allowed number or if the message has expired. All messages in the exception queue are in the MsgStateExpired state.

getMsgPropsExpiration :: PtrMsgProps -> IO Int

Returns the number of seconds the message is available to be dequeued. See function setMsgPropsExpiration for more information.

setMsgPropsExpiration :: PtrMsgProps -> Int -> IO Bool

Sets the number of seconds the message is available to be dequeued. This value is an offset from the delay. Expiration processing requires the queue monitor to be running. Until this time elapses, the messages are in the queue in the state MsgStateReady. After this time elapses messages are moved to the exception queue in the MsgStateExpired state.

getMsgPropsOriginalMsgId :: PtrMsgProps -> IO ByteString

Returns the id of the message in the last queue that generated this message. See function setMsgPropsOriginalMsgId for more information.

setMsgPropsOriginalMsgId :: PtrMsgProps -> ByteString -> IO Bool

Sets the id of the message in the last queue that generated this message.

getMsgPropsPriority :: PtrMsgProps -> IO Int

Returns the priority assigned to the message. See function setMsgPropsPriority for more information.

setMsgPropsPriority :: PtrMsgProps -> Int -> IO Bool

Sets the priority assigned to the message. A smaller number indicates a higher priority. The priority can be any number, including negative numbers.

getMsgPropsState :: PtrMsgProps -> IO MessageState

Returns the state of the message at the time of dequeue.

Subscr Interface

Subscription handles are used to represent subscriptions to events such as continuous query notification and object change notification. They are created by calling the function newSubscr and are destroyed by calling the function closeSubscr or releasing the last reference by calling the function releaseSubscr.

newSubscr :: PtrConn -> (Data_SubscrCreateParams -> Data_SubscrCreateParams) -> IO PtrSubscr

Returns a reference to a subscription which is used for requesting notifications of changes on tables or queries that are made in the database. The reference should be released as soon as it is no longer needed.

subscribe :: PtrConn -> (Data_SubscrCreateParams -> Data_SubscrCreateParams) -> IO PtrSubscr

Returns a reference to a subscription which is used for requesting notifications of events that take place in the database. Events that are supported are changes on tables or queries (continuous query notification) and the availability of messages to dequeue (advanced queuing). The reference should be released as soon as it is no longer needed.

@since ODPI-C 2.4.0

unsubscribe :: PtrConn -> PtrSubscr -> IO Bool

Unubscribes from the events that were earlier subscribed to via the function subscribe. Once this function completes successfully no further notifications will be sent for this subscription. Note that this method does not generate a notification either.

@since ODPI-C 2.4.0

subscrAddRef :: PtrSubscr -> IO Bool

Adds a reference to the subscription. This is intended for situations where a reference to the subscription needs to be maintained independently of the reference returned when the subscription was created.

closeSubscr :: PtrSubscr -> IO Bool

Closes the subscription now, rather than when the last reference is released. This deregisters it so that notifications will no longer be sent.

releaseSubscr :: PtrSubscr -> IO Bool

Releases a reference to the subscription. A count of the references to the subscription is maintained and when this count reaches zero, the memory associated with the subscription is freed. The subscription is also deregistered so that notifications are no longer sent, if this was not already done using the function closeSubscr.

subscrPrepareStatement

Arguments

:: PtrSubscr

a reference to the subscription on which the statement is to be prepared for registration.

-> ByteString

the SQL that is to be prepared

-> IO PtrStmt

a reference to the statement that was prepared

Prepares a statement for registration on the subscription. The statement is then registered by calling the function prepareStatement. The reference to the statement that is returned should be released as soon as it is no longer needed.

data DpiException

Constructors

ErrorInfoException Data_ErrorInfo

DpiException String

Instances

Show DpiException

Methods

showsPrec :: Int -> DpiException -> ShowS

show :: DpiException -> String

showList :: [DpiException] -> ShowS

Exception DpiException

Methods

toException :: DpiException -> SomeException

fromException :: SomeException -> Maybe DpiException

displayException :: DpiException -> String

data AuthMode

Constructors

ModeAuthDefault

ModeAuthSysdba

ModeAuthSysoper

ModeAuthPrelim

ModeAuthSysasm

ModeAuthSysbkp

ModeAuthSysdgd

ModeAuthSyskmt

ModeAuthSysrac

Instances

Enum AuthMode

Methods

succ :: AuthMode -> AuthMode

pred :: AuthMode -> AuthMode

toEnum :: Int -> AuthMode

fromEnum :: AuthMode -> Int

enumFrom :: AuthMode -> [AuthMode]

enumFromThen :: AuthMode -> AuthMode -> [AuthMode]

enumFromTo :: AuthMode -> AuthMode -> [AuthMode]

enumFromThenTo :: AuthMode -> AuthMode -> AuthMode -> [AuthMode]

Eq AuthMode

Methods

(==) :: AuthMode -> AuthMode -> Bool

(/=) :: AuthMode -> AuthMode -> Bool

Show AuthMode

Methods

showsPrec :: Int -> AuthMode -> ShowS

show :: AuthMode -> String

showList :: [AuthMode] -> ShowS

data ConnCloseMode

Constructors

ModeConnCloseDefault

ModeConnCloseDrop

ModeConnCloseRetag

Instances

Enum ConnCloseMode

Methods

succ :: ConnCloseMode -> ConnCloseMode

pred :: ConnCloseMode -> ConnCloseMode

toEnum :: Int -> ConnCloseMode

fromEnum :: ConnCloseMode -> Int

enumFrom :: ConnCloseMode -> [ConnCloseMode]

enumFromThen :: ConnCloseMode -> ConnCloseMode -> [ConnCloseMode]

enumFromTo :: ConnCloseMode -> ConnCloseMode -> [ConnCloseMode]

enumFromThenTo :: ConnCloseMode -> ConnCloseMode -> ConnCloseMode -> [ConnCloseMode]

Eq ConnCloseMode

Methods

(==) :: ConnCloseMode -> ConnCloseMode -> Bool

(/=) :: ConnCloseMode -> ConnCloseMode -> Bool

Show ConnCloseMode

Methods

showsPrec :: Int -> ConnCloseMode -> ShowS

show :: ConnCloseMode -> String

showList :: [ConnCloseMode] -> ShowS

data CreateMode

Constructors

ModeCreateDefault

ModeCreateThreaded

ModeCreateEvents

Instances

Enum CreateMode

Methods

succ :: CreateMode -> CreateMode

pred :: CreateMode -> CreateMode

toEnum :: Int -> CreateMode

fromEnum :: CreateMode -> Int

enumFrom :: CreateMode -> [CreateMode]

enumFromThen :: CreateMode -> CreateMode -> [CreateMode]

enumFromTo :: CreateMode -> CreateMode -> [CreateMode]

enumFromThenTo :: CreateMode -> CreateMode -> CreateMode -> [CreateMode]

Eq CreateMode

Methods

(==) :: CreateMode -> CreateMode -> Bool

(/=) :: CreateMode -> CreateMode -> Bool

Show CreateMode

Methods

showsPrec :: Int -> CreateMode -> ShowS

show :: CreateMode -> String

showList :: [CreateMode] -> ShowS

data DeqMode

Constructors

ModeDeqBrowse

ModeDeqLocked

ModeDeqRemove

ModeDeqRemoveNoData

Instances

Enum DeqMode

Methods

succ :: DeqMode -> DeqMode

pred :: DeqMode -> DeqMode

toEnum :: Int -> DeqMode

fromEnum :: DeqMode -> Int

enumFrom :: DeqMode -> [DeqMode]

enumFromThen :: DeqMode -> DeqMode -> [DeqMode]

enumFromTo :: DeqMode -> DeqMode -> [DeqMode]

enumFromThenTo :: DeqMode -> DeqMode -> DeqMode -> [DeqMode]

Eq DeqMode

Methods

(==) :: DeqMode -> DeqMode -> Bool

(/=) :: DeqMode -> DeqMode -> Bool

Show DeqMode

Methods

showsPrec :: Int -> DeqMode -> ShowS

show :: DeqMode -> String

showList :: [DeqMode] -> ShowS

data DeqNavigation

Constructors

DeqNavFirstMsg

DeqNavNextTransaction

DeqNavNextMsg

Instances

Enum DeqNavigation

Methods

succ :: DeqNavigation -> DeqNavigation

pred :: DeqNavigation -> DeqNavigation

toEnum :: Int -> DeqNavigation

fromEnum :: DeqNavigation -> Int

enumFrom :: DeqNavigation -> [DeqNavigation]

enumFromThen :: DeqNavigation -> DeqNavigation -> [DeqNavigation]

enumFromTo :: DeqNavigation -> DeqNavigation -> [DeqNavigation]

enumFromThenTo :: DeqNavigation -> DeqNavigation -> DeqNavigation -> [DeqNavigation]

Eq DeqNavigation

Methods

(==) :: DeqNavigation -> DeqNavigation -> Bool

(/=) :: DeqNavigation -> DeqNavigation -> Bool

Show DeqNavigation

Methods

showsPrec :: Int -> DeqNavigation -> ShowS

show :: DeqNavigation -> String

showList :: [DeqNavigation] -> ShowS

data EventType

Constructors

EventNone

EventStartup

EventShutdown

EventShutdownAny

EventDropDb

EventDereg

EventObjchange

EventQuerychange

EventAq

Instances

Enum EventType

Methods

succ :: EventType -> EventType

pred :: EventType -> EventType

toEnum :: Int -> EventType

fromEnum :: EventType -> Int

enumFrom :: EventType -> [EventType]

enumFromThen :: EventType -> EventType -> [EventType]

enumFromTo :: EventType -> EventType -> [EventType]

enumFromThenTo :: EventType -> EventType -> EventType -> [EventType]

Eq EventType

Methods

(==) :: EventType -> EventType -> Bool

(/=) :: EventType -> EventType -> Bool

Show EventType

Methods

showsPrec :: Int -> EventType -> ShowS

show :: EventType -> String

showList :: [EventType] -> ShowS

data ExecMode

Constructors

ModeExecDefault

ModeExecDescribeOnly

ModeExecCommitOnSuccess

ModeExecBatchErrors

ModeExecParseOnly

ModeExecArrayDmlRowcounts

Instances

Enum ExecMode

Methods

succ :: ExecMode -> ExecMode

pred :: ExecMode -> ExecMode

toEnum :: Int -> ExecMode

fromEnum :: ExecMode -> Int

enumFrom :: ExecMode -> [ExecMode]

enumFromThen :: ExecMode -> ExecMode -> [ExecMode]

enumFromTo :: ExecMode -> ExecMode -> [ExecMode]

enumFromThenTo :: ExecMode -> ExecMode -> ExecMode -> [ExecMode]

Eq ExecMode

Methods

(==) :: ExecMode -> ExecMode -> Bool

(/=) :: ExecMode -> ExecMode -> Bool

Show ExecMode

Methods

showsPrec :: Int -> ExecMode -> ShowS

show :: ExecMode -> String

showList :: [ExecMode] -> ShowS

data FetchMode

Constructors

ModeFetchNext

ModeFetchFirst

ModeFetchLast

ModeFetchPrior

ModeFetchAbsolute

ModeFetchRelative

Instances

Enum FetchMode

Methods

succ :: FetchMode -> FetchMode

pred :: FetchMode -> FetchMode

toEnum :: Int -> FetchMode

fromEnum :: FetchMode -> Int

enumFrom :: FetchMode -> [FetchMode]

enumFromThen :: FetchMode -> FetchMode -> [FetchMode]

enumFromTo :: FetchMode -> FetchMode -> [FetchMode]

enumFromThenTo :: FetchMode -> FetchMode -> FetchMode -> [FetchMode]

Eq FetchMode

Methods

(==) :: FetchMode -> FetchMode -> Bool

(/=) :: FetchMode -> FetchMode -> Bool

Show FetchMode

Methods

showsPrec :: Int -> FetchMode -> ShowS

show :: FetchMode -> String

showList :: [FetchMode] -> ShowS

data MessageDeliveryMode

Constructors

ModeMsgPersistent

ModeMsgBuffered

ModeMsgPersistentOrBuffered

Instances

Enum MessageDeliveryMode

Methods

succ :: MessageDeliveryMode -> MessageDeliveryMode

pred :: MessageDeliveryMode -> MessageDeliveryMode

toEnum :: Int -> MessageDeliveryMode

fromEnum :: MessageDeliveryMode -> Int

enumFrom :: MessageDeliveryMode -> [MessageDeliveryMode]

enumFromThen :: MessageDeliveryMode -> MessageDeliveryMode -> [MessageDeliveryMode]

enumFromTo :: MessageDeliveryMode -> MessageDeliveryMode -> [MessageDeliveryMode]

enumFromThenTo :: MessageDeliveryMode -> MessageDeliveryMode -> MessageDeliveryMode -> [MessageDeliveryMode]

Eq MessageDeliveryMode

Methods

(==) :: MessageDeliveryMode -> MessageDeliveryMode -> Bool

(/=) :: MessageDeliveryMode -> MessageDeliveryMode -> Bool

Show MessageDeliveryMode

Methods

showsPrec :: Int -> MessageDeliveryMode -> ShowS

show :: MessageDeliveryMode -> String

showList :: [MessageDeliveryMode] -> ShowS

data MessageState

Constructors

MsgStateReady

MsgStateWaiting

MsgStateProcessed

MsgStateExpired

Instances

Enum MessageState

Methods

succ :: MessageState -> MessageState

pred :: MessageState -> MessageState

toEnum :: Int -> MessageState

fromEnum :: MessageState -> Int

enumFrom :: MessageState -> [MessageState]

enumFromThen :: MessageState -> MessageState -> [MessageState]

enumFromTo :: MessageState -> MessageState -> [MessageState]

enumFromThenTo :: MessageState -> MessageState -> MessageState -> [MessageState]

Eq MessageState

Methods

(==) :: MessageState -> MessageState -> Bool

(/=) :: MessageState -> MessageState -> Bool

Show MessageState

Methods

showsPrec :: Int -> MessageState -> ShowS

show :: MessageState -> String

showList :: [MessageState] -> ShowS

data NativeTypeNum

Constructors

NativeTypeInt64

NativeTypeUint64

NativeTypeFloat

NativeTypeDouble

NativeTypeBytes

NativeTypeTimestamp

NativeTypeIntervalDs

NativeTypeIntervalYm

NativeTypeLob

NativeTypeObject

NativeTypeStmt

NativeTypeBoolean

NativeTypeRowid

Instances

Enum NativeTypeNum

Methods

succ :: NativeTypeNum -> NativeTypeNum

pred :: NativeTypeNum -> NativeTypeNum

toEnum :: Int -> NativeTypeNum

fromEnum :: NativeTypeNum -> Int

enumFrom :: NativeTypeNum -> [NativeTypeNum]

enumFromThen :: NativeTypeNum -> NativeTypeNum -> [NativeTypeNum]

enumFromTo :: NativeTypeNum -> NativeTypeNum -> [NativeTypeNum]

enumFromThenTo :: NativeTypeNum -> NativeTypeNum -> NativeTypeNum -> [NativeTypeNum]

Eq NativeTypeNum

Methods

(==) :: NativeTypeNum -> NativeTypeNum -> Bool

(/=) :: NativeTypeNum -> NativeTypeNum -> Bool

Show NativeTypeNum

Methods

showsPrec :: Int -> NativeTypeNum -> ShowS

show :: NativeTypeNum -> String

showList :: [NativeTypeNum] -> ShowS

data OpCode

Constructors

OpcodeAllOps

OpcodeAllRows

OpcodeInsert

OpcodeUpdate

OpcodeDelete

OpcodeAlter

OpcodeDrop

OpcodeUnknown

Instances

Enum OpCode

Methods

succ :: OpCode -> OpCode

pred :: OpCode -> OpCode

toEnum :: Int -> OpCode

fromEnum :: OpCode -> Int

enumFrom :: OpCode -> [OpCode]

enumFromThen :: OpCode -> OpCode -> [OpCode]

enumFromTo :: OpCode -> OpCode -> [OpCode]

enumFromThenTo :: OpCode -> OpCode -> OpCode -> [OpCode]

Eq OpCode

Methods

(==) :: OpCode -> OpCode -> Bool

(/=) :: OpCode -> OpCode -> Bool

Show OpCode

Methods

showsPrec :: Int -> OpCode -> ShowS

show :: OpCode -> String

showList :: [OpCode] -> ShowS

data OracleTypeNum

Constructors

OracleTypeNone

OracleTypeVarchar

OracleTypeNvarchar

OracleTypeChar

OracleTypeNchar

OracleTypeRowid

OracleTypeRaw

OracleTypeNativeFloat

OracleTypeNativeDouble

OracleTypeNativeInt

OracleTypeNumber

OracleTypeDate

OracleTypeTimestamp

OracleTypeTimestampTz

OracleTypeTimestampLtz

OracleTypeIntervalDs

OracleTypeIntervalYm

OracleTypeClob

OracleTypeNclob

OracleTypeBlob

OracleTypeBfile

OracleTypeStmt

OracleTypeBoolean

OracleTypeObject

OracleTypeLongVarchar

OracleTypeLongRaw

OracleTypeNativeUint

OracleTypeMax

Instances

Enum OracleTypeNum

Methods

succ :: OracleTypeNum -> OracleTypeNum

pred :: OracleTypeNum -> OracleTypeNum

toEnum :: Int -> OracleTypeNum

fromEnum :: OracleTypeNum -> Int

enumFrom :: OracleTypeNum -> [OracleTypeNum]

enumFromThen :: OracleTypeNum -> OracleTypeNum -> [OracleTypeNum]

enumFromTo :: OracleTypeNum -> OracleTypeNum -> [OracleTypeNum]

enumFromThenTo :: OracleTypeNum -> OracleTypeNum -> OracleTypeNum -> [OracleTypeNum]

Eq OracleTypeNum

Methods

(==) :: OracleTypeNum -> OracleTypeNum -> Bool

(/=) :: OracleTypeNum -> OracleTypeNum -> Bool

Show OracleTypeNum

Methods

showsPrec :: Int -> OracleTypeNum -> ShowS

show :: OracleTypeNum -> String

showList :: [OracleTypeNum] -> ShowS

data PoolCloseMode

Constructors

ModePoolCloseDefault

ModePoolCloseForce

Instances

Enum PoolCloseMode

Methods

succ :: PoolCloseMode -> PoolCloseMode

pred :: PoolCloseMode -> PoolCloseMode

toEnum :: Int -> PoolCloseMode

fromEnum :: PoolCloseMode -> Int

enumFrom :: PoolCloseMode -> [PoolCloseMode]

enumFromThen :: PoolCloseMode -> PoolCloseMode -> [PoolCloseMode]

enumFromTo :: PoolCloseMode -> PoolCloseMode -> [PoolCloseMode]

enumFromThenTo :: PoolCloseMode -> PoolCloseMode -> PoolCloseMode -> [PoolCloseMode]

Eq PoolCloseMode

Methods

(==) :: PoolCloseMode -> PoolCloseMode -> Bool

(/=) :: PoolCloseMode -> PoolCloseMode -> Bool

Show PoolCloseMode

Methods

showsPrec :: Int -> PoolCloseMode -> ShowS

show :: PoolCloseMode -> String

showList :: [PoolCloseMode] -> ShowS

data PoolGetMode

Constructors

ModePoolGetWait

ModePoolGetNowait

ModePoolGetForceget

ModePoolGetTimedwait

Instances

Enum PoolGetMode

Methods

succ :: PoolGetMode -> PoolGetMode

pred :: PoolGetMode -> PoolGetMode

toEnum :: Int -> PoolGetMode

fromEnum :: PoolGetMode -> Int

enumFrom :: PoolGetMode -> [PoolGetMode]

enumFromThen :: PoolGetMode -> PoolGetMode -> [PoolGetMode]

enumFromTo :: PoolGetMode -> PoolGetMode -> [PoolGetMode]

enumFromThenTo :: PoolGetMode -> PoolGetMode -> PoolGetMode -> [PoolGetMode]

Eq PoolGetMode

Methods

(==) :: PoolGetMode -> PoolGetMode -> Bool

(/=) :: PoolGetMode -> PoolGetMode -> Bool

Show PoolGetMode

Methods

showsPrec :: Int -> PoolGetMode -> ShowS

show :: PoolGetMode -> String

showList :: [PoolGetMode] -> ShowS

data Purity

Constructors

PurityDefault

PurityNew

PuritySelf

Instances

Enum Purity

Methods

succ :: Purity -> Purity

pred :: Purity -> Purity

toEnum :: Int -> Purity

fromEnum :: Purity -> Int

enumFrom :: Purity -> [Purity]

enumFromThen :: Purity -> Purity -> [Purity]

enumFromTo :: Purity -> Purity -> [Purity]

enumFromThenTo :: Purity -> Purity -> Purity -> [Purity]

Eq Purity

Methods

(==) :: Purity -> Purity -> Bool

(/=) :: Purity -> Purity -> Bool

Show Purity

Methods

showsPrec :: Int -> Purity -> ShowS

show :: Purity -> String

showList :: [Purity] -> ShowS

data ShutdownMode

Constructors

ModeShutdownDefault

ModeShutdownTransactional

ModeShutdownTransactionalLocal

ModeShutdownImmediate

ModeShutdownAbort

ModeShutdownFinal

Instances

Enum ShutdownMode

Methods

succ :: ShutdownMode -> ShutdownMode

pred :: ShutdownMode -> ShutdownMode

toEnum :: Int -> ShutdownMode

fromEnum :: ShutdownMode -> Int

enumFrom :: ShutdownMode -> [ShutdownMode]

enumFromThen :: ShutdownMode -> ShutdownMode -> [ShutdownMode]

enumFromTo :: ShutdownMode -> ShutdownMode -> [ShutdownMode]

enumFromThenTo :: ShutdownMode -> ShutdownMode -> ShutdownMode -> [ShutdownMode]

Eq ShutdownMode

Methods

(==) :: ShutdownMode -> ShutdownMode -> Bool

(/=) :: ShutdownMode -> ShutdownMode -> Bool

Show ShutdownMode

Methods

showsPrec :: Int -> ShutdownMode -> ShowS

show :: ShutdownMode -> String

showList :: [ShutdownMode] -> ShowS

data StartupMode

Constructors

ModeStartupDefault

ModeStartupForce

ModeStartupRestrict

Instances

Enum StartupMode

Methods

succ :: StartupMode -> StartupMode

pred :: StartupMode -> StartupMode

toEnum :: Int -> StartupMode

fromEnum :: StartupMode -> Int

enumFrom :: StartupMode -> [StartupMode]

enumFromThen :: StartupMode -> StartupMode -> [StartupMode]

enumFromTo :: StartupMode -> StartupMode -> [StartupMode]

enumFromThenTo :: StartupMode -> StartupMode -> StartupMode -> [StartupMode]

Eq StartupMode

Methods

(==) :: StartupMode -> StartupMode -> Bool

(/=) :: StartupMode -> StartupMode -> Bool

Show StartupMode

Methods

showsPrec :: Int -> StartupMode -> ShowS

show :: StartupMode -> String

showList :: [StartupMode] -> ShowS

data StatementType

Constructors

StmtTypeUnknown

StmtTypeSelect

StmtTypeUpdate

StmtTypeDelete

StmtTypeInsert

StmtTypeCreate

StmtTypeDrop

StmtTypeAlter

StmtTypeBegin

StmtTypeDeclare

StmtTypeCall

StmtTypeExplainPlan

StmtTypeMerge

StmtTypeRollback

StmtTypeCommit

Instances

Enum StatementType

Methods

succ :: StatementType -> StatementType

pred :: StatementType -> StatementType

toEnum :: Int -> StatementType

fromEnum :: StatementType -> Int

enumFrom :: StatementType -> [StatementType]

enumFromThen :: StatementType -> StatementType -> [StatementType]

enumFromTo :: StatementType -> StatementType -> [StatementType]

enumFromThenTo :: StatementType -> StatementType -> StatementType -> [StatementType]

Eq StatementType

Methods

(==) :: StatementType -> StatementType -> Bool

(/=) :: StatementType -> StatementType -> Bool

Show StatementType

Methods

showsPrec :: Int -> StatementType -> ShowS

show :: StatementType -> String

showList :: [StatementType] -> ShowS

data SubscrGroupingClass

Constructors

SubscrGroupingClassTime

Instances

Enum SubscrGroupingClass

Methods

succ :: SubscrGroupingClass -> SubscrGroupingClass

pred :: SubscrGroupingClass -> SubscrGroupingClass

toEnum :: Int -> SubscrGroupingClass

fromEnum :: SubscrGroupingClass -> Int

enumFrom :: SubscrGroupingClass -> [SubscrGroupingClass]

enumFromThen :: SubscrGroupingClass -> SubscrGroupingClass -> [SubscrGroupingClass]

enumFromTo :: SubscrGroupingClass -> SubscrGroupingClass -> [SubscrGroupingClass]

enumFromThenTo :: SubscrGroupingClass -> SubscrGroupingClass -> SubscrGroupingClass -> [SubscrGroupingClass]

Eq SubscrGroupingClass

Methods

(==) :: SubscrGroupingClass -> SubscrGroupingClass -> Bool

(/=) :: SubscrGroupingClass -> SubscrGroupingClass -> Bool

Show SubscrGroupingClass

Methods

showsPrec :: Int -> SubscrGroupingClass -> ShowS

show :: SubscrGroupingClass -> String

showList :: [SubscrGroupingClass] -> ShowS

data SubscrGroupingType

Constructors

SubscrGroupingTypeSummary

SubscrGroupingTypeLast

Instances

Enum SubscrGroupingType

Methods

succ :: SubscrGroupingType -> SubscrGroupingType

pred :: SubscrGroupingType -> SubscrGroupingType

toEnum :: Int -> SubscrGroupingType

fromEnum :: SubscrGroupingType -> Int

enumFrom :: SubscrGroupingType -> [SubscrGroupingType]

enumFromThen :: SubscrGroupingType -> SubscrGroupingType -> [SubscrGroupingType]

enumFromTo :: SubscrGroupingType -> SubscrGroupingType -> [SubscrGroupingType]

enumFromThenTo :: SubscrGroupingType -> SubscrGroupingType -> SubscrGroupingType -> [SubscrGroupingType]

Eq SubscrGroupingType

Methods

(==) :: SubscrGroupingType -> SubscrGroupingType -> Bool

(/=) :: SubscrGroupingType -> SubscrGroupingType -> Bool

Show SubscrGroupingType

Methods

showsPrec :: Int -> SubscrGroupingType -> ShowS

show :: SubscrGroupingType -> String

showList :: [SubscrGroupingType] -> ShowS

data SubscrNamespace

Constructors

SubscrNamespaceAq

SubscrNamespaceDbchange

Instances

Enum SubscrNamespace

Methods

succ :: SubscrNamespace -> SubscrNamespace

pred :: SubscrNamespace -> SubscrNamespace

toEnum :: Int -> SubscrNamespace

fromEnum :: SubscrNamespace -> Int

enumFrom :: SubscrNamespace -> [SubscrNamespace]

enumFromThen :: SubscrNamespace -> SubscrNamespace -> [SubscrNamespace]

enumFromTo :: SubscrNamespace -> SubscrNamespace -> [SubscrNamespace]

enumFromThenTo :: SubscrNamespace -> SubscrNamespace -> SubscrNamespace -> [SubscrNamespace]

Eq SubscrNamespace

Methods

(==) :: SubscrNamespace -> SubscrNamespace -> Bool

(/=) :: SubscrNamespace -> SubscrNamespace -> Bool

Show SubscrNamespace

Methods

showsPrec :: Int -> SubscrNamespace -> ShowS

show :: SubscrNamespace -> String

showList :: [SubscrNamespace] -> ShowS

data SubscrProtocol

Constructors

SubscrProtoCallback

SubscrProtoMail

SubscrProtoPlsql

SubscrProtoHttp

Instances

Enum SubscrProtocol

Methods

succ :: SubscrProtocol -> SubscrProtocol

pred :: SubscrProtocol -> SubscrProtocol

toEnum :: Int -> SubscrProtocol

fromEnum :: SubscrProtocol -> Int

enumFrom :: SubscrProtocol -> [SubscrProtocol]

enumFromThen :: SubscrProtocol -> SubscrProtocol -> [SubscrProtocol]

enumFromTo :: SubscrProtocol -> SubscrProtocol -> [SubscrProtocol]

enumFromThenTo :: SubscrProtocol -> SubscrProtocol -> SubscrProtocol -> [SubscrProtocol]

Eq SubscrProtocol

Methods

(==) :: SubscrProtocol -> SubscrProtocol -> Bool

(/=) :: SubscrProtocol -> SubscrProtocol -> Bool

Show SubscrProtocol

Methods

showsPrec :: Int -> SubscrProtocol -> ShowS

show :: SubscrProtocol -> String

showList :: [SubscrProtocol] -> ShowS

data SubscrQOS

Constructors

SubscrQosReliable

SubscrQosDeregNfy

SubscrQosRowids

SubscrQosQuery

SubscrQosBestEffort

Instances

Enum SubscrQOS

Methods

succ :: SubscrQOS -> SubscrQOS

pred :: SubscrQOS -> SubscrQOS

toEnum :: Int -> SubscrQOS

fromEnum :: SubscrQOS -> Int

enumFrom :: SubscrQOS -> [SubscrQOS]

enumFromThen :: SubscrQOS -> SubscrQOS -> [SubscrQOS]

enumFromTo :: SubscrQOS -> SubscrQOS -> [SubscrQOS]

enumFromThenTo :: SubscrQOS -> SubscrQOS -> SubscrQOS -> [SubscrQOS]

Eq SubscrQOS

Methods

(==) :: SubscrQOS -> SubscrQOS -> Bool

(/=) :: SubscrQOS -> SubscrQOS -> Bool

Show SubscrQOS

Methods

showsPrec :: Int -> SubscrQOS -> ShowS

show :: SubscrQOS -> String

showList :: [SubscrQOS] -> ShowS

data Visibility

Constructors

VisibilityImmediate

VisibilityOnCommit

Instances

Enum Visibility

Methods

succ :: Visibility -> Visibility

pred :: Visibility -> Visibility

toEnum :: Int -> Visibility

fromEnum :: Visibility -> Int

enumFrom :: Visibility -> [Visibility]

enumFromThen :: Visibility -> Visibility -> [Visibility]

enumFromTo :: Visibility -> Visibility -> [Visibility]

enumFromThenTo :: Visibility -> Visibility -> Visibility -> [Visibility]

Eq Visibility

Methods

(==) :: Visibility -> Visibility -> Bool

(/=) :: Visibility -> Visibility -> Bool

Show Visibility

Methods

showsPrec :: Int -> Visibility -> ShowS

show :: Visibility -> String

showList :: [Visibility] -> ShowS

type PtrConn = HasCxtPtr DPI_Conn

type PtrPool = HasCxtPtr DPI_Pool

type PtrStmt = HasCxtPtr DPI_Stmt

type PtrVar = HasCxtPtr DPI_Var

type PtrLob = HasCxtPtr DPI_Lob

type PtrObject = HasCxtPtr DPI_Object

type PtrObjectAttr = HasCxtPtr DPI_ObjectAttr

type PtrObjectType = HasCxtPtr DPI_ObjectType

type PtrRowid = HasCxtPtr DPI_Rowid

type PtrSubscr = HasCxtPtr DPI_Subscr

type PtrDeqOptions = HasCxtPtr DPI_DeqOptions

type PtrEnqOptions = HasCxtPtr DPI_EnqOptions

type PtrMsgProps = HasCxtPtr DPI_MsgProps

type PtrContext = Ptr DPI_Context

data Data_AppContext

Constructors

Data_AppContext

Fields

• namespaceName :: !CStringLen
• name :: !CStringLen
• value :: !CStringLen

Instances

Show Data_AppContext

Methods

showsPrec :: Int -> Data_AppContext -> ShowS

show :: Data_AppContext -> String

showList :: [Data_AppContext] -> ShowS

Storable Data_AppContext

Methods

sizeOf :: Data_AppContext -> Int

alignment :: Data_AppContext -> Int

peekElemOff :: Ptr Data_AppContext -> Int -> IO Data_AppContext

pokeElemOff :: Ptr Data_AppContext -> Int -> Data_AppContext -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_AppContext

pokeByteOff :: Ptr b -> Int -> Data_AppContext -> IO ()

peek :: Ptr Data_AppContext -> IO Data_AppContext

poke :: Ptr Data_AppContext -> Data_AppContext -> IO ()

data Data_CommonCreateParams

Constructors

Data_CommonCreateParams

Fields

• createMode :: !CreateMode
• encoding :: !ByteString
• nencoding :: !ByteString
• edition :: !CStringLen
• driverName :: !CStringLen

Instances

Show Data_CommonCreateParams

Methods

showsPrec :: Int -> Data_CommonCreateParams -> ShowS

show :: Data_CommonCreateParams -> String

showList :: [Data_CommonCreateParams] -> ShowS

Storable Data_CommonCreateParams

Methods

sizeOf :: Data_CommonCreateParams -> Int

alignment :: Data_CommonCreateParams -> Int

peekElemOff :: Ptr Data_CommonCreateParams -> Int -> IO Data_CommonCreateParams

pokeElemOff :: Ptr Data_CommonCreateParams -> Int -> Data_CommonCreateParams -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_CommonCreateParams

pokeByteOff :: Ptr b -> Int -> Data_CommonCreateParams -> IO ()

peek :: Ptr Data_CommonCreateParams -> IO Data_CommonCreateParams

poke :: Ptr Data_CommonCreateParams -> Data_CommonCreateParams -> IO ()

data Data_ConnCreateParams

Constructors

Data_ConnCreateParams

Fields

• authMode :: !AuthMode
• connectionClass :: !CStringLen
• purity :: !Purity
• newPassword :: !CStringLen
• appContext :: !PtrAppContext
• numAppContext :: !CUInt
• externalAuth :: !CInt
• externalHandle :: !(Ptr ())
• pool :: !(Ptr DPI_Pool)
• tag :: !CStringLen
• matchAnyTag :: !CInt
• outTag :: !CStringLen
• outTagFound :: !CInt
• shardingKeyColumns :: !PtrShardingKeyColumn
• numShardingKeyColumns :: !CUChar
• superShardingKeyColumns :: !PtrShardingKeyColumn
• numSuperShardingKeyColumns :: !CUChar

Instances

Show Data_ConnCreateParams

Methods

showsPrec :: Int -> Data_ConnCreateParams -> ShowS

show :: Data_ConnCreateParams -> String

showList :: [Data_ConnCreateParams] -> ShowS

Storable Data_ConnCreateParams

Methods

sizeOf :: Data_ConnCreateParams -> Int

alignment :: Data_ConnCreateParams -> Int

peekElemOff :: Ptr Data_ConnCreateParams -> Int -> IO Data_ConnCreateParams

pokeElemOff :: Ptr Data_ConnCreateParams -> Int -> Data_ConnCreateParams -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_ConnCreateParams

pokeByteOff :: Ptr b -> Int -> Data_ConnCreateParams -> IO ()

peek :: Ptr Data_ConnCreateParams -> IO Data_ConnCreateParams

poke :: Ptr Data_ConnCreateParams -> Data_ConnCreateParams -> IO ()

newtype Data

Constructors

Data (NativeTypeNum -> OracleTypeNum -> IO DataValue)

Instances

Storable Data

Methods

sizeOf :: Data -> Int

alignment :: Data -> Int

peekElemOff :: Ptr Data -> Int -> IO Data

pokeElemOff :: Ptr Data -> Int -> Data -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data

pokeByteOff :: Ptr b -> Int -> Data -> IO ()

peek :: Ptr Data -> IO Data

poke :: Ptr Data -> Data -> IO ()

data DataValue

Constructors

DataNull !NativeTypeNum

DataBFile !(Ptr DPI_Lob)

DataBoolean !Bool

DataBlob !(Ptr DPI_Lob)

DataChar !Data_Bytes

DataClob !(Ptr DPI_Lob)

DataDate !Data_Timestamp

DataIntervalDs !Data_IntervalDS

DataIntervalYm !Data_IntervalYM

DataLongRaw !Data_Bytes

DataLongVarchar !Data_Bytes

DataDouble !CDouble

DataFloat !CFloat

DataInt !Int64

DataUint !Word64

DataNChar !Data_Bytes

DataNClob !(Ptr DPI_Lob)

DataNumDouble !CDouble

DataNumBytes !Data_Bytes

DataNumInt !Int64

DataNumUint !Word64

DataNVarchar !Data_Bytes

DataObject !(Ptr DPI_Object)

DataRaw !Data_Bytes

DataRowid !(Ptr DPI_Rowid)

DataStmt !(Ptr DPI_Stmt)

DataTimestamp !Data_Timestamp

DataTimestampD !CDouble

DataTimestampLtz !Data_Timestamp

DataTimestampLtzD !CDouble

DataTimestampTz !Data_Timestamp

DataTimestampTzD !CDouble

DataVarchar !Data_Bytes

Instances

Show DataValue

Methods

showsPrec :: Int -> DataValue -> ShowS

show :: DataValue -> String

showList :: [DataValue] -> ShowS

data Data_Bytes

Constructors

Data_Bytes

Fields

• bytes :: !CStringLen
• encoding :: !ByteString

Instances

Show Data_Bytes

Methods

showsPrec :: Int -> Data_Bytes -> ShowS

show :: Data_Bytes -> String

showList :: [Data_Bytes] -> ShowS

Storable Data_Bytes

Methods

sizeOf :: Data_Bytes -> Int

alignment :: Data_Bytes -> Int

peekElemOff :: Ptr Data_Bytes -> Int -> IO Data_Bytes

pokeElemOff :: Ptr Data_Bytes -> Int -> Data_Bytes -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_Bytes

pokeByteOff :: Ptr b -> Int -> Data_Bytes -> IO ()

peek :: Ptr Data_Bytes -> IO Data_Bytes

poke :: Ptr Data_Bytes -> Data_Bytes -> IO ()

data Data_Timestamp

Constructors

Data_Timestamp

Fields

• year :: !CShort
• month :: !CUChar
• day :: !CUChar
• hour :: !CUChar
• minute :: !CUChar
• second :: !CUChar
• fsecond :: !CUInt
• tzHourOffset :: !CSChar
• tzMinuteOffset :: !CSChar

Instances

Show Data_Timestamp

Methods

showsPrec :: Int -> Data_Timestamp -> ShowS

show :: Data_Timestamp -> String

showList :: [Data_Timestamp] -> ShowS

Storable Data_Timestamp

Methods

sizeOf :: Data_Timestamp -> Int

alignment :: Data_Timestamp -> Int

peekElemOff :: Ptr Data_Timestamp -> Int -> IO Data_Timestamp

pokeElemOff :: Ptr Data_Timestamp -> Int -> Data_Timestamp -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_Timestamp

pokeByteOff :: Ptr b -> Int -> Data_Timestamp -> IO ()

peek :: Ptr Data_Timestamp -> IO Data_Timestamp

poke :: Ptr Data_Timestamp -> Data_Timestamp -> IO ()

data Data_IntervalDS

Constructors

Data_IntervalDS

Fields

• days :: !CInt
• hours :: !CInt
• minutes :: !CInt
• seconds :: !CInt
• fseconds :: !CInt

Instances

Show Data_IntervalDS

Methods

showsPrec :: Int -> Data_IntervalDS -> ShowS

show :: Data_IntervalDS -> String

showList :: [Data_IntervalDS] -> ShowS

Storable Data_IntervalDS

Methods

sizeOf :: Data_IntervalDS -> Int

alignment :: Data_IntervalDS -> Int

peekElemOff :: Ptr Data_IntervalDS -> Int -> IO Data_IntervalDS

pokeElemOff :: Ptr Data_IntervalDS -> Int -> Data_IntervalDS -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_IntervalDS

pokeByteOff :: Ptr b -> Int -> Data_IntervalDS -> IO ()

peek :: Ptr Data_IntervalDS -> IO Data_IntervalDS

poke :: Ptr Data_IntervalDS -> Data_IntervalDS -> IO ()

data Data_IntervalYM

Constructors

Data_IntervalYM

Fields

• years :: !CInt
• months :: !CInt

Instances

Show Data_IntervalYM

Methods

showsPrec :: Int -> Data_IntervalYM -> ShowS

show :: Data_IntervalYM -> String

showList :: [Data_IntervalYM] -> ShowS

Storable Data_IntervalYM

Methods

sizeOf :: Data_IntervalYM -> Int

alignment :: Data_IntervalYM -> Int

peekElemOff :: Ptr Data_IntervalYM -> Int -> IO Data_IntervalYM

pokeElemOff :: Ptr Data_IntervalYM -> Int -> Data_IntervalYM -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_IntervalYM

pokeByteOff :: Ptr b -> Int -> Data_IntervalYM -> IO ()

peek :: Ptr Data_IntervalYM -> IO Data_IntervalYM

poke :: Ptr Data_IntervalYM -> Data_IntervalYM -> IO ()

data Data_DataTypeInfo

Constructors

Data_DataTypeInfo

Fields

• oracleTypeNum :: !OracleTypeNum
• defaultNativeTypeNum :: !NativeTypeNum
• ociTypeCode :: !CUShort
• dbSizeInBytes :: !CUInt
• clientSizeInBytes :: !CUInt
• sizeInChars :: !CUInt
• precision :: !CShort
• scale :: !CSChar
• fsPrecision :: !CUChar
• objectType :: !(Ptr DPI_ObjectType)

Instances

Show Data_DataTypeInfo

Methods

showsPrec :: Int -> Data_DataTypeInfo -> ShowS

show :: Data_DataTypeInfo -> String

showList :: [Data_DataTypeInfo] -> ShowS

Storable Data_DataTypeInfo

Methods

sizeOf :: Data_DataTypeInfo -> Int

alignment :: Data_DataTypeInfo -> Int

peekElemOff :: Ptr Data_DataTypeInfo -> Int -> IO Data_DataTypeInfo

pokeElemOff :: Ptr Data_DataTypeInfo -> Int -> Data_DataTypeInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_DataTypeInfo

pokeByteOff :: Ptr b -> Int -> Data_DataTypeInfo -> IO ()

peek :: Ptr Data_DataTypeInfo -> IO Data_DataTypeInfo

poke :: Ptr Data_DataTypeInfo -> Data_DataTypeInfo -> IO ()

data Data_EncodingInfo

Constructors

Data_EncodingInfo

Fields

• encoding :: !ByteString
• maxBytesPerCharacter :: !CInt
• nencoding :: !ByteString
• nmaxBytesPerCharacter :: !CInt

Instances

Show Data_EncodingInfo

Methods

showsPrec :: Int -> Data_EncodingInfo -> ShowS

show :: Data_EncodingInfo -> String

showList :: [Data_EncodingInfo] -> ShowS

Storable Data_EncodingInfo

Methods

sizeOf :: Data_EncodingInfo -> Int

alignment :: Data_EncodingInfo -> Int

peekElemOff :: Ptr Data_EncodingInfo -> Int -> IO Data_EncodingInfo

pokeElemOff :: Ptr Data_EncodingInfo -> Int -> Data_EncodingInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_EncodingInfo

pokeByteOff :: Ptr b -> Int -> Data_EncodingInfo -> IO ()

peek :: Ptr Data_EncodingInfo -> IO Data_EncodingInfo

poke :: Ptr Data_EncodingInfo -> Data_EncodingInfo -> IO ()

data Data_ErrorInfo

Constructors

Data_ErrorInfo

Fields

• code :: !CInt
• offset :: !CUShort
• message :: !ByteString
• encoding :: !ByteString
• fnName :: !ByteString
• action :: !ByteString
• sqlState :: !ByteString
• isRecoverable :: !Bool

Instances

Show Data_ErrorInfo

Methods

showsPrec :: Int -> Data_ErrorInfo -> ShowS

show :: Data_ErrorInfo -> String

showList :: [Data_ErrorInfo] -> ShowS

Storable Data_ErrorInfo

Methods

sizeOf :: Data_ErrorInfo -> Int

alignment :: Data_ErrorInfo -> Int

peekElemOff :: Ptr Data_ErrorInfo -> Int -> IO Data_ErrorInfo

pokeElemOff :: Ptr Data_ErrorInfo -> Int -> Data_ErrorInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_ErrorInfo

pokeByteOff :: Ptr b -> Int -> Data_ErrorInfo -> IO ()

peek :: Ptr Data_ErrorInfo -> IO Data_ErrorInfo

poke :: Ptr Data_ErrorInfo -> Data_ErrorInfo -> IO ()

data Data_ObjectAttrInfo

Constructors

Data_ObjectAttrInfo

Fields

• name :: !CStringLen
• typeInfo :: !Data_DataTypeInfo

Instances

Show Data_ObjectAttrInfo

Methods

showsPrec :: Int -> Data_ObjectAttrInfo -> ShowS

show :: Data_ObjectAttrInfo -> String

showList :: [Data_ObjectAttrInfo] -> ShowS

Storable Data_ObjectAttrInfo

Methods

sizeOf :: Data_ObjectAttrInfo -> Int

alignment :: Data_ObjectAttrInfo -> Int

peekElemOff :: Ptr Data_ObjectAttrInfo -> Int -> IO Data_ObjectAttrInfo

pokeElemOff :: Ptr Data_ObjectAttrInfo -> Int -> Data_ObjectAttrInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_ObjectAttrInfo

pokeByteOff :: Ptr b -> Int -> Data_ObjectAttrInfo -> IO ()

peek :: Ptr Data_ObjectAttrInfo -> IO Data_ObjectAttrInfo

poke :: Ptr Data_ObjectAttrInfo -> Data_ObjectAttrInfo -> IO ()

data Data_ObjectTypeInfo

Constructors

Data_ObjectTypeInfo

Fields

• schema :: !CStringLen
• name :: !CStringLen
• isCollection :: !Bool
• elementTypeInfo :: !Data_DataTypeInfo
• numAttributes :: !CUShort

Instances

Show Data_ObjectTypeInfo

Methods

showsPrec :: Int -> Data_ObjectTypeInfo -> ShowS

show :: Data_ObjectTypeInfo -> String

showList :: [Data_ObjectTypeInfo] -> ShowS

Storable Data_ObjectTypeInfo

Methods

sizeOf :: Data_ObjectTypeInfo -> Int

alignment :: Data_ObjectTypeInfo -> Int

peekElemOff :: Ptr Data_ObjectTypeInfo -> Int -> IO Data_ObjectTypeInfo

pokeElemOff :: Ptr Data_ObjectTypeInfo -> Int -> Data_ObjectTypeInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_ObjectTypeInfo

pokeByteOff :: Ptr b -> Int -> Data_ObjectTypeInfo -> IO ()

peek :: Ptr Data_ObjectTypeInfo -> IO Data_ObjectTypeInfo

poke :: Ptr Data_ObjectTypeInfo -> Data_ObjectTypeInfo -> IO ()

data Data_PoolCreateParams

Constructors

Data_PoolCreateParams

Fields

• minSessions :: !CUInt
• maxSessions :: !CUInt
• sessionIncrement :: !CUInt
• pingInterval :: !CInt
• pingTimeout :: !CInt
• homogeneous :: !CInt
• externalAuth :: !CInt
• getMode :: !PoolGetMode
• outPoolName :: !CStringLen
• timeout :: !CUInt
• waitTimeout :: !CUInt
• maxLifetimeSession :: !CUInt

Instances

Show Data_PoolCreateParams

Methods

showsPrec :: Int -> Data_PoolCreateParams -> ShowS

show :: Data_PoolCreateParams -> String

showList :: [Data_PoolCreateParams] -> ShowS

Storable Data_PoolCreateParams

Methods

sizeOf :: Data_PoolCreateParams -> Int

alignment :: Data_PoolCreateParams -> Int

peekElemOff :: Ptr Data_PoolCreateParams -> Int -> IO Data_PoolCreateParams

pokeElemOff :: Ptr Data_PoolCreateParams -> Int -> Data_PoolCreateParams -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_PoolCreateParams

pokeByteOff :: Ptr b -> Int -> Data_PoolCreateParams -> IO ()

peek :: Ptr Data_PoolCreateParams -> IO Data_PoolCreateParams

poke :: Ptr Data_PoolCreateParams -> Data_PoolCreateParams -> IO ()

data Data_QueryInfo

Constructors

Data_QueryInfo

Fields

• name :: !CStringLen
• typeInfo :: !Data_DataTypeInfo
• nullOk :: !Bool

Instances

Show Data_QueryInfo

Methods

showsPrec :: Int -> Data_QueryInfo -> ShowS

show :: Data_QueryInfo -> String

showList :: [Data_QueryInfo] -> ShowS

Storable Data_QueryInfo

Methods

sizeOf :: Data_QueryInfo -> Int

alignment :: Data_QueryInfo -> Int

peekElemOff :: Ptr Data_QueryInfo -> Int -> IO Data_QueryInfo

pokeElemOff :: Ptr Data_QueryInfo -> Int -> Data_QueryInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_QueryInfo

pokeByteOff :: Ptr b -> Int -> Data_QueryInfo -> IO ()

peek :: Ptr Data_QueryInfo -> IO Data_QueryInfo

poke :: Ptr Data_QueryInfo -> Data_QueryInfo -> IO ()

data Data_ShardingKeyColumn

Constructors

Data_ShardingKeyColumn

Fields

• oracleTypeNum :: !OracleTypeNum
• nativeTypeNum :: !NativeTypeNum
• value :: !DataValue

Instances

Show Data_ShardingKeyColumn

Methods

showsPrec :: Int -> Data_ShardingKeyColumn -> ShowS

show :: Data_ShardingKeyColumn -> String

showList :: [Data_ShardingKeyColumn] -> ShowS

Storable Data_ShardingKeyColumn

Methods

sizeOf :: Data_ShardingKeyColumn -> Int

alignment :: Data_ShardingKeyColumn -> Int

peekElemOff :: Ptr Data_ShardingKeyColumn -> Int -> IO Data_ShardingKeyColumn

pokeElemOff :: Ptr Data_ShardingKeyColumn -> Int -> Data_ShardingKeyColumn -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_ShardingKeyColumn

pokeByteOff :: Ptr b -> Int -> Data_ShardingKeyColumn -> IO ()

peek :: Ptr Data_ShardingKeyColumn -> IO Data_ShardingKeyColumn

poke :: Ptr Data_ShardingKeyColumn -> Data_ShardingKeyColumn -> IO ()

data Data_StmtInfo

Constructors

Data_StmtInfo

Fields

• isQuery :: !Bool
• isPLSQL :: !Bool
• isDDL :: !Bool
• isDML :: !Bool
• statementType :: !StatementType
• isReturning :: !Bool

Instances

Show Data_StmtInfo

Methods

showsPrec :: Int -> Data_StmtInfo -> ShowS

show :: Data_StmtInfo -> String

showList :: [Data_StmtInfo] -> ShowS

Storable Data_StmtInfo

Methods

sizeOf :: Data_StmtInfo -> Int

alignment :: Data_StmtInfo -> Int

peekElemOff :: Ptr Data_StmtInfo -> Int -> IO Data_StmtInfo

pokeElemOff :: Ptr Data_StmtInfo -> Int -> Data_StmtInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_StmtInfo

pokeByteOff :: Ptr b -> Int -> Data_StmtInfo -> IO ()

peek :: Ptr Data_StmtInfo -> IO Data_StmtInfo

poke :: Ptr Data_StmtInfo -> Data_StmtInfo -> IO ()

data Data_SubscrCreateParams

Constructors

Data_SubscrCreateParams

Fields

• subscrNamespace :: !SubscrNamespace
• protocol :: !SubscrProtocol
• qos :: !SubscrQOS
• operations :: !CInt
• portNumber :: !CUInt
• timeout :: !CUInt
• name :: !CStringLen
• callback :: !(FunPtr (Ptr () -> PtrSubscrMessage -> IO ()))
• callbackContext :: !(Ptr ())
• recipientName :: !CStringLen
• ipAddress :: !CStringLen
• groupingClass :: !SubscrGroupingClass
• groupingValue :: !CUInt
• groupingType :: !SubscrGroupingType

Instances

Show Data_SubscrCreateParams

Methods

showsPrec :: Int -> Data_SubscrCreateParams -> ShowS

show :: Data_SubscrCreateParams -> String

showList :: [Data_SubscrCreateParams] -> ShowS

Storable Data_SubscrCreateParams

Methods

sizeOf :: Data_SubscrCreateParams -> Int

alignment :: Data_SubscrCreateParams -> Int

peekElemOff :: Ptr Data_SubscrCreateParams -> Int -> IO Data_SubscrCreateParams

pokeElemOff :: Ptr Data_SubscrCreateParams -> Int -> Data_SubscrCreateParams -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_SubscrCreateParams

pokeByteOff :: Ptr b -> Int -> Data_SubscrCreateParams -> IO ()

peek :: Ptr Data_SubscrCreateParams -> IO Data_SubscrCreateParams

poke :: Ptr Data_SubscrCreateParams -> Data_SubscrCreateParams -> IO ()

data Data_SubscrMessage

Constructors

Data_SubscrMessage

Fields

• eventType :: !EventType
• dbName :: !CStringLen
• tables :: !PtrSubscrMessageTable
• numTables :: !CUInt
• queries :: !PtrSubscrMessageQuery
• numQueries :: !CUInt
• errorInfo :: !PtrErrorInfo
• txId :: !(Ptr ())
• txIdLength :: !CUInt
• registered :: !CInt
• queueName :: !CStringLen
• consumerName :: !CStringLen

Instances

Show Data_SubscrMessage

Methods

showsPrec :: Int -> Data_SubscrMessage -> ShowS

show :: Data_SubscrMessage -> String

showList :: [Data_SubscrMessage] -> ShowS

Storable Data_SubscrMessage

Methods

sizeOf :: Data_SubscrMessage -> Int

alignment :: Data_SubscrMessage -> Int

peekElemOff :: Ptr Data_SubscrMessage -> Int -> IO Data_SubscrMessage

pokeElemOff :: Ptr Data_SubscrMessage -> Int -> Data_SubscrMessage -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_SubscrMessage

pokeByteOff :: Ptr b -> Int -> Data_SubscrMessage -> IO ()

peek :: Ptr Data_SubscrMessage -> IO Data_SubscrMessage

poke :: Ptr Data_SubscrMessage -> Data_SubscrMessage -> IO ()

data Data_SubscrMessageQuery

Constructors

Data_SubscrMessageQuery

Fields

• mid :: !Int64
• operation :: !OpCode
• tables :: !PtrSubscrMessageTable
• numTables :: !CUInt

Instances

Show Data_SubscrMessageQuery

Methods

showsPrec :: Int -> Data_SubscrMessageQuery -> ShowS

show :: Data_SubscrMessageQuery -> String

showList :: [Data_SubscrMessageQuery] -> ShowS

Storable Data_SubscrMessageQuery

Methods

sizeOf :: Data_SubscrMessageQuery -> Int

alignment :: Data_SubscrMessageQuery -> Int

peekElemOff :: Ptr Data_SubscrMessageQuery -> Int -> IO Data_SubscrMessageQuery

pokeElemOff :: Ptr Data_SubscrMessageQuery -> Int -> Data_SubscrMessageQuery -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_SubscrMessageQuery

pokeByteOff :: Ptr b -> Int -> Data_SubscrMessageQuery -> IO ()

peek :: Ptr Data_SubscrMessageQuery -> IO Data_SubscrMessageQuery

poke :: Ptr Data_SubscrMessageQuery -> Data_SubscrMessageQuery -> IO ()

data Data_SubscrMessageRow

Constructors

Data_SubscrMessageRow

Fields

• operation :: !OpCode
• rowid :: !CStringLen

Instances

Show Data_SubscrMessageRow

Methods

showsPrec :: Int -> Data_SubscrMessageRow -> ShowS

show :: Data_SubscrMessageRow -> String

showList :: [Data_SubscrMessageRow] -> ShowS

Storable Data_SubscrMessageRow

Methods

sizeOf :: Data_SubscrMessageRow -> Int

alignment :: Data_SubscrMessageRow -> Int

peekElemOff :: Ptr Data_SubscrMessageRow -> Int -> IO Data_SubscrMessageRow

pokeElemOff :: Ptr Data_SubscrMessageRow -> Int -> Data_SubscrMessageRow -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_SubscrMessageRow

pokeByteOff :: Ptr b -> Int -> Data_SubscrMessageRow -> IO ()

peek :: Ptr Data_SubscrMessageRow -> IO Data_SubscrMessageRow

poke :: Ptr Data_SubscrMessageRow -> Data_SubscrMessageRow -> IO ()

data Data_SubscrMessageTable

Constructors

Data_SubscrMessageTable

Fields

• operation :: !OpCode
• name :: !CStringLen
• rows :: !PtrSubscrMessageRow
• numRows :: !CUInt

Instances

Show Data_SubscrMessageTable

Methods

showsPrec :: Int -> Data_SubscrMessageTable -> ShowS

show :: Data_SubscrMessageTable -> String

showList :: [Data_SubscrMessageTable] -> ShowS

Storable Data_SubscrMessageTable

Methods

sizeOf :: Data_SubscrMessageTable -> Int

alignment :: Data_SubscrMessageTable -> Int

peekElemOff :: Ptr Data_SubscrMessageTable -> Int -> IO Data_SubscrMessageTable

pokeElemOff :: Ptr Data_SubscrMessageTable -> Int -> Data_SubscrMessageTable -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_SubscrMessageTable

pokeByteOff :: Ptr b -> Int -> Data_SubscrMessageTable -> IO ()

peek :: Ptr Data_SubscrMessageTable -> IO Data_SubscrMessageTable

poke :: Ptr Data_SubscrMessageTable -> Data_SubscrMessageTable -> IO ()

data Data_VersionInfo

Constructors

Data_VersionInfo

Fields

• versionNum :: !CInt
• releaseNum :: !CInt
• updateNum :: !CInt
• portReleaseNum :: !CInt
• portUpdateNum :: !CInt
• fullVersionNum :: !CUInt

Instances

Show Data_VersionInfo

Methods

showsPrec :: Int -> Data_VersionInfo -> ShowS

show :: Data_VersionInfo -> String

showList :: [Data_VersionInfo] -> ShowS

Storable Data_VersionInfo

Methods

sizeOf :: Data_VersionInfo -> Int

alignment :: Data_VersionInfo -> Int

peekElemOff :: Ptr Data_VersionInfo -> Int -> IO Data_VersionInfo

pokeElemOff :: Ptr Data_VersionInfo -> Int -> Data_VersionInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO Data_VersionInfo

pokeByteOff :: Ptr b -> Int -> Data_VersionInfo -> IO ()

peek :: Ptr Data_VersionInfo -> IO Data_VersionInfo

poke :: Ptr Data_VersionInfo -> Data_VersionInfo -> IO ()

type PtrAppContext = Ptr Data_AppContext

type PtrCommonCreateParams = Ptr Data_CommonCreateParams

type PtrConnCreateParams = Ptr Data_ConnCreateParams

type PtrData = Ptr Data

type PtrDataTypeInfo = Ptr Data_DataTypeInfo

type PtrEncodingInfo = Ptr Data_EncodingInfo

type PtrErrorInfo = Ptr Data_ErrorInfo

type PtrObjectAttrInfo = Ptr Data_ObjectAttrInfo

type PtrObjectTypeInfo = Ptr Data_ObjectTypeInfo

type PtrPoolCreateParams = Ptr Data_PoolCreateParams

type PtrQueryInfo = Ptr Data_QueryInfo

type PtrShardingKeyColumn = Ptr Data_ShardingKeyColumn

type PtrStmtInfo = Ptr Data_StmtInfo

type PtrSubscrCreateParams = Ptr Data_SubscrCreateParams

type PtrSubscrMessage = Ptr Data_SubscrMessage

type PtrSubscrMessageQuery = Ptr Data_SubscrMessageQuery

type PtrSubscrMessageRow = Ptr Data_SubscrMessageRow

type PtrSubscrMessageTable = Ptr Data_SubscrMessageTable

type PtrVersionInfo = Ptr Data_VersionInfo

getContextError :: PtrContext -> IO Data_ErrorInfo

Returns error information for the last error that was raised by the library. This function must be called with the same thread that generated the error. It must also be called before any other ODPI-C library calls are made on the calling thread since the error information specific to that thread is cleared at the start of every ODPI-C function call.