7.9. ODPI-C Structure dpiDataTypeInfo
This structure is used for passing data type information from ODPI-C. It is part of the structures dpiObjectAttrInfo, dpiObjectTypeInfo and dpiQueryInfo.
-
dpiOracleTypeNum dpiDataTypeInfo.oracleTypeNum
Specifies the type of the data. It will be one of the values from the enumeration dpiOracleTypeNum, or 0 if the type is not supported by ODPI-C.
-
dpiNativeTypeNum dpiDataTypeInfo.defaultNativeTypeNum
Specifies the default native type for the data. It will be one of the values from the enumeration dpiNativeTypeNum, or 0 if the type is not supported by ODPI-C.
-
uint16_t dpiDataTypeInfo.ociTypeCode
Specifies the OCI type code for the data, which can be useful if the type is not supported by ODPI-C.
-
uint32_t dpiDataTypeInfo.dbSizeInBytes
Specifies the size in bytes (from the database’s perspective) of the data. This value is only populated for strings and binary data. For all other data the value is zero.
-
uint32_t dpiDataTypeInfo.clientSizeInBytes
Specifies the size in bytes (from the client’s perspective) of the data. This value is only populated for strings and binary data. For all other data the value is zero.
-
uint32_t dpiDataTypeInfo.sizeInChars
Specifies the size in characters of the data. This value is only populated for string data. For all other data the value is zero.
-
int16_t dpiDataTypeInfo.precision
Specifies the precision of the data. This value is only populated for numeric and interval data. For all other data the value is zero.
-
int8_t dpiDataTypeInfo.scale
Specifies the scale of the data. This value is only populated for numeric data. For all other data the value is zero.
-
int16_t dpiDataTypeInfo.fsPrecision
Specifies the fractional seconds precision of the data. This value is only populated for timestamp and interval day to second data. For all other data the value is zero.
-
dpiObjectType *dpiDataTypeInfo.objectType
Specifies a reference to the type of the object. This value is only populated for named type data. For all other data the value is NULL. This reference is owned by the object attribute, object type or statement and a call to
dpiObjectType_addRef()
must be made if the reference is going to be used beyond the lifetime of the owning object.
-
int dpiDataTypeInfo.isJson
Specifies if the data contains JSON. This is set to true when columns are fetched that are of type
DPI_ORACLE_TYPE_JSON
or if the column fetched has the check constraint “IS JSON” enabled.
-
const char *dpiDataTypeInfo.domainSchema
Specifies the schema of the SQL domain associated with the column which is being queried, as a byte string in the encoding used for CHAR data.
-
uint32_t dpiDataTypeInfo.domainSchemaLength
Specifies the length of the
dpiDataTypeInfo.domainSchema
member, in bytes.
-
const char *dpiDataTypeInfo.domainName
Specifies the name of the SQL domain associated with the column which is being queried, as a byte string in the encoding used for CHAR data.
-
uint32_t dpiDataTypeInfo.domainNameLength
Specifies the length of the
dpiDataTypeInfo.domainName
member, in bytes.
-
uint32_t dpiDataTypeInfo.numAnnotations
Specifies the number of annotations associated with the column which is being fetched. It is the length of
dpiDataTypeInfo.annotations
.
-
uint32_t dpiDataTypeInfo.annotations
Specifies an array of structures of type dpiAnnotation. The length of the array is specified in the
dpiDataTypeInfo.numAnnotations
member.
-
int dpiDataTypeInfo.isOson
Specifies if the data contains binary encoded OSON. This is set to true when columns are fetched that have the check constraint “IS JSON FORMAT OSON” enabled.