[WIP] Redis ActiveRecord

[cebe]

This is WIP redis ActiveRecord support.
It has the following features:

• insert, update, delete interface is exactly the same as db\ActiveRecord
• relation, relations via (except relations viaTable because there are no tables in a key value store ;) )
• optimistic locking
• dirty attributes
• find() has the same interface as db\ActiveRecord except a few limitations. It does not support select(), from() join(), group(), having(), union()
• complex where conditions via Lua Script which is executed on redis server and will return matching records.

TODO

• support for orderBy(). should be possible to implement via Lua script on server side.
• support LIKE conditions. also possible via pattern matching in Lua script.
• Refactor ActiveRelation in db\AR
  • currently ActiveRelation class is hardcoded in db\AR. redis uses its own implementation which is nearly copy&paste from the db ActiveRelation class but it extends from the custom ActiveQuery.
  • One possible soution could be an interface for ActiveRelation
  • Another solution would be to define the ActiveRelation class via static property in AR class.
  • 6133133 adds a dependency db\AR -> redis\AR which makes it all work but needs to be refactored to remove the dependency.

A redis AR can be created like this:

class Customer extends yii\redis\ActiveRecord
{
    // relation declaration is the same as in db\AR
    /**
     * @return \yii\redis\ActiveRelation
     */
    public function getOrders()
    {
        return $this->hasMany('Order', array('customer_id' => 'id'));
    }

    // also scopes work the same as in db\AR but with limited query options (where is fully supported)
    public static function active($query)
    {
        $query->andWhere(array('status' => 1));
    }
    // this is the only new thing. you have to define attributes and pk yourself as there is no schema in redis
    public static function attributes()
    {
        return ['id', 'email', 'name', 'address', 'status']:
    }

       // primaryKey is "id" by default, can be customized by overriding primaryKey method (can be composite key)
}

[samdark]

ActiveRelationInterface?

[cebe]

Yep, needs to be defined. WIll discuss this with qiang when he has time.

[coveralls]

Coverage increased (+1.18%) when pulling b95c056 on redis into 7d2d925 on master.

[qiangxue]

From the test cases, the usage design looks good to me. One suggestion about ActiveRecord::getRecordSchema(): perhaps this can be replaced by introducing an abstract static method columns() and making both primaryKey() and tableName() static.

Also, why do we need to store the table schema cache in ActiveRecord instead of Connection?

I need more time to think about the class/interface designs.

[cebe]

One suggestion about ActiveRecord::getRecordSchema(): perhaps this can be replaced by introducing an abstract static method columns() and making both primaryKey() and tableName() static.

I tried that once but failed with that. Currently don't remember why. The main reason for recordSchema is that AR internals rely on getTableSchema() in many places. Will try again and see how it works.

Also, why do we need to store the table schema cache in ActiveRecord instead of Connection?

You can use the Connection without having AR. When you use redis itself there is no such thing as a table as redis is a key-value-store so I decided to leave this in AR.

[coveralls]

Coverage remained the same when pulling 179618c on redis into 7d2d925 on master.

[coveralls]

Coverage remained the same when pulling bc4324c on redis into 704f910 on master.

[coveralls]

Coverage increased (+0.46%) when pulling 8542448 on redis into 704f910 on master.

[coveralls]

Coverage remained the same when pulling cb4504a on redis into 704f910 on master.

[cebe]

Reworked the complete redis implementation. From my point it is ready for merge. We can add support for orderBy and Like conditions later if we find need and time for it.

[coveralls]

Coverage increased (+0.78%) when pulling 6995e8d on redis into 704f910 on master.

[coveralls]

Coverage increased (+0.8%) when pulling 6995e8d on redis into 704f910 on master.

[qiangxue]

I have reviewed the code. It looks great to me!

So will you still abstract out common part of ActiveRecord into interface and trait?

[coveralls]

Coverage increased (+0.46%) when pulling ed98df5 on redis into 704f910 on master.

[cebe]

Will do that when I have an idea of how eleasticsearch will work. Elasticsearch does not store the primarykey among the attributes but in an extra _id field. This currently messes up my implementation and is not the only point that is different.
Imo it's better to extract common parts when we have multiple systems that have something in common to see what that common parts actually are.