File: ingres_ii.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (841 lines) | stat: -rw-r--r-- 29,941 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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
<?xml version="1.0" encoding="utf-8"?>
 <reference id="ref.ingres">
  <title>Ingres II functions</title>
  <titleabbrev>Ingres II</titleabbrev>
  <partintro>
   &warn.experimental;
   <simpara>
    These functions allow you to access Ingres II database servers.
   </simpara>
   <simpara>
    In order to have these functions available, you must compile php
    with Ingres support by using the
    <option role="configure">--with-ingres</option> option.
    You need the Open API library and header files included with
    Ingres II. If the II_SYSTEM environment variable isn't correctly
    set you may have to use
    <option role="configure">--with-ingres=DIR</option>
    to specify your Ingres installation directory.
   </simpara>
   <simpara>
    When using this extension with Apache, if Apache does not start
    and complains with "PHP Fatal error:  Unable to start
    ingres_ii module in Unknown on line 0"
    then make sure the environement variable II_SYSTEM is correctly
    set. Adding "export II_SYSTEM="/home/ingres/II" in the script
    that starts Apache, just before launching httpd, should be fine.
   </simpara>
   <note>
    <para>
     If you already used PHP extensions to access other database servers,
     note that Ingres doesn't allow concurrent queries and/or transaction
     over one connection, thus you won't find any result or transaction
     handle in this extension. The result of a query must be treated
     before sending another query, and a transaction must be commited or
     rolled back before opening another transaction (which is automaticaly
     done when sending the first query).
    </para>
   </note>
  </partintro>

  <refentry id="function.ingres-connect">
   <refnamediv>
    <refname>ingres_connect</refname>
    <refpurpose>Open a connection to an Ingres II database.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>resource</type><methodname>ingres_connect</methodname>
      <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns a Ingres II link resource on success, or &false; on failure.
    </para>
    <para>
     <function>ingres_connect</function> opens a connection with the
     Ingres database designated by <parameter>database</parameter>, which
     follows the syntax <parameter>[node_id::]dbname[/svr_class]</parameter>.
    </para>
    <para>
     If some parameters are missing, <function>ingres_connect</function>
     uses the values in <filename>php.ini</filename> for
     <parameter>ingres.default_database</parameter>,
     <parameter>ingres.default_user</parameter> and
     <parameter>ingres.default_password</parameter>.
    </para>
    <para>
     The connection is closed when the script ends or when
     <function>ingres_close</function> is called on this link.
    </para>
    <para>
     All the other ingres functions use the last opened link as a
     default, so you need to store the returned value only if you use
     more than one link at a time.
    </para>
    <example>
     <title><function>ingres_connect</function> example</title>
     <programlisting>
&lt;?php
    $link = ingres_connect ("mydb", "user", "pass")
        or die ("Could not connect");
    print ("Connected successfully");
    ingres_close ($link);
?>
     </programlisting>
    </example>
    <example>
     <title><function>ingres_connect</function> example
      using default link</title>
     <programlisting>
&lt;?php
    ingres_connect ("mydb", "user", "pass")
        or die ("Could not connect");
    print ("Connected successfully");
    ingres_close ();
