mysql-xdevapi.getsession.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b0a34b2fce160f558e3c81bf73121d16c9d56eb8 Maintainer: samesch Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.mysql-xdevapi-getsession" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>getSession</refname>
  <refpurpose>Baut eine Verbindung zu einem MySQL-Server auf</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mysql_xdevapi\Session</type><methodname>mysql_xdevapi\getSession</methodname>
   <methodparam><type>string</type><parameter>uri</parameter></methodparam>
  </methodsynopsis>
  <para>
   Baut eine Verbindung zum MySQL-Server auf.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>uri</parameter></term>
    <listitem>
     <para>
      Der URI des MySQL-Servers, &zb;
      <literal>mysqlx://user:password@host</literal>.
     </para>
     <para>
      URI-Format:
     </para>
     <para>
      <code>scheme://[user[:[password]]@]target[:port][?attribute1=value1&amp;attribute2=value2...</code>
     </para>
     <itemizedlist>
      <listitem>
       <para>
        <literal>scheme</literal>: erforderlich; das Verbindungsprotokoll
       </para>
       <para>
        In mysql_xdevapi ist es immer 'mysqlx' (für das X-Protokoll)
       </para>
      </listitem>
      <listitem>
       <para>
        <literal>user</literal>: optional; das MySQL-Benutzerkonto für die
        Authentifizierung
       </para>
      </listitem>
      <listitem>
       <para>
        <literal>password</literal>: optional; das Passwort des
        MySQL-Benutzers für die Authentifizierung
       </para>
      </listitem>
      <listitem>
       <para>
        <literal>target</literal>: erforderlich; die Serverinstanz, auf die
        sich die Verbindung bezieht:
       </para>
       <para>
        * TCP-Verbindung (Hostname, IPv4-Adresse oder IPv6-Adresse)
       </para>
       <para>
        * Pfad des Unix-Sockets (lokaler Dateipfad)
       </para>
       <para>
        * Windows Named-Pipe (lokaler Dateipfad)
       </para>
      </listitem>
      <listitem>
       <para>
        <literal>port</literal>: optional; der Netzwerk-Port des MySQL-Servers
       </para>
       <para>
        der Standard-Port für das X-Protokoll ist 33060
       </para>
      </listitem>
      <listitem>
       <para>
        <literal>?attribute=value</literal>: Dieses Element ist optional und
        gibt ein Datenwörterbuch an, das verschiedene Optionen enthält, unter
        anderem:
       </para>
       <itemizedlist>
        <listitem>
         <para>
          Das Attribut <literal>auth</literal> (Authentifizierungsmechanismus),
          das für verschlüsselte Verbindungen benötigt wird. Für weitere
          Informationen siehe
          <link xlink:href="&url.mysql.docs.connect.encryption;">Command Options for Encrypted Connections</link>.
          Die folgenden 'auth'-Werte werden unterstützt:
          <literal>plain</literal>, <literal>mysql41</literal>,
          <literal>external</literal> und <literal>sha256_mem</literal>.
         </para>
        </listitem>
        <listitem>
         <para>
          Das Attribut <literal>connect-timeout</literal> betrifft die
          Verbindung selbst, aber nicht die nachfolgenden Operationen. Es wird
          pro Verbindung gesetzt, unabhängig davon, ob die Verbindung zu einem
          oder mehreren Hosts besteht.
         </para>
         <para>
          Das Zeitlimit für die Verbindung wird mit einer positiven Ganzzahl
          in Sekunden angegeben. Wenn 0 (Null) angegeben wird, ist das
          Zeitlimit deaktiviert (unendlich). Wird kein Zeitlimit angegeben,
          wird der Standardwert 10 verwendet.
         </para>
         <para>
          In diesem Zusammenhang können die Umgebungsvariablen
          MYSQLX_CONNECTION_TIMEOUT (Zeitlimit in Sekunden) und
          MYSQLX_TEST_CONNECTION_TIMEOUT (wird bei Tests verwendet) gesetzt
          und im URI anstelle von connect-timeout verwendet werden. Die
          URI-Option connect-timeout hat gegenüber diesen Umgebungsvariablen
          Vorrang.
         </para>
        </listitem>
        <listitem>
         <para>
          Das optionale Attribut <literal>compression</literal> akzeptiert
          diese Werte: <literal>preferred</literal> (der Client verhandelt mit
          dem Server, um einen unterstützten Algorithmus zu finden; wenn kein
          von beiden Seiten unterstützter Algorithmus gefunden wird, bleibt
          die Verbindung unkomprimiert), <literal>required</literal> (wie
          "preferred", aber die Verbindung wird abgebrochen, wenn kein von
          beiden Seiten unterstützter Algorithmus gefunden wird) oder
          <literal>disabled</literal> (die Verbindung bleibt unkomprimiert).
          Der Standardwert ist <literal>preferred</literal>.
         </para>
         <para>
          Diese Option wurde in Version 8.0.20 hinzugefügt.
         </para>
        </listitem>
        <listitem>
         <para>
          Das optionale Attribut <literal>compression-algorithms</literal>
          definiert die gewünschten Kompressionsalgorithmen (und die
          bevorzugte Reihenfolge ihrer Verwendung):
          <literal>zstd_stream</literal> (alias: zstd),
          <literal>lz4_message</literal> (alias: lz4) oder
          <literal>deflate_stream</literal> (alias: deflate oder zlib).
          Standardmäßig wird (je nach Verfügbarkeit des Systems) die
          Reihenfolge lz4_message, zstd_stream und dann deflate_stream
          verwendet. Wenn zum Beispiel compression-algorithms=[lz4,zstd_stream]
          übergeben wird, wird lz4 verwendet, wenn es verfügbar ist,
          andernfalls wird zstd_stream verwendet. Wenn beide nicht verfügbar
          sind, hängt das Verhalten vom compression-Wert ab, so wird &zb; bei
          compression=required eine Fehlermeldung ausgegeben.
         </para>
         <para>
          Diese Option wurde in Version 8.0.22 hinzugefügt.
         </para>
        </listitem>
       </itemizedlist>
      </listitem>
     </itemizedlist>
     <example>
      <title>Beispiele für URIs</title>
      <programlisting role="php">
