tigrov/yii2-pgsql

Improved PostgreSQL schemas for Yii2

yii2-pgsql

Improved PostgreSQL schemas for Yii2., _(*1)

Yii 2.0.14 and above supports array and json DB types., _(*2)

Supports follow types for ActiveRecord models: * array, Yii 2.0.14 and above supports array DB type * json, Yii 2.0.14 and above supports json DB type * composite, https://www.postgresql.org/docs/current/static/rowtypes.html * domain, https://www.postgresql.org/docs/current/static/sql-createdomain.html * fixes type bit, issue #7682 * converts Postgres types timestamp, date and time to PHP type \DateTime and vice versa., _(*3)

, _(*4)

Limitation

Since version 1.2.0 requires Yii 2.0.14 and above.
You can use version 1.1.11 if you have Yii 2.0.13 and below., _(*5)

Installation

The preferred way to install this extension is through composer., _(*6)

Either run, _(*7)

php composer.phar require --prefer-dist tigrov/yii2-pgsql

or add, _(*8)

"tigrov/yii2-pgsql": "~1.0"

to the require section of your composer.json file., _(*9)

Configuration

Once the extension is installed, add following code to your application configuration:, _(*10)

return [
    //...
    'components' => [
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'pgsql:host=localhost;dbname=<database>',
            'username' => 'postgres',
            'password' => '<password>',
            'schemaMap' => [
                'pgsql'=> 'tigrov\pgsql\Schema',
            ],
        ],
    ],
];

Specify the desired types for a table, _(*11)

CREATE TABLE public.model (
    id serial NOT NULL,
    attribute1 text[],
    attribute2 jsonb,
    attribute3 timestamp DEFAULT now(),
    CONSTRAINT model_pkey PRIMARY KEY (id)
);

Configure Model's rules, _(*12)

/**
 * @property string[] $attribute1 array of string
 * @property array $attribute2 associative array or just array
 * @property integer|string|\DateTime $attribute3 for more information about the type see \Yii::$app->formatter->asDatetime()
 */
class Model extends ActiveRecord
{
    //...
    public function rules()
    {
        return [
            [['attribute1'], 'each', 'rule' => ['string']],
            [['attribute2', 'attribute3'], 'safe'],
        ];
    }
}

Usage

You can then save array, json and timestamp types in database as follows:, _(*13)

/**
 * @var ActiveRecord $model
 */
$model->attribute1 = ['some', 'values', 'of', 'array'];
$model->attribute2 = ['some' => 'values', 'of' => 'array'];
$model->attribute3 = new \DateTime('now');
$model->save();

and then use them in your code, _(*14)

/**
 * @var ActiveRecord $model
 */
$model = Model::findOne($pk);
$model->attribute1; // is array
$model->attribute2; // is associative array (decoded json)
$model->attribute3; // is \DateTime

Composite types, _(*15)

License

MIT, _(*16)