?>
     </programlisting>
    </example>
    <para> See also
     <function>ingres_pconnect</function>, and
     <function>ingres_close</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-pconnect">
   <refnamediv>
    <refname>ingres_pconnect</refname>
    <refpurpose>
     Open a persistent connection to an Ingres II database.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>resource</type><methodname>ingres_pconnect</methodname>
      <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns a Ingres II link resource on success, or &false; on failure.
    </para>
    <para>
     See <function>ingres_connect</function> for parameters details and
     examples. There are only 2 differences between
     <function>ingres_pconnect</function> and
     <function>ingres_connect</function> : 
     First, when connecting, the function will first try to find a
     (persistent) link that's already opened with the same parameters.
     If one is found, an identifier for it will be returned instead of
     opening a new connection. Second, the connection to the Ingres
     server will not be closed when the execution of the script ends.
     Instead, the link will remain open for future use
     (<function>ingres_close</function> will not close links established
     by <function>ingres_pconnect</function>). This type of link is
     therefore called 'persistent'.
    </para>
    <para> See also
     <function>ingres_connect</function>, and
     <function>ingres_close</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-close">
   <refnamediv>
    <refname>ingres_close</refname>
    <refpurpose>Close an Ingres II database connection</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ingres_close</methodname>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns &true; on success, or &false; on failure.
    </para>
    <para>
     <function>ingres_close</function> closes the connection to
     the Ingres server that's associated with the specified link.
     If the <parameter>link</parameter> parameter isn't
     specified, the last opened link is used.
    </para>
    <para>
     <function>ingres_close</function> isn't usually necessary, as it
     won't close persistent connections and all non-persistent connections
     are automatically closed at the end of the script.
    </para>
    <para> See also
     <function>ingres_connect</function>, and
     <function>ingres_pconnect</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-query">
   <refnamediv>
    <refname>ingres_query</refname>
    <refpurpose>Send a SQL query to Ingres II</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ingres_query</methodname>
      <methodparam><type>string</type><parameter>query</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns &true; on success, or &false; on failure.
    </para>
    <para>
     <function>ingres_query</function> sends the given
     <parameter>query</parameter> to the Ingres server. This query
     must be a valid SQL query (see the Ingres SQL reference guide)
    </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 either
     call <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 immediatly commited.
    </para>
    <para>
     Some types of SQL queries can't be sent with this function :
     <itemizedlist>
      <listitem>
       <simpara>close (see <function>ingres_close</function>).</simpara>
      </listitem>
     <listitem>
       <simpara>commit (see <function>ingres_commit</function>).</simpara>
      </listitem>
      <listitem>
       <simpara>connect (see <function>ingres_connect</function>).</simpara>
      </listitem>
      <listitem>
       <simpara>disconnect (see <function>ingres_close</function>).</simpara>
      </listitem>
      <listitem><simpara>get dbevent</simpara></listitem>
      <listitem><simpara>prepare to commit</simpara></listitem>
      <listitem>
       <simpara>
	rollback (see <function>ingres_rollback</function>).
       </simpara>
      </listitem>
      <listitem><simpara>savepoint</simpara></listitem>
      <listitem>
       <simpara>
	set autocommit (see <function>ingres_autocommit</function>).
       </simpara>
      </listitem>
      <listitem>
       <simpara>all cursor related queries are unsupported</simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     <example>
      <title><function>ingres_query</function> example</title>
      <programlisting role="php">
&lt;?php 
ingres_connect ($database, $user, $password);

