aura/sqlschema

Provides facilities to read table names and table columns from a database using PDO.

Aura.SqlSchema

Provides facilities to read table names and table columns from a database using a PDO connection., _(*1)

Foreword

Installation

This library requires PHP 5.3 or later; we recommend using the latest available version of PHP as a matter of principle. It has no userland dependencies., _(*2)

It is installable and autoloadable via Composer as aura/sqlschema., _(*3)

Alternatively, download a release or clone this repository, then require or include its autoload.php file., _(*4)

Quality

, _(*5)

To run the unit tests at the command line, issue phpunit at the package root. (This requires PHPUnit to be available as phpunit.), _(*6)

This library attempts to comply with PSR-1, PSR-2, and PSR-4. If you notice compliance oversights, please send a patch via pull request., _(*7)

Community

To ask questions, provide feedback, or otherwise communicate with the Aura community, please join our Google Group, follow @auraphp on Twitter, or chat with us on #auraphp on Freenode., _(*8)

Getting Started

Instantiation

Instantiate a driver-specific schema object with a matching PDO instance:, _(*9)

Fetching Table Lists

To get a list of tables in the database, issue fetchTableList():, _(*10)

<?php
$tables = $schema->fetchTableList();
foreach ($tables as $table) {
    echo $table . PHP_EOL;
}
?>

Fetching Column Information

To get information about the columns in a table, issue fetchTableCols():, _(*11)

<?php
$cols = $schema->fetchTableCols('table_name');
foreach ($cols as $name => $col) {
    echo "Column $name is of type "
       . $col->type
       . " with a size of "
       . $col->size
       . PHP_EOL;
}
?>

Each column description is a Column object with the following properties:, _(*12)

• name: (string) The column name, _(*13)

• type: (string) The column data type. Data types are as reported by the database., _(*14)

• size: (int) The column size., _(*15)

• scale: (int) The number of decimal places for the column, if any., _(*16)

• notnull: (bool) Is the column marked as NOT NULL?, _(*17)

• default: (mixed) The default value for the column. Note that sometimes this will be null if the underlying database is going to set a timestamp automatically., _(*18)

• autoinc: (bool) Is the column auto-incremented?, _(*19)

• primary: (bool) Is the column part of the primary key?, _(*20)