sqlsrv-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sqlsrv-connect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sqlsrv_connect</refname>
  <refpurpose>Opens a connection to a Microsoft SQL Server database</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>sqlsrv_connect</methodname>
   <methodparam><type>string</type><parameter>serverName</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>connectionInfo</parameter></methodparam>
  </methodsynopsis>
  <para>
   Opens a connection to a Microsoft SQL Server database. By default, the connection 
   is attempted using Windows Authentication. To connect using SQL Server 
   Authentication, include "UID" and "PWD" in the connection options array.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>serverName</parameter></term>
     <listitem>
      <para>
       The name of the server to which a connection is established. To connect 
       to a specific instance, follow the server name with a backward slash 
       and the instance name (e.g. serverName\sqlexpress).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>connectionInfo</parameter></term>
     <listitem>
      <para>
       An associative array that specifies options for connecting to the server. 
       If values for the UID and PWD keys are not specified, the connection 
       will be attempted using Windows Authentication. For a complete list of supported 
       keys, see <link xlink:href="&url.sqlsrv.connection.options;">SQLSRV Connection Options</link>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A connection resource. If a connection cannot be successfully opened, &false; is returned.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Connect using Windows Authentication.</title>
    <programlisting role="php">
<![CDATA[
<?php
$serverName = "serverName\\sqlexpress"; //serverName\instanceName

// Since UID and PWD are not specified in the $connectionInfo array,
// The connection will be attempted using Windows Authentication.
$connectionInfo = array( "Database"=>"dbName");
$conn = sqlsrv_connect( $serverName, $connectionInfo);

if( $conn ) {
     echo "Connection established.<br />";
}else{
     echo "Connection could not be established.<br />";
     die( print_r( sqlsrv_errors(), true));
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Connect by specifying a user name and password.</title>
    <programlisting role="php">
<![CDATA[
<?php
$serverName = "serverName\\sqlexpress"; //serverName\instanceName
$connectionInfo = array( "Database"=>"dbName", "UID"=>"userName", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);

if( $conn ) {
     echo "Connection established.<br />";
}else{
     echo "Connection could not be established.<br />";
     die( print_r( sqlsrv_errors(), true));
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Connect on a specified port.</title>
    <programlisting role="php">
<![CDATA[
<?php
$serverName = "serverName\\sqlexpress, 1542"; //serverName\instanceName, portNumber (default is 1433)
$connectionInfo = array( "Database"=>"dbName", "UID"=>"userName", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);

if( $conn ) {
     echo "Connection established.<br />";
}else{
     echo "Connection could not be established.<br />";
     die( print_r( sqlsrv_errors(), true));
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   By default, the <function>sqlsrv_connect</function> uses connection pooling to 
   improve connection performance. To turn off connection pooling (i.e. force a 
   new connection on each call), set the "ConnectionPooling" option in the 
   $connectionOptions array to 0 (or &false;). For more information, see 
   <link xlink:href="&url.sqlsrv.connection.pooling;">SQLSRV Connection Pooling</link>.
  </para>
  <para>
  The SQLSRV extension does not have a dedicated function for changing which 
  database is connected to. The target database is specified in the 
  $connectionOptions array that is passed to sqlsrv_connect. To change the 
  database on an open connection, execute the following query "USE dbName" 
  (e.g. sqlsrv_query($conn, "USE dbName")).
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sqlsrv_close</function></member>
    <member><function>sqlsrv_errors</function></member>
    <member><function>sqlsrv_query</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
-->