File: ingres-prepare.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 (196 lines) | stat: -rw-r--r-- 5,641 bytes parent folder | download | duplicates (2)
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.ingres-prepare" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ingres_prepare</refname>
  <refpurpose>Prepare a query for later execution</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>ingres_prepare</methodname>
   <methodparam><type>resource</type><parameter>link</parameter></methodparam>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
  </methodsynopsis>
  <para>
   Prepares a query for execution by <function>ingres_execute</function>.
  </para>
  <para>
   The query becomes part of the currently open transaction.  If
   there is no open transaction, <function>ingres_query</function>
   opens a new transaction. To close the transaction, you can 
   call either <function>ingres_commit</function> to commit the changes
   made to the database or <function>ingres_rollback</function> to
   cancel these changes. When the script ends, any open transaction
   is rolled back (by calling
   <function>ingres_rollback</function>). You can also use
   <function>ingres_autocommit</function> before opening a new
   transaction to have every SQL query immediately committed.
  </para>

  <note>
   <title>Related Configurations</title>
   <para>
    See also the <link linkend="ini.ingres.describe">ingres.describe</link>,
    <link linkend="ini.ingres.scrollable">ingres.scrollable</link> and
    <link linkend="ini.ingres.utf8">ingres.utf8</link> directives in 
    <link linkend="ingres.configuration">Runtime Configuration</link>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>link</parameter></term>
     <listitem>
      <para>
       The connection link identifier
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>query</parameter></term>
     <listitem>
      <para>
       A valid SQL query (see the Ingres <literal>SQL reference
       guide</literal>) in the Ingres documentation.
       See the <link linkend="function.ingres-query.query">query</link>
       parameter in <function>ingres_query</function> for a list of SQL
       statements which cannot be executed using
       <function>ingres_prepare</function>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>ingres_prepare</function> returns a query result identifier that
   is used with <function>ingres_execute</function> to execute the query. To see 
   if an error occurred, use <function>ingres_errno</function>, 
   <function>ingres_error</function>, or 
   <function>ingres_errsqlstate</function>.
  </para>
 </refsect1>

<!--
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A simple select using <function>ingres_query</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$link = ingres_connect("demodb");

$result = ingres_query($link, "select * from user_profile");
while ($row = ingres_fetch_row($result)) {
    echo $row[1];
    echo $row[2];
}
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Passing query parameters to <function>ingres_query</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$link = ingres_connect("demodb");

$params[] = "Emma";
$query = "select * from user_profile where up_first = ?";
$result = ingres_query($link, $query, $params);
while ($row = ingres_fetch_row($result)) {
    echo $row[1];
    echo $row[2];
}
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Inserting a BLOB with parameter types</title>
    <programlisting role="php">
<![CDATA[
<?php
$link = ingres_connect("demodb");

//Open a photo
$fh = fopen("photo.jpg","r");
$blob_data = stream_get_contents($fh);
fclose($fh);

//Prepare parameters
$params[] = $blob_data;
$params[] = 1201;

//Define parameter types
$param_types = "Bi";

$query = "update user_profile set up_image = ? where up_id = ?";
$result = ingres_query($link, $query , $params, $param_types);

if (ingres_errno())
{
    echo ingres_errno() . "-" . ingres_error() . "\n";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ingres_unbuffered_query</function></member>
    <member><function>ingres_fetch_array</function></member>
    <member><function>ingres_fetch_assoc</function></member>
    <member><function>ingres_fetch_object</function></member>
    <member><function>ingres_fetch_row</function></member>
    <member><function>ingres_commit</function></member>
    <member><function>ingres_rollback</function></member>
    <member><function>ingres_autocommit</function></member>
    <member><function>ingres_set_environment</function></member>
    <member><function>ingres_errno</function></member>
    <member><function>ingres_error</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
-->