db2_set_option

Set options for connection or statement resources

bool **db2_set_option** resource $resource array $options int $type

Sets options for a statement resource or a connection resource. You cannot set options for result set resources.

resource A valid statement resource as returned from or a valid connection resource as returned from or . db2_prepare``db2_connect``db2_pconnect

options 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.

       `autocommit`
                Passing  turns
                autocommit on for the specified connection resource.
               `DB2_AUTOCOMMIT_ON`


                Passing  turns
                autocommit off for the specified connection resource.
               `DB2_AUTOCOMMIT_OFF`

cursor Passing specifies a forward-only cursor for a statement resource. This is the default cursor type, and is supported by all database servers. DB2_FORWARD_ONLY

                Passing  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.
               `DB2_SCROLLABLE`

binmode Passing specifies that binary data will be returned as is. This is the default mode. This is the equivalent of setting in php.ini. DB2_BINARY``ibm_db2.binmode=1

                Passing  specifies that
                binary data will be converted to hexadecimal encoding,
                and will be returned as such. This is the equivalent of
                setting  in php.ini.
               `DB2_CONVERT``ibm_db2.binmode=2`


                Passing  specifies that
                binary data will be converted to null. This is the
                equivalent of setting 
                in php.ini.
               `DB2_PASSTHRU``ibm_db2.binmode=3`

db2_attr_case Passing specifies that column names of the result set are returned in lower case. DB2_CASE_LOWER

                Passing  specifies that
                column names of the result set are returned in upper case.
               `DB2_CASE_UPPER`


                Passing  specifies that
                column names of the result set are returned in natural
                case.
               `DB2_CASE_NATURAL`

deferred_prepare Passing turns deferred prepare on for the specified statement resource. DB2_DEFERRED_PREPARE_ON

              Passing  turns deferred
              prepare off for the specified statement resource.
             `DB2_DEFERRED_PREPARE_OFF`




        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.
         
       `i5_fetch_only`
                 - Cursors are read-only
                and cannot be used for positioned updates or deletes. This
                is the default unless 
                environment has been set to .
               `DB2_I5_FETCH_ON``SQL_ATTR_FOR_FETCH_ONLY``SQL_FALSE`


                 - Cursors can be used
                for positioned updates and deletes.
               `DB2_I5_FETCH_OFF`




        The following new option is available in ibm_db2 version 1.8.0 and later.
         
       `rowcount`
                 - Client can request
                the full row count prior to fetching, which means that
                 returns the number of rows selected
                even when a  cursor is used.
               `DB2_ROWCOUNT_PREFETCH_ON``db2_num_rows``ROLLFORWARD_ONLY`


                 - Client cannot request
                the full row count prior to fetching.
               `DB2_ROWCOUNT_PREFETCH_OFF`




        The following new options are available in ibm_db2 version 1.7.0 and later.
         
       `trusted_user`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.

trusted_passwordThe password (String) that corresponds to the user specified by the trusted_user key.

        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 .
        
        
       `db2_get_option`> **Opmerking:** > When the value in each option is being set, some servers might not handle

          the entire length provided and might truncate the value.
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 (.).

userid - 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.

           `SQL_ATTR_INFO_USERID`> **Opmerking:** > 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.

acctstr - 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.

           `SQL_ATTR_INFO_ACCTSTR`> **Opmerking:** > DB2 for z/OS and OS/390 servers support up to a length of 200 characters.

applname - 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.

           `SQL_ATTR_INFO_APPLNAME`> **Opmerking:** > DB2 for z/OS and OS/390 servers support up to a length of 32 characters.

wrkstnname - 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.

           `SQL_ATTR_INFO_WRKSTNNAME`> **Opmerking:** > DB2 for z/OS and OS/390 servers support up to a length of 18 characters.

typeAn integer value that specifies the type of resource that was passed into the function. The type of resource and this value must correspond.

        Passing  as the value specifies that
        a connection resource has been passed into the function.
       `1`


        Passing any integer not equal to  as
        the value specifies that a statement resource has been
        passed into the function.
       `1`

The following table specifies which options are compatible with the available resource types:

return.success

**Voorbeeld: Setting one parameter with a connection resource**

<?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';
}
?>

Options Set Successfully

Voorbeeld: Setting multiple parameters with a connection resource

<?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';
}
?>

Options Set Successfully

Voorbeeld: Setting multiple parameters with an invalid key

<?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';
}
?>

Could Not Set Options

Voorbeeld: Setting multiple parameters with an invalid value

<?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';
}
?>

Could Not Set Options

Voorbeeld: Setting multiple parameters with a connection resource and the wrong type

<?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';
}
?>

Could Not Set Options

Voorbeeld: Setting multiple parameters with the wrong resource

<?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';
}
?>

Could Not Set Options

Voorbeeld: Putting it all together

<?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));

?>

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
)

Voorbeeld: i5/OS cursors are read-only

<?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]}";
    }
  }
?>

first2 last2

db2_connect``db2_pconnect``db2_exec``db2_prepare``db2_cursor_type

Vorige ← db2_server_info Volgende db2_special_columns →

db2_set_option

db2_set_option

Documentatie