PHPackages                             softr/mako-schema-builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. softr/mako-schema-builder

ActiveLibrary[Framework](/categories/framework)

softr/mako-schema-builder
=========================

Database Schema Builder package for Mako Framework

1.0.x-dev(9y ago)3831PHPPHP >=5.4

Since Nov 25Pushed 7y ago1 watchersCompare

[ Source](https://github.com/softr/mako-schema-builder)[ Packagist](https://packagist.org/packages/softr/mako-schema-builder)[ Docs](https://github.com/softr/mako-schema-builder)[ RSS](/packages/softr-mako-schema-builder/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (2)Used By (0)

Mako Schema Builder
===================

[](#mako-schema-builder)

This is a simple database schema builder package for Mako Framework >=4.5.

This package runs on top of [Phinx](https://phinx.org/)

Install
-------

[](#install)

Use composer to install. Simply add package to your project.

```
composer require softr/mako-schema-builder:*
```

So now you can update your project with a single command.

```
composer update
```

### Register Service

[](#register-service)

After installing you'll have to register the package in your `app/config/application.php` file.

```
'packages' =>
[
    ...
    'web' =>
    [
        ...
        // Register the package for web app
        'softr\MakoSchemaBuilder\SchemaPackage',
    ],
    'cli' =>
    [
        ...
        // Register the package for command line app
        'softr\MakoSchemaBuilder\SchemaPackage',
    ]
],

```

Creating Tables
---------------

[](#creating-tables)

To create a new database table, use the `create` method. The create method accepts two arguments. The first is the name of the table, while the second is a Closure which receives a object used to define the new table:

```
$this->schema->create('users', function($table)
{
    $table
        ->addColumn('username', 'string', ['limit' => 20])
        ->addColumn('password', 'string', ['limit' => 40])
        ->addColumn('password_salt', 'string', ['limit' => 40])
        ->addColumn('email', 'string', ['limit' => 100])
        ->addIndex(['username', 'email'], ['unique' => true]);
});
```

Modifying Tables
----------------

[](#modifying-tables)

To modify an existing table, use the `table` method. The table method accepts two arguments. The first is the name of the table, while the second is a Closure which receives a object used to define the table wich will be modified:

```
$this->schema->table('users', function($table)
{
    $table->addColumn('username', 'string', ['limit' => 20])
          ->changeColumn('email', 'string', ['limit' => 255]);
});
```

Connection
----------

[](#connection)

You can also specify an alternative connection. Just use the `connection` method specifing the connection name.

```
$this->schema->connection('foo')->create('table', function($table)
{
    ....
});
```

Renaming / Dropping Tables
--------------------------

[](#renaming--dropping-tables)

To rename an existing database table, use the `renameTable` method:

```
$this->schema->renameTable('from', 'to');
```

To drop an existing table, you may use the `dropTable` or `dropIfExists` methods:

```
$this->schema->dropTable('users');

$this->schema->dropIfExists('users');
```

Checking For Table / Column Existence
-------------------------------------

[](#checking-for-table--column-existence)

You may easily check for the existence of a table or column using the `hasTable`, `hasColumn` and `hasColumns` methods:

```
if($this->schema->hasTable('users'))
{
    // Do something
}

if($this->schema->hasColumn('users', 'email'))
{
    // Do something
}

if($this->schema->hasColumns('users', ['name', 'email']))
{
    // Only returns true if all fields exists on table
}
```

Working With Columns
--------------------

[](#working-with-columns)

#### Get a column list

[](#get-a-column-list)

To retrieve all table columns, simply call the `getTableColumns` method. This method will return an array of column names.

```
$columns = $this->schema->getTableColumns('users');
```

#### Renaming a Column

[](#renaming-a-column)

To rename a column access an instance of the Table object then call the `renameColumn` method.

```
$table->renameColumn('bio', 'biography');
```

#### Adding a Column After Another Column

[](#adding-a-column-after-another-column)

When adding a column you can dictate its position using the after option.

```
$table->addColumn('city', 'string', ['after' => 'email']);
```

#### Dropping a Column

[](#dropping-a-column)

To drop a column, use the `removeColumn` method.

```
$table->removeColumn('short_name');
```

#### Specifying a Column Limit

[](#specifying-a-column-limit)

You can limit the maximum length of a column by using the limit option.

```
$table->addColumn('short_name', 'string', ['limit' => 30]);
```

#### Changing Column Attributes

[](#changing-column-attributes)

To change column type or options on an existing column, use the `changeColumn` method.

```
$table->changeColumn('email', 'string', ['limit' => 255]);
```

Working with Indexes
--------------------

[](#working-with-indexes)

To add an index to a table you can simply call the addIndex() method on the table object.

```
$table->addIndex(['email']);
```

We can pass an additional parameter to the addIndex() method to specify a unique index.

```
$table->addIndex(['email'], ['unique' => true]);
```

Removing indexes is as easy as calling the removeIndex() method. You must call this method for each index.

```
$table->removeIndex(['email']);
```

Working With Foreign Keys
-------------------------

[](#working-with-foreign-keys)

Phinx has support for creating foreign key constraints on your database tables. Let’s add a foreign key to an example table:

```
$this->schema->create('tags', function($table)
{
    $table->addColumn('tag_name', 'string')
});

$this->schema->create('tag_relationships', function($table)
{
    $table->addColumn('tag_id', 'integer')
          ->addForeignKey('tag_id', 'tags', 'id', ['delete'=> 'SET_NULL', 'update'=> 'NO_ACTION']);
});
```

It is also possible to pass `addForeignKey` an array of columns. This allows us to establish a foreign key relationship to a table which uses a combined key.

```
$this->schema->table('follower_events', function($table)
{
    $table->addColumn('user_id', 'integer')
          ->addColumn('follower_id', 'integer')
          ->addColumn('event_id', 'integer')
          ->addForeignKey(['user_id', 'follower_id'], 'followers', ['user_id', 'follower_id'], ['delete'=> 'NO_ACTION', 'update'=> 'NO_ACTION']);
});
```

We can also easily check if a foreign key exists:

```
$this->schema->table('tag_relationships', function($table)
{
    if($table->hasForeignKey('tag_id'))
    {
        // do something
    }
});
```

Finally to delete a foreign key use the `dropForeignKey` method.

```
$this->schema->table('tag_relationships', function($table)
{
    $table->dropForeignKey('tag_id');
});
```

Valid Column Types
------------------

[](#valid-column-types)

For a full accepted column types please check the oficial documentation avaliable [on this link](http://docs.phinx.org/en/latest/migrations.html#valid-column-types)

Limitations
-----------

[](#limitations)

This package was tested only with `MySQL` databases. Please feel free to contribute to this project.

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community5

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3451d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0bbb75946e7d75134253ef101e005e3b645577ef13c754d9ca2264f91377359e?d=identicon)[aldoanizio](/maintainers/aldoanizio)

---

Tags

frameworkschemadatabasemakophinx

### Embed Badge

![Health badge](/badges/softr-mako-schema-builder/health.svg)

```
[![Health](https://phpackages.com/badges/softr-mako-schema-builder/health.svg)](https://phpackages.com/packages/softr-mako-schema-builder)
```

###  Alternatives

[kohana/database

The official Kohana module for database interactions, building queries, and prepared statements

158486.0k19](/packages/kohana-database)[kohana/orm

The official Kohana ORM module

15772.1k8](/packages/kohana-orm)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)