mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
84 lines
2.8 KiB
XML
84 lines
2.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/sesam.xml, last change in rev 1.1 -->
|
|
<refentry id="function.sesam-connect">
|
|
<refnamediv>
|
|
<refname>sesam_connect</refname>
|
|
<refpurpose>Open SESAM database connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>sesam_connect</methodname>
|
|
<methodparam><type>string</type><parameter>catalog</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>user</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns &true; if a connection to the SESAM
|
|
database was made, or &false; on error.
|
|
</para>
|
|
<para>
|
|
<function>sesam_connect</function> establishes a connection to an
|
|
SESAM database handler task. The connection is always
|
|
"persistent" in the sense that only the very first invocation
|
|
will actually load the driver from the configured SESAM OML PLAM
|
|
library. Subsequent calls will reuse the driver and will
|
|
immediately use the given catalog, schema, and user.
|
|
</para>
|
|
<para>
|
|
When creating a database, the <parameter>"catalog"</parameter>
|
|
name is specified in the SESAM configuration directive
|
|
<command>//ADD-SQL-DATABASE-CATALOG-LIST ENTRY-1 =
|
|
*CATALOG(CATALOG-NAME = catalogname,...)</command>
|
|
</para>
|
|
<para>
|
|
The <parameter>"schema"</parameter> references the desired
|
|
database schema (see SESAM handbook).
|
|
</para>
|
|
<para>
|
|
The <parameter>"user"</parameter> argument references one of the
|
|
users which are allowed to access this
|
|
<parameter>"catalog"</parameter> /
|
|
<parameter>"schema"</parameter> combination. Note that
|
|
<parameter>"user"</parameter> is completely independent from both
|
|
the system's user id's and from HTTP user/password protection. It
|
|
appears in the SESAM configuration only.
|
|
</para>
|
|
<para>
|
|
See also <function>sesam_disconnect</function>.
|
|
<example>
|
|
<title>Connect to a SESAM database</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
if (!sesam_connect ("mycatalog", "myschema", "otto")
|
|
die("Unable to connect to SESAM");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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
|
|
-->
|