Data structure used to obtain metadata for a NuoDB_ResultSet. More...

#include <resultSetMetaData.h>

Data Fields
_NuoDB_ResultSetMetaData_state_t *	_state

int(*	getColumnCount )(NuoDB_ResultSetMetaData *_this)
	returns the number of columns in this ResultSet data structure

int(*	getColumnDisplaySize )(NuoDB_ResultSetMetaData *_this, int index)
	Indicates the designated column's normal maximum width in characters.

const char (	getColumnLabel )(NuoDB_ResultSetMetaData *_this, int index)
	Gets the designated column's suggested title for use in printouts and displays.

const char (	getColumnName )(NuoDB_ResultSetMetaData *_this, int index)
	Gets the designated column's name.

NuoDB_Status(*	getColumnType )(NuoDB_ResultSetMetaData _this, int index, NuoDB_Type columnType)
	Retrieves the designated colunmn's SQL type.

const char (	getColumnTypeName )(NuoDB_ResultSetMetaData *_this, int index)
	Retrieves the designated colunmn's type name.

int(*	getCurrentColumnMaxLength )(NuoDB_ResultSetMetaData *_this, int index)
	Gets the maximum column width which would be the larger of the length of the value stored in the designated column and the declared length of the column.

int(*	getPrecision )(NuoDB_ResultSetMetaData *_this, int index)
	Get the designated column's specified column size.

int(*	getScale )(NuoDB_ResultSetMetaData *_this, int index)
	Get the designated column's number of digits to the right of the decimal point.

const char (	getSchemaName )(NuoDB_ResultSetMetaData *_this, int index)
	Gets the designated column's table's schema.

const char (	getTableName )(NuoDB_ResultSetMetaData *_this, int index)
	Gets the designated column's table name.

nuodb_bool_t(*	isAutoIncrement )(NuoDB_ResultSetMetaData *_this, int index)
	Indicates whether the designated column is auto increment.

nuodb_bool_t(*	isNullable )(NuoDB_ResultSetMetaData *_this, int index)
	Indicates the nullability of values in the designated column.

nuodb_bool_t(*	isReadOnly )(NuoDB_ResultSetMetaData *_this, int index)
	Indicates whether the designated column is definitely not writable.

nuodb_bool_t(*	isWritable )(NuoDB_ResultSetMetaData *_this, int index)
	Indicates whether it is possible for a write on the designated column to succeed.

Detailed Description

Data structure used to obtain metadata for a NuoDB_ResultSet.

An data structure that can be used to get information about the types and properties of the columns in a NuoDB_ResultSet data structure.

Field Documentation

◆ getColumnCount

int(* NuoDB_ResultSetMetaData::getColumnCount) (NuoDB_ResultSetMetaData *_this)

returns the number of columns in this ResultSet data structure

Parameters

[in] _this a pointer to the current (this) data structure.

Returns: the number of columns

◆ getColumnDisplaySize

int(* NuoDB_ResultSetMetaData::getColumnDisplaySize) (NuoDB_ResultSetMetaData *_this, int index)

Indicates the designated column's normal maximum width in characters.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: the normal maximum number of characters allowed as the width of the designated column

◆ getColumnLabel

const char *(* NuoDB_ResultSetMetaData::getColumnLabel) (NuoDB_ResultSetMetaData *_this, int index)

Gets the designated column's suggested title for use in printouts and displays.

The suggested title is usually specified by the SQL AS clause. If a SQL AS is not specified, the value returned from getColumnLabel() will be the same as the value returned by getColumnName()

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: the column label

◆ getColumnName

const char *(* NuoDB_ResultSetMetaData::getColumnName) (NuoDB_ResultSetMetaData *_this, int index)

Gets the designated column's name.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: column name

◆ getColumnType

NuoDB_Status(* NuoDB_ResultSetMetaData::getColumnType) (NuoDB_ResultSetMetaData *_this, int index, NuoDB_Type *columnType)

Retrieves the designated colunmn's SQL type.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...
[out]	columnType	pointer to the NuoDB_Type which is set to the column's SQL type.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getColumnTypeName

const char *(* NuoDB_ResultSetMetaData::getColumnTypeName) (NuoDB_ResultSetMetaData *_this, int index)

Retrieves the designated colunmn's type name.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: the columnn type name

◆ getCurrentColumnMaxLength

int(* NuoDB_ResultSetMetaData::getCurrentColumnMaxLength) (NuoDB_ResultSetMetaData *_this, int index)

Gets the maximum column width which would be the larger of the length of the value stored in the designated column and the declared length of the column.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: the max length

◆ getPrecision

int(* NuoDB_ResultSetMetaData::getPrecision) (NuoDB_ResultSetMetaData *_this, int index)

Get the designated column's specified column size.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: precision

◆ getScale

int(* NuoDB_ResultSetMetaData::getScale) (NuoDB_ResultSetMetaData *_this, int index)

Get the designated column's number of digits to the right of the decimal point.

0 is returned for data types where the scale is not applicable

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: scale

◆ getSchemaName

const char *(* NuoDB_ResultSetMetaData::getSchemaName) (NuoDB_ResultSetMetaData *_this, int index)

Gets the designated column's table's schema.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: schema name or "" if not applicable

◆ getTableName

const char *(* NuoDB_ResultSetMetaData::getTableName) (NuoDB_ResultSetMetaData *_this, int index)

Gets the designated column's table name.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: table name or "" if not applicable

◆ isAutoIncrement

nuodb_bool_t(* NuoDB_ResultSetMetaData::isAutoIncrement) (NuoDB_ResultSetMetaData *_this, int index)

Indicates whether the designated column is auto increment.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: true if so and false otherwise

◆ isNullable

nuodb_bool_t(* NuoDB_ResultSetMetaData::isNullable) (NuoDB_ResultSetMetaData *_this, int index)

Indicates the nullability of values in the designated column.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: true if the column is nullable and false otherwise

◆ isReadOnly

nuodb_bool_t(* NuoDB_ResultSetMetaData::isReadOnly) (NuoDB_ResultSetMetaData *_this, int index)

Indicates whether the designated column is definitely not writable.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: true if not writable and false otherwise

◆ isWritable

nuodb_bool_t(* NuoDB_ResultSetMetaData::isWritable) (NuoDB_ResultSetMetaData *_this, int index)

Indicates whether it is possible for a write on the designated column to succeed.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first column is 1, the second is 2, ...

Returns: true if possibly writable and false otherwise

The documentation for this struct was generated from the following file:

/data/builds/RELEASE-DB17-LIN/CDriver/nuodb/resultSetMetaData.h

Data Fields

Detailed Description

Field Documentation

◆ getColumnCount

◆ getColumnDisplaySize

◆ getColumnLabel

◆ getColumnName

◆ getColumnType

◆ getColumnTypeName

◆ getCurrentColumnMaxLength

◆ getPrecision

◆ getScale

◆ getSchemaName

◆ getTableName

◆ isAutoIncrement

◆ isNullable

◆ isReadOnly

◆ isWritable