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 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.db2-set-option">
<refnamediv>
<refname>db2_set_option</refname>
<refpurpose>Set options for connection or statement resources</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>db2_set_option</methodname>
<methodparam><type>resource</type><parameter>resource</parameter></methodparam>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
<methodparam><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
Sets options for a statement resource or a connection resource. You
cannot set options for result set resources.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>resource</parameter></term>
<listitem>
<para>
A valid statement resource as returned from
<function>db2_prepare</function> or a valid connection resource as
returned from <function>db2_connect</function> or
<function>db2_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An associative array containing valid statement or connection
options. This parameter can be used to change autocommit values,
cursor types (scrollable or forward), and to specify the case of
the column names (lower, upper, or natural) that will appear in a
result set.
<variablelist>
<varlistentry>
<term><parameter>autocommit</parameter></term>
<listitem>
<para>
Passing <constant>DB2_AUTOCOMMIT_ON</constant> turns
autocommit on for the specified connection resource.
</para>
<para>
Passing <constant>DB2_AUTOCOMMIT_OFF</constant> turns
autocommit off for the specified connection resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
Passing <constant>DB2_FORWARD_ONLY</constant> specifies a
forward-only cursor for a statement resource. This is the
default cursor type, and is supported by all database
servers.
</para>
<para>
Passing <constant>DB2_SCROLLABLE</constant> specifies a
scrollable cursor for a statement resource. Scrollable
cursors enable result set rows to be accessed in
non-sequential order, but are only supported by
IBM DB2 Universal Database databases.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>binmode</parameter></term>
<listitem>
<para>
Passing <constant>DB2_BINARY</constant> specifies that
binary data will be returned as is. This is the default
mode. This is the equivalent of setting
<literal>ibm_db2.binmode=1</literal> in &php.ini;.
</para>
<para>
Passing <constant>DB2_CONVERT</constant> specifies that
binary data will be converted to hexadecimal encoding,
and will be returned as such. This is the equivalent of
setting <literal>ibm_db2.binmode=2</literal> in &php.ini;.
</para>
<para>
Passing <constant>DB2_PASSTHRU</constant> specifies that
binary data will be converted to &null;. This is the
equivalent of setting <literal>ibm_db2.binmode=3</literal>
in &php.ini;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>db2_attr_case</parameter></term>
<listitem>
<para>
Passing <constant>DB2_CASE_LOWER</constant> specifies that
column names of the result set are returned in lower case.
</para>
<para>
Passing <constant>DB2_CASE_UPPER</constant> specifies that
column names of the result set are returned in upper case.
</para>
<para>
Passing <constant>DB2_CASE_NATURAL</constant> specifies that
column names of the result set are returned in natural
case.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>deferred_prepare</parameter></term>
<listitem>
<para>
Passing <constant>DB2_DEFERRED_PREPARE_ON</constant> turns deferred
prepare on for the specified statement resource.
</para>
<para>
Passing <constant>DB2_DEFERRED_PREPARE_OFF</constant> turns deferred
prepare off for the specified statement resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following new i5/OS options are available in ibm_db2 version 1.5.1
and later. These options apply only when running PHP and ibm_db2 natively on i5 systems.
<variablelist>
<varlistentry>
<term><parameter>i5_fetch_only</parameter></term>
<listitem>
<para>
<literal>DB2_I5_FETCH_ON</literal> - Cursors are read-only
and cannot be used for positioned updates or deletes. This
is the default unless <literal>SQL_ATTR_FOR_FETCH_ONLY</literal>
environment has been set to <literal>SQL_FALSE</literal>.
</para>
<para>
<literal>DB2_I5_FETCH_OFF</literal> - Cursors can be used
for positioned updates and deletes.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following new option is available in ibm_db2 version 1.8.0 and later.
<variablelist>
<varlistentry>
<term><parameter>rowcount</parameter></term>
<listitem>
<para>
<literal>DB2_ROWCOUNT_PREFETCH_ON</literal> - Client can request
the full row count prior to fetching, which means that
<function>db2_num_rows</function> returns the number of rows selected
even when a <literal>ROLLFORWARD_ONLY</literal> cursor is used.
</para>
<para>
<literal>DB2_ROWCOUNT_PREFETCH_OFF</literal> - Client cannot request
the full row count prior to fetching.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following new options are available in ibm_db2 version 1.7.0 and later.
<variablelist>
<varlistentry>
<term><parameter>trusted_user</parameter></term>
<listitem>
<para>
To switch the user to a trusted user, pass the User ID (String)
of the trusted user as the value of this key. This option can
be set on a connection resource only. To use this option, trusted
context must be enabled on the connection resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>trusted_password</parameter></term>
<listitem>
<para>
The password (String) that corresponds to the user specified
by the trusted_user key.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following new options are available in ibm_db2 version 1.6.0 and later.
These options provide useful tracking information that can be accessed during
execution with <function>db2_get_option</function>.
<note>
<para>
When the value in each option is being set, some servers might not handle
the entire length provided and might truncate the value.
</para>
<para>
To ensure that the data specified in each option is converted correctly
when transmitted to a host system, use only the characters A through Z,
0 through 9, and the underscore (_) or period (.).
</para>
</note>
<variablelist>
<varlistentry>
<term><parameter>userid</parameter></term>
<listitem>
<para>
<literal>SQL_ATTR_INFO_USERID</literal> - A pointer to a null-terminated
character string used to identify the client user ID sent to the host
database server when using DB2 Connect.
<note>
<para>
DB2 for z/OS and OS/390 servers support up to a length of 16 characters.
This user-id is not to be confused with the authentication user-id, it is for
identification purposes only and is not used for any authorization.
</para>
</note>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>acctstr</parameter></term>
<listitem>
<para>
<literal>SQL_ATTR_INFO_ACCTSTR</literal> - A pointer to a null-terminated
character string used to identify the client accounting string sent to the
host database server when using DB2 Connect.
<note>
<para>
DB2 for z/OS and OS/390 servers support up to a length of 200 characters.
</para>
</note>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>applname</parameter></term>
<listitem>
<para>
<literal>SQL_ATTR_INFO_APPLNAME</literal> - A pointer to a null-terminated
character string used to identify the client application name sent to the
host database server when using DB2 Connect.
<note>
<para>
DB2 for z/OS and OS/390 servers support up to a length of 32 characters.
</para>
</note>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wrkstnname</parameter></term>
<listitem>
<para>
<literal>SQL_ATTR_INFO_WRKSTNNAME</literal> - A pointer to a null-terminated
character string used to identify the client workstation name sent to the
host database server when using DB2 Connect.
<note>
<para>
DB2 for z/OS and OS/390 servers support up to a length of 18 characters.
</para>
</note>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
An integer value that specifies the type of resource that was
passed into the function. The type of resource and this value
must correspond.
</para>
<para>
Passing <literal>1</literal> as the value specifies that
a connection resource has been passed into the function.
</para>
<para>
Passing any integer not equal to <literal>1</literal> as
the value specifies that a statement resource has been
passed into the function.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
</para>
<para>
The following table specifies which options are compatible with
the available resource types:
<table>
<title>Resource-Parameter Matrix</title>
<tgroup cols="5">
<colspec colnum="1" colname="col1" align="center" />
<colspec colnum="2" colname="col2" align="center" />
<colspec colnum="3" colname="col3" align="center" />
<colspec colnum="4" colname="col4" align="center" />
<colspec colnum="5" colname="col5" align="center" />
<thead>
<row>
<entry morerows="1">Key</entry>
<entry morerows="1">Value</entry>
<entry namest="col3" nameend="col5">Resource Type</entry>
</row>
</thead>
<tbody>
<row>
<entry colname="col3">Connection</entry>
<entry colname="col4">Statement</entry>
<entry colname="col5">Result Set</entry>
</row>
<row>
<entry>autocommit</entry>
<entry><constant>DB2_AUTOCOMMIT_ON</constant></entry>
<entry colname="col3">X</entry>
<entry colname="col4">-</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>autocommit</entry>
<entry><constant>DB2_AUTOCOMMIT_OFF</constant></entry>
<entry colname="col3">X</entry>
<entry colname="col4">-</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>cursor</entry>
<entry><constant>DB2_SCROLLABLE</constant></entry>
<entry colname="col3">-</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>cursor</entry>
<entry><constant>DB2_FORWARD_ONLY</constant></entry>
<entry colname="col3">-</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>binmode</entry>
<entry><constant>DB2_BINARY</constant></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>binmode</entry>
<entry><constant>DB2_CONVERT</constant></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>binmode</entry>
<entry><constant>DB2_PASSTHRU</constant></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>db2_attr_case</entry>
<entry><constant>DB2_CASE_LOWER</constant></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>db2_attr_case</entry>
<entry><constant>DB2_CASE_UPPER</constant></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>db2_attr_case</entry>
<entry><constant>DB2_CASE_NATURAL</constant></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>deferred_prepare</entry>
<entry><constant>DB2_DEFERRED_PREPARE_ON</constant></entry>
<entry colname="col3">-</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>deferred_prepare</entry>
<entry><constant>DB2_DEFERRED_PREPARE_OFF</constant></entry>
<entry colname="col3">-</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>i5_fetch_only</entry>
<entry><literal>DB2_I5_FETCH_ON</literal></entry>
<entry colname="col3">-</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>i5_fetch_only</entry>
<entry><literal>DB2_I5_FETCH_OFF</literal></entry>
<entry colname="col3">-</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>rowcount</entry>
<entry><literal>DB2_ROWCOUNT_PREFETCH_ON</literal></entry>
<entry colname="col3">-</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>rowcount</entry>
<entry><literal>DB2_ROWCOUNT_PREFETCH_OFF</literal></entry>
<entry colname="col3">-</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>trusted_user</entry>
<entry><literal><USER NAME> (String)</literal></entry>
<entry colname="col3">X</entry>
<entry colname="col4">-</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>trusted_password</entry>
<entry><literal><PASSWORD> (String)</literal></entry>
<entry colname="col3">X</entry>
<entry colname="col4">-</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>userid</entry>
<entry><literal>SQL_ATTR_INFO_USERID</literal></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>acctstr</entry>
<entry><literal>SQL_ATTR_INFO_ACCTSTR</literal></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>applname</entry>
<entry><literal>SQL_ATTR_INFO_APPLNAME</literal></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
<row>
<entry>wrkstnname</entry>
<entry><literal>SQL_ATTR_INFO_WRKSTNNAME</literal></entry>
<entry colname="col3">X</entry>
<entry colname="col4">X</entry>
<entry colname="col5">-</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<!-- Place Changelog next if any -->
<!-- Place Examples next if any -->
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Setting one parameter with a connection resource</title>
<programlisting role="php">
<![CDATA[
<?php
/* Database Connection Parameters */
$database = 'SAMPLE';
$hostname = 'localhost';
$port = 50000;
$protocol = 'TCPIP';
$username = 'db2inst1';
$password = 'ibmdb2';
/* Connection String */
$conn_string = "DRIVER={IBM DB2 ODBC DRIVER};DATABASE=$database;";
$conn_string .= "HOSTNAME=$hostname;PORT=$port;PROTOCOL=$protocol;";
$conn_string .= "UID=$username;PWD=$password;";
/* Obtain Connection Resource */
$conn = db2_connect($conn_string, '', '');
/* Create the associative options array with valid key-value pairs */
$options = array('autocommit' => DB2_AUTOCOMMIT_ON);
/* Call the function using the correct resource, options array, and type values */
$result = db2_set_option($conn, $options, 1);
/* Check if all options could be set correctly */
if($result)
{
echo 'Options Set Successfully';
}
else
{
echo 'Could Not Set Options';
}
?>
]]>
</programlisting>
&example.outputs;
<screen><![CDATA[Options Set Successfully]]></screen>
</example>
<example>
<title>Setting multiple parameters with a connection resource</title>
<programlisting role="php">
<![CDATA[
<?php
/* Database Connection Parameters */
$database = 'SAMPLE';
$hostname = 'localhost';
$port = 50000;
$protocol = 'TCPIP';
$username = 'db2inst1';
$password = 'ibmdb2';
/* Connection String */
$conn_string = "DRIVER={IBM DB2 ODBC DRIVER};DATABASE=$database;";
$conn_string .= "HOSTNAME=$hostname;PORT=$port;PROTOCOL=$protocol;";
$conn_string .= "UID=$username;PWD=$password;";
/* Obtain Connection Resource */
$conn = db2_connect($conn_string, '', '');
/* Create the associative options array with valid key-value pairs */
$options = array('autocommit' => DB2_AUTOCOMMIT_OFF,
'binmode' => DB2_PASSTHRU,
'db2_attr_case' => DB2_CASE_UPPER,
'cursor' => DB2_SCROLLABLE);
/* Call the function using the correct resource, options array, and type values */
$result = db2_set_option($conn, $options, 1);
/* Check if all options could be set correctly */
if($result)
{
echo 'Options Set Successfully';
}
else
{
echo 'Could Not Set Options';
}
?>
]]>
</programlisting>
&example.outputs;
<screen><![CDATA[Options Set Successfully]]></screen>
</example>
<!-- Behaves Incorrectly -->
<example>
<title>Setting multiple parameters with an invalid key</title>
<programlisting role="php">
<![CDATA[
<?php
/* Database Connection Parameters */
$database = 'SAMPLE';
$hostname = 'localhost';
$port = 50000;
$protocol = 'TCPIP';
$username = 'db2inst1';
$password = 'ibmdb2';
/* Connection String */
$conn_string = "DRIVER={IBM DB2 ODBC DRIVER};DATABASE=$database;";
$conn_string .= "HOSTNAME=$hostname;PORT=$port;PROTOCOL=$protocol;";
$conn_string .= "UID=$username;PWD=$password;";
/* Obtain Connection Resource */
$conn = db2_connect($conn_string, '', '');
/* Create the associative options array with valid key-value pairs */
$options = array('autocommit' => DB2_AUTOCOMMIT_OFF,
'MY_INVALID_KEY' => DB2_PASSTHRU,
'db2_attr_case' => DB2_CASE_UPPER,
'cursor' => DB2_SCROLLABLE);
/* Call the function using the correct resource, options array, and type values */
$result = db2_set_option($conn, $options, 1);
/* Check if all options could be set correctly */
if($result)
{
echo 'Options Set Successfully';
}
else
{
echo 'Could Not Set Options';
}
?>
]]>
</programlisting>
&example.outputs;
<screen><![CDATA[Could Not Set Options]]></screen>
</example>
<!-- Behaves Incorrectly -->
<example>
<title>Setting multiple parameters with an invalid value</title>
<programlisting role="php">
<![CDATA[
<?php
/* Database Connection Parameters */
$database = 'SAMPLE';
$hostname = 'localhost';
$port = 50000;
$protocol = 'TCPIP';
$username = 'db2inst1';
$password = 'ibmdb2';
/* Connection String */
$conn_string = "DRIVER={IBM DB2 ODBC DRIVER};DATABASE=$database;";
$conn_string .= "HOSTNAME=$hostname;PORT=$port;PROTOCOL=$protocol;";
$conn_string .= "UID=$username;PWD=$password;";
/* Obtain Connection Resource */
$conn = db2_connect($conn_string, '', '');
/* Create the associative options array with valid key-value pairs */
$options = array('autocommit' => DB2_AUTOCOMMIT_OFF,
'binmode' => 'INVALID_VALUE',
'db2_attr_case' => DB2_CASE_UPPER,
'cursor' => DB2_SCROLLABLE);
/* Call the function using the correct resource, options array, and type values */
$result = db2_set_option($conn, $options, 1);
/* Check if all options could be set correctly */
if($result)
{
echo 'Options Set Successfully';
}
else
{
echo 'Could Not Set Options';
}
?>
]]>
</programlisting>
&example.outputs;
<screen><![CDATA[Could Not Set Options]]></screen>
</example>
<example>
<title>Setting multiple parameters with a connection resource and the wrong type</title>
<programlisting role="php">
<![CDATA[
<?php
/* Database Connection Parameters */
$database = 'SAMPLE';
$hostname = 'localhost';
$port = 50000;
$protocol = 'TCPIP';
$username = 'db2inst1';
$password = 'ibmdb2';
/* Connection String */
$conn_string = "DRIVER={IBM DB2 ODBC DRIVER};DATABASE=$database;";
$conn_string .= "HOSTNAME=$hostname;PORT=$port;PROTOCOL=$protocol;";
$conn_string .= "UID=$username;PWD=$password;";
/* Obtain Connection Resource */
$conn = db2_connect($conn_string, '', '');
/* Create the associative options array with valid key-value pairs */
$options = array('autocommit' => DB2_AUTOCOMMIT_OFF,
'binmode' => DB2_PASSTHRU,
'db2_attr_case' => DB2_CASE_UPPER,
'cursor' => DB2_SCROLLABLE);
/* Call the function using the correct resource, options array, and the wrong type value */
$result = db2_set_option($conn, $options, 2);
/* Check if all options could be set correctly */
if($result)
{
echo 'Options Set Successfully';
}
else
{
echo 'Could Not Set Options';
}
?>
]]>
</programlisting>
&example.outputs;
<screen><![CDATA[Could Not Set Options]]></screen>
</example>
<example>
<title>Setting multiple parameters with the wrong resource</title>
<programlisting role="php">
<![CDATA[
<?php
/* Database Connection Parameters */
$database = 'SAMPLE';
$hostname = 'localhost';
$port = 50000;
$protocol = 'TCPIP';
$username = 'db2inst1';
$password = 'ibmdb2';
/* Connection String */
$conn_string = "DRIVER={IBM DB2 ODBC DRIVER};DATABASE=$database;";
$conn_string .= "HOSTNAME=$hostname;PORT=$port;PROTOCOL=$protocol;";
$conn_string .= "UID=$username;PWD=$password;";
/* Obtain Connection Resource */
$conn = db2_connect($conn_string, '', '');
/* Create the associative options array with valid key-value pairs */
$options = array('autocommit' => DB2_AUTOCOMMIT_OFF,
'binmode' => DB2_PASSTHRU,
'db2_attr_case' => DB2_CASE_UPPER,
'cursor' => DB2_SCROLLABLE);
$stmt = db2_prepare($conn, 'SELECT * FROM EMPLOYEE');
/* Call the function using the wrong resource, and the correct options array, and type values */
$result = db2_set_option($stmt, $options, 1);
/* Check if all options could be set correctly */
if($result)
{
echo 'Options Set Successfully';
}
else
{
echo 'Could Not Set Options';
}
?>
]]>
</programlisting>
&example.outputs;
<screen><![CDATA[Could Not Set Options]]></screen>
</example>
<example>
<title>Putting it all together</title>
<programlisting role="php">
<![CDATA[
<?php
/* Database Connection Parameters */
$database = 'SAMPLE';
$hostname = 'localhost';
$port = 50000;
$protocol = 'TCPIP';
$username = 'db2inst1';
$password = 'ibmdb2';
/* Connection String */
$conn_string = "DRIVER={IBM DB2 ODBC DRIVER};DATABASE=$database;";
$conn_string .= "HOSTNAME=$hostname;PORT=$port;PROTOCOL=$protocol;";
$conn_string .= "UID=$username;PWD=$password;";
/* Obtain Connection Resource */
$conn = db2_connect($conn_string, '', '');
/* Create the associative options array with valid key-value pairs */
$options = array('db2_attr_case' => DB2_CASE_LOWER,
'cursor' => DB2_SCROLLABLE);
$stmt = db2_prepare($conn, 'SELECT * FROM EMPLOYEE WHERE EMPNO = ? OR EMPNO = ?');
/* Call the function using the correct resource, options array, and type values */
$option_result = db2_set_option($stmt, $options, 2);
$result = db2_execute($stmt, array('000130', '000140'));
/* Get Row 2 before Row 1 since Scrollable Cursor */
print_r(db2_fetch_assoc($stmt, 2));
print '<br /><br />';
print_r(db2_fetch_assoc($stmt, 1));
?>
]]>
</programlisting>
&example.outputs;
<screen><![CDATA[Array
(
[empno] => 000140
[firstnme] => HEATHER
[midinit] => A
[lastname] => NICHOLLS
[workdept] => C01
[phoneno] => 1793
[hiredate] => 1976-12-15
[job] => ANALYST
[edlevel] => 18
[sex] => F
[birthdate] => 1946-01-19
[salary] => 28420.00
[bonus] => 600.00
[comm] => 2274.00
)
Array
(
[empno] => 000130
[firstnme] => DELORES
[midinit] => M
[lastname] => QUINTANA
[workdept] => C01
[phoneno] => 4578
[hiredate] => 1971-07-28
[job] => ANALYST
[edlevel] => 16
[sex] => F
[birthdate] => 1925-09-15
[salary] => 23800.00
[bonus] => 500.00
[comm] => 1904.00
)]]></screen>
</example>
<example>
<title>i5/OS cursors are read-only</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = db2_connect("", "", "", array("i5_lib"=>"nobody"));
$stmt = db2_prepare($conn, 'select * from names where first = ?');
$name = "first2";
db2_bind_param($stmt, 1, "name", DB2_PARAM_IN);
$options = array("i5_fetch_only"=>DB2_I5_FETCH_ON);
db2_set_option($stmt,$options,0);
if (db2_execute($stmt)) {
while ($row = db2_fetch_array($stmt)) {
echo "{$row[0]} {$row[1]}";
}
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
first2 last2
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>db2_connect</function></member>
<member><function>db2_pconnect</function></member>
<member><function>db2_exec</function></member>
<member><function>db2_prepare</function></member>
<member><function>db2_cursor_type</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
-->
|