Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elusivecodes/fyreschema
FyreSchema is a free, open-source database schema library for PHP.
https://github.com/elusivecodes/fyreschema
database mysql php postgreql schema sqlite
Last synced: about 1 month ago
JSON representation
FyreSchema is a free, open-source database schema library for PHP.
- Host: GitHub
- URL: https://github.com/elusivecodes/fyreschema
- Owner: elusivecodes
- License: mit
- Created: 2022-01-16T09:14:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-08T12:33:53.000Z (about 2 months ago)
- Last Synced: 2024-11-08T13:07:20.762Z (about 2 months ago)
- Topics: database, mysql, php, postgreql, schema, sqlite
- Language: PHP
- Homepage:
- Size: 198 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FyreSchema
**FyreSchema** is a free, open-source database schema library for *PHP*.
## Table Of Contents
- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Methods](#methods)
- [Schemas](#schemas)
- [Table Schemas](#table-schemas)
## Installation
**Using Composer**
```
composer require fyre/schema
```
In PHP:
```php
use Fyre\Schema\SchemaRegistry;
```
## Basic Usage
- `$container` is a [*Container*](https://github.com/elusivecodes/FyreContainer).
```php
$schemaRegistry = new SchemaRegistry($container);
```
**Autoloading**
It is recommended to bind the *SchemaRegistry* to the [*Container*](https://github.com/elusivecodes/FyreContainer) as a singleton.
```php
$container->singleton(SchemaRegistry::class);
```
Any dependencies will be injected automatically when loading from the [*Container*](https://github.com/elusivecodes/FyreContainer).
```php
$schemaRegistry = $container->use(SchemaRegistry::class);
```
## Methods
**Map**
Map a [*Connection*](https://github.com/elusivecodes/FyreDB#connections) class to a [*Schema*](#schemas) handler.
- `$connectionClass` is a string representing the [*Connection*](https://github.com/elusivecodes/FyreDB#connections) class name.
- `$schemaClass` is a string representing the [*Schema*](#schemas) class name.
```php
$schemaRegistry->map($connectionClass, $schemaClass);
```
**Use**
Load the shared [*Schema*](#schemas) for a [*Connection*](https://github.com/elusivecodes/FyreDB#connections).
- `$connection` is a [*Connection*](https://github.com/elusivecodes/FyreDB#connections).
```php
$schema = $schemaRegistry->use($connection);
```
[*Schema*](#schemas) dependencies will be resolved automatically from the [*Container*](https://github.com/elusivecodes/FyreContainer).
## Schemas
**Clear**
Clear data from the cache.
```php
$schema->clear();
```
**Describe**
Get the [*TableSchema*](#table-schemas) for a table.
- `$name` is a string representing the table name.
```php
$tableSchema = $schema->describe($name);
```
[*TableSchema*](#table-schemas) dependencies will be resolved automatically from the [*Container*](https://github.com/elusivecodes/FyreContainer).
**Get Connection**
Get the [*Connection*](https://github.com/elusivecodes/FyreDB#connections).
```php
$connection = $schema->getConnection();
```
**Get Database Name**
Get the database name.
```php
$database = $schema->getDatabaseName();
```
**Has Table**
Determine whether the schema has a table.
- `$name` is a string representing the table name.
```php
$hasTable = $schema->hasTable($name);
```
**Table**
Get the data for a table.
- `$name` is a string representing the table name.
```php
$table = $schema->table($name);
```
**Table Names**
Get the names of all schema tables.
```php
$tableNames = $schema->tableNames();
```
**Tables**
Get the data for all schema tables.
```php
$tables = $schema->tables();
```
## Table Schemas
**Clear**
Clear data from the cache.
```php
$tableSchema->clear();
```
**Column**
Get the data for a table column.
- `$name` is a string representing the column name.
```php
$column = $tableSchema->column($name);
```
**Column Names**
Get the names of all table columns.
```php
$columnNames = $tableSchema->columnNames();
```
**Columns**
Get the data for all table columns.
```php
$columns = $tableSchema->columns();
```
**Default Value**
Get the default value for a column.
- `$name` is a string representing the column name.
```php
$defaultValue = $tableSchema->defaultValue($name);
```
This method will evaluate expression values (eg. *current_timestamp()*).
**Foreign Key**
Get the data for a table foreign key.
- `$name` is a string representing the foreign key name.
```php
$foreignKey = $tableSchema->foreignKey($name);
```
**Foreign Keys**
Get the data for all table foreign keys.
```php
$foreignKeys = $tableSchema->foreignKeys();
```
**Get Schema**
Get the [*Schema*](#schemas).
```php
$schema = $tableSchema->getSchema();
```
**Get Table Name**
Get the table name.
```php
$tableName = $tableSchema->getTableName();
```
**Get Type**
Get the [*Type*](https://github.com/elusivecodes/FyreTypeParser) parser for a column.
- `$name` is a string representing the column name.
```php
$parser = $tableSchema->getType($name);
```
**Has Auto Increment**
Determine whether the table has an auto increment column.
```php
$hasAutoIncrement = $tableSchema->hasAutoIncrement();
```
**Has Column**
Determine whether the table has a column.
- `$name` is a string representing the column name.
```php
$hasColumn = $tableSchema->hasColumn($name);
```
**Has Foreign Key**
Determine whether the table has a foreign key.
- `$name` is a string representing the foreign key name.
```php
$hasForeignKey = $tableSchema->hasForeignKey($name);
```
**Has Index**
Determine whether the table has an index.
- `$name` is a string representing the index name.
```php
$hasIndex = $tableSchema->hasIndex($name);
```
**Index**
Get the data for a table index.
- `$name` is a string representing the index name.
```php
$index = $tableSchema->index($name);
```
**Indexes**
Get the data for all table indexes.
```php
$indexes = $tableSchema->indexes();
```
**Is Nullable**
Determine whether a table column is nullable.
- `$name` is a string representing the column name.
```php
$isNullable = $tableSchema->isNullable($name);
```
**Primary Key**
Get the primary key for the table.
```php
$primaryKey = $tableSchema->primaryKey();
```