-
Notifications
You must be signed in to change notification settings - Fork 76
/
Copy pathquickstart.xml
1656 lines (1546 loc) · 69.9 KB
/
quickstart.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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 60a292997b3c6341cf52099d901aa0b5f8673d87 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<chapter xml:id="mysqli.quickstart" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Краткое руководство</title>
<para>
Это практическое руководство помогает освоить основные моменты API-интерфейса
MySQL-сервера.
</para>
<para>
В этом руководстве приводится краткий обзор модуля mysqli. Для всех основных
особенностей API-интерфейса приведены примеры PHP-кода. Также объясняются
принципы работы баз данных в целом, чтобы иметь возможность описать какие-то
отдельные моменты, присущие конкретно MySQL.
</para>
<para>
Требования: Знакомство с языком программирования PHP, SQL, а также знание основ
работы с MySQL-сервером.
</para>
<section xml:id="mysqli.quickstart.dual-interface">
<title>Процедурный и объектно-ориентированный интерфейс</title>
<para>
Модуль mysqli предоставляет двойной интерфейс программисту. Поддерживаются
как процедурная, так и объектно-ориентированная парадигмы программирования.
</para>
<para>
Пользователи, переходящие со старого модуля mysql, возможно, предпочтут
процедурный интерфейс. Он весьма схож с интерфейсом старого модуля, и во
многих случаях функции отличаются только префиксом в имени. Некоторые
mysqli-функции принимают дескриптор соединения первым аргументом, в отличие от
соответствующих им функций старого модуля, которые принимают его в качестве
последнего необязательного аргумента.
</para>
<para>
<example>
<title>Простота перехода со старого модуля mysql</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = mysqli_connect("example.com", "user", "password", "database");
$result = mysqli_query($mysqli, "SELECT 'Пожалуйста, не используйте устаревший модуль mysql в новых проектах.' AS _msg FROM DUAL");
$row = mysqli_fetch_assoc($result);
echo $row['_msg'];
$mysql = mysql_connect("example.com", "user", "password");
mysql_select_db("test");
$result = mysql_query("SELECT 'Используйте вместо него модуль mysqli.' AS _msg FROM DUAL", $mysql);
$row = mysql_fetch_assoc($result);
echo $row['_msg'];
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Пожалуйста, не используйте устаревший модуль mysql в новых проектах. Используйте вместо него модуль mysqli.
]]>
</screen>
</example>
</para>
<para>
<emphasis role="bold">Объектно-ориентированный интерфейс</emphasis>
</para>
<para>
В дополнение к процедурному пользователи могут использовать
объектно-ориентированный интерфейс. Документация заточена именно под
объектный интерфейс. Объектно-ориентированный интерфейс предлагает функции
сгруппированные по цели их применения, что облегчает их поиск и освоение. Тем
не менее, в практических примерах к функциям приводится код для обеих парадигм.
</para>
<para>
Каких-либо принципиальных отличий в производительности между интерфейсами нет.
Пользователи вольны в выборе интерфейса, основываясь на личных предпочтениях.
</para>
<para>
<example>
<title>Объектно-ориентированный и процедурный интерфейсы</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = mysqli_connect("example.com", "user", "password", "database");
$result = mysqli_query($mysqli, "SELECT 'Мир, полный ' AS _msg FROM DUAL");
$row = mysqli_fetch_assoc($result);
echo $row['_msg'];
$mysqli = new mysqli("example.com", "user", "password", "database");
$result = $mysqli->query("SELECT 'выбора, чтобы угодить всем.' AS _msg FROM DUAL");
$row = $result->fetch_assoc();
echo $row['_msg'];
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Мир, полный выбора, чтобы угодить всем.
]]>
</screen>
</example>
</para>
<para>
Примеры в этом руководстве будут написаны в объектном стиле в виду того, что
объектному подходу отдавалось предпочтение при создании документации.
</para>
<para>
<emphasis role="bold">Смешивание стилей</emphasis>
</para>
<para>
Переключаться между стилями программирования можно сколь угодно часто и в любое
время, однако делать этого не рекомендуется, так как это ухудшает читаемость
кода и затрудняет его поддержку.
</para>
<para>
<example>
<title>Плохой стиль программирования</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("example.com", "user", "password", "database");
$result = mysqli_query($mysqli, "SELECT 'Этот код работает, но лучше так не писать.' AS _msg FROM DUAL");
if ($row = $result->fetch_assoc()) {
echo $row['_msg'];
}
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Этот код работает, но лучше так не писать.
]]>
</screen>
</example>
</para>
<para>
<emphasis role="bold">Смотрите также</emphasis>
</para>
<para>
<simplelist>
<member><methodname>mysqli::__construct</methodname></member>
<member><methodname>mysqli::query</methodname></member>
<member><methodname>mysqli_result::fetch_assoc</methodname></member>
<member><link linkend="mysqli.connect-errno">$mysqli::connect_errno</link></member>
<member><link linkend="mysqli.connect-error">$mysqli::connect_error</link></member>
<member><link linkend="mysqli.errno">$mysqli::errno</link></member>
<member><link linkend="mysqli.error">$mysqli::error</link></member>
<member><link linkend="mysqli.summary">Общее описание функций модуля MySQLi</link></member>
</simplelist>
</para>
</section>
<section xml:id="mysqli.quickstart.connections">
<title>Соединения</title>
<para>
Сервер MySQL поддерживает различные способы передачи данных. Соединения могут
использовать протоколы TCP/IP, сокеты Unix-доменов или именованные пайпы
Windows.
</para>
<para>
Имя хоста <literal>localhost</literal> имеет особое значение.
Оно используется только в сокетах Unix доменов.
Чтобы открыть TCP/IP-соединение с локальным хостом, необходимо использовать <literal>127.0.0.1</literal> вместо имени хоста <literal>localhost</literal>.
</para>
<para>
<example>
<title>Специальное назначение localhost</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "user", "password", "database");
echo $mysqli->host_info . "\n";
$mysqli = new mysqli("127.0.0.1", "user", "password", "database", 3306);
echo $mysqli->host_info . "\n";
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Localhost via UNIX socket
127.0.0.1 via TCP/IP
]]>
</screen>
</example>
</para>
<para>
<emphasis role="bold">Умолчания для параметров соединений</emphasis>
</para>
<para>
В зависимости от функции, осуществляющей подключение, какие-то параметры можно
не задавать. Если параметр не задан, модуль попытается использовать
значение по умолчанию для этого параметра, которое задано в конфигурационном
файле PHP.
</para>
<para>
<example>
<title>Задание значений по умолчанию</title>
<programlisting role="ini">
<![CDATA[
mysqli.default_host=192.168.2.27
mysqli.default_user=root
mysqli.default_pw=""
mysqli.default_port=3306
mysqli.default_socket=/tmp/mysql.sock
]]>
</programlisting>
</example>
</para>
<para>
Далее, чтобы установить соединение, функция передаёт параметры в клиентскую
библиотеку, которой пользуется модуль. Если библиотека обнаружит пустые или
отсутствующие параметры, она может подставить вместо них свои встроенные
значения по умолчанию.
</para>
<para>
<emphasis role="bold">
Встроенные библиотечные значения по умолчанию для параметров соединения
</emphasis>
</para>
<para>
Если имя хоста не задано или передана пустая строка, клиентская библиотека
использует для подключения к Unix-сокету хоста <literal>localhost</literal>.
Если сокет не задан или передана пустая строка, и при этом запрошено
подключение к Unix-сокету, библиотека попытается подключиться к сокету
<literal>/tmp/mysql.sock</literal>.
</para>
<para>
В Windows-системах, если в качестве имени хоста передаётся <literal>.</literal>,
библиотека попытается открыть соединение на основе именованного пайпа. В этом
случае имя сокета будет воспринято как имя пайпа. Если имя сокета не задано, то
будет использовано значение <literal>\\.\pipe\MySQL</literal>.
</para>
<para>
Если соединение не использует ни сокет Unix-домена, ни именованный пайп Windows,
и при этом не задан порт для подключения, библиотека использует номер порта
<literal>3306</literal>.
</para>
<para>
В драйвере <link linkend="mysqlnd.overview">mysqlnd</link> и клиентской
библиотеке MySQL (libmysqlclient) заложена та же логика определения умолчаний.
</para>
<para>
<emphasis role="bold">Настройки соединения</emphasis>
</para>
<para>
Настройки соединения позволяют, например, задать какие-то команды, которые
нужно выполнить сразу после подключения, или отдать распоряжение использовать
определённый набор символов. Настройки должны быть заданы до подключения к
серверу.
</para>
<para>
Когда требуется задать настройки соединения, операция подключения выполняется
в три этапа: функцией <function>mysqli_init</function> или <methodname>mysqli::__construct</methodname> создаётся дескриптор
подключения, затем подключение настраивается с помощью функции
<methodname>mysqli::options</methodname>, и наконец устанавливается сетевое
соединение с сервером посредством функции
<methodname>mysqli::real_connect</methodname>.
</para>
<para>
<emphasis role="bold">Объединение подключений в пул</emphasis>
</para>
<para>
Модуль mysqli поддерживает постоянные соединения с базой данных, которые
представляют из себя специальный вид объединяемых соединений. По умолчанию
каждое открытое скриптом соединение закрывается либо самим скриптом в ходе
выполнения, либо автоматически по завершении работы скрипта. Постоянные
соединения отличаются тем, что не закрываются, а помещаются в пул для
повторного использования в дальнейшем. Если требуется подключиться к тому
же серверу и базе данных, с тем же именем пользователя, паролем, сокетом и
портом, то вместо создания нового подключения из пула извлекается уже
существующее. Повторное использование подключений позволяет избежать
накладных расходов на создание новых соединений.
</para>
<para>
Каждый PHP-процесс использует свой пул подключений mysqli. В зависимости от
конфигурации веб-сервера, PHP-процесс может обслуживать один или несколько
запросов. Соответственно, соединение из пула могут последовательно использовать
несколько скриптов.
</para>
<para>
<emphasis role="bold">Постоянное соединение</emphasis>
</para>
<para>
Новое подключение создаётся, только если в пуле не найдётся свободного
подключения с теми же данными хоста, имени пользователя, пароля, сокета, порта
и базы данных по умолчанию. Механизм постоянных соединений можно включать
и выключать PHP директивой <link linkend="ini.mysqli.allow-persistent">mysqli.allow_persistent</link>.
Максимальное количество соединений, которые может открыть скрипт, ограничено
значением <link linkend="ini.mysqli.max-links">mysqli.max_links</link>.
Максимальное количество соединений, которые может открыть один PHP-процесс,
ограничено значением <link linkend="ini.mysqli.max-persistent">mysqli.max_persistent</link>. Следует
заметить, что веб-сервер может порождать множество PHP процессов.
</para>
<para>
Главный недостаток постоянных подключений заключается в том, что перед
повторным использованием их состояние не сбрасывается к изначальному. Например,
открытые и незавершённые транзакции не будут автоматически откатываться. Также,
если во время нахождения соединения в пуле для процесса изменились
какие-либо разрешения или уровни доступа, этот факт никак не отразится на
подключении при его извлечении из пула. Такое поведение может привести к
нежелательным результатам. Хотя, с другой стороны, название
<literal>постоянный</literal> можно рассматривать, как обещание, что подключение
и правда останется в том состоянии, в котором оно было помещено в пул.
</para>
<para>
Модуль mysqli поддерживает обе интерпретации термина постоянное соединение:
состояние соединения может сохраняться, а может и сбрасываться в изначальное.
По умолчанию при извлечении из пула, соединение сбрасывается. mysqli делает
это неявным вызовом функции <methodname>mysqli::change_user</methodname> каждый раз,
когда подключение используется повторно. С точки зрения пользователя подключение
выглядит, как только что созданное.
</para>
<para>
Однако, вызов функции <methodname>mysqli::change_user</methodname> довольно
дорогостоящая операция. Для улучшения быстродействия можно перекомпилировать
модуль с установленным флагом
<constant>MYSQLI_NO_CHANGE_USER_ON_PCONNECT</constant>.
</para>
<para>
Выбор между безопасным поведением подключений и наилучшим быстродействием
остаётся за пользователем. Здесь нельзя дать однозначного совета. Для простоты
использования, по умолчанию включён безопасный режим с очисткой соединений.
</para>
<para>
<emphasis role="bold">Смотрите также</emphasis>
</para>
<para>
<simplelist>
<member><methodname>mysqli::__construct</methodname></member>
<member><function>mysqli_init</function></member>
<member><methodname>mysqli::options</methodname></member>
<member><methodname>mysqli::real_connect</methodname></member>
<member><methodname>mysqli::change_user</methodname></member>
<member><link linkend="mysqli.get-host-info">$mysqli::host_info</link></member>
<member><link linkend="mysqli.configuration">MySQLi Configuration Options</link></member>
<member><link linkend="features.persistent-connections">Persistent Database Connections</link></member>
</simplelist>
</para>
</section>
<section xml:id="mysqli.quickstart.statements">
<title>Выполнение запросов</title>
<para>
За выполнение запросов отвечают функции
<methodname>mysqli::query</methodname>, <methodname>mysqli::real_query</methodname>
и <methodname>mysqli::multi_query</methodname>. Чаще всего
применяется функция <methodname>mysqli::query</methodname>, так как она выполняет
сразу две задачи: выполняет запрос и буферизует на клиенте результат этого
запроса (если он есть). Вызов <methodname>mysqli::query</methodname> идентичен
последовательному вызову функций <methodname>mysqli::real_query</methodname> и
<methodname>mysqli::store_result</methodname>.
</para>
<para>
<example>
<title>Выполнение запросов</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT)");
]]>
</programlisting>
</example>
</para>
<para>
<emphasis role="bold">Буферизация результатов запроса</emphasis>
</para>
<para>
После выполнения запроса результаты можно либо получить сразу,
либо считать строку за строкой с сервера. Буферизация набора результатов
на стороне клиента позволяет серверу как можно раньше высвободить ресурсы, связанные с результатами запроса.
Проще говоря, клиенты медленно используют наборы результатов.
Поэтому рекомендуется использовать буферизованные наборы результатов. <methodname>mysqli::query</methodname>
объединяет выполнение запроса и буферизацию набора результатов.
</para>
<para>
PHP-приложения могут свободно оперировать данными внутри буферизованных
результирующих наборов. Быстрая навигация по строкам наборов обусловлена тем,
что наборы полностью располагаются в памяти клиента. Следует помнить, что
зачастую обработка результатов на клиенте проще, нежели средствами сервера.
</para>
<para>
<example>
<title>Навигация по строкам буферизованной результирующей таблицы</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT)");
$mysqli->query("INSERT INTO test(id) VALUES (1), (2), (3)");
$result = $mysqli->query("SELECT id FROM test ORDER BY id ASC");
echo "Обратный порядок...\n";
for ($row_no = $result->num_rows - 1; $row_no >= 0; $row_no--) {
$result->data_seek($row_no);
$row = $result->fetch_assoc();
echo " id = " . $row['id'] . "\n";
}
echo "Исходный порядок строк...\n";
foreach ($result as $row) {
echo " id = " . $row['id'] . "\n";
}
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Обратный порядок...
id = 3
id = 2
id = 1
Исходный порядок строк...
id = 1
id = 2
id = 3
]]>
</screen>
</example>
</para>
<para>
<emphasis role="bold">Небуферизованные результирующие наборы</emphasis>
</para>
<para>
Если клиентские ресурсы ограничены, и в тоже время не требуется поддерживать
низкую нагрузку на сервер, можно использовать не буферизованные результирующие
наборы. Навигация по таким таблицам невозможна, потому что так или иначе должны
быть обработаны все строки набора.
</para>
<para>
<example>
<title>Навигация по строкам небуферизованной результирующей таблицы</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli->real_query("SELECT id FROM test ORDER BY id ASC");
$result = $mysqli->use_result();
echo "Порядок строк в результирующем наборе...\n";
foreach ($result as $row) {
echo " id = " . $row['id'] . "\n";
}
]]>
</programlisting>
</example>
</para>
<para>
<emphasis role="bold">Типы данных значений в результирующей таблице</emphasis>
</para>
<para>
Функции <methodname>mysqli::query</methodname>,
<methodname>mysqli::real_query</methodname> и <methodname>mysqli::multi_query</methodname>
предназначены для выполнения не подготавливаемых запросов. На уровне протокола
клиент-серверного взаимодействия MySQL за выполнение запросов отвечают команда
<literal>COM_QUERY</literal> и текстовый протокол. Когда используется текстовый
протокол, сервер MySQL перед отправкой клиенту преобразовывает все данные в
результирующем наборе в текстовые строки. Это преобразование выполняется вне
зависимости от типа данных SQL-столбца результирующей таблицы. Клиентские
библиотеки mysql, в свою очередь, получают все данные, принимая их за строки.
На клиенте не проводится никакого обратного преобразования к исходным типам, все
данные, полученные приложением остаются PHP строками.
</para>
<para>
<example>
<title>Текстовый протокол по умолчанию возвращает строки</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT, label CHAR(1))");
$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'a')");
$result = $mysqli->query("SELECT id, label FROM test WHERE id = 1");
$row = $result->fetch_assoc();
printf("id = %s (%s)\n", $row['id'], gettype($row['id']));
printf("label = %s (%s)\n", $row['label'], gettype($row['label']));
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
id = 1 (string)
label = a (string)
]]>
</screen>
</example>
</para>
<para>
Если используется библиотека mysqlnd, можно включить преобразование
целочисленных значений и чисел с плавающей точкой из столбцов таблицы в
PHP числа. Делается это заданием настройки подключения
<constant>MYSQLI_OPT_INT_AND_FLOAT_NATIVE</constant>. В таком случае mysqlnd
будет проверять метаданные столбцов и преобразовывать SQL-числа этих полей в
PHP-числа, если эти значения не выходят за рамки допустимых диапазонов
типов данных PHP. То есть, например, SQL INT число попадёт в PHP
приложение в виде целого (integer).
</para>
<para>
<example>
<title>Получение исходных типов данных в приложении</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli();
$mysqli->options(MYSQLI_OPT_INT_AND_FLOAT_NATIVE, 1);
$mysqli->real_connect("example.com", "user", "password", "database");
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT, label CHAR(1))");
$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'a')");
$result = $mysqli->query("SELECT id, label FROM test WHERE id = 1");
$row = $result->fetch_assoc();
printf("id = %s (%s)\n", $row['id'], gettype($row['id']));
printf("label = %s (%s)\n", $row['label'], gettype($row['label']));
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
id = 1 (integer)
label = a (string)
]]>
</screen>
</example>
</para>
<para>
<emphasis role="bold">Смотрите также</emphasis>
</para>
<para>
<simplelist>
<member><methodname>mysqli::__construct</methodname></member>
<member><methodname>mysqli::options</methodname></member>
<member><methodname>mysqli::real_connect</methodname></member>
<member><methodname>mysqli::query</methodname></member>
<member><methodname>mysqli::multi_query</methodname></member>
<member><methodname>mysqli::use_result</methodname></member>
<member><methodname>mysqli::store_result</methodname></member>
</simplelist>
</para>
</section>
<section xml:id="mysqli.quickstart.prepared-statements">
<title>Подготавливаемые запросы</title>
<para>
СУБД MySQL поддерживает подготавливаемые запросы. Подготавливаемые (или
параметризованные) запросы используются для повышения эффективности, когда
один запрос выполняется многократно и защищает от SQL-инъекций.
</para>
<para>
<emphasis role="bold">Принцип работы</emphasis>
</para>
<para>
Выполнение подготавливаемого запроса проводится в два этапа: подготовка и
исполнение. На этапе подготовки на сервер посылается шаблон запроса. Сервер
выполняет синтаксическую проверку этого шаблона, строит план выполнения запроса
и выделяет под него ресурсы.
</para>
<para>
MySQL сервер поддерживает неименованные, или позиционные, псевдопеременные
<literal>?</literal>.
</para>
<para>
За подготовкой следует выполнение. Во время выполнения клиент связывает значения параметров и отправляет их на сервер.
Сервер выполняет запрос со связанными значениями, используя ранее созданные внутренние ресурсы.
</para>
<para>
<example>
<title>Подготовленный запрос</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
/* Неподготовленный запрос */
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT, label TEXT)");
/* Подготовленный запрос, шаг 1: подготовка */
$stmt = $mysqli->prepare("INSERT INTO test(id, label) VALUES (?, ?)");
/* Подготовленный запрос, шаг 2: связывание и выполнение */
$id = 1;
$label = 'PHP';
$stmt->bind_param("is", $id, $label); // "is" означает, что $id связывается, как целое число, а $label — как строка
$stmt->execute();
]]>
</programlisting>
</example>
</para>
<para>
<emphasis role="bold">Повторное выполнение запроса</emphasis>
</para>
<para>
Подготовленный запрос можно запускать многократно. Перед каждым запуском
значения привязанных переменных будут передаваться на сервер и подставляться
в текст запроса. Сам текст запроса повторно не анализируется, равно как и не
отсылается повторно шаблон.
</para>
<para>
<example>
<title>Выражение INSERT один раз подготавливается, а затем многократно выполняется</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
/* Неподготовленный запрос */
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT, label TEXT)");
/* Подготовленный запрос, шаг 1: подготовка */
$stmt = $mysqli->prepare("INSERT INTO test(id, label) VALUES (?, ?)");
/* Подготовленный запрос, шаг 2: связывание и выполнение */
$stmt->bind_param("is", $id, $label); // "is" означает, что $id связывается, как целое число, а $label — как строка
$data = [
1 => 'PHP',
2 => 'Java',
3 => 'C++'
];
foreach ($data as $id => $label) {
$stmt->execute();
}
$result = $mysqli->query('SELECT id, label FROM test');
var_dump($result->fetch_all(MYSQLI_ASSOC));
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(3) {
[0]=>
array(2) {
["id"]=>
string(1) "1"
["label"]=>
string(3) "PHP"
}
[1]=>
array(2) {
["id"]=>
string(1) "2"
["label"]=>
string(4) "Java"
}
[2]=>
array(2) {
["id"]=>
string(1) "3"
["label"]=>
string(3) "C++"
}
}
]]>
</screen>
</example>
</para>
<para>
Каждый подготавливаемый запрос использует ресурсы сервера. Если запрос больше
не нужен, его необходимо сразу закрыть. Если не сделать этого явно, запрос
закроется сам, но только когда PHP освободит его дескриптор, как правило это
происходит при выходе запроса из области видимости или при завершении работы
скрипта.
</para>
<para>
Использование подготавливаемых запросов не всегда приводит к повышению
эффективности. Если параметризованный запрос запускается лишь раз, это приводит
к большему количеству клиент-серверных обменов данными, нежели при выполнении
простого запроса. Именно по этой причине в примере выше выражение
<literal>SELECT</literal> выполнялось, как обычный запрос.
</para>
<para>
Также имеет смысл рассмотреть SQL-синтаксис вставки множества значений в
выражении INSERT. В примере выше мультивставка (значения для вставки
перечисляются через запятую) в предложении INSERT обошлась бы дешевле,
чем подготовленный запрос.
</para>
<para>
<example>
<title>Меньше обменов данными при использовании мультивставок SQL</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT)");
$values = [1, 2, 3, 4];
$stmt = $mysqli->prepare("INSERT INTO test(id) VALUES (?), (?), (?), (?)");
$stmt->bind_param('iiii', ...$values);
$stmt->execute();
]]>
</programlisting>
</example>
</para>
<para>
<emphasis role="bold">Типы данных значений в результирующей таблице</emphasis>
</para>
<para>
В протоколе клиент-серверного взаимодействия MySQL для обычных и
подготавливаемых запросов определены разные протоколы передачи данных клиенту.
Параметризованные запросы используют так называемый двоичный протокол. Сервер
MySQL посылает результирующий набор клиенту «как есть» в двоичном формате.
Данные в таблице не преобразовываются в текст. Клиентские библиотеки получают двоичные данные и пытаются преобразовать значения в
соответствующие типы данных PHP.
Например, столбец результатов запроса типа SQL <literal>INT</literal> PHP примет
и преобразует в тип integer.
</para>
<para>
<example>
<title>Исходные типы данных</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
/* Неподготовленный запрос */
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT, label TEXT)");
$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'PHP')");
$stmt = $mysqli->prepare("SELECT id, label FROM test WHERE id = 1");
$stmt->execute();
$result = $stmt->get_result();
$row = $result->fetch_assoc();
printf("id = %s (%s)\n", $row['id'], gettype($row['id']));
printf("label = %s (%s)\n", $row['label'], gettype($row['label']));
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
id = 1 (integer)
label = PHP (string)
]]>
</screen>
</example>
</para>
<para>
Такое поведение не характерно для обычных запросов, которые по умолчанию
все результаты возвращают в виде текстовых строк. Это поведение по умолчанию можно изменить,
настроив соединение соответствующим образом. После такой настройки разницы
между данными подготавливаемого и обычного запросов уже не будет.
</para>
<para>
<emphasis role="bold">Получение результатов запроса с привязкой переменных</emphasis>
</para>
<para>
Результаты из подготовленного запроса можно получить либо привязав выходные
переменные, либо запросив объект <classname>mysqli_result</classname>.
</para>
<para>
Выходные параметры нужно привязывать после выполнения запроса. Каждому столбцу
результирующей таблицы должна соответствовать ровно одна переменная.
</para>
<para>
<example>
<title>Привязка переменных к результату запроса</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
/* Неподготовленный запрос */
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT, label TEXT)");
$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'PHP')");
$stmt = $mysqli->prepare("SELECT id, label FROM test WHERE id = 1");
$stmt->execute();
$stmt->bind_result($out_id, $out_label);
while ($stmt->fetch()) {
printf("id = %s (%s), label = %s (%s)\n", $out_id, gettype($out_id), $out_label, gettype($out_label));
}
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
id = 1 (integer), label = PHP (string)
]]>
</screen>
</example>
</para>
<para>
Объекты подготавливаемых запросов по умолчанию возвращают небуферизованные
результирующие наборы. Эти таблицы никаким неявным образом не переносятся
на клиента, они остаются на сервере, занимая его ресурсы, пока клиентский
процесс самостоятельно не извлечёт все данные. Если клиент не может извлечь
данные результирующего набора, или после закрытия объекта запроса остаются
невыбранными какие-то данные, то на <literal>mysqli</literal> ложится
ответственность неявно подчистить этот мусор за клиентским процессом.
</para>
<para>
Также можно буферизовать данные результирующих таблиц подготовленного запроса
с помощью функции <methodname>mysqli_stmt::store_result</methodname>.
</para>
<para>
<emphasis role="bold">
Извлечение результатов запроса посредством mysqli_result интерфейса
</emphasis>
</para>
<para>
Вместо использования привязки переменных к результатам запроса, результирующие
таблицы можно извлекать средствами интерфейса mysqli_result. Функция
<methodname>mysqli_stmt::get_result</methodname> возвращает буферизованный
результирующий набор строк.
</para>
<para>
<example>
<title>Использование mysqli_result для выборки результатов запроса</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
/* Неподготовленный запрос */
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT, label TEXT)");
$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'PHP')");
$stmt = $mysqli->prepare("SELECT id, label FROM test WHERE id = 1");
$stmt->execute();
$result = $stmt->get_result();
var_dump($result->fetch_all(MYSQLI_ASSOC));
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(1) {
[0]=>
array(2) {
["id"]=>
int(1)
["label"]=>
string(3) "PHP"
}
}
]]>
</screen>
</example>
</para>
<para>
Использование интерфейса <classname>mysqli_result</classname> имеет
дополнительное преимущество в том, что буферизация результирующих таблиц на
клиенте предлагает гибкую систему навигации по этим таблицам.
</para>
<para>
<example>
<title>Буферизация результирующего набора для удобства чтения данных</title>
<programlisting role="php">
<![CDATA[
<?php
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
$mysqli = new mysqli("example.com", "user", "password", "database");
/* Неподготовленный запрос */
$mysqli->query("DROP TABLE IF EXISTS test");
$mysqli->query("CREATE TABLE test(id INT, label TEXT)");
$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'PHP'), (2, 'Java'), (3, 'C++')");
$stmt = $mysqli->prepare("SELECT id, label FROM test");
$stmt->execute();
$result = $stmt->get_result();
for ($row_no = $result->num_rows - 1; $row_no >= 0; $row_no--) {
$result->data_seek($row_no);
var_dump($result->fetch_assoc());
}
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(2) {
["id"]=>
int(3)
["label"]=>
string(3) "C++"
}
array(2) {
["id"]=>
int(2)
["label"]=>
string(4) "Java"
}
array(2) {
["id"]=>
int(1)
["label"]=>
string(3) "PHP"
}
]]>
</screen>
</example>
</para>
<para>
<emphasis role="bold">Экранирование и SQL-инъекции</emphasis>
</para>
<para>
Привязанные переменные отправляются на сервер отдельно от запроса и таким
образом не могут влиять на него. Сервер использует эти значения непосредственно в
момент выполнения, уже после того, как был обработан шаблон выражения.
Привязанные параметры не нуждаются в экранировании, так как они никогда не подставляются
непосредственно в строку запроса. Необходимо отправлять тип привязанной переменной на сервер,
чтобы определить соответствующее преобразование. Смотрите функцию
<methodname>mysqli_stmt::bind_param</methodname> для получения большей информации.
</para>
<para>
Такое разделение часто считается единственным способом обезопаситься от
SQL-инъекции, но на самом деле такого же уровня безопасности можно добиться
и с неподготовленными выражениями, если правильно отформатировать все значения.
Важно отметить, что правильное форматирование — не то же самое, что и экранирование,
и включает в себя больше логики. Таким образом, подготовленные выражения -
просто более удобный и менее подверженный ошибкам способ для достижения
такой безопасности базы данных.
</para>
<para>
<emphasis role="bold">Эмуляция подготовленного запроса на клиенте</emphasis>
</para>
<para>
В API нет возможности эмулировать подготавливаемые запросы на клиенте.
</para>
<para>
<emphasis role="bold">Смотрите также</emphasis>
</para>
<para>
<simplelist>
<member><methodname>mysqli::__construct</methodname></member>
<member><methodname>mysqli::query</methodname></member>
<member><methodname>mysqli::prepare</methodname></member>
<member><methodname>mysqli_stmt::prepare</methodname></member>
<member><methodname>mysqli_stmt::execute</methodname></member>
<member><methodname>mysqli_stmt::bind_param</methodname></member>
<member><methodname>mysqli_stmt::bind_result</methodname></member>
</simplelist>
</para>
</section>
<section xml:id="mysqli.quickstart.stored-procedures">
<title>Хранимые процедуры</title>
<para>
СУБД MySQL поддерживает хранимые процедуры. Под этим термином понимается
последовательность операций, хранящаяся как единое целое в каталоге базы
данных на сервере. Приложения могут вызывать и запускать хранимые процедуры.
Для запуска хранимой процедуры используется SQL выражение
<literal>CALL</literal>.
</para>
<para>