Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hectororm/schema

Hector Schema is the schema generator module of Hector ORM. Can be used independently of ORM.
https://github.com/hectororm/schema

orm pdo php php8 schema sql

Last synced: about 1 month ago
JSON representation

Hector Schema is the schema generator module of Hector ORM. Can be used independently of ORM.

Host: GitHub
URL: https://github.com/hectororm/schema
Owner: hectororm
License: mit
Created: 2021-01-26T21:02:47.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-09-25T15:04:10.000Z (about 2 months ago)
Last Synced: 2024-09-28T20:40:50.722Z (about 2 months ago)
Topics: orm, pdo, php, php8, schema, sql
Language: PHP
Homepage: https://gethectororm.com
Size: 2.32 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Hector Schema

[![Latest Version](https://img.shields.io/packagist/v/hectororm/schema.svg?style=flat-square)](https://github.com/hectororm/schema/releases)

[![Software license](https://img.shields.io/github/license/hectororm/schema.svg?style=flat-square)](https://github.com/hectororm/schema/blob/main/LICENSE)

[![Build Status](https://img.shields.io/github/actions/workflow/status/hectororm/schema/tests.yml?branch=main&style=flat-square)](https://github.com/hectororm/schema/actions/workflows/tests.yml?query=branch%3Amain)

[![Quality Grade](https://img.shields.io/codacy/grade/7a46b10dec0a43268fab3de12d0f0529/main.svg?style=flat-square)](https://app.codacy.com/gh/hectororm/schema)

[![Total Downloads](https://img.shields.io/packagist/dt/hectororm/schema.svg?style=flat-square)](https://packagist.org/packages/hectororm/schema)

**Hector Schema** is the schema generator module of Hector ORM. Can be used independently of ORM.

## Installation

### Composer

You can install **Hector Schema** with [Composer](https://getcomposer.org/), it's the recommended installation.

```bash

$ composer require hectororm/schema

```

### Dependencies

* **PHP** ^8.0

* Packages dependencies:

  * **hectororm/connection**

## DBMS compatibility

| DBMS    | Version | Compatibility |

|---------|:-------:|:-------------:|

| MySQL   |   8.0   |       ✔       |

| MySQL   |   5.7   |       ✔       |

| MySQL   |   5.6   |       ✔       |

| MySQL   |   5.5   |       ?       |

| MariaDB |  10.6   |       ✔       |

| MariaDB |  10.5   |       ✔       |

| MariaDB |  10.4   |       ✔       |

| MariaDB |  10.3   |       ✔       |

| MariaDB |  10.2   |       ?       |

| Sqlite  |   3.x   |       ✔       |

If you have any information on the compatibility of other versions, feel free to make a PR. 

## Usage

### Generate a schema

```php

use Hector\Connection\Connection;

use Hector\Schema\Generator\MySQL;

$connection = new Connection('...');

$generator = new MySQL($connection);

$schema = $generator->generateSchema('schema_name'); // Returns a `Hector\Schema\Schema` object

$container = $generator->generateSchemas('schema1_name', 'schema2_name'); // Returns a `Hector\Schema\SchemaContainer` object

```

Generators:

- `Hector\Schema\Generato\MySQL` for MySQL or derived DBMS

- `Hector\Schema\Generato\Sqlite` for Sqlite

### Cache

This library don't provide cache management for schemas.

It's to the user library to imagine how store the generated schema.

To help to do that, library only provide serialization of objects and restoration of inheritance between objects.

### Schema

Description of classes represents the a schema.

#### `Hector\Schema\SchemaContainer`

It's a container of schema. Methods available:

- `SchemaContainer::getSchemas(?string $connection = null): Generator` Returns a generator of `Hector\Schema\Schema` objects, you can pass a specific connection

- `SchemaContainer::hasSchema(string $name, ?string $connection = null): bool` Check if container has a schema

- `SchemaContainer::getSchema(string $name, ?string $connection = null): Schema` Returns representation of a schema, an `Hector\Schema\Schema` object

- `SchemaContainer::hasTable(string $name, ?string $schemaName = null, ?string $connection = null): bool` Check if a schema in the container has a table

- `SchemaContainer::getTable(string $name, ?string $schemaName = null, ?string $connection = null): Table` Returns representation of a table, an `Hector\Schema\Table` object

It's an iterable class, returns `Hector\Schema\Schema` objects.

#### `Hector\Schema\Schema`

Represent a schema. Methods available:

- `Schema::getName(bool $quoted = false): string` Returns the name of schema

- `Schema::getCharset(): string` Returns the charset of schema

- `Schema::getCollation(): string` Returns the charset of schema

- `Schema::getTables(): Generator` Returns a generator of `Hector\Schema\Table` objects

- `Schema::hasTable(string $name): bool` Check if schema has a table

- `Schema::getTable(string $name): Table` Returns representation of a table, an `Hector\Schema\Table` object

- `Schema::getContainer(): ?SchemaContainer` Returns the container of schema if it's a part of a container

It's an iterable class, returns `Hector\Schema\Table` objects.

#### `Hector\Schema\Table`

Represent a table of a schema. Methods available:

- `Table::getSchemaName(bool $quoted = false): string`

- `Table::getName(bool $quoted = false): string`

- `Table::getFullName(bool $quoted = false): string`

- `Table::getType(): string`

- `Table::getCharset(): ?string`

- `Table::getCollation(): ?string`

- `Table::getColumns(): Generator`

- `Table::getColumnsName(bool $quoted = false, ?string $tableAlias = null): array`

- `Table::hasColumn(string $name): bool`

- `Table::getColumn(string $name): Column`

- `Table::getAutoIncrementColumn(): ?Column`

- `Table::getIndexes(?string $type = null): Generator`

- `Table::hasIndex(string $name): bool`

- `Table::getIndex(string $name): Index`

- `Table::getPrimaryIndex(): ?Index`

- `Table::getForeignKeys(Table $table = null): Generator`

- `Table::getSchema(): Schema`

#### `Hector\Schema\Column`

Represent a column of a table. Methods available:

- `Column::getName(bool $quoted = false, ?string $tableAlias = null): string`

- `Column::getFullName(bool $quoted = false): string`

- `Column::getPosition(): int`

- `Column::getDefault(): mixed`

- `Column::isNullable(): bool`

- `Column::getType(): string`

- `Column::isAutoIncrement(): bool`

- `Column::getMaxlength(): ?int`

- `Column::getNumericPrecision(): ?int`

- `Column::getNumericScale(): ?int`

- `Column::isUnsigned(): bool`

- `Column::getCharset(): ?string`

- `Column::getCollation(): ?string`

- `Column::getTable(): Table`

- `Column::isPrimary(): bool`

#### `Hector\Schema\Index`

Represent an index of a table. Methods available:

- `Index::getName(): string`

- `Index::getType(): string`

- `Index::getColumnsName(bool $quoted = false, ?string $tableAlias = null): array`

- `Index::getTable(): Table`

- `Index::getColumns(): array`

- `Index::hasColumn(Column $column): bool`

#### `Hector\Schema\ForeignKey`

Represent a foreign key of a table. Methods available:

- `ForeignKey::getName(): string`

- `ForeignKey::getColumnsName(bool $quoted = false, ?string $tableAlias = null): array`

- `ForeignKey::getReferencedSchemaName(): string`

- `ForeignKey::getReferencedTableName(): string`

- `ForeignKey::getReferencedColumnsName(bool $quoted = false, ?string $tableAlias = null): array`

- `ForeignKey::getUpdateRule(): string`

- `ForeignKey::getDeleteRule(): string`

- `ForeignKey::getTable(): Table`

- `ForeignKey::getColumns(): Generator`

- `ForeignKey::getReferencedTable(): ?Table`

- `ForeignKey::getReferencedColumns(): Generator`