odbc_tables

    (PHP 4, PHP 5, PHP 7, PHP 8)

    odbc_tables — Get the list of table names stored in a specific data source

    Descrição

    odbc_tables(
        resource$odbc,
        ?string$catalog = null,
        ?string$schema = null,
        ?string$table = null,
        ?string$types = null
    ): resource|false

    Lists all tables in the requested range.

    To support enumeration of qualifiers, owners, and table types, the following special semantics for the catalog, schema, table, and table_type are available:

    • If catalog is a single percent character (%) and schema and table are empty strings, then the result set contains a list of valid qualifiers for the data source. (All columns except the TABLE_QUALIFIER column contain NULLs.)
    • If schema is a single percent character (%) and catalog and table are empty strings, then the result set contains a list of valid owners for the data source. (All columns except the TABLE_OWNER column contain NULLs.)
    • If table_type is a single percent character (%) and catalog, schema and table are empty strings, then the result set contains a list of valid table types for the data source. (All columns except the TABLE_TYPE column contain NULLs.)

    Parâmetros

    odbc

    O identificador da conexão ODBC. Consulte odbc_connect() para obter detalhes.

    catalog

    O catálogo ('qualifier' na linguagem ODBC 2).

    schema

    O esquema ('owner' na linguagem ODBC 2). Este parâmetro aceita os seguintes padrões de pesquisa: % para corresponder a zero ou mais caracteres e _ para corresponder a um único caractere.

    table

    The name. Este parâmetro aceita os seguintes padrões de pesquisa: % para corresponder a zero ou mais caracteres e _ para corresponder a um único caractere.

    types

    If table_type is not an empty string, it must contain a list of comma-separated values for the types of interest; each value may be enclosed in single quotes (') or unquoted. For example, 'TABLE','VIEW' or TABLE, VIEW. If the data source does not support a specified table type, odbc_tables() does not return any results for that type.

    Valor Retornado

    Returns an ODBC result identifier containing the information ou false em caso de falha.

    The result set has the following columns:

    • TABLE_CAT
    • TABLE_SCHEM
    • TABLE_NAME
    • TABLE_TYPE
    • REMARKS
    Drivers podem listar colunas adicionais.

    The result set is ordered by TABLE_TYPE, TABLE_CAT, TABLE_SCHEM and TABLE_NAME.

    Registro de Alterações

    VersãoDescrição
    8.0.0schema, table and types are now nullable.

    Exemplos

    Exemplo #1 List Tables in a Catalog

    <?php
    $conn     = odbc_connect($dsn, $user, $pass);
    $tables = odbc_tables($conn, 'SalesOrders', 'dbo', '%', 'TABLE');
    while ((    $row = odbc_fetch_array($tables))) {
    print_r($row);
    break;     // further rows omitted for brevity
    }
    ?>

    O exemplo acima produzirá algo semelhante a:

    Array ( [TABLE_CAT] => SalesOrders [TABLE_SCHEM] => dbo [TABLE_NAME] => Orders [TABLE_TYPE] => TABLE [REMARKS] => )

    Veja Também

    To Top