mysqlx://foobar
mysqlx://root@localhost?socket=%2Ftmp%2Fmysqld.sock%2F
mysqlx://foo:bar@localhost:33060
mysqlx://foo:bar@localhost:33160?ssl-mode=disabled
mysqlx://foo:bar@localhost:33260?ssl-mode=required
mysqlx://foo:bar@localhost:33360?ssl-mode=required&amp;auth=mysql41
mysqlx://foo:bar@(/path/to/socket)
mysqlx://foo:bar@(/path/to/socket)?auth=sha256_mem
mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061]
mysqlx://foobar?ssl-ca=(/path/to/ca.pem)&amp;ssl-crl=(/path/to/crl.pem)
mysqlx://foo:bar@[localhost:33060, 127.0.0.1:33061]?ssl-mode=disabled
mysqlx://foo:bar@localhost:33160/?connect-timeout=0
mysqlx://foo:bar@localhost:33160/?connect-timeout=10&amp;compression=required
mysqlx://foo:bar@localhost:33160/?connect-timeout=10&amp;compression=required&amp;compression-algorithms=[lz4,zstd_stream]
      </programlisting>
     </example>
     <para>
      Für weitere Informationen siehe den Abschnitt
      <link xlink:href="&url.mysql.docs.connect.shell.uri;">Connecting using a URI String</link>
      zur MySQL Shell.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt ein <classname>Session</classname>-Objekt zurück.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Ein Verbindungsfehler löst eine <classname>Exception</classname> aus.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>mysql_xdevapi\getSession</function>-Beispiel</title>
   <programlisting role="php">
<![CDATA[
<?php
try {
    $session = mysql_xdevapi\getSession("mysqlx://user:password@host");
} catch(Exception $e) {
    die("Die Verbindung konnte nicht aufgebaut werden: " . $e->getMessage());
}

$schemas = $session->getSchemas();
print_r($schemas);

$mysql_version = $session->getServerVersion();
print_r($mysql_version);

var_dump($collection->find("name = 'Alfred'")->execute()->fetchOne());
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
Array
(
    [0] => mysql_xdevapi\Schema Object
        (
            [name] => helloworld
        )
    [1] => mysql_xdevapi\Schema Object
        (
            [name] => information_schema
        )
    [2] => mysql_xdevapi\Schema Object
        (
            [name] => mysql
        )
    [3] => mysql_xdevapi\Schema Object
        (
            [name] => performance_schema
        )
    [4] => mysql_xdevapi\Schema Object
        (
            [name] => sys
        )
)

80012

array(4) {
  ["_id"]=>
  string(28) "00005ad66abf0001000400000003"
  ["age"]=>
  int(42)
  ["job"]=>
  string(7) "Butler"
  ["name"]=>
  string(4) "Alfred"
}
]]>
   </screen>
  </example>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->