Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/belgattitude/soluble-schema
Database information schema inspector
https://github.com/belgattitude/soluble-schema
database-schema information-schema mariadb mysql php
Last synced: 28 days ago
JSON representation
Database information schema inspector
- Host: GitHub
- URL: https://github.com/belgattitude/soluble-schema
- Owner: belgattitude
- License: mit
- Created: 2015-12-28T15:03:26.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-17T08:48:36.000Z (about 7 years ago)
- Last Synced: 2024-05-01T14:11:24.561Z (7 months ago)
- Topics: database-schema, information-schema, mariadb, mysql, php
- Language: PHP
- Size: 586 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Soluble\Schema
[](https://packagist.org/packages/soluble/schema)
[](https://travis-ci.org/belgattitude/soluble-schema)
[](https://codecov.io/gh/belgattitude/soluble-schema)
[](https://scrutinizer-ci.com/g/belgattitude/soluble-schema/)
[](https://packagist.org/packages/soluble/schema)
[](https://packagist.org/packages/soluble/schema)
[](https://packagist.org/packages/soluble/schema)
## Introduction
Query your database schema to know everything about your tables, columns, types, foreign keys...
## Features
- Inspect, query and discover your database structure.
- Rely on information schema tables for deep and accurate info.
- Support database extended informations (native types, relations...)
- Fast and reliable implementation (at least as fast as possible).
## Requirements
- PHP engine 5.4+, 7.0+ or HHVM >= 3.2.
## Supported databases
Currently only MySQL and MariaDB are supported.
| Database | Driver | Source class |
|--------------|--------------------|------------------------------------------------------|
| MySQL 5.1+ | pdo_mysql, mysqli | `Soluble\Schema\Source\MysqlInformationSchema` |
| Mariadb 5.5+ | pdo_mysql, mysqli | `Soluble\Schema\Source\MysqlInformationSchema` |
You can create new schema sources (oracle, postgresql...) by implementing the `Soluble\Schema\Source\SchemaSourceInterface`.
Please see the [contribution guide](./CONTRIBUTING.md) and send a pull request.
## Documentation
- [Manual](http://docs.soluble.io/soluble-schema/manual/) in progress and [API documentation](http://docs.soluble.io/soluble-schema/api/) available.
## Installation
Instant installation via [composer](http://getcomposer.org/).
```console
$ composer require soluble/schema:0.*
```
Most modern frameworks will include Composer out of the box, but ensure the following file is included:
```php
"SET NAMES utf8"
]);
/* Alternatively, use a \mysqli connection instead of PDO */
// $conn = new \mysqli($hostname,$username,$password,$database);
// $conn->set_charset($charset);
$schema = new Schema\Source\MysqlInformationSchema($conn);
// By default the schema (database) is taken from current connection.
// If you wnat to query a different schema, set it in the second parameter.
$otherDbSchema = new Schema\Source\MysqlInformationSchema($conn, 'otherDbSchema');
```
### Retrieve table informations in a database schema
```php
getTables();
// Retrieve full information of tables defined in schema
$infos = $schema->getTablesInformation();
// The resulting array looks like
[
["table_name_1"] => [
["name"] => (string) 'Table name'
["columns"] => [ // Columns information,
// @see AbstractSource::getColumnsInformation()
"col name_1" => ["name" => "", "type" => "", ...]',
"col name_2" => ["name" => "", "type" => "", ...]'
]
["primary_keys"] => [ // Primary key column(s) or empty
"pk_col1", "pk_col2"
],
["unique_keys"] => [ // Uniques constraints or empty if none
"unique_index_name_1" => ["col1", "col3"],
"unique_index_name_2" => ["col4"]
],
["foreign_keys"] => [ // Foreign keys columns and their references or empty if none
"col_1" => [
"referenced_table" => "Referenced table name",
"referenced_column" => "Referenced column name",
"constraint_name" => "Constraint name i.e. 'FK_6A2CA10CBC21F742'"
],
"col_2" => [ // ...
]
],
["references"] => [ // Relations referencing this table
"ref_table:ref_column->column1" => [
"column" => "Colum name in this table",
"referencing_table" => "Referencing table name",
"referencing_column" => "Column name in the referencing table",
"constraint_name" => "Constraint name i.e. 'FK_6A2CA10CBC21F742'"
],
"ref_table:ref_column->column2" => [
//...
]
]
["indexes"] => [],
["options"] => [ // Specific table creation options
"comment" => (string) "Table comment",
"collation" => (string) "Table collation, i.e. 'utf8_general_ci'",
"type" => (string) "Table type, i.e: 'BASE TABLE'",
"engine" => (string) "Engine type if applicable, i.e. 'InnoDB'",
]
],
["table_name_2"] => [
//...
]
]
// Test if table exists in schema
if ($schema->hasTable($table)) {
//...
}
```
### Get table columns information
```php
getColumns($table);
// -> ['column_name_1', 'column_name_2']
// Retrieve full columns information from a tabme
$columns = $schema->getColumnsInformation($table);
// resulting column array looks like ->
[
["column_name_1"] => [
["type"] => (string) "Database type, i.e: 'char', 'int', 'bigint', 'decimal'...",
["primary"] => (boolean) "Whether column is (part of) a primary key",
["nullable"] => (boolean) "Whether column is nullable",
["default"] => (string) "Default value for column or null if none",
// Specific to primary key(s) columns
["autoincrement"] => (boolean) "Whether the primary key is autoincremented"
// Specific to numeric, decimal, boolean... types
["unsigned"] => (boolean) "Whether the column is unsigned",
["precision"] => (int) "Number precision (or maximum length)",
// Specific to character oriented types as well as enum, blobs...
["length"] => (int) "Maximum length",
["octet_length"] => (int) "Maximum length in octets (differs from length when using multibyte charsets",
// Columns specific ddl information
["options"] => [ // Column specific options
"comment" => "Column comment",
"definition" => "DDL definition, i.e. varchar(250)",
"ordinal_position" => "Column position number",
"constraint_type" => "Type of constraint if applicable",
"column_key" => "",
"charset" => "Column charset, i.e. 'utf8'",
"collation" => "Column collation, i.e. 'utf8_unicode_ci'"
],
],
["column_name_2"] => [
//...
]
]
```
### Retrieve table primary key(s)
```php
getPrimaryKey($table);
} catch (Schema\Exception\MultiplePrimaryKeyException $e) {
//...
} catch (Schema\Exception\NoPrimaryKeyException $e) {
//...
}
// Get multiple primary keys
try {
$pks = $schema->getPrimaryKeys($table);
} catch (Schema\Exception\NoPrimaryKeyException $e) {
// ...
}
```
### Retrieve information about unique keys
```php
getUniqueKeys($table);
// The resulting array look like
[
"unique_index_name_1" => [
"column_name_1", "column_name_2"
],
"unique_index_name_2" => [ "column_name_1" ]
]
```
### Get foreign keys informations
```php
getForeignKeys($table);
// The resulting array looks like
[
"column_name_1" => [
"referenced_table" => "Referenced table name",
"referenced_column" => "Referenced column name",
"constraint_name" => "Constraint name i.e. 'FK_6A2CA10CBC21F742'"
],
"column_name_2" => [
// ...
]
]
```
### Retrieve references informations
```php
getReferences($table);
// The resulting array looks like
[
"ref_table:ref_column->column1" => [
"column" => "Colum name in this table",
"referencing_table" => "Referencing table name",
"referencing_column" => "Column name in the referencing table",
"constraint_name" => "Constaint name i.e. 'FK_6A2CA10CBC21F742'"
],
"ref_table:ref_column->column2" => [
//...
]
]
```
## API methods
Once a `Schema\Source\SchemaSourceInterface` is intitalized, you have access to the following methods
| Methods | Return | Description |
|---------------------------------|---------------|---------------------------------------------|
| `getSchemaConfig()` | `ArrayObject` | Retrieve full extended schema config |
| `getTables()` | `array` | Retrieve table names |
| `getTablesInformation()` | `array` | Retrieve extended tables information |
| `hasTable()` | `boolean` | Whether table exists |
| `getColumns($table)` | `array` | Retrieve column names |
| `getColumnsInformation($table)` | `array` | Retrieve extended columns information |
| `getPrimaryKey($table)` | `string` | Retrieve primary key (unique) |
| `getPrimaryKeys($table)` | `array` | Retrieve primary keys (multiple) |
| `getUniqueKeys($table)` | `array` | Retrieve unique keys |
| `getForeignKeys($table)` | `array` | Retrieve foreign keys information |
| `getReferences($table)` | `array` | Retrieve referencing tables (relations) |
| `getIndexes($table)` | `array` | Retrieve indexes info |
## Future enhancements
- Supporting more sources like postgres, oracle
- PSR-6 cache implementation
## Contributing
Contribution are welcome see [contribution guide](./CONTRIBUTING.md)
## Coding standards
* [PSR 4 Autoloader](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)
* [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
* [PSR 1 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
* [PSR 0 Autoloading standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)