You've already forked mariadb-connector-c
mirror of
https://github.com/mariadb-corporation/mariadb-connector-c.git
synced 2025-08-08 14:02:17 +03:00
Updated manpages
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_cancel" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_cancel" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_connection" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_connection" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_check" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_check" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_column_cmp_named" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_column_cmp_named" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_column_count" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_column_count" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_create_many_named" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_create_many_named" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_create_many_num" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_create_many_num" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_exists_named" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_exists_named" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_exists_num" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_exists_num" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_free" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_free" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
36
man/mariadb_dyncol_get_named.3
Normal file
36
man/mariadb_dyncol_get_named.3
Normal file
@@ -0,0 +1,36 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_get_named" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
mariadb_dyncol_get_name \- Get value of a column with given key
|
||||
.SS Synopsis
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#include <mariadb_dyncol.h>
|
||||
|
||||
enum enum_dyncol_func_result
|
||||
mariadb_dyncol_get_named(DYNAMIC_COLUMN *str,
|
||||
LEX_STRING *key,
|
||||
DYNAMIC_COLUMN_VALUE *store_it_here)
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Description
|
||||
.PP
|
||||
Returns a dynamic column value by given key
|
||||
.SS Parameter
|
||||
.IP \[bu] 2
|
||||
\f[C]str\f[R]: Dynamic column
|
||||
.IP \[bu] 2
|
||||
\f[C]name\f[R]: Name to search for
|
||||
.IP \[bu] 2
|
||||
\f[C]value\f[R]: Value of dynamic column
|
||||
.SS Return value
|
||||
.PP
|
||||
Returns \f[C]ER_DYNCOL_OK\f[R]on success, otherwise error.
|
||||
If the column name could not be found, value will be NULL
|
||||
.SS See also
|
||||
.IP \[bu] 2
|
||||
\f[B]mariadb_dyncol_get_num(3)\f[R]
|
36
man/mariadb_dyncol_get_num.3
Normal file
36
man/mariadb_dyncol_get_num.3
Normal file
@@ -0,0 +1,36 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_get_num" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
mariadb_dyncol_get_num \- Get value of a column with given number
|
||||
.SS Synopsis
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#include <mariadb_dyncol.h>
|
||||
|
||||
enum enum_dyncol_func_result
|
||||
mariadb_dyncol_get_num(DYNAMIC_COLUMN *str,
|
||||
uint column_nr,
|
||||
DYNAMIC_COLUMN_VALUE *store_it_here)
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Description
|
||||
.PP
|
||||
Returns a dynamic column value by given number
|
||||
.SS Parameter
|
||||
.IP \[bu] 2
|
||||
\f[C]str\f[R]: Dynamic column
|
||||
.IP \[bu] 2
|
||||
\f[C]column_nr\f[R]: Number of column
|
||||
.IP \[bu] 2
|
||||
\f[C]value\f[R]: Value of dynamic column
|
||||
.SS Return value
|
||||
.PP
|
||||
Returns \f[C]ER_DYNCOL_OK\f[R]on success, otherwise error.
|
||||
If the column number could not be found, value will be NULL
|
||||
.SS See also
|
||||
.IP \[bu] 2
|
||||
\f[B]mariadb_dyncol_get_named(3)\f[R]
|
29
man/mariadb_dyncol_has_names.3
Normal file
29
man/mariadb_dyncol_has_names.3
Normal file
@@ -0,0 +1,29 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_has_names" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
mariadb_dyncol_has_names \- Checks if dynamic column uses named keys
|
||||
.SS Synopsis
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#include <mariadb_dyncol.h>
|
||||
|
||||
my_bool mariadb_dyncol_has_names(DYNAMIC_COLUMN *str)
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Description
|
||||
.PP
|
||||
Checks if the specified dynamic column uses named keys.
|
||||
.SS Parameter
|
||||
.IP \[bu] 2
|
||||
\f[C]str\f[R]: Dynamic column
|
||||
.SS Return value
|
||||
.PP
|
||||
Returns 1 if the specified dynamic column uses named keys, otherwise
|
||||
zero.
|
||||
.SS See also
|
||||
.IP \[bu] 2
|
||||
\f[B]mariadb_dyncol_get_named(3)\f[R]
|
33
man/mariadb_dyncol_json.3
Normal file
33
man/mariadb_dyncol_json.3
Normal file
@@ -0,0 +1,33 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_json" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
mariadb_dyncol_json \- Get content of a dynamic column in JSON format
|
||||
.SS Synopsis
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#include <mariadb_dyncol.h>
|
||||
|
||||
enum enum_dyncol_func_result
|
||||
mariadb_dyncol_json(DYNAMIC_COLUMN *str,
|
||||
DYNAMIC_STRING *json)
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Description
|
||||
.PP
|
||||
Get content of a dynamic column in JSON format.
|
||||
.SS Parameter
|
||||
.IP \[bu] 2
|
||||
\f[C]*str\f[R] \- Dynamic column
|
||||
.IP \[bu] 2
|
||||
\f[C]*json\f[R] \- Pointer to a dynamic string which contains json
|
||||
output
|
||||
.SS Return value
|
||||
.PP
|
||||
Returns \f[C]ER_DYNCOL_OK\f[R]on success, otherwise error.
|
||||
.SS See also
|
||||
.IP \[bu] 2
|
||||
\f[B]mariadb_dyncol_list_json(3)\f[R]
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_list_named" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_list_named" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_list_num" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_list_num" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_unpack" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_unpack" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_update_many_named" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_update_many_named" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_dyncol_update_many_num" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_dyncol_update_many_num" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
92
man/mariadb_field_attr.3
Normal file
92
man/mariadb_field_attr.3
Normal file
@@ -0,0 +1,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]
|
26
man/mariadb_free_rpl_event.3
Normal file
26
man/mariadb_free_rpl_event.3
Normal file
@@ -0,0 +1,26 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_free_rpl_event" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
mariadb_free_rpl_event \- free event memory
|
||||
.SS Synopsis
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#include <mariadb_rpl.h>
|
||||
|
||||
void mariadb_free_rpl_event(MARIADB_RPL_EVENT *event)
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Description
|
||||
.PP
|
||||
Frees event memory.
|
||||
.SS Parameter
|
||||
.IP \[bu] 2
|
||||
\f[C]event\f[R] \- An event handle which was previously obtained by
|
||||
\f[B]mariadb_rpl_fetch(3)\f[R].
|
||||
.SS History
|
||||
.PP
|
||||
\f[C]mariadb_free_rpl_event\f[R] was added in MariaDB Connector/C 3.1.0
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_get_infov" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_get_infov" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
@@ -47,14 +47,14 @@ T}@T{
|
||||
\f[C]MARIADB_CONNECTION_PVIO_TYPE\f[R],
|
||||
\f[C]MARIADB_CONNECTION_SERVER_STATUS\f[R],
|
||||
\f[C]MARIADB_CONNECTION_SERVER_VERSION_ID\f[R],
|
||||
\f[C]MARIADB_CONNECTION_SSL_VERSION_ID\f[R]
|
||||
\f[C]MARIADB_CONNECTION_TLS_VERSION_ID\f[R]
|
||||
T}
|
||||
T{
|
||||
\f[C]unsigned long\f[R]
|
||||
T}@T{
|
||||
\f[C]MARIADB_CONNECTION_CLIENT_CAPABILITIES\f[R],
|
||||
\f[C]MARIADB_CONNECTION_EXTENDED_SERVER_CAPABILITIES\f[R],
|
||||
\f[C]MARIADB_CONNECTION__SERVER_CAPABILITIES\f[R]
|
||||
\f[C]MARIADB_CONNECTION_SERVER_CAPABILITIES\f[R]
|
||||
T}
|
||||
T{
|
||||
\f[C]size_t\f[R]
|
||||
@@ -65,14 +65,14 @@ T}
|
||||
T{
|
||||
\f[C]const char *\f[R]
|
||||
T}@T{
|
||||
\f[C]MARIADB_CLIENT_VERSION\f[R], \f[C]MARIADB_SSL_VERSION\f[R],
|
||||
\f[C]MARIADB_CLIENT_VERSION\f[R], \f[C]MARIADB_TLS_VERSION\f[R],
|
||||
\f[C]MARIADB_CONNECTION_ERROR\f[R], \f[C]MARIADB_CONNECTION_HOST\f[R],
|
||||
\f[C]MARIADB_CONNECTION_INFO\f[R], \f[C]MARIADB_CONNECTION_SCHEMA\f[R],
|
||||
\f[C]MARIADB_CONNECTION_SERVER_TYPE\f[R],
|
||||
\f[C]MARIADB_CONNECTION_SERVER_VERSION\f[R],
|
||||
\f[C]MARIADB_CONNECTION_SQLSTATE\f[R],
|
||||
\f[C]MARIADB_CONNECTION_SSL_CIPHER\f[R],
|
||||
\f[C]MARIADB_CONNECTIONSSL_VERSION\f[R],
|
||||
\f[C]MARIADB_CONNECTION_TLS_VERSION\f[R],
|
||||
\f[C]MARIADB_CONNECTUION_UNIX_SOCKET\f[R],
|
||||
\f[C]MARIADB_CONNECTION_USER\f[R],
|
||||
T}
|
||||
@@ -273,13 +273,13 @@ Retrieves current sqlstate information for last used command.
|
||||
.PD
|
||||
Retrieves the TLS/SSL cipher in use.
|
||||
.IP \[bu] 2
|
||||
\f[C]MARIADB_CONNECTION_SSL_VERSION\f[R]
|
||||
\f[C]MARIADB_CONNECTION_TLS_VERSION\f[R]
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
Retrieves the TLS protocol version used in literal format.
|
||||
.IP \[bu] 2
|
||||
\f[C]MARIADB_CONNECTION_SSL_VERSION_ID\f[R]
|
||||
\f[C]MARIADB_CONNECTION_TLS_VERSION_ID\f[R]
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_reconnect" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_reconnect" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_rpl_close" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_rpl_close" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_rpl_fetch" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_rpl_fetch" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_rpl_get_optionsv" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_rpl_get_optionsv" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_rpl_open" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_rpl_open" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_rpl_optionsv" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_rpl_optionsv" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_stmt_execute_direct" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_stmt_execute_direct" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mariadb_stmt_fetch_fields" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mariadb_stmt_fetch_fields" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_affected_rows" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_affected_rows" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_autocommit" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_autocommit" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_change_user" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_change_user" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_close" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_close" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_commit" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_commit" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_data_seek" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_data_seek" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
29
man/mysql_eof.3
Normal file
29
man/mysql_eof.3
Normal file
@@ -0,0 +1,29 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_eof" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
mysql_eof \- determines if the last row of a result set has been read
|
||||
.SS Synopsis
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#include <mysql.h>
|
||||
|
||||
my_bool mysql_eof(MYSQL_RES *result);
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Description
|
||||
.PP
|
||||
Determines if the last row of a result set has been read.
|
||||
.PP
|
||||
\f[B]Notes:\f[R] * This function is deprecated and will be removed.
|
||||
Instead determine the end of a result set by checking return value of
|
||||
\f[B]mysql_fetch_row(3)\f[R].
|
||||
* If a result set was acquired by \f[B]mysql_store_result(3)\f[R]
|
||||
mysql_eof will always return true.
|
||||
## Return value Returns true if the entire result set was read.
|
||||
.SS See also
|
||||
.IP \[bu] 2
|
||||
\f[B]mysql_fetch_row(3)\f[R]
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_errno" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_errno" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_error" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_error" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_fetch_field" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_fetch_field" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_fetch_field_direct" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_fetch_field_direct" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_fetch_fields" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_fetch_fields" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_fetch_lengths" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_fetch_lengths" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_fetch_row" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_fetch_row" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_field_count" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_field_count" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_field_seek" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_field_seek" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_field_tell" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_field_tell" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_free_result" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_free_result" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_character_set_info" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_character_set_info" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_client_info" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_client_info" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_client_version" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_client_version" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_host_info" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_host_info" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_proto_info" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_proto_info" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_server_info" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_server_info" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_server_version" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_server_version" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_socket" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_socket" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_get_ssl_cipher" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_get_ssl_cipher" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_hex_string" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_hex_string" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_info" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_info" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_init" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_init" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
33
man/mysql_insert_id.3
Normal file
33
man/mysql_insert_id.3
Normal file
@@ -0,0 +1,33 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_insert_id" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
mysql_insert_id \- returns the auto generated ID used in last statement
|
||||
.SS Synopsis
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#include <mysql.h>
|
||||
|
||||
my_ulonglong mysql_insert_id(MYSQL * mysql);
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Description
|
||||
.PP
|
||||
Returns the auto generated ID generated by a SQL statement (usually
|
||||
INSERT) on a table for a column defined with AUTO_INCREMENT attribute.
|
||||
.SS Parameters:
|
||||
.PP
|
||||
\f[C]mysql\f[R] is a connection identifier, which was previously
|
||||
allocated by \f[B]mysql_init(3)\f[R] and connected by
|
||||
\f[B]mysql_real_connect(3)\f[R].
|
||||
.SH Return value
|
||||
.PP
|
||||
Returns the value of the modified column with AUTO_INCREMENT attribute.
|
||||
If the table doesn\[cq]t contain an auto_increment column or no
|
||||
INSERT/UPDATE statement was executed, this function will return zero.
|
||||
.SS See also
|
||||
.IP \[bu] 2
|
||||
\f[B]mysql_query(3)\f[R]
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_kill" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_kill" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_more_results" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_more_results" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_next_result" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_next_result" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_num_fields" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_num_fields" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_num_rows" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_num_rows" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_options" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_options" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_options4" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_options4" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_optionsv" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_optionsv" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
@@ -41,17 +41,16 @@ _
|
||||
T{
|
||||
\f[C]my_bool\f[R]
|
||||
T}@T{
|
||||
\f[C]MYSQL_OPT_RECONNECT\f[R], \f[C]MYSQL_OPT_LOCAL_INFILE\f[R],
|
||||
\f[C]MYSQL_SECURE_AUTH\f[R], \f[C]MYSQL_REPORT_DATA_TRUNCATION\f[R],
|
||||
\f[C]MYSQL_OPT_SSL_ENFORCE\f[R],
|
||||
\f[C]MYSQL_OPT_RECONNECT\f[R], \f[C]MYSQL_SECURE_AUTH\f[R],
|
||||
\f[C]MYSQL_REPORT_DATA_TRUNCATION\f[R], \f[C]MYSQL_OPT_SSL_ENFORCE\f[R],
|
||||
\f[C]MYSQL_OPT_SSL_VERIFY_SERVER_CERT\f[R]
|
||||
T}
|
||||
T{
|
||||
\f[C]unsigned int\f[R]
|
||||
T}@T{
|
||||
\f[C]MYSQL_OPT_PORT\f[R], \f[C]MYSQL_OPT_CONNECT_TIMEOUT\f[R],
|
||||
\f[C]MYSQL_OPT_PROTOCOL\f[R], \f[C]MYSQL_OPT_READ_TIMEOUT\f[R],
|
||||
\f[C]MYSQL_OPT_WRITE_TIMEOUT\f[R]
|
||||
\f[C]MYSQL_OPT_PORT\f[R], \f[C]MYSQL_OPT_LOCAL_INFILE\f[R],
|
||||
\f[C]MYSQL_OPT_CONNECT_TIMEOUT\f[R], \f[C]MYSQL_OPT_PROTOCOL\f[R],
|
||||
\f[C]MYSQL_OPT_READ_TIMEOUT\f[R], \f[C]MYSQL_OPT_WRITE_TIMEOUT\f[R]
|
||||
T}
|
||||
T{
|
||||
\f[C]unsigned long\f[R]
|
||||
@@ -75,13 +74,18 @@ T}@T{
|
||||
\f[C]MYSQL_OPT_BIND\f[R], \f[C]MYSQL_OPT_CONNECT_ATTR_DELETE\f[R],
|
||||
\f[C]MYSQL_OPT_CONNECT_ATTR_ADD\f[R],
|
||||
\f[C]MARIADB_OPT_CONNECTION_HANDLER\f[R],
|
||||
\f[C]MYSQL_SERVER_PUBLIC_KEY\f[R]
|
||||
\f[C]MYSQL_SERVER_PUBLIC_KEY\f[R], \f[C]MARIADB_OPT_RESTRICTED_AUTH\f[R]
|
||||
T}
|
||||
T{
|
||||
\-
|
||||
T}@T{
|
||||
\f[C]MYSQL_OPT_CONNECT_ATTR_RESET\f[R]
|
||||
T}
|
||||
T{
|
||||
void *
|
||||
T}@T{
|
||||
\f[C]MARIADB_OPT_PROXY_HEADER\f[R]
|
||||
T}
|
||||
.TE
|
||||
.IP \[bu] 2
|
||||
\f[C]MYSQL_INIT_COMMAND\f[R]
|
||||
@@ -187,9 +191,8 @@ will be always processed:
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
Read options from the named group from
|
||||
[[configuring\-mariadb\-with\-mycnf|my.cnf]] or the file specified with
|
||||
MYSQL_READ_DEFAULT_FILE.
|
||||
Read options from the named group from default configuration
|
||||
file (config_files) or the file specified with MYSQL_READ_DEFAULT_FILE.
|
||||
.IP \[bu] 2
|
||||
\f[C]MYSQL_REPORT_DATA_TRUNCATION\f[R]
|
||||
.PD 0
|
||||
@@ -353,6 +356,33 @@ Connector/C 3.1.0
|
||||
.P
|
||||
.PD
|
||||
This option is not in use anymore.
|
||||
.IP \[bu] 2
|
||||
\f[C]MARIADB_OPT_RESTRICTED_AUTH\f[R]
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
Specifies one or more comma separated authentication plugins which are
|
||||
allowed for authentication.
|
||||
If the database server asks for an authentication plugin not listed in
|
||||
this option, MariaDB Connector/C will return an error.
|
||||
This option was added in MariaDB Connector/C 3.3.0
|
||||
.SS Proxy settings
|
||||
.PP
|
||||
As per the proxy protocol specification, the connecting client can
|
||||
prefix its first packet with a proxy protocol header.
|
||||
The server will parse the header and assume the client\[cq]s IP address
|
||||
is the one set in the proxy header.
|
||||
* \f[C]MARIADB_OPT_PROXY_HEADER\f[R] \- specifies the proxy header which
|
||||
will be prefixed to the first packet.
|
||||
Parameters are void * for the prefix buffer and size_t for length of the
|
||||
buffer:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
const char *hdr=\[dq]PROXY TCP4 192.168.0.1 192.168.0.11 56324 443\[rs]r\[rs]n\[dq];
|
||||
mysql_optionsv(mysql, MARIADB_OPT_PROXY_HEADER, hdr, strlen(hdr));
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Connection Attributes
|
||||
.PP
|
||||
Connection attributes are stored in the \f[C]session_connect_attrs\f[R]
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_ping" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_ping" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_query" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_query" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_read_query_result" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_read_query_result" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_real_connect" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_real_connect" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
@@ -33,6 +33,9 @@ Establishes a connection to a database server.
|
||||
Passing the NULL value or the string \[lq]localhost\[rq] to this
|
||||
parameter, the local host is assumed.
|
||||
When possible, pipes will be used instead of the TCP/IP protocol.
|
||||
Since version 3.3.0 it is also possible to provide a comma separated
|
||||
list of hosts for simple fail over in case of one or more hosts are not
|
||||
available.
|
||||
.IP \[bu] 2
|
||||
\f[C]user\f[R] \- the user name.
|
||||
.IP \[bu] 2
|
||||
@@ -132,6 +135,29 @@ It must be closed and reinitialized before.
|
||||
.IP \[bu] 2
|
||||
mysql_real_connect() must complete successfully before you can execute
|
||||
any other API functions beside \f[B]mysql_optionsv(3)\f[R].
|
||||
.IP \[bu] 2
|
||||
host parameter may contain multiple host/port combinations (supported
|
||||
since version 3.3.0).
|
||||
The following syntax is required:
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
hostname and port must be seperated by a colon (:)
|
||||
.IP \[bu] 2
|
||||
IPv6 addresses must be enclosed within square brackets
|
||||
.IP \[bu] 2
|
||||
hostname:port pairs must be be seperated by a comma (,)
|
||||
.IP \[bu] 2
|
||||
if only one host:port was specified, the host string needs to end with a
|
||||
comma.
|
||||
.IP \[bu] 2
|
||||
if no port was specified, the default port will be used.
|
||||
.PP
|
||||
\f[B]Examples for failover host string:\f[R]
|
||||
.PP
|
||||
\f[C]host=[::1]:3306,192.168.0.1:3306,test.example.com\f[R]
|
||||
.PP
|
||||
\f[C]host=127.0.0.1:3306,\f[R]
|
||||
.RE
|
||||
.SS See also
|
||||
.IP \[bu] 2
|
||||
\f[B]mysql_init(3)\f[R]
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_real_escape_string" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_real_escape_string" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_real_query" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_real_query" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_refresh" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_refresh" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_reset_connection" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_reset_connection" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_rollback" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_rollback" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_row_seek" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_row_seek" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_row_tell" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_row_tell" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_select_db" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_select_db" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_send_query" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_send_query" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_server_end" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_server_end" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_server_init" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_server_init" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_session_track_get_first" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_session_track_get_first" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_session_track_get_next" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_session_track_get_next" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_set_character_set" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_set_character_set" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_set_server_option" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_set_server_option" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_shutdown" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_shutdown" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
@@ -17,6 +17,9 @@ int mysql_shutdown(MYSQL * mysql,
|
||||
.fi
|
||||
.SS Description
|
||||
.PP
|
||||
This function is deprecated.
|
||||
Instead please use SQL \f[C]SHUTDOWN\f[R] command.
|
||||
.PP
|
||||
Sends a shutdown message to the server.
|
||||
.SS Parameter
|
||||
.IP \[bu] 2
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_sqlstate" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_sqlstate" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_ssl_set" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_ssl_set" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stat" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stat" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stmt_affected_rows" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stmt_affected_rows" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stmt_attr_get" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stmt_attr_get" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,7 +1,7 @@
|
||||
.\"t
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stmt_attr_set" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stmt_attr_set" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stmt_bind_param" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stmt_bind_param" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stmt_bind_result" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stmt_bind_result" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stmt_close" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stmt_close" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stmt_data_seek" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stmt_data_seek" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "mysql_stmt_errno" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||||
.TH "mysql_stmt_errno" "3" "" "Version 3.3.1" "MariaDB Connector/C"
|
||||
.hy
|
||||
.SS Name
|
||||
.PP
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user