archived-doc-es/reference/mysql_xdevapi/functions/mysql-xdevapi.getsession.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0a34b2fce160f558e3c81bf73121d16c9d56eb8 Maintainer: PhilDaiguille 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>Conecta a un servidor MySQL</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>
   Conecta al servidor MySQL.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>uri</parameter></term>
    <listitem>
     <para>
      El URI del servidor MySQL, tal como <literal>mysqlx://user:password@host</literal>.
     </para>
     <para>
      Formato de URI:
     </para>
     <para>
      <code>scheme://[user[:[password]]@]target[:port][?attribute1=value1&amp;attribute2=value2...</code>
     </para>
     <itemizedlist>
      <listitem>
        <para><literal>scheme</literal>: requerido, el protocolo de conexión</para>
        <para>En mysql_xdevapi es siempre 'mysqlx' (para el protocolo X)</para>
      </listitem>
      <listitem>
        <para><literal>user</literal>: opcional, la cuenta de usuario MySQL para la autenticación</para>
      </listitem>
      <listitem>
        <para><literal>password</literal>: opcional, la contraseña del usuario MySQL para la autenticación</para>
      </listitem>
      <listitem>
        <para><literal>target</literal>: requerido, la instancia del servidor a la que se refiere la conexión:</para>
        <para>* Conexión TCP (nombre de host, dirección IPv4 o dirección IPv6)</para>
        <para>* Ruta de socket Unix (ruta de fichero local)</para>
        <para>* Pipe nombrado Windows (ruta de fichero local)</para>
      </listitem>
      <listitem>
        <para><literal>port</literal>: opcional, el puerto de red del servidor MySQL.</para>
        <para>Por omisión, el puerto para el protocolo X es 33060</para>
      </listitem>
      <listitem>
        <para>
          <literal>?attribute=value</literal>: este elemento es opcional y especifica un diccionario de datos
          que contiene diferentes opciones, incluyendo:
        </para>
        <itemizedlist>
          <listitem>
          <para>
            El atributo <literal>auth</literal> (mecanismo de autenticación) relacionado con las conexiones cifradas.
            Para más información, ver <link xlink:href="&url.mysql.docs.connect.encryption;">Opciones de comando para las conexiones cifradas</link>.
            Los siguientes valores 'auth' son soportados: <literal>plain</literal>,
            <literal>mysql41</literal>, <literal>external</literal>, y <literal>sha256_mem</literal>.
          </para>
          </listitem>
          <listitem>
          <para>
           El atributo <literal>connect-timeout</literal> afecta la conexión y
           no las operaciones siguientes. Se define por conexión, ya sea en
           un solo host o en varios.
          </para>
          <para>
           Pasar un entero positivo para definir el tiempo límite de conexión en segundos,
           o pasar 0 (cero) para desactivar el tiempo límite (infinito). No definir
           connect-timeout utiliza el valor por omisión de 10.
          </para>
          <para>
            En relación, las variables de entorno MYSQLX_CONNECTION_TIMEOUT (tiempo límite en segundos) y MYSQLX_TEST_CONNECTION_TIMEOUT (utilizado durante la ejecución de pruebas)
            pueden ser definidas y utilizadas en lugar de connect-timeout en el URI. La opción
            connect-timeout del URI tiene prioridad sobre estas variables de entorno.
          </para>
          </listitem>
          <listitem>
            <para>
              El atributo opcional <literal>compression</literal> acepta estos valores:
              <literal>preferred</literal> (el cliente negocia con el servidor para encontrar un algoritmo soportado; la conexión no está comprimida si no se encuentra un algoritmo soportado mutuamente),
              <literal>required</literal> (como "preferred", pero la conexión se termina si no se encuentra un algoritmo soportado mutuamente), o
              <literal>disabled</literal> (la conexión no está comprimida). Por omisión, <literal>preferred</literal>.
            </para>
            <para>
              Esta opción fue añadida en la versión 8.0.20.
            </para>
          </listitem>
          <listitem>
            <para>
              El atributo opcional <literal>compression-algorithms</literal> define los algoritmos
              de compresión deseados (y su orden de uso preferido):
              <literal>zstd_stream</literal> (alias: zstd),
              <literal>lz4_message</literal> (alias: lz4), o
              <literal>deflate_stream</literal> (alias: deflate o zlib).
              Por omisión, el orden utilizado (según la disponibilidad del sistema) es lz4_message, zstd_stream, y luego deflate_stream.
              Por ejemplo, pasar compression-algorithms=[lz4,zstd_stream] utiliza lz4 si está disponible, de lo contrario
              se utiliza zstd_stream. Si ninguno de los dos está disponible, el comportamiento depende del valor de compression
              por ejemplo, si compression=required entonces fallará con un error.
            </para>
            <para>
              Esta opción fue añadida en la versión 8.0.22.
            </para>
          </listitem>
        </itemizedlist>
       </listitem>
      </itemizedlist>

  <example>
  <title>Ejemplo de URI</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>
    Para más información, ver conexión a MySQL Shell
    <link xlink:href="&url.mysql.docs.connect.shell.uri;">utilizando una cadena de URI</link>.
   </para>

    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Un objeto <classname>Session</classname>.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Un error de conexión lanza una excepción <classname>Exception</classname>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Ejemplo de <function>mysql_xdevapi\getSession</function></title>
   <programlisting role="php">
<![CDATA[
<?php
try {
    $session = mysql_xdevapi\getSession("mysqlx://user:password@host");
} catch(Exception $e) {
    die("La conexión no pudo ser establecida: " . $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
-->