Извлекает значение параметра для ресурса оператора или ресурса соединения

# db2_get_option

(PECL ibm_db2 >= 1.6.0)

db2_get_option — Извлекает значение параметра для ресурса оператора или ресурса соединения

### Описание

function db2_get_option(resource `$resource`, string `$option`): string|false

Извлекает значение указанного параметра для ресурса оператора или ресурса соединения.

### Список параметров

`resource`
  Допустимый ресурс оператора, возвращаемый db2_prepare() или допустимый ресурс соединения, возвращаемый db2_connect() или db2_pconnect().
`option`

  Допустимый оператор или варианты подключения. Следующие новые параметры доступны в ibm_db2 версии 1.6.0. Они предоставляют полезную информацию для отслеживания, которую можно установить во время выполнения с помощью db2_get_option().

  > Замечание: Предыдущие версии ibm_db2 не поддерживают эти новые параметры. Когда устанавливается значение в каждой опции, некоторые серверы могут не обрабатывать всю предоставленную длину и могут усекать значение. Чтобы обеспечить правильное преобразование данных, указанных в каждой опции, при передаче в хост-систему, используйте только символы от A до Z, от 0 до 9, знак подчёркивания (_) или точку (.).

  `userid`

    `SQL_ATTR_INFO_USERID` - Указатель на символьную строку с завершающим нулём, используемую для идентификации ID пользователя клиента, отправляемого на сервер базы данных хоста при использовании DB2 Connect.

    > Замечание: Серверы DB2 для z/OS и OS/390 поддерживают длину до 16 символов. Идентификатор пользователя не следует путать с идентификатором пользователя для аутентификации, он используется только для целей идентификации и не используется для какой-либо авторизации.

  `acctstr`

    `SQL_ATTR_INFO_ACCTSTR` - Указатель на символьную строку с завершающим нулём, используемую для идентификации учётной строки клиента, отправляемой на сервер базы данных хоста при использовании DB2 Connect.

    > Замечание: Серверы DB2 для z/OS и OS/390 поддерживают длину до 200 символов.

  `applname`

    `SQL_ATTR_INFO_APPLNAME` - Указатель на символьную строку с завершающим нулём, используемую для идентификации имени клиентского приложения, отправляемого на сервер базы данных хоста при использовании DB2 Connect.

    > Замечание: Серверы DB2 для z/OS и OS/390 поддерживают длину до 32 символов.

  `wrkstnname`

    `SQL_ATTR_INFO_WRKSTNNAME` - Указатель на символьную строку с завершающим нулём, используемую для идентификации имени клиентского приложения, отправляемого на сервер базы данных хоста при использовании DB2 Connect.

    > Замечание: Серверы DB2 для z/OS и OS/390 поддерживают длину до 18 символов.

В следующей таблице указаны параметры, совместимые с доступными типами ресурсов:

Матрица параметров ресурсов
Ключ | Значение | Тип ресурса
--- | --- | ---
|  | Connection | Statement | Result Set
userid | `SQL_ATTR_INFO_USERID` | X | X | -
acctstr | `SQL_ATTR_INFO_ACCTSTR` | X | X | -
applname | `SQL_ATTR_INFO_APPLNAME` | X | X | -
wrkstnname | `SQL_ATTR_INFO_WRKSTNNAME` | X | X | -

### Возвращаемые значения

Возвращает текущую настройку атрибута подключения, предоставленную в случае успешного выполнения или `false`, если возникла ошибка.

### Примеры

Пример #1 Установка и получение параметров через ресурс подключения

    <?php
    /* Параметры подключения к базе данных */
    $database = 'SAMPLE';
    $user     = 'db2inst1';
    $password = 'ibmdb2';

    /* Получение ресурса подключения */
    $conn = db2_connect($database, $user, $password);

    echo "Атрибуты клиента, передаваемые через строку подключения:\n";

    /* Создайте массив ассоциативных опций с допустимыми парами "ключ-значение" */
    /* Назначьте атрибуты через строку подключения */
    /* Доступ к указанным параметрам */
    $options1 = array('userid' => 'db2inst1');
    $conn1 = db2_connect($database, $user, $password, $options1);
    $val = db2_get_option($conn1, 'userid');
    echo $val . "\n";

    $options2 = array('acctstr' => 'account');
    $conn2 = db2_connect($database, $user, $password, $options2);
    $val = db2_get_option($conn2, 'acctstr');
    echo $val . "\n";

    $options3 = array('applname' => 'myapp');
    $conn3 = db2_connect($database, $user, $password, $options3);
    $val = db2_get_option($conn3, 'applname');
    echo $val . "\n";

    $options4 = array('wrkstnname' => 'workstation');
    $conn4 = db2_connect($database, $user, $password, $options4);
    $val = db2_get_option($conn4, 'wrkstnname');
    echo $val . "\n";

    echo "Атрибуты клиента прошли после подключения:\n";

    /* Create the associative options array with valid key-value pairs */
    /* Assign the attributes after a connection is made */
    /* Access the options specified */
    $options5 = array('userid' => 'db2inst1');
    $conn5 = db2_connect($database, $user, $password);
    $rc = db2_set_option($conn5, $options5, 1);
    $val = db2_get_option($conn5, 'userid');
    echo $val . "\n";

    $options6 = array('acctstr' => 'account');
    $conn6 = db2_connect($database, $user, $password);
    $rc = db2_set_option($conn6, $options6, 1);
    $val = db2_get_option($conn6, 'acctstr');
    echo $val . "\n";

    $options7 = array('applname' => 'myapp');
    $conn7 = db2_connect($database, $user, $password);
    $rc = db2_set_option($conn7, $options7, 1);
    $val = db2_get_option($conn7, 'applname');
    echo $val . "\n";

    $options8 = array('wrkstnname' => 'workstation');
    $conn8 = db2_connect($database, $user, $password);
    $rc = db2_set_option($conn8, $options8, 1);
    $val = db2_get_option($conn8, 'wrkstnname');
    echo $val . "\n";
    ?>

Результат выполнения приведённого примера:

    Атрибуты клиента, передаваемые через строку подключения
    db2inst1
    account
    myapp
    workstation
    Атрибуты клиента прошли после подключения:
    db2inst1
    account
    myapp
    workstation

### Смотрите также

- db2_connect() - Возвращает соединение с базой данных
- db2_cursor_type() - Возвращает тип курсора, который используется в ресурсе оператора
- db2_exec() - Выполняет SQL-запрос напрямую
- db2_set_option() - Устанавливает опции для ресурса соединения или ресурса запроса
- db2_pconnect() - Возвращает постоянное соединение с базой данных
- db2_prepare() - Подготавливает SQL-запрос к выполнению

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open