Edit Report a Bug

    odbc_tables

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

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

    Description

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

    Parameters

    odbc

    The ODBC connection identifier, see odbc_connect() for details.

    catalog

    The catalog ('qualifier' in ODBC 2 parlance).

    schema

    The schema ('owner' in ODBC 2 parlance). This parameter accepts the following search patterns: % to match zero or more characters, and _ to match a single character.

    table

    The name. This parameter accepts the following search patterns: % to match zero or more characters, and _ to match a single character.

    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.

    Return Values

    Returns an ODBC result identifier containing the information or false on failure.

    The result set has the following columns:

    • TABLE_CAT
    • TABLE_SCHEM
    • TABLE_NAME
    • TABLE_TYPE
    • REMARKS
    Drivers can report additional columns.

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

    Changelog

    Version Description
    8.0.0 schema, table and types are now nullable.

    Examples

    Example #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
    }
    ?>

    The above example will output something similar to:

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

    See Also

    add a note add a note

    User Contributed Notes 4 notes

    up
    2
    liquidicee at hotmail dot com
    23 years ago
    Here's how to get a list of all the tables in your database.. with an actual example of how its done and how to get the results.. and you don't need to put in schema and all that other crap

    <?php
    $conn     = odbc_connect("$database", "$username", "$password");
    $tablelist = odbc_tables($conn);
    while (    odbc_fetch_row($tablelist)) {
    if (    odbc_result($tablelist, 4) == "TABLE")
    echo     odbc_result($tablelist, 3) ."<br>";
    }
    ?>

    to understand what the above is doing,
    use odbc_result_all($tablelist); this will show you EVERYTHING returned by odbc_tables() then you can look through it and see better how odbc_tables() works and what exactly it returns in the string to get a better idea on how to deal with it.
    it would have saved me alot of time if i would have just taken a look at the full string returned by odbc_tables(), so i suggest you take the minute or two and look... here is an example of how to do it..which would have been helpful for me ;x.

    <?php
    $conn     = odbc_connect("$database", "$username", "$password");
    $tablelist = odbc_tables($conn);
    while (    odbc_fetch_row($tablelist)) {
    echo     odbc_result_all($tablelist);
    }
    ?>

    hopefully this will help some people.. i have alot more to add about this but no time :(
    so again hope this helps.
    Liquidice
    up
    1
    iggvopvantoodlwin
    20 years ago
    With regard to the note made on results not working.
    Test the database with the easy:

    odbc_result_all(odbc_tables($db));

    $db is obviously a connected batadase. Then start to experiment:

    if(!$odbcr=odbc_tables($db,"udb","", "%", "'TABLE'"))

    "udb" is the DNS - aka 'name of my ODBC database in the Windows ODBC thingamy'. In result_all the full path was shown but I just used the name I assigned; either should work.

    The second parameter "" is listed by result_all as "TABLE_SCHEM" and all items were "NULL", so I have put "".

    The third parameter is "%". According to result_all this col is "TABLE_NAME", so I could have put the name of one of my tables, i.e. "Address".

    In my case I have an Access database setup with several tables. In ODBC I have created a link. Running the all on everything result above shows a set of system tables which I do not need to know about at this point so I look at the result and then build my new table check using the "TABLE" string as the tables I am interested in are listed as "TABLE" under their "TABLE_TYPE" column.
    up
    -1
    narcomweb at wanadoo dot fr
    19 years ago
    Here a Code for listing Table names
    <?php
    $dbh     = odbc_connect($dsn, $user, $pwd);

           $result = odbc_tables($dbh);

           $tables = array();
       while (    odbc_fetch_row($result)){
         if(    odbc_result($result,"TABLE_TYPE")=="TABLE")
           echo    "<br>".odbc_result($result,"TABLE_NAME");

       }
    ?>
    You don't have views or System tables with.
    Only simple tables in your database.
    up
    -5
    pmains at ux dot com
    19 years ago
    This probably works for a variety of formats, but if you want a list of *just* the table names from an SQL dsn source (I'm using MSSQL), here's the code.

    <?php

    # ... assign $dsn, $uid, & $pwd ...

    $dbh = odbc_connect($dsn, $uid, $pwd);

            $result = odbc_tables($dbh);
       
            $tables = array();
        while (    odbc_fetch_row($result))
                array_push($tables, odbc_result($result, "TABLE_NAME") );
       
        foreach(     $tables as $t ) {
            echo     "$t\n";   
        }

    ?>
    add a note add a note
    To Top