Movatterモバイル変換

MYSQL_DEFAULT_AUTH (argument type:char *)

The name of the authentication plugin to use.

MYSQL_ENABLE_CLEARTEXT_PLUGIN (argument type:my_bool *)

Enable themysql_clear_password cleartext authentication plugin. SeeClient-Side Cleartext Pluggable Authentication.

MYSQL_INIT_COMMAND (argument type:char *)

SQL statement to execute when connecting to the MySQL server. Automatically re-executed if reconnection occurs.

MYSQL_OPT_BIND (argument:char *)

The network interface from which to connect to the server. This is used when the client host has multiple network interfaces. The argument is a host name or IP address (specified as a string).

MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS (argument type:my_bool *)

Indicate whether the client can handle expired passwords. SeeServer Handling of Expired Passwords.

MYSQL_OPT_COMPRESS (argument: not used)

Compress all information sent between the client and the server if possible. SeeConnection Compression Control.

MYSQL_OPT_CONNECT_ATTR_DELETE (argument type:char *)

Given a key name, this option deletes a key-value pair from the current set of connection attributes to pass to the server at connect time. The argument is a pointer to a null-terminated string naming the key. Comparison of the key name with existing keys is case-sensitive.

See also the description for theMYSQL_OPT_CONNECT_ATTR_RESET option, as well as the description for theMYSQL_OPT_CONNECT_ATTR_ADD option in the description of themysql_options4() function. That function description also includes a usage example.

The Performance Schema exposes connection attributes through thesession_connect_attrs andsession_account_connect_attrs tables. SeePerformance Schema Connection Attribute Tables.

MYSQL_OPT_CONNECT_ATTR_RESET (argument not used)

This option resets (clears) the current set of connection attributes to pass to the server at connect time.

See also the description for theMYSQL_OPT_CONNECT_ATTR_DELETE option, as well as the description for theMYSQL_OPT_CONNECT_ATTR_ADD option in the description of themysql_options4() function. That function description also includes a usage example.

The Performance Schema exposes connection attributes through thesession_connect_attrs andsession_account_connect_attrs tables. SeePerformance Schema Connection Attribute Tables.

MYSQL_OPT_CONNECT_TIMEOUT (argument type:unsigned int *)

The connect timeout in seconds.

MYSQL_OPT_GET_SERVER_PUBLIC_KEY (argument type:my_bool *)

Enables the client to request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with thecaching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection.

IfMYSQL_SERVER_PUBLIC_KEY is given and specifies a valid public key file, it takes precedence overMYSQL_OPT_GET_SERVER_PUBLIC_KEY.

For information about thecaching_sha2_password plugin, seeCaching SHA-2 Pluggable Authentication.

This option was added in MySQL 5.7.23.

MYSQL_OPT_GUESS_CONNECTION (argument: not used)

For an application linked against thelibmysqld embedded server library, this option enables the library to guess whether to use the embedded server or a remote server.“Guess” means that if the host name is set and is notlocalhost, it uses a remote server. This behavior is the default.MYSQL_OPT_USE_EMBEDDED_CONNECTION andMYSQL_OPT_USE_REMOTE_CONNECTION can be used to override it. This option is ignored for applications linked against thelibmysqlclient client library.

MYSQL_OPT_LOCAL_INFILE (argument type: optional pointer tounsigned int)

This option affects client-sideLOCAL capability forLOAD DATA operations. By default,LOCAL capability is determined by the default compiled into the MySQL client library. To control this capability explicitly, invokemysql_options() to enable or disable theMYSQL_OPT_LOCAL_INFILE option:

TheENABLED_LOCAL_INFILECMake option controls the client library default for local data loading (seeMySQL Source-Configuration Options).

Successful use ofLOCAL load operations by a client also requires that the server permits local loading; seeSecurity Considerations for LOAD DATA LOCAL

MYSQL_OPT_MAX_ALLOWED_PACKET (argument:unsigned long *)

This option sets the client-side maximum size of the buffer for client/server communication. If themysql argument is non-NULL, the call sets the option value for that session. Ifmysql isNULL, the call sets the option value globally for all subsequent sessions for which a session-specific value is not specified.

Because it is possible to set a session or global maximum buffer size, depending on whether themysql argument is non-NULL orNULL,mysql_get_option() similarly returns the session or global value depending on itsmysql argument.

MYSQL_OPT_NAMED_PIPE (argument: not used)

Use a named pipe to connect to the MySQL server on Windows, if the server permits named-pipe connections.

MYSQL_OPT_NET_BUFFER_LENGTH (argument:unsigned long *)

This option sets the client-side buffer size for TCP/IP and socket communication.

MYSQL_OPT_PROTOCOL (argument type:unsigned int *)

Transport protocol to use for connection. Specify one of the enum values ofmysql_protocol_type defined inmysql.h.

MYSQL_OPT_READ_TIMEOUT (argument type:unsigned int *)

The timeout in seconds for each attempt to read from the server. There are retries if necessary, so the total effective timeout value is three times the option value. You can set the value so that a lost connection can be detected earlier than the TCP/IPClose_Wait_Timeout value of 10 minutes.

MYSQL_OPT_RECONNECT (argument type:my_bool *)

Enable or disable automatic reconnection to the server if the connection is found to have been lost. Reconnect is off by default; this option provides a way to set reconnection behavior explicitly. SeeSection 3.6.6, “Automatic Reconnection Control”.

MYSQL_OPT_RETRY_COUNT (argument type:unsigned int *)

The retry count for I/O-related system calls that are interrupted while connecting to the server or communicating with it. If this option is not specified, the default value is 1 (1 retry if the initial call is interrupted for 2 tries total).

