README

Eloquent syntax for DynamoDB

Custom from https://github.com/baopham/laravel-dynamodb

Supports all key types - primary hash key and composite keys.

For advanced users only. If you're not familiar with Laravel, Laravel Eloquent and DynamoDB, then I suggest that you get familiar with those first.

Breaking Changes for v0.4

• If you're using v0.3 and below, please see here
• To upgrade to v0.4, please see the migration note

• Install
• Usage
• Indexes
• Composite Keys
• Test
• Requirements
• Todo
• License
• Author and Contributors

Install

• Composer install

   composer require quankim/laravel-dynamodb-eloquent-syntax   ```

• Install service provider:

  // config/app.php
  
  'providers' => [
      ...
        QuanKim\DynamoDbEloquentSyntax\DynamoDbServiceProvider::class,
      ...
  ];

• Put DynamoDb config in config/aws.php:

  // config/aws.php
  ...
  'credentials' => [
      'key'    => env('AWS_ACCESS_KEY_ID', ''),
      'secret' => env('AWS_SECRET_ACCESS_KEY', ''),
  ],
  'region' => env('AWS_REGION', 'us-east-1'),
  'version' => 'latest',
  'endpoint' => env('AWS_ENDPOINT', ''),
  ...

Usage

• Extends your model with QuanKim\DynamoDbEloquentSyntax\DynamoDbModel, then you can use Eloquent methods that are supported. The idea here is that you can switch back to Eloquent without changing your queries.

Supported methods:

// find and delete
$model->find(<id>);
$model->delete();

// Using getIterator(). If 'key' is the primary key or a global/local index and the condition is EQ, will use 'Query', otherwise 'Scan'.
$model->where('key', 'key value')->get();

$model->where(['key' => 'key value']);
// Chainable for 'AND'. 'OR' is not supported.
$model->where('foo', 'bar')
    ->where('foo2', '!=' 'bar2')
    ->get();

// Using scan operator, not too reliable since DynamoDb will only give 1MB total of data.
$model->all();

// Basically a scan but with limit of 1 item.
$model->first();

// update
$model->update($attributes);

$model = new Model();
// Define fillable attributes in your Model class.
$model->fillableAttr1 = 'foo';
$model->fillableAttr2 = 'foo';
// DynamoDb doesn't support incremented Id, so you need to use UUID for the primary key.
$model->id = 'de305d54-75b4-431b-adb2-eb6b9e546014'
$model->save();

// chunk
$model->chunk(10, function ($records) {
    foreach ($records as $record) {

    }
});

// Additional
// Where in
$model->where('id', 'in', [])
// Sub query
$model->where(function($q) {
    $q->where('id', 1)
        ->where('name', 'contains', 'a');
})->orWhere('email', 'contains', 'abc'));

// Delete all
$model->where('id', 'in', [1,2,3])->deleteAll();
// Increment/ Decrement a column
$model->increment('view_count', 1);
$model->decrement('total_product', 1);

// Paginate
$model->paginate([], $limit, $lastEvaluatedKey);

• Or if you want to sync your DB table with a DynamoDb table, use trait QuanKim\DynamoDbEloquentSyntax\ModelTrait, it will call a PutItem after the model is saved.

Indexes

If your table has indexes, make sure to declare them in your model class like so

/**
 * Indexes.
 * [
 *     'simple_index_name' => [
 *          'hash' => 'index_key'
 *     ],
 *     'composite_index_name' => [
 *          'hash' => 'index_hash_key',
 *          'range' => 'index_range_key'
 *     ],
 * ].
 *
 * @var array
 */
protected $dynamoDbIndexKeys = [
    'count_index' => [
        'hash' => 'count'
    ],
];

Note that order of index matters when a key exists in multiple indexes.
For example, we have this

$this->where('user_id', 123)->where('count', '>', 10)->get();

with

protected $dynamoDbIndexKeys = [
    'count_index' => [
        'hash' => 'user_id',
        'range' => 'count'
    ],
    'user_index' => [
        'hash' => 'user_id',
    ],
];

will use count_index.

protected $dynamoDbIndexKeys = [
    'user_index' => [
        'hash' => 'user_id',
    ],
    'count_index' => [
        'hash' => 'user_id',
        'range' => 'count'
    ]
];

will use user_index.

Composite Keys

To use composite keys with your model:

• Set $compositeKey to an array of the attributes names comprising the key, e.g.

protected $primaryKey = ['customer_id'];
protected $compositeKey = ['customer_id', 'agent_id'];

• To find a record with a composite key

$model->find(['id1' => 'value1', 'id2' => 'value2']);