Schema

Functions
ESPAPICALL int32_t	esp_schema_get_numcolumns (const EspSchema *schema, int32_t *numcolumns, EspError *error)
ESPAPICALL const char *	esp_schema_get_column_name (const EspSchema *schema, const int32_t column_no, EspError *error)
ESPAPICALL int32_t	esp_schema_get_column_type (const EspSchema *schema, const int32_t column_no, int32_t *type, EspError *error)
ESPAPICALL int32_t	esp_schema_get_column_type_by_name (const EspSchema *schema, const char *column_name, int32_t *type, EspError *error)
ESPAPICALL int32_t	esp_schema_is_keycolumn (const EspSchema *schema, const int32_t column_no, int32_t *key, EspError *error)

---

Function Documentation

ESPAPICALL const char* esp_schema_get_column_name	(	const EspSchema *	schema,
		const int32_t	column_no,
		EspError *	error
	)

Returns then column name for specified position.

Returns:

column name, NULL on error.

Parameters:

schema	EspSchema to query
column_no	Column number to query

ESPAPICALL int32_t esp_schema_get_column_type	(	const EspSchema *	schema,
		const int32_t	column_no,
		int32_t *	type,
		EspError *	error
	)

Returns the data type of the column at the specified position.

Returns:

0 on success.

Parameters:

schema	EspSchema to query
column_no	Column number to query
type	Pointer to int32_t to return column type in

ESPAPICALL int32_t esp_schema_get_column_type_by_name	(	const EspSchema *	schema,
		const char *	column_name,
		int32_t *	type,
		EspError *	error
	)

Determine data type for the specified column name.

Returns:

0 on success.

Parameters:

schema	EspSchema to query
column_name	Column name to query
type	Pointer to int32_t to return column type in

ESPAPICALL int32_t esp_schema_get_numcolumns	(	const EspSchema *	schema,
		int32_t *	numcolumns,
		EspError *	error
	)

Get the number of columns for this schema.

Returns:

0 on success.

Parameters:

schema	EspSchema to query
numcolumns	Pointer to int32_t to return number of columns in

ESPAPICALL int32_t esp_schema_is_keycolumn	(	const EspSchema *	schema,
		const int32_t	column_no,
		int32_t *	key,
		EspError *	error
	)

Determine if the column at the specified position is a key column.

Returns:

0 on success.

Parameters:

schema	EspSchema to query
column_no	Column number to query
key	Pointer to int32_t in which to return the key indication. Non-zero indicates a key column.