8. API: FetchInfo Objects
These objects are created internally when a query is executed. They are found
in the sequence Cursor.description
. For compatibility with the Python
Database API, this object behaves as a 7-tuple containing the values for the
attributes name
, type_code
, display_size
, internal_size
,
precision
, scale
, and null_ok
in that order. For example, if
fetch_info
is of type FetchInfo, then fetch_info[2]
is the same as
fetch_info.display_size
.
New in version 1.4.0.
Note
This object is an extension the DB API.
8.1. FetchInfo Attributes
- FetchInfo.display_size
This read-only attribute returns the display size of the column as mandated by the Python Database API.
- FetchInfo.internal_size
This read-only attribute returns the internal size of the column as mandated by the Python Database API.
- FetchInfo.is_json
This read-only attribute returns whether the column is known to contain JSON data. This will be
true
when the type code isoracledb.DB_TYPE_JSON
as well as when an “IS JSON” constraint is enabled on LOB and VARCHAR2 columns.
- FetchInfo.name
This read-only attribute returns the name of the column as mandated by the Python Database API.
- FetchInfo.null_ok
This read-only attribute returns whether nulls are allowed in the column as mandated by the Python Database API.
- FetchInfo.precision
This read-only attribute returns the precision of the column as mandated by the Python Database API.
- FetchInfo.scale
This read-only attribute returns the scale of the column as mandated by the Python Database API.
- FetchInfo.type
This read-only attribute returns the type of the column. This will be an Oracle Object Type if the column contains Oracle objects; otherwise, it will be one of the database type constants defined at the module level.
- FetchInfo.type_code
This read-only attribute returns the type of the column as mandated by the Python Database API. The type will be one of the database type constants defined at the module level.