ingres_query ("select * from table");
while ($row = ingres_fetch_row()) {
    echo $row[1];
    echo $row[2];
}
?>
      </programlisting>
     </example>
    </para>
    <para>
     See also
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function>,
     <function>ingres_fetch_row</function>,
     <function>ingres_commit</function>,
     <function>ingres_rollback</function> and
     <function>ingres_autocommit</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-num-rows">
   <refnamediv>
    <refname>ingres_num_rows</refname>
    <refpurpose>
     Get the number of rows affected or returned by the last query
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>ingres_num_rows</methodname>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     For delete, insert or update queries,
     <function>ingres_num_rows</function> returns the number of rows
     affected by the query. For other queries,
     <function>ingres_num_rows</function> returns the number of rows
     in the query's result.
    </para>
    <para>
     <note>
      <simpara>
       This function is mainly meant to get the number of rows
       modified in the database.
       If this function is called before using
       <function>ingres_fetch_array</function>,
       <function>ingres_fetch_object</function> or
       <function>ingres_fetch_row</function> the server will delete
       the result's data and the script won't be able to get them.
      </simpara>
      <simpara>
       You should instead retrieve the result's data using one of these
       fetch functions in a loop until it returns &false;, indicating that
       no more results are available.
      </simpara>
     </note>
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-num-fields">
   <refnamediv>
    <refname>ingres_num_fields</refname>
    <refpurpose>
     Get the number of fields returned by the last query
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>ingres_num_fields</methodname>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_num_fields</function> returns the number of fields
     in the results returned by the Ingres server after a call to
     <function>ingres_query</function>
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-field-name">
   <refnamediv>
    <refname>ingres_field_name</refname>
    <refpurpose>Get the name of a field in a query result.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ingres_field_name</methodname>
      <methodparam><type>int</type><parameter>index</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_field_name</function> returns the name of a field
     in a query result, or &false; on failure.
    </para>
    <para>
     <parameter>index</parameter> is the number of the field and must be
     between 1 and the value given by
     <function>ingres_num_fields</function>.
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-field-type">
   <refnamediv>
    <refname>ingres_field_type</refname>
    <refpurpose>Get the type of a field in a query result.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ingres_field_type</methodname>
      <methodparam><type>int</type><parameter>index</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_field_type</function> returns the type of a field
     in a query result, or &false; on failure.
     Examples of types returned are "IIAPI_BYTE_TYPE",
     "IIAPI_CHA_TYPE", "IIAPI_DTE_TYPE", "IIAPI_FLT_TYPE",
     "IIAPI_INT_TYPE", "IIAPI_VCH_TYPE". Some of these types can map
     to more than one SQL type depending on the length of the field
     (see <function>ingres_field_length</function>). For example
     "IIAPI_FLT_TYPE" can be a float4 or a float8. For detailed
     information, see the Ingres/OpenAPI User Guide - Appendix C.
    </para>
    <para>
     <parameter>index</parameter> is the number of the field and must be
     between 1 and the value given by
     <function>ingres_num_fields</function>.
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-field-nullable">
   <refnamediv>
    <refname>ingres_field_nullable</refname>
    <refpurpose>Test if a field is nullable.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ingres_field_nullable</methodname>
      <methodparam><type>int</type><parameter>index</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_field_nullable</function> returns &true; if the field
     can be set to the &null; value and &false; if it can't.
    </para>
    <para>
     <parameter>index</parameter> is the number of the field and must be
     between 1 and the value given by
     <function>ingres_num_fields</function>.
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-field-length">
   <refnamediv>
    <refname>ingres_field_length</refname>
    <refpurpose>Get the length of a field.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>ingres_field_length</methodname>
      <methodparam><type>int</type><parameter>index</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_field_length</function> returns the length of a field.
     This is the number of bytes used by the server to store the field.
     For detailed information, see the Ingres/OpenAPI User Guide - Appendix C.
    </para>
    <para>
     <parameter>index</parameter> is the number of the field and must be
     between 1 and the value given by
     <function>ingres_num_fields</function>.     
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-field-precision">
   <refnamediv>
    <refname>ingres_field_precision</refname>
    <refpurpose>Get the precision of a field.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>ingres_field_precision</methodname>
      <methodparam><type>int</type><parameter>index</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_field_precision</function> returns the precision of
     a field. This value is used only for decimal, float and money SQL data
     types. For detailed information, see the Ingres/OpenAPI User Guide -
     Appendix C.
    </para>
    <para>
     <parameter>index</parameter> is the number of the field and must be
     between 1 and the value given by
     <function>ingres_num_fields</function>.     
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-field-scale">
   <refnamediv>
    <refname>ingres_field_scale</refname>
    <refpurpose>Get the scale of a field.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>ingres_field_scale</methodname>
      <methodparam><type>int</type><parameter>index</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_field_scale</function> returns the scale of a field.
     This value is used only for the decimal SQL data type. For detailed
     information, see the Ingres/OpenAPI User Guide - Appendix C.
    </para>
    <para>
     <parameter>index</parameter> is the number of the field and must be
     between 1 and the value given by
     <function>ingres_num_fields</function>.     
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-fetch-array">
   <refnamediv>
    <refname>ingres_fetch_array</refname>
    <refpurpose>Fetch a row of result into an array.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>ingres_fetch_array</methodname>
      <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_fetch_array</function> Returns an array that corresponds
     to the fetched row, or &false; if there are no more rows.
    </para>
    <para>
     This function is an extended version of
     <function>ingres_fetch_row</function>.  In addition to storing the
     data in the numeric indices of the result array, it also stores
     the data in associative indices, using the field names as keys.
    </para>
    <para>
     If two or more columns of the result have the same field names,
     the last column will take precedence. To access the other column(s)
     of the same name, you must use the numeric index of the column or
     make an alias for the column.
     <informalexample>
      <programlisting>
ingres_query(select t1.f1 as foo t2.f1 as bar from t1, t2);
$result = ingres_fetch_array();
$foo = $result["foo"];
$bar = $result["bar"];
      </programlisting>
     </informalexample>
    </para>
    <para>
     <parameter>result_type</parameter> can be II_NUM for enumerated array,
     II_ASSOC for associative array, or II_BOTH (default).
    </para>
    <para>
     Speed-wise, the function is identical to
     <function>ingres_fetch_object</function>, and almost as quick as
     <function>ingres_fetch_row</function> (the difference is
     insignificant).
    </para>
    <para>
     <example>
      <title><function>ingres_fetch_array</function> example</title>
      <programlisting role="php">
&lt;?php 
ingres_connect ($database, $user, $password);

