« Query custom function… | Home | MBS @ FMTraining.TV »

SQL options applicable to MySQL and MariaDB in MBS Plugin

Let us list options for connecting to MySQL or MariaDB via MBS FileMaker Plugin or MBS Xojo SQL Plugin:

MYSQL.LIBS

Api Scope

Forces plugin Library to use specified MySQL client library.

Valid values: Any valid MySQL CLI library name list. Names separated by ';' on Windows or ':' on other operating systems.
Default value:
  • Windows - "libmySQL.dll;libmariadb.dll"
  • Linux - "libmysqlclient.so:libmysqlclient.so.15:libmysqlclient.so.16:libmysqlclient.so.18:libmariadb.so"
  • macOS - "libmysqlclient.dylib:libmariadb.dylib"

CLIENT_COMPRESS
CLIENT_FOUND_ROWS
CLIENT_IGNORE_SPACE
CLIENT_INTERACTIVE
CLIENT_LOCAL_FILES
CLIENT_NO_SCHEMA
CLIENT_ODBC
CLIENT_MULTI_STATEMENTS
CLIENT_MULTI_RESULTS
CLIENT_REMEMBER_OPTIONS

Connection Scope

Allows to specify various options that will be passed on to mysql_real_connect(). See MySQL documentation for more information how these options affect underlying connection behaviour.

Valid values: "true" to specify a flag, "false" (or not specified) to omit
Default value: not specified, but CLIENT_MULTI_STATEMENTS, CLIENT_MULTI_RESULTS and CLIENT_REMEMBER_OPTIONS are turned on

CharacterSet

Connection Scope

Allows to set the client connection character set.

Valid values: Any MySQL allowed character set name
Default value: not specified

Utf8CharacterSetName

Connection Scope

Allows to define the client connection character set used by Unicode plugin version. By default "utf8" is used and now it's a synonym for "utf8mb3". But modern MySQL versions support also "utf8mb4" and it may become the default soon.`

Valid values: Any MySQL allowed Unicode character set name
Default value: "utf8"

UseMySQLKillQueryConnection

Connection Scope

Instructs plugin to create an additional connection that is used for 'KILL QUERY ..' command when SACommand::Cancel method executed.

Valid values: "true", "false"
Default value: "false"

MYSQL_OPT_CONNECT_TIMEOUT
MYSQL_OPT_READ_TIMEOUT
MYSQL_OPT_WRITE_TIMEOUT

Connection Scope

Allows to specify timeout values that are used with mysql_options. See MySQL documentation for more information how these options affect underlying connection behaviour.

Valid values: string that represents an integer value
Default value: not specified

MYSQL_OPT_RECONNECT

Connection Scope

Allows to specify reconnect option that will be used with mysql_options. See MySQL documentation for more information on how this option affects underlying connection behaviour.

Valid values: "true" to specify a flag, "false" to omit
Default value: not specified

MYSQL_OPT_SSL_MODE

Connection Scope

Allows to specify MySQL SSL mode parameters. See MySQL documentation for more information about these options.

Valid values: "SSL_MODE_DISABLED" , "SSL_MODE_PREFERRED" , "SSL_MODE_REQUIRED" , "SSL_MODE_VERIFY_CA" , "SSL_MODE_VERIFY_IDENTITY"
Default value: not specified

MYSQL_OPT_TLS_VERSION

Connection Scope

Allows to specify MySQL SSL protocols the client permits for encrypted connections. See MySQL documentation for more information about these options.

Default value: not specified

MYSQL_SSL_KEY
MYSQL_SSL_CERT
MYSQL_SSL_CA
MYSQL_SSL_CAPATH
MYSQL_SSL_CIPHER

Connection Scope

Allows to specify MySQL SSL parameters that will be used with mysql_ssl_set. MySQL API method called only when at least one mentioned or MYSQL_OPT_SSL_MODEparameter specified. See MySQL documentation for more information about these options.

Default value: not specified

HandleResult

Command Scope

Determines whether the result set will be stored in a temporary table or a local buffer on a client (it allows to open several result sets simultaneously in one transaction), or it will be read row by row directly from the server (somewhat faster and uses much less memory). For more information see MySQL documentation on mysql_store_result() and mysql_use_result() functions.

Valid values:
  • "use" to force plugin to call mysql_use_result() function
  • "store" to force plugin to call mysql_store_result() function
Default value: "use"

UseStatement

Command Scope

Determines whether MySQL statement API should be used (if supported by MySQL client library). Be aware that statement API cannot be used with multi-statement, multi-result queries and has some additional restrictions.

Valid values: "true", "false"
Default value: "false"

PreFetchRows

Command Scope

Forces plugin library to fetch rows in bulk, rather than retrieving records one by one. Only has an effect if MySQL statement API is used (see UseStatement option).

Valid values: String containing number of rows in the fetch buffer
Default value: "1"

UseDynamicCursor
Scrollable

Command Scope

Forces plugin to store MySQL result set that allows scrolling through the data rows.

Valid values: "True", "1"
Default value: "False"

IgnoreFieldBinaryFlag

Command Scope

Forces plugin to ignore MySQL result set field binary flag - any STRING/BLOB field is interpreted as a text data when this option is used.

Valid values: "True", "1"
Default value: "False"
Claris FileMaker Plugin
04 02 22 - 13:41

Start Chat