-
Notifications
You must be signed in to change notification settings - Fork 76
/
Copy pathmysql-xdevapi.getsession.xml
253 lines (237 loc) · 10.8 KB
/
mysql-xdevapi.getsession.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0a34b2fce160f558e3c81bf73121d16c9d56eb8 Maintainer: sergey 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>Подключается к серверу 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>
Подключается к серверу MySQL.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<para>
URI к серверу MySQL, такой как <literal>mysqlx://user:password@host</literal>.
</para>
<para>
Формат URI:
</para>
<para>
<code>scheme://[user[:[password]]@]target[:port][?attribute1=value1&attribute2=value2...</code>
</para>
<itemizedlist>
<listitem>
<para><literal>scheme</literal>: обязательный, протокол соединения</para>
<para>В mysql_xdevapi это всегда 'mysqlx' (для X Protocol)</para>
</listitem>
<listitem>
<para><literal>user</literal>: необязательный, учётная запись пользователя MySQL для аутентификации</para>
</listitem>
<listitem>
<para><literal>password</literal>: необязательный, пароль пользователя MySQL для аутентификации</para>
</listitem>
<listitem>
<para><literal>target</literal>: обязательный, экземпляр сервера, к которому относится соединение:</para>
<para>* TCP-соединение (имя хоста, адрес IPv4 или адрес IPv6)</para>
<para>* Путь к сокету Unix (локальный путь к файлу)</para>
<para>* Именованный канал Windows (локальный путь к файлу)</para>
</listitem>
<listitem>
<para><literal>port</literal>: необязательный, сетевой порт сервера MySQL.</para>
<para>по умолчанию порт для X Protocol равен 33060</para>
</listitem>
<listitem>
<para>
<literal>?attribute=value</literal>: этот элемент является необязательным и определяет словарь данных,
который содержит различные параметры, в том числе:
</para>
<itemizedlist>
<listitem>
<para>
Атрибут <literal>auth</literal> (механизм аутентификации), поскольку он относится к зашифрованным соединениям.
Для получения дополнительной информации смотрите <link xlink:href="&url.mysql.docs.connect.encryption;">Параметры
команды для зашифрованных соединений</link>.
Поддерживаются следующие значения: <literal>plain</literal>,
<literal>mysql41</literal>, <literal>external</literal>, и <literal>sha256_mem</literal>.
</para>
</listitem>
<listitem>
<para>
Атрибут <literal>connect-timeout</literal> влияет на соединение,
а не на последующие операции. Он устанавливается для каждого соединения на
одном или нескольких хостах.
</para>
<para>
Введите положительное целое число, чтобы определить время ожидания соединения в секундах,
или введите 0 (ноль), чтобы отключить время ожидания (бесконечно). Не определяя
время ожидания подключения, вы используется значение по умолчанию 10.
</para>
<para>
Связанные, переменные среды MYSQLX_CONNECTION_TIMEOUT (время ожидания в секундах) и MYSQLX_TEST_CONNECTION_TIMEOUT (используемые во время выполнения тестов)
могут быть установлены и использованы вместо connect-timeout соединения в URI.
Параметр URI подключения к connect-timeout имеет приоритет над переменными среды.
</para>
</listitem>
<listitem>
<para>
Необязательный атрибут <literal>compression</literal> принимает следующие значения:
<literal>preferred</literal> (клиент договаривается с сервером, чтобы найти поддерживаемый алгоритм; соединение не сжато, если взаимно поддерживаемый алгоритм не найден),
<literal>required</literal> (как "preferred", но соединение разрывается, если взаимно поддерживаемый алгоритм не найден), или
<literal>disabled</literal> (соединение не сжато). По умолчанию используется <literal>preferred</literal>.
</para>
<para>
Опция была добавлена в версии 8.0.20.
</para>
</listitem>
<listitem>
<para>
Необязательный атрибут <literal>compression-algorithms</literal> определяет
желаемые алгоритмы сжатия (и их предпочтительный порядок использования):
<literal>zstd_stream</literal>(псевдоним: zstd),
<literal>lz4_message</literal> (псевдоним: lz4) или
<literal>deflate_stream</literal> (псевдонимы: deflate или zlib).
По умолчанию используется порядок (в зависимости от доступности системы): lz4_message, zstd_stream, затем deflate_stream.
Например, при передаче compression-algorithms=[lz4, zstd_stream] используется lz4, если он доступен, в противном случае
используется zstd_stream. Если оба недоступны, поведение зависит от значения сжатия,
например, если compression=required, то произойдёт сбой с ошибкой.
</para>
<para>
Опция была добавлена в версии 8.0.22.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<example>
<title>Примеры 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&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)&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&compression=required
mysqlx://foo:bar@localhost:33160/?connect-timeout=10&compression=required&compression-algorithms=[lz4,zstd_stream]
</programlisting>
</example>
<para>
Для получения дополнительной информации смотрите MySQL Shell
<link xlink:href="&url.mysql.docs.connect.shell.uri;">Подключение с использованием строки URI</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Объект <classname>Session</classname>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Ошибка соединения вызывает <classname>Exception</classname>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Пример использования <function>mysql_xdevapi\getSession</function></title>
<programlisting role="php">
<![CDATA[
<?php
try {
$session = mysql_xdevapi\getSession("mysqlx://user:password@host");
} catch(Exception $e) {
die("Не удалось установить соединение: " . $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
-->