Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tigrov/yii2-pgsql
Improved PostgreSQL schemas for Yii2
https://github.com/tigrov/yii2-pgsql
pgsql postgres postgresql yii2 yii2-extension
Last synced: 28 days ago
JSON representation
Improved PostgreSQL schemas for Yii2
- Host: GitHub
- URL: https://github.com/tigrov/yii2-pgsql
- Owner: Tigrov
- License: mit
- Created: 2016-10-21T20:39:48.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-10T09:33:06.000Z (about 3 years ago)
- Last Synced: 2024-10-10T22:04:05.516Z (28 days ago)
- Topics: pgsql, postgres, postgresql, yii2, yii2-extension
- Language: PHP
- Homepage:
- Size: 87.9 KB
- Stars: 34
- Watchers: 7
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
yii2-pgsql
==============
Improved PostgreSQL schemas for Yii2.
Yii 2.0.14 and above supports `array` and `json` DB types.
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`](docs/composite.md), 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](https://github.com/yiisoft/yii2/issues/7682)
* converts Postgres types `timestamp`, `date` and `time` to PHP type `\DateTime` and vice versa.
[](https://packagist.org/packages/Tigrov/yii2-pgsql)
[](https://travis-ci.org/Tigrov/yii2-pgsql)
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.
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist tigrov/yii2-pgsql
```
or add
```
"tigrov/yii2-pgsql": "~1.0"
```
to the require section of your `composer.json` file.
Configuration
-------------
Once the extension is installed, add following code to your application configuration:
```php
return [
//...
'components' => [
'db' => [
'class' => 'yii\db\Connection',
'dsn' => 'pgsql:host=localhost;dbname=',
'username' => 'postgres',
'password' => '',
'schemaMap' => [
'pgsql'=> 'tigrov\pgsql\Schema',
],
],
],
];
```
Specify the desired types for a table
```sql
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
```php
/**
* @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:
```php
/**
* @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
```php
/**
* @var ActiveRecord $model
*/
$model = Model::findOne($pk);
$model->attribute1; // is array
$model->attribute2; // is associative array (decoded json)
$model->attribute3; // is \DateTime
```
[Composite types](docs/composite.md)
License
-------
[MIT](LICENSE)