blob: 80a2cb8cb8c2c01e3e453d6439f02960a1905491 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mariadb_field_attr" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mariadb_field_attr \- returns extended metadata information for
pluggable field types
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>
int *mariadb_field_attr(MARIADB_CONST_STRING *attr,
const MYSQL_FIELD *field,
enum mariadb_field_attr_t type)
\f[R]
.fi
.SS Description
.PP
Returns extended metadata information for pluggable field types like
JSON and GEOMETRY.
.SS Parameter
.IP \[bu] 2
\f[C]attr\f[R]: A pointer which returns extended metadata information
.IP \[bu] 2
\f[C]field\f[R]: Specifies the field which contains extended metadata
information
.IP \[bu] 2
\f[C]type:\f[R] Specifies type of metadata information.
Supported types are \f[C]MARIADB_FIELD_METADATA_DATA_TYPE_NAME\f[R] and
\f[C]MARIADB_FIELD_METADATA_FORMAT_NAME\f[R].
.SS Return value
.PP
Returns zero on success or non zero if the field doesn\[cq]t provide
extended metadata information.
.SS Notes
.IP \[bu] 2
Pluggable field type support is available in MariaDB server version
10.5.2 and later
.IP \[bu] 2
To check if the server supports pluggable field types, check the
extended server capabilities which can be obtained by api function
\f[B]mariadb_get_info(3)\f[R]
.SS Example
.IP
.nf
\f[C]
#include <mysql.h>
int display_extended_field_attribute(MYSQL *mysql)
{
MYSQL_RES *result;
MYSQL_FIELD *fields;
if (mysql_query(mysql, \[dq]CREATE TEMPORARY TABLE t1 (a POINT)\[dq]))
return 1;
if (mysql_query(mysql, \[dq]SELECT a FROM t1\[dq]))
return 1;
if (!(result= mysql_store_result(mysql)))
return 1;
if ((fields= mysql_fetch_fields(result)))
{
MARIADB_CONST_STRING field_attr;
if (!mariadb_field_attr(&field_attr, &fields[0],
MARIADB_FIELD_ATTR_DATA_TYPE_NAME))
{
printf(\[dq]Extended field attribute: %s\[rs]n\[dq], field_attr.str);
}
}
mysql_free_result(result);
return 0;
}
\f[R]
.fi
.SS History
.PP
mariadb_field_attr was added in MariaDB Connector/C 3.1.8
.SS See also
.IP \[bu] 2
\f[B]mysql_store_result(3)\f[R]
.IP \[bu] 2
\f[B]mysql_use_result(3)\f[R]
.IP \[bu] 2
\f[B]mariadb_get_info(3)\f[R]
.IP \[bu] 2
\f[B]mysql_fetch_fields(3)\f[R]
|
