Download the PHP package laravie/eloquent-dynamodb without Composer

Eloquent syntax for 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.

• Installation
• Usages
  • find() and delete()
  • Conditions
  • all() and first()
  • Pagination
  • updateAsync()
  • saveAsync()
  • deleteAsync()
  • chunk
  • limit() and take()
  • firstOrFail()
  • findOrFail()
  • refresh()
  • Query scope
  • REMOVE — Deleting Attributes From An Item
  • toSql() Style
  • Decorate Query
• Indexes
• Composite Keys
• Query Builder
• FAQ
• License
• Author and Contributors

Installation

To install through composer, run the following command from terminal:

composer require "laravie/eloquent-dynamodb"

Laravel setup

Only if you disable package discovery, please add the following service provider to config/app.php under providers:

Next you may want to publish the configuration file using the following command:

php artisan vendor:publish --provider="Laravie\DynamoDb\DynamoDbServiceProvider"

You can then update DynamoDb config in config/dynamodb.php or configurate the value using .env.

Lumen setup

You can either copy the configuration file manually or use laravelista/lumen-vendor-publish to install the vendor:publish command.

Next, load configuration file and enable Eloquent support in bootstrap/app.php:

You can then update DynamoDb config in config/dynamodb.php or configurate the value using .env.

Usages

• Extends your model with Laravie\DynamoDb\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.
• Or if you want to sync your DB table with a DynamoDb table, use trait Laravie\DynamoDb\ModelTrait, it will call a PutItem after the model is saved.
• Alternatively, you can use the query builder facade to build more complex queries.
• AWS SDK v3 for PHP uses guzzlehttp promises to allow for asynchronous workflows. Using this package you can run eloquent queries like save asynchronously on DynamoDb.

Supported features:

find() and delete()

Conditions

whereNull() and whereNotNull()

NULL and NOT_NULL only check for the attribute presence not its value being null
See: http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html

all() and first()

Pagination

Unfortunately, offset of how many records to skip does not make sense for DynamoDb. Instead, provide the last result of the previous query as the starting point for the next query.

Examples:

For query such as:

Take the last item of this query result as the next "offset":

update()

updateAsync()

save()

saveAsync()

Saving single model asynchronously and waiting on the promise for completion.

Saving multiple models asynchronously and waiting on all of them simultaneously.

delete()

deleteAsync()

chunk()

limit() and take()

firstOrFail()

findOrFail()

refresh()

Query Scope

REMOVE — Deleting Attributes From An Item

See: http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.UpdateExpressions.html#Expressions.UpdateExpressions.REMOVE

toSql() Style

For debugging purposes, you can choose to convert to the actual DynamoDb query

where $raw is an instance of RawDynamoDbQuery

Decorate Query

Use decorate when you want to enhance the query. For example:

To set the order of the sort key:

To force to use "Query" instead of "Scan" if the library fails to detect the correct operation:

Indexes

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

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

with

will use count_index.

will use user_index.

Most of the time, you should not have to do anything but if you need to use a specific index, you can specify it like so

Composite Keys

To use composite keys with your model:

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

• To find a record with a composite key

Query Builder

Use DynamoDb facade to build raw queries

The query builder methods are in the form of set<key_name>, where <key_name> is the key name of the query body to be sent.

For example, to build an UpdateTable query:

Do:

And when ready:

FAQ

Q: Cannot assign id property if its not in the fillable array
A: Try this?

Q: How to create migration?
A: Please see this issue

Q: How to use with factory?
A: Please see this issue

Q: How do I use with Job? Getting a SerializesModels error
A: You can either write your own restoreModel or remove the SerializesModels trait from your Job.

Author and Contributors

• Bao Pham
• warrick-loyaltycorp
• Alexander Ward
• Quang Ngo
• David Higgins
• Damon Williams
• David Palmer