File: sqlsrv-connect.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (177 lines) | stat: -rw-r--r-- 5,575 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 317663 $ -->
<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 forward 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 specifed 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
-->