mariadb connect: Difference between revisions

Revision as of 10:49, 19 May 2019

mariadb connect

Type: Function
Context: Server
Introduced: v1.0

NOTICE

This function is provided by the official MariaDB plugin.

__EDIT_ME__

mariadb_connect(host_str, user_str, passwd_str, db_str [, ssl_key_file, ssl_cert_file, ssl_ca_file, ssl_ca_path, ssl_cipher])

host_str
The MariaDB server to connect to. This can be an IP address or hostname.
user_str
The MariaDB user.
passwd_str
The password for the user.
db_str
MariaDB database to use.
ssl_key_file (optional)
Private key for SSL connections.
ssl_cert_file (optional)
__EDIT_ME__
ssl_ca_file (optional)
__EDIT_ME__
ssl_ca_path (optional)
__EDIT_ME__
ssl_cipher (optional)
__EDIT_ME__

Returns an identifier/handle to the new database connection. false on error.

__EDIT_ME__

@@ Line 7: / Line 7: @@
 {{FuncParameters}}
-{{FuncParam|host_str|__EDIT_ME__}}
+{{FuncParam|host_str|The MariaDB server to connect to. This can be an IP address or hostname.}}
-{{FuncParam|user_str|__EDIT_ME__}}
+{{FuncParam|user_str|The MariaDB user.}}
-{{FuncParam|passwd_str|__EDIT_ME__}}
+{{FuncParam|passwd_str|The password for the user.}}
-{{FuncParam|db_str |__EDIT_ME__}}
+{{FuncParam|db_str |MariaDB database to use.}}
-{{FuncParam|ssl_key_file|__EDIT_ME__}}
+{{FuncParamOptional|ssl_key_file|Private key for SSL connections.}}
-{{FuncParam|ssl_cert_file|__EDIT_ME__}}
+{{FuncParamOptional|ssl_cert_file|__EDIT_ME__}}
-{{FuncParam|ssl_ca_file|__EDIT_ME__}}
+{{FuncParamOptional|ssl_ca_file|__EDIT_ME__}}
-{{FuncParam|ssl_ca_path|__EDIT_ME__}}
+{{FuncParamOptional|ssl_ca_path|__EDIT_ME__}}
 {{FuncParamOptional|ssl_cipher|__EDIT_ME__}}
-{{FuncReturnValue|__EDIT_ME__}}
+{{FuncReturnValue|Returns an identifier/handle to the new database connection. '''false''' on error.}}
 == Example ==