explosivebit/yii2-arangodb

Yii2 arangodb components

Описание на Русском, _(*1)

ArangoDb Extension for Yii 2

This extension provides the ArangoDB integration for the Yii2 framework., _(*2)

Installation

This extension requires ArangoDB PHP Extension, _(*3)

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

Either run, _(*5)

php composer.phar require --prefer-dist explosivebit/yii2-arangodb "*"

or add, _(*6)

"explosivebit/yii2-arangodb": "*"

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

General Usage

To use this extension, simply add the following code in your application configuration:, _(*8)

return [
    //....
    'components' => [
        'arangodb' => [
            'class' => '\explosivebit\arangodb\Connection',
            'connectionOptions' => [
                ArangoDBClient\ConnectionOptions::OPTION_DATABASE => "mydatabase",
                ArangoDBClient\ConnectionOptions::OPTION_ENDPOINT => 'tcp://127.0.0.1:8529',
                ArangoDBClient\ConnectionOptions::OPTION_AUTH_TYPE => 'Basic',
                //ArangoDBClient\ConnectionOptions::OPTION_AUTH_USER   => '',
                //ArangoDBClient\ConnectionOptions::OPTION_AUTH_PASSWD => '',
            ],
        ],
    ],
];

Using the connection instance you may access databases, collections and documents., _(*9)

To perform "find" queries, you should use [[\explosivebit\arangodb\Query]]:, _(*10)

use explosivebit\arangodb\Query;

$query = new Query;
// compose the query
$query->select(['name', 'status'])
    ->from('customer')
    ->limit(10);
// execute the query
$rows = $query->all();

Using the ArangoDB ActiveRecord

This extension provides ActiveRecord solution similar ot the [[\yii\db\ActiveRecord]]. To declare an ActiveRecord class you need to extend [[\explosivebit\arangodb\ActiveRecord]] and implement the collectionName and 'attributes' methods:, _(*11)

use explosivebit\arangodb\ActiveRecord;

class Customer extends ActiveRecord
{
    /**
     * @return string the name of the index associated with this ActiveRecord class.
     */
    public static function collectionName()
    {
        return 'customer';
    }

    /**
     * @return array list of attribute names.
     */
    public function attributes()
    {
        return ['_key', 'name', 'email', 'address', 'status'];
    }
}

Note: collection primary key name ('_key') should be always explicitly setup as an attribute., _(*12)

You can use [[\yii\data\ActiveDataProvider]] with [[\explosivebit\arangodb\Query]] and [[\explosivebit\arangodb\ActiveQuery]]:, _(*13)

use yii\data\ActiveDataProvider;
use explosivebit\arangodb\Query;

$query = new Query;
$query->from('customer')->where(['status' => 2]);
$provider = new ActiveDataProvider([
    'query' => $query,
    'pagination' => [
        'pageSize' => 10,
    ]
]);
$models = $provider->getModels();

use yii\data\ActiveDataProvider;
use app\models\Customer;

$provider = new ActiveDataProvider([
    'query' => Customer::find(),
    'pagination' => [
        'pageSize' => 10,
    ]
]);
$models = $provider->getModels();

Using Migrations

ArangoDB migrations are managed via [[explosivebit\arangodb\console\controllers\MigrateController]], which is an analog of regular [[\yii\console\controllers\MigrateController]]., _(*14)

In order to enable this command you should adjust the configuration of your console application:, _(*15)

return [
    // ...
    'controllerMap' => [
        'arangodb-migrate' => 'explosivebit\arangodb\console\controllers\MigrateController'
    ],
];

Below are some common usages of this command:, _(*16)

# creates a new migration named 'create_user_collection'
yii arangodb-migrate/create create_user_collection

# applies ALL new migrations
yii arangodb-migrate

# Apply 1 migration
yii arangodb-migrate/up 1

# reverts the last applied migration
yii arangodb-migrate/down

# Rollback 1 migration
yii arangodb-migrate/down 1

Once migration created, you can configure the migration:, _(*17)

When you start the migration as in the example below, you create a normal document collection with the migration name, you need to add an additional parameter Type => 3 to create the edge collection. Example of such a query: $this-> createCollection ('services', ['Type' => 3] ); If you want to create a document collection, then delete the 'Type' => 3 or replace the number 3 with 2., _(*18)

class m170413_210957_create_services_collection extends \explosivebit\arangodb\Migration
{
    public function up()
    {
        # When you start the migration, a collection of "services" with the edge type is created
        $this->createCollection('services',['Type' => 3]);
    }

    public function down()
    {
        # When the migration rollback starts, the collection "services"
        $this->dropCollection('services');
    }
}

Using Debug Panel

Add ArangoDb panel to your yii\debug\Module configuration, _(*19)

return [
    'bootstrap' => ['debug'],
    'modules' => [
        'debug' => 'yii\debug\Module',
        'panels' => [
            'arango' => [
                'class' => 'explosivebit\arangodb\panels\arangodb\ArangoDbPanel',
            ],
        ],
        ...
    ],
    ...
];

, _(*20)