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/
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
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
Describe requires a vendor-specific driver to get a database table's structure:
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:
After specifying the driver, use the columns method to return a list of columns:
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.
Adding a new database driver
Use the DriverInterface for implementing a vendor-specific driver:
Use-cases
The following projects below uses Describe as a valuable tool:
Combustor
Combustor is a utility package for Codeigniter 3 that generates controllers, models, and views based on the provided database tables. It uses Describe for getting columns from a database table and as the basis for code generation.
Refinery
Refinery is a console-based package of Migrations Class for the Codeigniter 3. It uses Describe for retrieving the database tables for creating database migrations.
Changelog
Please see CHANGELOG for more recent changes.
Development
Includes configuration for code quality, coding style, and unit tests.
[!NOTE] The sub-sections below are for those who need to access the package's source code for development, such as creating fixes or new features.
Code quality
Analyze code quality using phpstan:
Coding style
Enforce coding style using php-cs-fixer:
Unit tests
Execute unit tests using phpunit:
Credits
Big thanks to all contributors in this package!
License
This package uses the MIT Licenses (MIT).
