mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
8a5f2d9f34
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@185785 c90b9560-bf6c-de11-be94-00142212c4b1
300 lines
7.8 KiB
XML
300 lines
7.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
|
<refentry id="function.db2-connect">
|
|
<refnamediv>
|
|
<refname>db2_connect</refname>
|
|
<refpurpose>
|
|
Returns a connection to a database
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>db2_connect</methodname>
|
|
<methodparam><type>string</type><parameter>database</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>username</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>password</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
&warn.experimental.func;
|
|
<para>
|
|
Creates a new connection to an IBM DB2 Universal Database, IBM Cloudscape,
|
|
or Apache Derby database.
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>database</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
For a cataloged connection to a database, <parameter>database</parameter>
|
|
represents the database alias in the DB2 client catalog.
|
|
</para>
|
|
<para>
|
|
For an uncataloged connection to a database,
|
|
<parameter>database</parameter> represents a complete connection
|
|
string in the following format:
|
|
<literal>DRIVER={IBM DB2 ODBC DRIVER};DATABASE=<parameter>database</parameter>;HOSTNAME=<parameter>hostname</parameter>;PORT=<parameter>port</parameter>;PROTOCOL=TCPIP;UID=<parameter>username</parameter>;PWD=<parameter>password</parameter>;</literal>
|
|
where the parameters represent the following values:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>database</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The name of the database.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>hostname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The hostname or IP address of the database server.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>port</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The TCP/IP port on which the database is listening for
|
|
requests.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>username</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The username with which you are connecting to the
|
|
database.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>password</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The password with which you are connecting to the database.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>username</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The username with which you are connecting to the database.
|
|
</para>
|
|
<para>
|
|
For uncataloged connections, you must pass a &null; value or empty
|
|
string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>password</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The password with which you are connecting to the database.
|
|
</para>
|
|
<para>
|
|
For uncataloged connections, you must pass a &null; value or empty
|
|
string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An associative array of connection options that affect the behavior
|
|
of the connection, where valid array keys include:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>autocommit</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Passing the <literal>DB2_AUTOCOMMIT_ON</literal> value turns
|
|
autocommit on for this connection handle.
|
|
</para>
|
|
<para>
|
|
Passing the <literal>DB2_AUTOCOMMIT_OFF</literal> value turns
|
|
autocommit off for this connection handle.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a connection handle resource if the connection attempt is
|
|
successful. If the connection attempt fails, <function>db2_connect</function>
|
|
returns &false;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Creating a cataloged connection</title>
|
|
<para>
|
|
Cataloged connections require you to have previously cataloged the target
|
|
database through the DB2 Command Line Processor (CLP) or DB2
|
|
Configuration Assistant.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$database = 'SAMPLE';
|
|
$user = 'db2inst1';
|
|
$password = 'ibmdb2';
|
|
|
|
$conn = db2_connect($database, $user, $password);
|
|
|
|
if ($conn) {
|
|
echo "Connection succeeded.";
|
|
db2_close($conn);
|
|
}
|
|
else {
|
|
echo "Connection failed.";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Connection succeeded.
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>Creating an uncataloged connection</title>
|
|
<para>
|
|
An uncataloged connection enables you to dynamically connect to a
|
|
database.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$database = 'SAMPLE';
|
|
$user = 'db2inst1';
|
|
$password = 'ibmdb2';
|
|
$hostname = 'localhost';
|
|
$port = 50000;
|
|
|
|
$conn_string = "DRIVER={IBM DB2 ODBC DRIVER};DATABASE=$database;" .
|
|
"HOSTNAME=$hostname;PORT=$port;PROTOCOL=TCPIP;UID=$user;PWD=$password;";
|
|
$conn = db2_connect($conn_string, '', '');
|
|
|
|
if ($conn) {
|
|
echo "Connection succeeded.";
|
|
db2_close($conn);
|
|
}
|
|
else {
|
|
echo "Connection failed.";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Connection succeeded.
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>Creating a connection with autocommit off by default</title>
|
|
<para>
|
|
Passing an array of options to <function>db2_connect</function> enables
|
|
you to modify the default behavior of the connection handle.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$database = 'SAMPLE';
|
|
$user = 'db2inst1';
|
|
$password = 'ibmdb2';
|
|
$options = array('autocommit' => DB2_AUTOCOMMIT_OFF);
|
|
|
|
$conn = db2_connect($database, $user, $password, $options);
|
|
|
|
if ($conn) {
|
|
echo "Connection succeeded.\n";
|
|
if (db2_autocommit($conn)) {
|
|
echo "Autocommit is on.\n";
|
|
}
|
|
else {
|
|
echo "Autocommit is off.\n";
|
|
}
|
|
db2_close($conn);
|
|
}
|
|
else {
|
|
echo "Connection failed.";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Connection succeeded.
|
|
Autocommit is off.
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>db2_close</function></member>
|
|
<member><function>db2_pconnect</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</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
|
|
-->
|