File: mysqli-real-connect.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (210 lines) | stat: -rw-r--r-- 6,871 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
  <refentry id="function.mysqli-real-connect">
   <refnamediv>
    <refname>mysqli_real_connect</refname>
    <refname>mysqli->real_connect</refname>
    <refpurpose>Opens a connection to a mysql server</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <para>Procedural style</para>
     <methodsynopsis>
      <type>bool</type><methodname>mysqli_real_connect</methodname>
      <methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
      <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
      <methodparam choice='opt'><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
     <para>Object oriented style (method)</para>
     <classsynopsis>
      <ooclass><classname>mysqli</classname></ooclass>
      <methodsynopsis>
       <type>bool</type><methodname>real_connect</methodname>
       <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam>
       <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
       <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
       <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
       <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
       <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
       <methodparam choice='opt'><type>int</type><parameter>flags</parameter></methodparam>
      </methodsynopsis>
     </classsynopsis>
    <para>
     <function>mysqli_real_connect</function> attempts to establish a
     connection to a MySQL database engine running on
     <parameter>hostname</parameter>. 
    </para> 
    <para>
     This function differs from <function>mysqli_connect</function>:
    </para>
    <itemizedlist>
     <listitem>
      <para>
       <function>mysqli_real_connect</function> needs a valid object which has
       to be created by function <function>mysqli_init</function>
      </para>
     </listitem>
     <listitem>
      <para>
       With function <function>mysqli_options</function> you can set various options for connection.
      </para>
     </listitem>
     <listitem>
      <para>
       With the parameter <parameter>flags</parameter> you can set different connection options:
      </para>
      <table>
       <title>Supported flags</title>
       <tgroup cols='2'>
       <thead>
        <row>
         <entry>Name</entry>
         <entry>Description</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry><literal>MYSQLI_CLIENT_COMPRESS</literal></entry>
         <entry>Use compression protocol</entry>
        </row>
        <row>
         <entry><literal>MYSQLI_CLIENT_FOUND_ROWS</literal></entry>
         <entry>return number of matched rows, not the number of affected rows</entry>
        </row>
        <row>
         <entry><literal>MYSQLI_CLIENT_IGNORE_SPACE</literal></entry>
         <entry>Allow spaces after function names. Makes all function names reserved words.</entry>
        </row>
        <row>
         <entry><literal>MYSQLI_CLIENT_INTERACTIVE</literal></entry>
         <entry>
          Allow <literal>interactive_timeout</literal> seconds (instead of 
          <literal>wait_timeout</literal> seconds) of inactivity before closing the connection
         </entry>
        </row>
        <row>
         <entry><literal>MYSQLI_CLIENT_SSL</literal></entry>
         <entry>Use SSL (encryption)</entry>
        </row>
        </tbody>
       </tgroup>
      </table>
      <note>
       <para>
        For security reasons the <literal>MULTI_STATEMENT</literal> flag is not supported in 
        PHP. If you want to execute multiple queries use the 
        <function>mysqli_multi_query</function> function.
       </para>
      </note>
     </listitem>
    </itemizedlist>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>&return.success;</para>
   </refsect1>
   <refsect1>
    &reftitle.seealso;
    <para>
     <function>mysqli_connect</function>,
     <function>mysqli_init</function>,
     <function>mysqli_options</function>,
     <function>mysqli_ssl_set</function>&listendand;
     <function>mysqli_close</function>.
    </para>
   </refsect1>
   <refsect1>
    &reftitle.examples;
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php

/* create a connection object which is not connected */
$mysqli = mysqli_init();

/* set connection options */
$mysqli->options(MYSQLI_INIT_COMMAND, "SET AUTOCOMMIT=0");
$mysqli->options(MYSQLI_OPT_CONNECT_TIMEOUT, 5);

/* connect to server */
$mysqli->real_connect('localhost', 'my_user', 'my_password', 'world');

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

printf ("Connection: %s\n.", $mysqli->host_info);

$mysqli->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php

/* create a connection object which is not connected */
$link = mysqli_init();

/* set connection options */
mysqli_options($link, MYSQLI_INIT_COMMAND, "SET AUTOCOMMIT=0");
mysqli_options($link, MYSQLI_OPT_CONNECT_TIMEOUT, 5);

/* connect to server */
mysqli_real_connect($link, 'localhost', 'my_user', 'my_password', 'world');

/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", mysqli_connect_error());
    exit();
}

printf ("Connection: %s\n.", mysqli_get_host_info($link));

mysqli_close($link);
?>
]]>
     </programlisting>
    </example>
    &example.outputs;
    <screen>
<![CDATA[
Connection: Localhost via UNIX socket

]]>
    </screen>
   </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:"../../../../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
-->