The Pdo\Odbc class

Introduction

A PDO subclass representing a connection using the ODBC PDO driver.

Class synopsis

Pdo\Odbc

extends PDO

/* Inherited constants */

public const int PDO::PARAM_NULL;

public const int PDO::PARAM_BOOL = 5;

public const int PDO::PARAM_INT = 1;

public const int PDO::PARAM_STR = 2;

public const int PDO::PARAM_LOB = 3;

public const int PDO::PARAM_STMT = 4;

public const int PDO::PARAM_INPUT_OUTPUT;

public const int PDO::PARAM_STR_NATL;

public const int PDO::PARAM_STR_CHAR;

public const int PDO::PARAM_EVT_ALLOC;

public const int PDO::PARAM_EVT_FREE;

public const int PDO::PARAM_EVT_EXEC_PRE;

public const int PDO::PARAM_EVT_EXEC_POST;

public const int PDO::PARAM_EVT_FETCH_PRE;

public const int PDO::PARAM_EVT_FETCH_POST;

public const int PDO::PARAM_EVT_NORMALIZE;

public const int PDO::FETCH_DEFAULT;

public const int PDO::FETCH_LAZY;

public const int PDO::FETCH_ASSOC;

public const int PDO::FETCH_NUM;

public const int PDO::FETCH_BOTH;

public const int PDO::FETCH_OBJ;

public const int PDO::FETCH_BOUND;

public const int PDO::FETCH_COLUMN;

public const int PDO::FETCH_CLASS;

public const int PDO::FETCH_INTO;

public const int PDO::FETCH_FUNC;

public const int PDO::FETCH_GROUP;

public const int PDO::FETCH_UNIQUE;

public const int PDO::FETCH_KEY_PAIR;

public const int PDO::FETCH_CLASSTYPE;

public const int PDO::FETCH_SERIALIZE;

public const int PDO::FETCH_PROPS_LATE;

public const int PDO::FETCH_NAMED;

public const int PDO::ATTR_AUTOCOMMIT;

public const int PDO::ATTR_PREFETCH;

public const int PDO::ATTR_TIMEOUT;

public const int PDO::ATTR_ERRMODE;

public const int PDO::ATTR_SERVER_VERSION;

public const int PDO::ATTR_CLIENT_VERSION;

public const int PDO::ATTR_SERVER_INFO;

public const int PDO::ATTR_CONNECTION_STATUS;

public const int PDO::ATTR_CASE;

public const int PDO::ATTR_CURSOR_NAME;

public const int PDO::ATTR_CURSOR;

public const int PDO::ATTR_ORACLE_NULLS;

public const int PDO::ATTR_PERSISTENT;

public const int PDO::ATTR_STATEMENT_CLASS;

public const int PDO::ATTR_FETCH_TABLE_NAMES;

public const int PDO::ATTR_FETCH_CATALOG_NAMES;

public const int PDO::ATTR_DRIVER_NAME;

public const int PDO::ATTR_STRINGIFY_FETCHES;

public const int PDO::ATTR_MAX_COLUMN_LEN;

public const int PDO::ATTR_EMULATE_PREPARES;

public const int PDO::ATTR_DEFAULT_FETCH_MODE;

public const int PDO::ATTR_DEFAULT_STR_PARAM;

public const int PDO::ERRMODE_SILENT;

public const int PDO::ERRMODE_WARNING;

public const int PDO::ERRMODE_EXCEPTION;

public const int PDO::CASE_NATURAL;

public const int PDO::CASE_LOWER;

public const int PDO::CASE_UPPER;

public const int PDO::NULL_NATURAL;

public const int PDO::NULL_EMPTY_STRING;

public const int PDO::NULL_TO_STRING;

public const string PDO::ERR_NONE;

public const int PDO::FETCH_ORI_NEXT;

public const int PDO::FETCH_ORI_PRIOR;

public const int PDO::FETCH_ORI_FIRST;

public const int PDO::FETCH_ORI_LAST;

public const int PDO::FETCH_ORI_ABS;

public const int PDO::FETCH_ORI_REL;

public const int PDO::CURSOR_FWDONLY;

public const int PDO::CURSOR_SCROLL;

/* Constants */

public const int Pdo\Odbc::ATTR_USE_CURSOR_LIBRARY;

public const int Pdo\Odbc::ATTR_ASSUME_UTF8;

public const int Pdo\Odbc::SQL_USE_IF_NEEDED;

public const int Pdo\Odbc::SQL_USE_DRIVER;

public const int Pdo\Odbc::SQL_USE_ODBC;

/* Inherited methods */

public __construct(
    string $dsn,
    stringnull $username = null,
    #[\SensitiveParameter]stringnull $password = null,
    arraynull $options = null
)

public bool beginTransaction()

public bool commit()

public static static connect(
    string $dsn,
    stringnull $username = null,
    #[\SensitiveParameter]stringnull $password = null,
    arraynull $options = null
)

public stringnull errorCode()

public array errorInfo()

public intfalse exec(string $statement)

public mixed getAttribute(int $attribute)

public static array getAvailableDrivers()

public bool inTransaction()

public stringfalse lastInsertId(stringnull $name = null)

public PDOStatementfalse prepare(string $query, array $options = [])

public PDOStatementfalse query(string $query, intnull $fetchMode = null)

public PDOStatementfalse query(string $query, intnull $fetchMode = PDO::FETCH_COLUMN, int $colno)

public PDOStatementfalse query(
    string $query,
    intnull $fetchMode = PDO::FETCH_CLASS,
    string $classname,
    array $constructorArgs
)

public PDOStatementfalse query(string $query, intnull $fetchMode = PDO::FETCH_INTO, object $object)

public stringfalse quote(string $string, int $type = PDO::PARAM_STR)

public bool rollBack()

public bool setAttribute(int $attribute, mixed $value)

Predefined Constants

Pdo\Odbc::ATTR_USE_CURSOR_LIBRARY

This option controls whether the ODBC cursor library is used. The ODBC cursor library supports some advanced ODBC features (e.g. block scrollable cursors), which may not be implemented by the driver. The following values are supported:

Pdo\Odbc::SQL_USE_IF_NEEDED: Use the ODBC cursor library when needed. This is the default.
Pdo\Odbc::SQL_USE_DRIVER: Never use the ODBC cursor library.
Pdo\Odbc::SQL_USE_ODBC: Always use the ODBC cursor library.

Pdo\Odbc::ATTR_ASSUME_UTF8

Windows only. If true, UTF-16 encoded character data (CHAR, VARCHAR and LONGVARCHAR) is converted to UTF-8 when reading from or writing data to the database. If false (the default), character encoding conversion may be done by the driver.