add batch write and read support

Author: mehedimi

src/Contracts/BatchRequest.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Mehedi\LaravelDynamoDB\Contracts;
+
+interface BatchRequest
+{
+    public function toArray() : array;
+}

src/Eloquent/Builder.php

@@ -46,7 +46,7 @@ class Builder
      * @var string[]
      */
     protected $passthru = [
-        'toArray', 'insert'
+        'toArray', 'insert', 'putItemBatch', 'deleteItemBatch'
     ];
 
     public function __construct(QueryBuilder $query)
@@ -113,6 +113,89 @@ public function first(array $columns = ['*'], string $mode = FetchMode::QUERY):
         return is_null($item) ? null : $this->model->newFromBuilder($item);
     }
 
+    /**
+     * Get the first record matching the attributes or create it.
+     *
+     * @param array|string $key
+     * @param array $values
+     * @return Model
+     */
+    public function firstOrCreate($key, array $values = []): Model
+    {
+        $model = $this->firstOrNew($key, $values);
+
+        if ($model->exists) {
+            return $model;
+        }
+
+        $model->save();
+
+        return $model;
+    }
+
+    /**
+     * Get the first record matching the attributes or instantiate it.
+     *
+     * @param array $key
+     * @param array $values
+     * @return Model
+     */
+    public function firstOrNew(array $key, array $values = [])
+    {
+        $model = $this->find($key);
+
+        return is_null($model) ? $this->newModelInstance($values)->setKey($key) : $model;
+    }
+
+    /**
+     * Create or update a record matching the attributes, and fill it with values.
+     *
+     * @param array $key
+     * @param array $values
+     * @return Model
+     */
+    public function updateOrCreate(array $key, array $values = [])
+    {
+        $model = $this->firstOrNew($key, $values);
+
+        $model->exists ? $model->update($values) : $model->save();
+
+        return $model;
+    }
+
+    /**
+     * Alias of getItemBatch
+     *
+     * @param $keys
+     * @param int $chunkSize
+     * @alias getItemBatch()
+     * @return \Illuminate\Support\Collection
+     */
+    public function findMany($keys, int $chunkSize = 100)
+    {
+        return $this->getItemBatch($keys, $chunkSize);
+    }
+
+    /**
+     * Find many models in a single request
+     *
+     * @param $keys
+     * @param int $chunkSize
+     * @return \Illuminate\Support\Collection
+     */
+    public function getItemBatch($keys, int $chunkSize = 100)
+    {
+        $primaryKey = $this->model->getKeysName();
+
+        $keys = array_map(function ($key) use ($primaryKey) {
+            return array_combine($primaryKey, $key);
+        }, $keys);
+
+        return $this->query->getItemBatch($keys, $chunkSize)->transform(function ($item) {
+            return $this->model->newFromBuilder($item);
+        });
+    }
+
     /**
      * Query items from database using query mode
      *
@@ -160,9 +243,9 @@ protected function checkFetchMode($mode)
      * Save a new model and return the instance.
      *
      * @param  array  $attributes
-     * @return Model|$this
+     * @return Model
      */
