Download the PHP package rougin/describe without Composer
On this page you can find all versions of the php package rougin/describe. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rougin/describe
More information about rougin/describe
Files in rougin/describe
Package describe
Short Description Obtain information of a database table.
License MIT
Homepage https://roug.in/describe/
Informations about the package describe
Describe
Describe is a PHP package that returns information about a table structure from a database.
Installation
Install Describe
via Composer:
Basic Usage
Prior in getting information of a table structure, a vendor-specific driver must be implemented:
Below are the available drivers for specified vendors:
Driver | Description | Vendor |
---|---|---|
Rougin\Describe\Driver\MysqlDriver |
Uses the DESCRIBE query. |
MySQL |
Rougin\Describe\Driver\SqlServerDriver |
Uses the INFORMATION_SCHEMA.COLUMNS query. |
SQL Server |
Rougin\Describe\Driver\SqliteDriver |
Uses the PRAGMA table_info() query. |
SQLite |
Alternatively, the DatabaseDriver
can also be used to use a vendor-specific driver based on keyword:
[!NOTE]
DatabaseDriver
is currently available to driversMysqlDriver
andSqliteDriver
only.
After specifying the driver, use the columns
method to return a list of columns:
Adding a new database driver
To add a new driver for a specified vendor, kindly implement it to a DriverInterface
:
Using Table
The Table
class is similar with the DriverInterface
with the difference that it can return the primary key from the list of columns:
For more information regarding the Column
object, kindly check its code documentation.
Projects using Describe
The following projects below uses Describe
as a valuable tool for getting a structure of a database table:
Combustor is a utility package for Codeigniter 3 that generates controllers, models, and views based on the provided database tables. It uses the Describe package for getting columns from a database table and as the basis for code generation.
Refinery is a console-based package of Migrations Class for the Codeigniter 3. It uses the Describe package for retrieving the database tables for creating database migrations.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
The unit tests for this package were written on PHPUnit:
Credits
License
The MIT License (MIT). Please see LICENSE for more information.