https://github.com/cycle/schema-builder

Declarative schema generation for Cycle ORM
https://github.com/cycle/schema-builder

cycle datamapper hacktoberfest orm php schema

Last synced: 10 months ago
JSON representation

Declarative schema generation for Cycle ORM

• Host: GitHub
• URL: https://github.com/cycle/schema-builder
• Owner: cycle
• License: mit
• Created: 2019-02-18T11:14:31.000Z (almost 7 years ago)
• Default Branch: 2.x
• Last Pushed: 2024-12-13T15:53:08.000Z (about 1 year ago)
• Last Synced: 2025-03-30T00:09:53.401Z (11 months ago)
• Topics: cycle, datamapper, hacktoberfest, orm, php, schema
• Language: PHP
• Homepage:
• Size: 575 KB
• Stars: 16
• Watchers: 6
• Forks: 12
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Cycle ORM - Schema Builder

[![Latest Stable Version](https://poser.pugx.org/cycle/schema-builder/version)](https://packagist.org/packages/cycle/schema-builder)

[![Build Status](https://github.com/cycle/schema-builder/workflows/build/badge.svg)](https://github.com/cycle/schema-builder/actions)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/schema-builder/badges/quality-score.png?b=2.x)](https://scrutinizer-ci.com/g/cycle/schema-builder/?branch=2.x)

[![Codecov](https://codecov.io/gh/cycle/schema-builder/graph/badge.svg)](https://codecov.io/gh/cycle/schema-builder)

Schema Builder package provides a convenient way to configure your ORM and Database schema via 

[annotations (attributes)](https://github.com/cycle/annotated) or custom generators.

## Installation

```bash

composer require cycle/schema-builder

```

## Configuration

```php

use Cycle\Migrations;

use Cycle\Database;

use Cycle\Database\Config;

$dbal = new Database\DatabaseManager(new Config\DatabaseConfig([

    'default' => 'default',

    'databases' => [

        'default' => [

            'connection' => 'sqlite'

        ]

    ],

    'connections' => [

        'sqlite' => new Config\SQLiteDriverConfig(

            connection: new Config\SQLite\MemoryConnectionConfig(),

            queryCache: true,

        ),

    ]

]));

$registry = new \Cycle\Schema\Registry($dbal);

```

We can now register our first entity, add its columns and link to a specific table:

```php

use Cycle\Schema\Definition;

$entity = new Definition\Entity();

$entity

    ->setRole('user')

    ->setClass(User::class);

// add fields

$entity->getFields()

    ->set('id', (new Definition\Field())->setType('primary')->setColumn('id')->setPrimary(true))

    ->set('name', (new Definition\Field())->setType('string(32)')->setColumn('user_name'));

// register entity

$r->register($entity);

// associate table

$r->linkTable($entity, 'default', 'users');

```

You can generate ORM schema immediately using `Cycle\Schema\Compiler`:

```php

use Cycle\Schema\Compiler;

$schema = (new Compiler())->compile($r);

$orm = $orm->with(schema: new \Cycle\ORM\Schema($schema));

```

You can find more information about Schema builder package [here](https://cycle-orm.dev/docs/advanced-schema-builder).

License:

--------

The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information. Maintained

by [Spiral Scout](https://spiralscout.com).