-    public function create(array $attributes = [])
+    public function create(array $attributes = []): Model
     {
         return tap($this->newModelInstance($attributes), function (Model $instance) {
             $instance->save();
@@ -191,7 +274,6 @@ public function update(array $values, string $returnValues = ReturnValues::NONE)
         return $this->query->update($values);
     }
 
-
     /**
      * Query items from database using scan mode
      *
@@ -213,7 +295,7 @@ public function scan($columns = [])
      * Create a new instance of the model being queried.
      *
      * @param array $attributes
-     * @return \Illuminate\Database\Eloquent\Model|static
+     * @return Model
      */
     public function newModelInstance(array $attributes = [])
     {

src/Eloquent/Model.php

@@ -3,6 +3,8 @@
 namespace Mehedi\LaravelDynamoDB\Eloquent;
 
 use Illuminate\Database\Eloquent\Model as BaseModel;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
 use Mehedi\LaravelDynamoDB\Collections\ItemCollection;
 
 /**
@@ -14,6 +16,13 @@
  * @method static Model find($key, $column = [])
  * @method static Model findOrFail($key, $column = [])
  * @method static Model create(array $attributes)
+ * @method static Model firstOrCreate(array $key, $values = [])
+ * @method static Model firstOrNew(array $key, $values = [])
+ * @method static Model updateOrCreate(array $key, $values = [])
+ * @method static array putItemBatch(array $items, $chunkSize = 25)
+ * @method static array deleteItemBatch(array $keys, $chunkSize = 25)
+ * @method static Collection getItemBatch(array $keys, $chunkSize = 25)
+ * @method static Collection findMany(array $keys, $chunkSize = 25)
  *
  * @see  \Mehedi\LaravelDynamoDB\Eloquent\Builder
  */
@@ -252,7 +261,7 @@ protected function updatePerform($query)
      */
     protected function setKeysForSaveQuery($query): Builder
     {
-        $key = (array) $this->getKey();
+        $key = $this->getKey();
 
         $query->key(...array_values($key));
 
@@ -292,6 +301,54 @@ public function refresh()
         return $this;
     }
 
+    /**
+     * Clone the model into a new, non-existing instance.
+     *
+     * @param array|null $except
+     * @return Model
+     */
+    public function replicate(array $except = null)
+    {
+        $replicate = parent::replicate($except);
+
+        if ($this->sortKey) {
+            Arr::forget($replicate->attributes, $this->sortKey);
+        }
+
+        return $replicate;
+    }
+
+    /**
+     * Set key on the model instance
+     *
+     * @param $key
+     * @return Model
+     */
+    public function setKey($key)
+    {
+        $key = (array) $key;
+
+        $this->attributes += $this->key(...$key)->query->key;
+
+        return $this;
+    }
+
+    /**
+     * Get only keys name
+     *
+     * @return array
+     */
+    public function getKeysName()
+    {
+        $primaryKey = [$this->getKeyName()];
+
+        if ($sortKey = $this->getSortKeyName()) {
+            $primaryKey[] = $sortKey;
+        }
+
+        return $primaryKey;
+    }
+
 
     /**
      * Handle dynamic method calls into the model.

src/Query/Batch/DeleteRequest.php

@@ -0,0 +1,41 @@
+<?php
+namespace Mehedi\LaravelDynamoDB\Query\Batch;
+
+use Mehedi\LaravelDynamoDB\Contracts\BatchRequest;
+use Mehedi\LaravelDynamoDB\Utils\Marshaler;
+
+class DeleteRequest implements BatchRequest
+{
+    /**
+     * @var array
+     */
+    protected $key;
+
+    public function __construct($key)
+    {
+        $this->key = $key;
+    }
+
+    /**
+     * Processed request payload
+     *
+     * @return array
+     */
+    public function toArray() : array
+    {
+        return [
+            'Key' => Marshaler::marshalItem($this->key)
+        ];
+    }
+
+    /**
+     * Make an instance of PutRequest
+     *
+     * @param $key
+     * @return DeleteRequest
+     */
+    public static function make($key) : DeleteRequest
+    {
+        return new self($key);
+    }
+}

src/Query/Batch/Get.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Mehedi\LaravelDynamoDB\Query\Batch;
+
+class Get
+{
+    /**
+     * @var array $keys
+     */
+    protected $keys = [];
+
+    /**
+     * Make an instance of Get class
+     *
+     * @return Get
+     */
+    public static function make()
+    {
+        return new self();
+    }
+
+    /**
+     * Add a single key
+     *
+     * @param $table
+     * @param $key
+     * @return $this
+     */
+    public function add($table, $key)
+    {
+        $this->makeTableSpace($table);
+
+        $this->keys[$table][] = $key;
+
+        return $this;
+    }
+
+    /**
+     * Add multiple keys
+     *
+     * @param $table
+     * @param $keys
+     * @return $this
+     */
+    public function addMany($table, $keys)
+    {
+        $this->makeTableSpace($table);
+
+        $this->keys[$table] += $keys;
+
+        return $this;
+    }
+
+    /**
+     * Add an array inside of table name key
+     *
+     * @param $table
+     */
+    public function makeTableSpace($table)
+    {
+        if (! array_key_exists($table, $this->keys)) {
+            $this->keys[$table] = [];
+        }
+    }
+
+    /**
+     * Get keys
+     *
+     * @return array
+     */
+    public function keys()
+    {
+        return $this->keys;
+    }
+}

src/Query/Batch/PutRequest.php

@@ -0,0 +1,41 @@
+<?php
+namespace Mehedi\LaravelDynamoDB\Query\Batch;
+
+use Mehedi\LaravelDynamoDB\Contracts\BatchRequest;
+use Mehedi\LaravelDynamoDB\Utils\Marshaler;
+
+class PutRequest implements BatchRequest
+{
+    /**
+     * @var array
+     */
+    protected $item;
+
+    public function __construct($item)
+    {
+        $this->item = $item;
+    }
+
+    /**
+     * Processed request payload
+     *
+     * @return array
+     */
+    public function toArray() : array
+    {
+        return [
+            'Item' => Marshaler::marshalItem($this->item)
+        ];
+    }
+
+    /**
+     * Make an instance of PutRequest
+     *
+     * @param $item
+     * @return PutRequest
+     */
+    public static function make($item) : PutRequest
+    {
+        return new self($item);
+    }
+}