php-doc-en/reference/uodbc/functions/odbc-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_connect</refname>
  <refpurpose>Connect to a datasource</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>odbc_connect</methodname>
   <methodparam><type>string</type><parameter>dsn</parameter></methodparam>
   <methodparam><type>string</type><parameter>user</parameter></methodparam>
   <methodparam><type>string</type><parameter>password</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>cursor_type</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   The connection id returned by this functions is needed by other
   ODBC functions. You can have multiple connections open at once as long as
   they either use different db or different credentials.
  </simpara>
  <simpara>
   With some ODBC drivers, executing a complex stored procedure may
   fail with an error similar to: "Cannot open a cursor on a stored
   procedure that has anything other than a single select statement
   in it".  Using SQL_CUR_USE_ODBC may avoid that error. Also, some
   drivers don't support the optional row_number parameter in
   <function>odbc_fetch_row</function>. SQL_CUR_USE_ODBC might help
   in that case, too.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dsn</parameter></term>
     <listitem>
      <para>
       The database source name for the connection. Alternatively, a
       DSN-less connection string can be used.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>user</parameter></term>
     <listitem>
      <para>
       The username.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       The password.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cursor_type</parameter></term>
     <listitem>
      <para>
       This sets the type of cursor to be used
       for this connection. This parameter is not normally needed, but
       can be useful for working around problems with some ODBC drivers.
      </para>
      <simpara>
       The following constants are defined for cursortype:
      </simpara>
      <para>
       <itemizedlist>
        <listitem>
         <simpara>
          SQL_CUR_USE_IF_NEEDED
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          SQL_CUR_USE_ODBC
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          SQL_CUR_USE_DRIVER
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an ODBC connection or (&false;) on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>DSN-less connections</title>
    <programlisting role="php">
<![CDATA[
<?php
// Microsoft SQL Server using the SQL Native Client 10.0 ODBC Driver - allows connection to SQL 7, 2000, 2005 and 2008
$connection = odbc_connect("Driver={SQL Server Native Client 10.0};Server=$server;Database=$database;", $user, $password);

// Microsoft Access
$connection = odbc_connect("Driver={Microsoft Access Driver (*.mdb)};Dbq=$mdbFilename", $user, $password);

// Microsoft Excel
$excelFile = realpath('C:/ExcelData.xls');
$excelDir = dirname($excelFile);
$connection = odbc_connect("Driver={Microsoft Excel Driver (*.xls)};DriverId=790;Dbq=$excelFile;DefaultDir=$excelDir" , '', '');
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>For persistent connections: <function>odbc_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:"~/.phpdoc/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
-->