0 | module Oracle.FFI.QueryInfo
 1 |
 2 | ||| Retrieve metadata for a query column.
 3 | |||
 4 | ||| Parameters:
 5 | ||| - Statement handle.
 6 | ||| - Zero-based column index.
 7 | |||
 8 | ||| Returns:
 9 | ||| - Pointer to an allocated dpiQueryInfo structure.
10 | ||| - NULL on failure.
11 | |||
12 | export %foreign "C:oracle_query_info,oracle-idris"
13 | prim__queryInfo : AnyPtr -> Int32 -> PrimIO AnyPtr
14 |
15 | ||| Frees query column metadata.
16 | |||
17 | export %foreign "C:oracle_query_info_free,oracle-idris"
18 | prim__queryInfoFree : AnyPtr -> PrimIO ()
19 |
20 | ||| Retrieve the Oracle type number for a column.
21 | |||
22 | export %foreign "C:oracle_query_info_type,oracle-idris"
23 | prim__queryInfoType : AnyPtr -> PrimIO Int32
24 |
25 | ||| Retrieve the column name from a dpiQueryInfo structure.
26 | |||
27 | ||| Returns the Oracle column name exactly as reported by ODPI-C.
28 | |||
29 | export %foreign "C:oracle_query_info_name,oracle-idris"
30 | prim__queryInfoName : AnyPtr -> PrimIO String
31 |
32 | ||| Returns whether the column accepts NULL values.
33 | |||
34 | ||| Result:
35 | ||| - 1 = nullable
36 | ||| - 0 = not nullable
37 | |||
38 | export %foreign "C:oracle_query_info_nullable,oracle-idris"
39 | prim__queryInfoNullable : AnyPtr -> PrimIO Int32
40 |
41 | ||| Retrieve the declared size of the column.
42 | |||
43 | ||| For character columns this typically corresponds to the maximum number of characters.
44 | |||
45 | export %foreign "C:oracle_query_info_size,oracle-idris"
46 | prim__queryInfoSize : AnyPtr -> PrimIO Int32
47 |