mysqli::options

mysqli_options

(PHP 5, PHP 7, PHP 8)

mysqli::options -- mysqli_optionsSetzt Optionen

Beschreibung

Objektorientierter Stil

public mysqli::options(int $option, string|int $value): bool

Prozeduraler Stil

mysqli_options(mysqli $mysql, int $option, string|int $value): bool

Wird verwendet, um zusätzliche Verbindungsoptionen festzulegen und das Verhalten einer Verbindung zu beeinflussen.

Diese Funktion kann mehrfach aufgerufen werden, um mehrere Optionen zu setzen.

mysqli_options() muss nach mysqli_init() und vor mysqli_real_connect() aufgerufen werden.

Parameter-Liste

mysql

Nur bei prozeduralem Aufruf: ein von mysqli_connect() oder mysqli_init() zurückgegebenes mysqli-Objekt.

option

Die Option, die gesetzt werden soll. Es kann einer der folgenden Werte sein:

Gültige Optionen
Name Beschreibung
MYSQLI_OPT_CONNECT_TIMEOUT Zeitlimit für den Verbindungsaufbau (in Sekunden)
MYSQLI_OPT_READ_TIMEOUT Zeitlimit für die Ausführung eines Befehls (in Sekunden). Verfügbar seit PHP 7.2.0.
MYSQLI_OPT_LOCAL_INFILE Aktivieren/Deaktivieren von LOAD LOCAL INFILE
MYSQLI_INIT_COMMAND Der Befehl, der nach dem Aufbau einer Verbindung zum MySQL-Server ausgeführt wird
MYSQLI_SET_CHARSET_NAME Der Zeichensatz, der als Standard gesetzt werden soll
MYSQLI_READ_DEFAULT_FILE Optionen aus der benannten Optionsdatei lesen statt aus my.cnf; wird von mysqlnd nicht unterstützt.
MYSQLI_READ_DEFAULT_GROUP Liest die Optionen der benannten Gruppe aus der Datei my.cnf oder der Datei, die mit MYSQL_READ_DEFAULT_FILE angegeben wurde; wird von mysqlnd nicht unterstützt.
MYSQLI_SERVER_PUBLIC_KEY Die öffentliche RSA-Schlüsseldatei, die für die SHA-256-basierte Authentifizierung verwendet wird.
MYSQLI_OPT_NET_CMD_BUFFER_SIZE Die Größe des internen Befehls-/Netzwerkpuffers; gilt nur für mysqlnd.
MYSQLI_OPT_NET_READ_BUFFER_SIZE Maximale zu lesende Blockgröße (in Bytes), wenn der Textkörper eines MySQL-Befehlspakets gelesen wird; gilt nur für mysqlnd.
MYSQLI_OPT_INT_AND_FLOAT_NATIVE Konvertiert Spalten mit Werten vom Typ Integer und Float zurück in PHP-Zahlen; gilt nur für mysqlnd.
MYSQLI_OPT_SSL_VERIFY_SERVER_CERT Gibt an, ob das Serverzertifikat verifiziert werden soll oder nicht.

value

Der Wert für die Option

Rückgabewerte

Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

Beispiele

Siehe mysqli_real_connect().

Anmerkungen

Hinweis:

MySQLnd nimmt immer den Standardzeichensatz des Servers an. Dieser Zeichensatz wird während des Aufbaus der Verbindung bzw. der Authentifizierung übermittelt und danach von MySQLnd verwendet.

Libmysqlclient verwendet als Standardzeichensatz den, der in der Datei my.cnf angegeben oder durch einen Aufruf von mysqli_options() vor dem Aufruf von mysqli_real_connect() aber nach mysqli_init() gesetzt wurde.

Siehe auch

  • mysqli_init() - Initialisiert MySQLi und liefert ein Objekt zur Verwendung mit mysqli_real_connect()
  • mysqli_real_connect() - Baut eine Verbindung zu einem MySQL-Server auf

add a note add a note

User Contributed Notes 3 notes

up
8
php at darkain dot com
4 years ago
There is an undocumented option: MYSQLI_OPT_READ_TIMEOUT. This is similar to MYSQLI_OPT_CONNECT_TIMEOUT in theory, but has a slightly different application. Connection timeout only specifies the wait time for the initial TCP connection. Once that is created, the timeout no longer applies. Read timeout, however, is from the time the TCP connection is created until the first packet of actual data is received. There are instances where a TCP connection can be established, but the MySQL server stalls indefinitely, preventing execution from ever returning to PHP. Specifying a read timeout alleviates this condition, whereas connect timeout wouldn't.

If the MYSQLI_OPT_READ_TIMEOUT constant isn't defined, it is still supported on versions where that isn't the case. You can define it yourself in older PHP versions with the following code.

<?php
if (!defined('MYSQLI_OPT_READ_TIMEOUT')) {
   
define ('MYSQLI_OPT_READ_TIMEOUT', 11);
}
?>

You can then use read timeout the same way you could a connect timeout as follows. Please note that since these are two different timeout values for two different parts of the entire connection process, the timeouts do stack (eg: 10 seconds connect timeout + 10 seconds read timeout = maximum possible timeout of 20 seconds)

<?php
//create the object
$connection = mysqli_init();

//specify the connection timeout
$connection->options(MYSQLI_OPT_CONNECT_TIMEOUT, 10);

//specify the read timeout
$connection->options(MYSQLI_OPT_READ_TIMEOUT, 10);

//initiate the connection to the server, using both previously specified timeouts
$connection->real_connect('server', 'user', 'pass', 'database');
?>
up
8
fluppy
15 years ago
Here es little example to create a SSL Connection

<?php

$db
= mysqli_init();

/*
When you want so use a separate cnf
$test = $db->options(MYSQLI_EAD_DEFAULT_FILE,'myother.cnf');
*/

$db->ssl_set('server-key.pem','server-cert.pem',
'cacert.pem',NULL,NULL);

$db->real_connect('localhost','root','','mydb');

//Here some query

$db->close();

?>
up
-1
king at bobfish dot org
14 years ago
Example on using mysqli_options to increase size of max_allowed_packet for working with big blobs.

function dbConnect()
{
   $user = 'jomama';
   $pass = 'cartoon';
   $dbName = 'LifeCycle';
   $host = 'localhost';

   $mysqli = mysqli_init();
   mysqli_options($mysqli,MYSQLI_READ_DEFAULT_GROUP,
                                    "max_allowed_packet=50M");
   mysqli_real_connect($mysqli,$host, $user, $pass,$dbName)
                  or die ('<P>Unable to connect</P>');

   return $mysqli;
}
To Top