This option can be used only by clients that link against a C client library compiiled with NDB Cluster support. It is available as of MySQL NDB Cluster 7.5.1.

MYSQL_OPT_SSL_CA (argument type:char *)

The path name of the Certificate Authority (CA) certificate file. This option, if used, must specify the same certificate used by the server.

MYSQL_OPT_SSL_CAPATH (argument type:char *)

The path name of the directory that contains trusted SSL CA certificate files.

MYSQL_OPT_SSL_CERT (argument type:char *)

The path name of the client public key certificate file.

MYSQL_OPT_SSL_CIPHER (argument type:char *)

The list of permissible ciphers for SSL encryption.

MYSQL_OPT_SSL_CRL (argument type:char *)

The path name of the file containing certificate revocation lists.

MYSQL_OPT_SSL_CRLPATH (argument type:char *)

The path name of the directory that contains files containing certificate revocation lists.

MYSQL_OPT_SSL_ENFORCE (argument type:my_bool *)

Whether to require the connection to use SSL. If enabled and an encrypted connection cannot be established, the connection attempt fails.

This option is deprecated as of MySQL 5.7.11 and is removed in MySQL 8.0. Instead, useMYSQL_OPT_SSL_MODE with a value ofSSL_MODE_REQUIRED.

MYSQL_OPT_SSL_KEY (argument type:char *)

The path name of the client private key file.

MYSQL_OPT_SSL_MODE (argument type:unsigned int *)

The security state to use for the connection to the server:SSL_MODE_DISABLED,SSL_MODE_PREFERRED,SSL_MODE_REQUIRED,SSL_MODE_VERIFY_CA,SSL_MODE_VERIFY_IDENTITY. If this option is not specified, the default isSSL_MODE_PREFERRED. These modes are the permitted values of themysql_ssl_mode enumeration defined inmysql.h. For more information about the security states, see the description of--ssl-mode inCommand Options for Encrypted Connections.

This option was added in MySQL 5.7.11.

MYSQL_OPT_SSL_VERIFY_SERVER_CERT (argument type:my_bool *)

Enable or disable verification of the server's Common Name identity in its certificate against the host name used when connecting to the server. The connection is rejected if there is a mismatch. For encrypted connections, this feature can be used to prevent man-in-the-middle attacks. Identity verification is disabled by default.

This option does not work with self-signed certificates, which do not contain the server name as the Common Name value.

This option is deprecated as of MySQL 5.7.11 and is removed in MySQL 8.0. Instead, useMYSQL_OPT_SSL_MODE with a value ofSSL_MODE_VERIFY_IDENTITY.

MYSQL_OPT_TLS_VERSION (argument type:char *)

Which protocols the client permits for encrypted connections. The value is a list of one or more comma-separated protocol versions. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, seeEncrypted Connection TLS Protocols and Ciphers.

This option was added in MySQL 5.7.10.

MYSQL_OPT_USE_EMBEDDED_CONNECTION (argument: not used)

For an application linked against thelibmysqld embedded server library, this option forces the use of the embedded server for the connection. It is ignored for applications linked against thelibmysqlclient client library.

MYSQL_OPT_USE_REMOTE_CONNECTION (argument: not used)

For an application linked against thelibmysqld embedded server library, this option forces the use of a remote server for the connection. It is ignored for applications linked against thelibmysqlclient client library.

MYSQL_OPT_USE_RESULT (argument: not used)

This option is unused.

MYSQL_OPT_WRITE_TIMEOUT (argument type:unsigned int *)

The timeout in seconds for each attempt to write to the server. There is a retry if necessary, so the total effective timeout value is two times the option value.

MYSQL_PLUGIN_DIR (argument type:char *)

The directory in which to look for client plugins.

MYSQL_READ_DEFAULT_FILE (argument type:char *)

Read options from the named option file instead of frommy.cnf.

MYSQL_READ_DEFAULT_GROUP (argument type:char *)

Read options from the named group frommy.cnf or the file specified withMYSQL_READ_DEFAULT_FILE.

MYSQL_REPORT_DATA_TRUNCATION (argument type:my_bool *)

Enable or disable reporting of data truncation errors for prepared statements using theerror member ofMYSQL_BIND structures. (Default: enabled.)

MYSQL_SECURE_AUTH (argument type:my_bool *)

Whether to connect to a server that does not support the password hashing used in MySQL 4.1.1 and later. This option is enabled by default.

MYSQL_SERVER_PUBLIC_KEY (argument type:char *)

The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with thesha256_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection.

IfMYSQL_SERVER_PUBLIC_KEY is given and specifies a valid public key file, it takes precedence overMYSQL_OPT_GET_SERVER_PUBLIC_KEY.

For information about thesha256_password andcaching_sha2_password plugins, seeSHA-256 Pluggable Authentication, andCaching SHA-2 Pluggable Authentication.

MYSQL_SET_CHARSET_DIR (argument type:char *)

The path name of the directory that contains character set definition files.

MYSQL_SET_CHARSET_NAME (argument type:char *)

The name of the character set to use as the default character set. The argument can beMYSQL_AUTODETECT_CHARSET_NAME to cause the character set to be autodetected based on the operating system setting (seeConnection Character Sets and Collations).

MYSQL_SET_CLIENT_IP (argument type:char *)

For an application linked against thelibmysqld embedded server library (whenlibmysqld is compiled with authentication support), this option means that the user is considered to have connected from the specified IP address (specified as a string) for authentication purposes. It is ignored for applications linked against thelibmysqlclient client library.

MYSQL_SHARED_MEMORY_BASE_NAME (argument type:char *)

The name of the shared-memory object for communication to the server on Windows, if the server supports shared-memory connections. Specify the same value as used for theshared_memory_base_name system variable. of themysqld server you want to connect to.