mariadb_field_attr

Name

mariadb_field_attr - returns extended metadata information for pluggable field types

Synopsis

#include <mysql.h>

int *mariadb_field_attr(MARIADB_CONST_STRING *attr,
                        const MYSQL_FIELD *field,
                        enum mariadb_field_attr_t type)

Description

Returns extended metadata information for pluggable field types like JSON and GEOMETRY.

Parameter

• attr A pointer which returns extended metadata information
• field specifies the field which contains extended metadata information
• type specifies type of metadata information. Current supported values are MARIADB_FIELD_METADATA_DATA_TYPE_NAME and MARIADB_FIELD_METADATA_FORMAT_NAME.

Return value

Returns zero on success or non zero if the field doesn't provide extended metadata information.

Notes

• Pluggable field type support is available in MariaDB server version 10.5.2 and later
• To check if the server supports pluggable field types, check the extended server capabilities which can be obtained by api function mariadb_get_info()

History

mariadb_field_attr was added in MariaDB Connector/C 3.1.8

See also

• mysql_store_result()
• mysql_use_result()
• mariadb_get_info()
• mysql_fetch_fields()