ingres_query ("select * from table");
while ($row = ingres_fetch_array()) {
    echo $row["user_id"];  # using associative array
    echo $row["fullname"];
    echo $row[1];          # using enumerated array
    echo $row[2];
}
?>
      </programlisting>
     </example>
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_num_fields</function>,
     <function>ingres_field_name</function>,
     <function>ingres_fetch_object</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-fetch-row">
   <refnamediv>
    <refname>ingres_fetch_row</refname>
    <refpurpose>Fetch a row of result into an enumerated array.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>ingres_fetch_row</methodname>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_fetch_row</function> returns an array that corresponds
     to the fetched row, or &false; if there are no more rows. Each result
     column is stored in an array offset, starting at offset 1.
    </para>
    <para>
     Subsequent call to <function>ingres_fetch_row</function> would
     return the next row in the result set, or &false; if there are no
     more rows.
    </para>
    <para>
     <example>
      <title><function>ingres_fetch_row</function> example</title>
      <programlisting role="php">
&lt;?php 
ingres_connect ($database, $user, $password);

ingres_query ("select * from table");
while ($row = ingres_fetch_row()) {
    echo $row[1];
    echo $row[2];
}
?>
      </programlisting>
     </example>
    </para>
    <para>
     See also
     <function>ingres_num_fields</function>,
     <function>ingres_query</function>,
     <function>ingres_fetch_array</function> and
     <function>ingres_fetch_object</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-fetch-object">
   <refnamediv>
    <refname>ingres_fetch_object</refname>
    <refpurpose>Fetch a row of result into an object.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>object</type><methodname>ingres_fetch_object</methodname>
      <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_fetch_object</function> Returns an object that
     corresponds to the fetched row, or &false; if there are no more rows.
    </para>
    <para> 
     This function is similar to
     <function>ingres_fetch_array</function>, with one difference - an
     object is returned, instead of an array.  Indirectly, that means
     that you can only access the data by the field names, and not by
     their offsets (numbers are illegal property names).
    </para>
    <para>
     The optional argument <parameter>result_type</parameter> is a
     constant and can take the following values: II_ASSOC,
     II_NUM, and II_BOTH.
    </para>
    <para>
     Speed-wise, the function is identical to
     <function>ingres_fetch_array</function>, and almost as quick as
     <function>ingres_fetch_row</function> (the difference is
     insignificant).
    </para>
    <para>
     <example>
      <title><function>ingres_fetch_object</function> example</title>
      <programlisting role="php">
&lt;?php 
ingres_connect ($database, $user, $password);
ingres_query ("select * from table");
while ($row = ingres_fetch_object()) {
    echo $row->user_id;
    echo $row->fullname;
}
?>
      </programlisting>
     </example>
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_num_fields</function>,
     <function>ingres_field_name</function>,
     <function>ingres_fetch_array</function> and
     <function>ingres_fetch_row</function>.     
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-rollback">
   <refnamediv>
    <refname>ingres_rollback</refname>
    <refpurpose>Roll back a transaction.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ingres_rollback</methodname>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_rollback</function> rolls back the currently open
     transaction, actualy canceling all changes made to the database
     during the transaction.
    </para>
    <para>
     This closes the transaction. A new one can be open by sending a
     query with <function>ingres_query</function>.
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_commit</function> and
     <function>ingres_autocommit</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-commit">
   <refnamediv>
    <refname>ingres_commit</refname>
    <refpurpose>Commit a transaction.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ingres_commit</methodname>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_commit</function> commits the currently open
     transaction, making all changes made to the database permanent.
    </para>
    <para>
     This closes the transaction. A new one can be open by sending a
     query with <function>ingres_query</function>.
    </para>
    <para>
     You can also have the server commit automaticaly after every query
     by calling <function>ingres_autocommit</function> before opening the
     transaction.
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_rollback</function> and
     <function>ingres_autocommit</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ingres-autocommit">
   <refnamediv>
    <refname>ingres_autocommit</refname>
    <refpurpose>Switch autocommit on or off.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ingres_autocommit</methodname>
      <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ingres_autocommit</function> is called before opening a
     transaction (before the first call to <function>ingres_query</function>
     or just after a call to <function>ingres_rollback</function> or
     <function>ingres_autocommit</function>) to switch the "autocommit" mode
     of the server on or off (when the script begins the autocommit mode is
     off).
    </para>
    <para>
     When the autocommit mode is on, every query is automaticaly commited
     by the server, as if <function>ingres_commit</function> was called
     after every call to <function>ingres_query</function>.
    </para>
    <para>
     See also
     <function>ingres_query</function>,
     <function>ingres_rollback</function> and
     <function>ingres_commit</function>.
    </para>
   </refsect1>
  </refentry>

 </reference>
<!-- 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:
-->