mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
WS, preparation for the new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183223 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson
parent
00fa1c917a
commit
d2c0234593
1 changed files with 90 additions and 96 deletions
|
|
@ -1,99 +1,93 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.13 $ -->
|
||||
<!-- $Revision: 1.14 $ -->
|
||||
<!-- splitted from ./en/functions/mysql.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.mysql-connect">
|
||||
<refnamediv>
|
||||
<refname>mysql_connect</refname>
|
||||
<refpurpose>Open a connection to a MySQL Server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>mysql_connect</methodname>
|
||||
<methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>
|
||||
password
|
||||
</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>bool</type><parameter>
|
||||
new_link
|
||||
</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>
|
||||
client_flags
|
||||
</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<refentry id="function.mysql-connect">
|
||||
<refnamediv>
|
||||
<refname>mysql_connect</refname>
|
||||
<refpurpose>Open a connection to a MySQL Server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>mysql_connect</methodname>
|
||||
<methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>bool</type><parameter>new_link</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>client_flags</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns a MySQL link identifier on success, or &false; on failure.
|
||||
</para>
|
||||
<para>
|
||||
<function>mysql_connect</function> establishes a connection
|
||||
to a MySQL server. The following defaults are assumed for
|
||||
missing optional parameters: <parameter>server</parameter> =
|
||||
'localhost:3306', <parameter>username</parameter> = name of the
|
||||
user that owns the server process and
|
||||
<parameter>password</parameter> = empty password.
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>server</parameter> parameter can also include a port
|
||||
number. e.g. "hostname:port" or a path to a local socket
|
||||
e.g. ":/path/to/socket" for the localhost.
|
||||
<note>
|
||||
<para>
|
||||
Returns a MySQL link identifier on success, or &false; on failure.
|
||||
Whenever you specify "localhost" or
|
||||
"localhost:port" as server, the MySQL client library will
|
||||
override this and try to connect to a local socket (named pipe on
|
||||
Windows). If you want to use TCP/IP, use "127.0.0.1"
|
||||
instead of "localhost". If the MySQL client library tries to
|
||||
connect to the wrong local socket, you should set the correct path as
|
||||
mysql.default_host in your PHP configuration and leave the server field
|
||||
blank.
|
||||
</para>
|
||||
<para>
|
||||
<function>mysql_connect</function> establishes a connection
|
||||
to a MySQL server. The following defaults are assumed for
|
||||
missing optional parameters: <parameter>server</parameter> =
|
||||
'localhost:3306', <parameter>username</parameter> = name of the
|
||||
user that owns the server process and
|
||||
<parameter>password</parameter> = empty password.
|
||||
Support for ":port" was added in PHP 3.0B4.
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>server</parameter> parameter can also include a port
|
||||
number. e.g. "hostname:port" or a path to a local socket
|
||||
e.g. ":/path/to/socket" for the localhost.
|
||||
<note>
|
||||
<para>
|
||||
Whenever you specify "localhost" or
|
||||
"localhost:port" as server, the MySQL client library will
|
||||
override this and try to connect to a local socket (named pipe on
|
||||
Windows). If you want to use TCP/IP, use "127.0.0.1"
|
||||
instead of "localhost". If the MySQL client library tries to
|
||||
connect to the wrong local socket, you should set the correct path as
|
||||
mysql.default_host in your PHP configuration and leave the server field
|
||||
blank.
|
||||
</para>
|
||||
<para>
|
||||
Support for ":port" was added in PHP 3.0B4.
|
||||
</para>
|
||||
<para>
|
||||
Support for ":/path/to/socket" was added in
|
||||
PHP 3.0.10.
|
||||
</para>
|
||||
<para>
|
||||
You can suppress the error message on failure by prepending
|
||||
a <link linkend="language.operators.errorcontrol">@</link>
|
||||
to the function name.
|
||||
</para>
|
||||
</note>
|
||||
Support for ":/path/to/socket" was added in
|
||||
PHP 3.0.10.
|
||||
</para>
|
||||
<para>
|
||||
If a second call is made to <function>mysql_connect</function>
|
||||
with the same arguments, no new link will be established, but
|
||||
instead, the link identifier of the already opened link will be
|
||||
returned. The <parameter>new_link</parameter> parameter modifies this
|
||||
behavior and makes <function>mysql_connect</function> always open
|
||||
a new link, even if <function>mysql_connect</function> was called
|
||||
before with the same parameters. The <parameter>client_flags</parameter>
|
||||
parameter can be a combination of the constants
|
||||
<constant>MYSQL_CLIENT_COMPRESS</constant>,
|
||||
<constant>MYSQL_CLIENT_IGNORE_SPACE</constant> or
|
||||
<constant>MYSQL_CLIENT_INTERACTIVE</constant>.
|
||||
You can suppress the error message on failure by prepending
|
||||
a <link linkend="language.operators.errorcontrol">@</link>
|
||||
to the function name.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
The <parameter>new_link</parameter> parameter became available
|
||||
in PHP 4.2.0
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>client_flags</parameter> parameter became available in
|
||||
PHP 4.3.0
|
||||
</para>
|
||||
</note>
|
||||
<para>
|
||||
The link to the server will be closed as soon as the execution of
|
||||
the script ends, unless it's closed earlier by explicitly calling
|
||||
<function>mysql_close</function>.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>mysql_connect</function> example</title>
|
||||
<programlisting role="php">
|
||||
</note>
|
||||
</para>
|
||||
<para>
|
||||
If a second call is made to <function>mysql_connect</function>
|
||||
with the same arguments, no new link will be established, but
|
||||
instead, the link identifier of the already opened link will be
|
||||
returned. The <parameter>new_link</parameter> parameter modifies this
|
||||
behavior and makes <function>mysql_connect</function> always open
|
||||
a new link, even if <function>mysql_connect</function> was called
|
||||
before with the same parameters. The <parameter>client_flags</parameter>
|
||||
parameter can be a combination of the constants
|
||||
<constant>MYSQL_CLIENT_COMPRESS</constant>,
|
||||
<constant>MYSQL_CLIENT_IGNORE_SPACE</constant> or
|
||||
<constant>MYSQL_CLIENT_INTERACTIVE</constant>.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
The <parameter>new_link</parameter> parameter became available
|
||||
in PHP 4.2.0
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>client_flags</parameter> parameter became available in
|
||||
PHP 4.3.0
|
||||
</para>
|
||||
</note>
|
||||
<para>
|
||||
The link to the server will be closed as soon as the execution of
|
||||
the script ends, unless it's closed earlier by explicitly calling
|
||||
<function>mysql_close</function>.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>mysql_connect</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$link = mysql_connect('localhost', 'mysql_user', 'mysql_password');
|
||||
|
|
@ -104,16 +98,16 @@ echo 'Connected successfully';
|
|||
mysql_close($link);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
See also
|
||||
<function>mysql_pconnect</function> and
|
||||
<function>mysql_close</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
See also
|
||||
<function>mysql_pconnect</function> and
|
||||
<function>mysql_close</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
|
|||
Loading…
Reference in a new issue