Laravel DynamoDB

https://github.com/kitar/laravel-dynamodb
Admin
This Laravel package provides DynamoDB integration by adapting Laravel's database layer to work with...
Tokens:43,920
Snippets:472
Trust Score:7.3
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### create() usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Example of creating a User model with email and type attributes.

```php
$user = User::create([
    'email' => 'foo@bar.com',
    'type'  => 'profile',
]);
```

--------------------------------

### Install via Composer

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Install the package using Composer. Run this command in your project root.

```bash
$ composer require kitar/laravel-dynamodb
```

--------------------------------

### find() usage examples

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Examples of calling find() with different key types: partition key only, full key dictionary, and scalar with sortKeyDefault.

```php
ProductCatalog::find(101);              // partition key only
Thread::find(['ForumName' => 'Amazon DynamoDB', 'Subject' => 'Thread 1']);
User::find('foo@bar.com');              // sortKeyDefault supplies the sort key
```

--------------------------------

### save() usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Example of creating a new User, setting a name, and saving. Returns false only if a model event cancels it.

```php
$user = new User(['email' => 'foo@bar.com']);
$user->name = 'foo';
$saved = $user->save();   // false only if a model event cancels it
```

--------------------------------

### compileUpdates() return example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Example return value for compileUpdates when both set and remove buckets are present. The set and remove fragments are joined with ', ' and the clauses with a space.

```php
['UpdateExpression' => 'set <parts>, <parts> remove <parts>', 'ReturnValues' => 'UPDATED_NEW']
```

--------------------------------

### scan() usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Example of scanning the ProductCatalog table with a limit of 5, then using the LastEvaluatedKey to fetch the next page.

```php
$response = DB::table('ProductCatalog')->limit(5)->scan();
$next = DB::table('ProductCatalog')->exclusiveStartKey($response['LastEvaluatedKey'])->limit(5)->scan();
```

--------------------------------

### DynamoDB Local connection example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Example of creating a Connection for DynamoDB Local using an endpoint. The endpoint is kept as-is because it already starts with http://. The key and secret are set to 'local'.

```php
$connection = new Kitar\Dynamodb\Connection([
    'key'      => 'local',
    'secret'   => 'local',
    'region'   => 'us-east-1',
    'endpoint' => 'http://localhost:8000', // kept as-is, already http(s)://
]);
```

--------------------------------

### compileBatchWriteRequestItems() return example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Example return value for compileBatchWriteRequestItems showing the structure with PutRequest and marshaled item.

```php
['RequestItems' => [$table_name => [['PutRequest' => ['Item' => <marshaled>]], ...]]]
```

--------------------------------

### Collection usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/helpers.md

Shows how to use Collection for pagination with scan and getLastEvaluatedKey.

```php
$products = ProductCatalog::limit(5)->scan();

$products->getLastEvaluatedKey(); // array|null — pass to exclusiveStartKey() for the next page

foreach ($products as $product) {
    // $product is a Kitar\Dynamodb\Model\Model instance
}
```

--------------------------------

### Non-Laravel connection setup

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Create a Kitar\Dynamodb\Connection manually for non-Laravel projects. The 'prefix' option sets a table prefix. Then use the table method to start querying.

```php
$connection = new Kitar\Dynamodb\Connection([
    'key' => env('AWS_ACCESS_KEY_ID'),
    'secret' => env('AWS_SECRET_ACCESS_KEY'),
    'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
    'token' => env('AWS_SESSION_TOKEN', null),
    'endpoint' => env('DYNAMODB_ENDPOINT', null),
    'prefix' => '', // table prefix
]);

$connection->table('your-table')->...
```

--------------------------------

### delete() usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Example of deleting a model instance.

```php
$user->delete();
```

--------------------------------

### scan() example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Perform a scan operation on a table.

```php
$response = DB::table('Thread')->scan();
```

--------------------------------

### NumberIterator usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/helpers.md

Shows how to use NumberIterator to generate placeholder keys.

```php
$it = new Kitar\Dynamodb\Helpers\NumberIterator(1, '#');
$it->current(); // '#1'
$it->next();
$it->current(); // '#2'
```

--------------------------------

### compileConditions() return example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Example return value for compileConditions showing the expression key placeholder and the compiled wheres with the leading 'where ' stripped.

```php
['<WhereAs>' => preg_replace('/^where\s/', '', $this->compileWheres($query))]
```

--------------------------------

### getItem() example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Retrieve an item by key using getItem(). Pass a plain array; marshaling is automatic.

```php
$response = DB::table('ProductCatalog')
    ->getItem(['Id' => 101]);
```

--------------------------------

### Query builder scan example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Creates a query builder for the 'Thread' table and performs a scan operation.

```php
$connection->table('Thread')->scan();
```

--------------------------------

### ExpressionAttributes usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Shows how to add names and values, check for placeholders, and retrieve the resulting dictionaries. Demonstrates deduplication and marshaling.

```php
$ea = new ExpressionAttributes();

$ea->addName('Price');   // '#1'
$ea->addName('Price');   // '#1' (deduplicated)
$ea->addValue(500);      // ':1'
$ea->hasName();          // true
$ea->hasValue();         // true

$ea->names();            // ['#1' => 'Price']
$ea->values();           // [':1' => ['N' => '500']]
```

--------------------------------

### putItem() example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Insert an item with putItem(). Provide attribute values as a plain array.

```php
DB::table('Thread')
    ->putItem([
        'ForumName' => 'Amazon DynamoDB',
        'Subject' => 'New discussion thread',
        'Message' => 'First post in this thread',
        'LastPostedBy' => 'fred@example.com',
        'LastPostedDateTime' => '201603190422'
    ]);
```

--------------------------------

### Query forwarding with keyCondition and filter

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Use this query forwarding example to build a DynamoDB query with key conditions and a filter. It chains keyCondition() calls for equality and begins_with, adds a filter on Views, and executes the query. The example is from the Model documentation and demonstrates the forwarded query builder surface.

```php
Thread::keyCondition('ForumName', '=', 'Amazon DynamoDB')
      ->keyCondition('Subject', 'begins_with', 'DynamoDB')
      ->filter('Views', '=', 0)
      ->query();
```

--------------------------------

### batchWriteItem() usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Shows how to use batchWriteItem with PutRequest and DeleteRequest items.

```php
DB::table('Thread')->batchWriteItem([
    ['PutRequest'    => ['Item' => ['ForumName' => 'Amazon DynamoDB', 'Subject' => 'Thread 3']]],
    ['DeleteRequest' => ['Key'  => ['ForumName' => 'Amazon DynamoDB', 'Subject' => 'Thread 1']]],
]);
```

--------------------------------

### NumberIterator constructor

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/helpers.md

Constructor with optional start and prefix parameters.

```php
public function __construct($start = 1, $prefix = '')
```

--------------------------------

### keyConditionBetween() example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Use keyConditionBetween() to specify a range condition on the sort key.

```php
$response = DB::table('Thread')
    ->keyCondition('ForumName', '=', 'Amazon DynamoDB')
    ->keyConditionBetween('Subject', ['DynamoDB Thread 1', 'DynamoDB Thread 2'])
    ->query();
```

--------------------------------

### deleteItem() example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Delete an item by key using deleteItem().

```php
DB::table('Thread')
    ->deleteItem([
        'ForumName' => 'Amazon DynamoDB',
        'Subject' => 'New discussion thread'
    ]);
```

--------------------------------

### Scan with limit and getLastEvaluatedKey

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-processor.md

Example usage of processMultipleItems: scans ProductCatalog with a limit of 5 and reads the LastEvaluatedKey from the collection meta.

```php
$products = ProductCatalog::limit(5)->scan();
$products->getLastEvaluatedKey(); // reads meta['LastEvaluatedKey']
```

--------------------------------

### Nested where() filter example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Example of a nested filter using where() and orWhere() inside a closure, passed to scan().

```php
DB::table('ProductCatalog')->filter(function ($query) {
    $query->where(function ($query) {
        $query->where('ProductCategory', 'Bicycle');
        $query->where('Brand', 'Mountain A');
    });
    $query->orWhere('Price', '>=', 500);
})->scan();
```

--------------------------------

### dryRun() usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Shows how to use dryRun() to get the compiled DynamoDB request without executing it. The returned array contains 'method', 'params', and 'processor' keys. The example uses DB::table('ProductCatalog')->dryRun()->getItem(['Id' => 101]) and comments show the expected values.

```php
$request = DB::table('ProductCatalog')->dryRun()->getItem(['Id' => 101]);
// $request['method']  == 'getItem'
// $request['params']  == the compiled DynamoDB parameter array
// $request['processor'] == 'processSingleItem'
```

--------------------------------

### conditionIn() example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Use conditionIn() to check if an attribute is in a list of values. Works with updateItem().

```php
ProductCatalog::key(['Id' => 101])
    ->conditionIn('ProductCategory', ['Book', 'Bicycle'])
    ->updateItem([
        'Description' => 'updated!'
    ]);
```

--------------------------------

### increment() usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Example of incrementing the 'Replies' column by 2 and updating 'LastPostedBy' in the same UpdateExpression. The extra attributes are passed as the third argument.

```php
DB::table('Thread')
    ->key(['ForumName' => 'Laravel', 'Subject' => 'Thread 1'])
    ->increment('Replies', 2, ['LastPostedBy' => 'User A']);
```

--------------------------------

### Query builder method signatures and dry-run compiled output

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Method signatures for overridden query builder methods and a dry-run example showing compiled DynamoDB expression parameters.

```php
protected function whereBasic($query, $where)
```

```php
protected function whereBetween($query, $where)
```

```php
protected function whereIn($query, $where)
```

```php
$request = DB::table('ProductCatalog')
    ->dryRun()
    ->select('Price', 'Title')
    ->getItem(['Id' => 101]);

// $request['params'] ≈
// [
//   'ProjectionExpression' => '#1, #2',
//   'TableName' => 'ProductCatalog',
//   'Key' => ['Id' => ['N' => '101']],
//   'ExpressionAttributeNames' => ['#1' => 'Price', '#2' => 'Title', '#3' => 'Id'],
//   'ExpressionAttributeValues' => [':1' => ['N' => '101']],
// ]
```

--------------------------------

### updateItem() usage example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Shows how to use updateItem with ExpressionAttributes. Attributes with null values become REMOVE actions; all other values become SET actions.

```php
DB::table('Thread')
    ->key(['ForumName' => 'Laravel', 'Subject' => 'Thread 1'])
    ->updateItem([
        'LastPostedBy' => null,      // REMOVE
        'Message'      => 'Updated', // SET
    ]);
```

--------------------------------

### Get LastEvaluatedKey via individual model meta() (deprecated)

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Alternative approach using individual models to get the LastEvaluatedKey. Planned to be deprecated in versions subsequent to v2.x.

```php
$products->first()->meta()['LastEvaluatedKey']; // array
```

--------------------------------

### AND conditions with multiple condition()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Combine conditions with AND by chaining condition() calls. Note the missing closing quote in the source example.

```php
DB::table('ProductCatalog')
    ->condition('Id', 'attribute_not_exists')
    ->condition('Price', 'attribute_not_exists)
    ->putItem([...]);
```

--------------------------------

### OR conditions with orCondition()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Combine conditions with OR using orCondition(). Note the missing closing quote in the source example.

```php
DB::table('ProductCatalog')
    ->condition('Id', 'attribute_not_exists')
    ->orCondition('Price', 'attribute_not_exists)
    ->putItem([...]);
```

--------------------------------

### conditionBetween() example

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Use conditionBetween() to check if an attribute is between two values. Works with updateItem().

```php
ProductCatalog::key(['Id' => 101])
    ->conditionBetween('Price', [0, 10])
    ->updateItem([
        'Description' => 'updated!'
    ]);
```

--------------------------------

### Increment and decrement usage

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Example usage of increment() and decrement() on a model instance. These methods are intercepted by __call() and routed to atomic counter updates.

```php
$user->increment('views', 1);
$user->decrement('views', 1, ['last_viewed_at' => '...']);
```

--------------------------------

### processBatchGetItems method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-processor.md

Processes batch get responses. Returns an array if no model class, or an Illuminate\Support\Collection of hydrated models from all Responses tables, with per-item meta set.

```php
public function processBatchGetItems(Result $awsResponse, $modelClass = null)
```

--------------------------------

### Constructor

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Creates a new Connection instance with the given configuration array.

```APIDOC
## Constructor

### Description
Creates a new Connection instance, building the AWS SDK client and setting up the table prefix and default grammar/processor.

### Method
Constructor

### Signature
`public function __construct($config)`

### Parameters
- **$config** (array) - Required - Connection configuration array. See Configuration for accepted keys.

### Example
```php
$connection = new Kitar\Dynamodb\Connection([
    'key'      => env('AWS_ACCESS_KEY_ID'),
    'secret'   => env('AWS_SECRET_ACCESS_KEY'),
    'region'   => env('AWS_DEFAULT_REGION', 'us-east-1'),
    'token'    => env('AWS_SESSION_TOKEN', null),
    'endpoint' => env('DYNAMODB_ENDPOINT', null),
    'prefix'   => '',
]);
```
```

--------------------------------

### Thread model with table and key attributes

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Example subclass defining the table, primary key, sort key, and fillable attributes for a DynamoDB model. The sort key is optional but required for queries that use it.

```php
class Thread extends Kitar\Dynamodb\Model\Model
{
    protected $table = 'Thread';
    protected $primaryKey = 'ForumName';
    protected $sortKey = 'Subject';
    protected $fillable = ['ForumName', 'Subject'];
}
```

--------------------------------

### query() with keyCondition()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Perform a query with keyCondition(). Partition key must use equality; sort key can use comparison operators.

```php
$response = DB::table('Thread')
    ->keyCondition('ForumName', '=', 'Amazon DynamoDB')
    ->keyCondition('Subject', 'begins_with', 'DynamoDB')
    ->query();
```

--------------------------------

### dryRun() with Model and Query Builder

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Use dryRun() to inspect the request parameters and method that would be sent to DynamoDB. The example shows usage via a Model and via the Query Builder, and then dumps the request. This feature is also used in PHPUnit tests to avoid actual DynamoDB calls.

```php
// via Model
$request = ProductCatalog::dryRun()->getItem(['Id' => 101]);

// via Query Builder
$request = DB::table('ProductCatalog')->dryRun()->getItem(['Id' => 101]);

dump($request);
```

--------------------------------

### Using the DynamoDB connection via DB facade

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/dynamodb-service-provider.md

Shows how to query the 'Thread' table using the DB facade, which resolves to the 'dynamodb' connection when DB_CONNECTION=dynamodb. Also shows how to retrieve the connection object directly.

```php
$result = DB::table('Thread')->scan();
// DB resolves to the 'dynamodb' connection when DB_CONNECTION=dynamodb
```

```php
$connection = DB::connection('dynamodb');
```

--------------------------------

### NumberIterator rewind method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/helpers.md

Resets the counter to the start value.

```php
public function rewind(): void
```

--------------------------------

### create() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Static method to create a new model instance and save it.

```php
public static function create(array $fillables = [], array $options = [])
```

--------------------------------

### compileExclusiveStartKey() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when the key is empty, otherwise returns an array with the ExclusiveStartKey parameter (not marshaled).

```php
public function compileExclusiveStartKey($key)
```

--------------------------------

### batchGetItem() - Batch get items

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Performs a batch get operation on the 'Thread' table using the batchGetItem method. Provide an array of key arrays, each containing the partition key and sort key values. This is subject to DynamoDB batch limitations such as item count and payload size.

```php
DB::table('Thread')
    ->batchGetItem([
        [
            'ForumName' => 'Amazon DynamoDB',
            'Subject' => 'DynamoDB Thread 1'
        ],
        [
            'ForumName' => 'Amazon DynamoDB',
            'Subject' => 'DynamoDB Thread 2'
        ]
    ]);
```

--------------------------------

### Save a new model with save()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Instantiates a new User model, sets attributes, and saves it. Also shows updating an existing model's attribute and saving again.

```php
$user = new User([
    'email' => 'foo@bar.com',
    'type' => 'profile'
]);

$user->save();
```

```php
$user->name = 'foo';
$user->save();
```

--------------------------------

### Laravel 11+ alternative drivers

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

For Laravel 11 and later, set session, cache, and queue drivers to file/sync because the default database drivers are not compatible with this package.

```bash
SESSION_DRIVER=file
CACHE_STORE=file
QUEUE_CONNECTION=sync
```

--------------------------------

### Create a new model with create()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Creates a new model instance and saves it to the database. The 'type' attribute is the sort key; if omitted, sortKeyDefault is used.

```php
$user = User::create([
    'email' => 'foo@bar.com',
    'type' => 'profile' // Sort key. If we don't specify this, sortKeyDefault will be used.
]);
```

--------------------------------

### exclusiveStartKey()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Sets the ExclusiveStartKey for pagination.

```APIDOC
## exclusiveStartKey()

### Description
Sets the `ExclusiveStartKey` parameter, which is used for pagination. Pass a previous response's `LastEvaluatedKey` to continue reading from that point.

### Method
exclusiveStartKey

### Signature
```php
public function exclusiveStartKey($key)
```

### Parameters
- **$key** (mixed) - Required - The key to start from, typically the `LastEvaluatedKey` from a previous response.

### Returns
`$this` - The builder instance for chaining.
```

--------------------------------

### Create a DynamoDB Connection with constructor options

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/configuration.md

Instantiate a Kitar\Dynamodb\Connection outside Laravel, passing an options array. Credentials are forwarded to the AWS SDK only when both 'key' and 'secret' are set; omit them to rely on the SDK's own credential providers. 'version' and 'endpoint' are passed directly to the SDK, while 'prefix' is not.

```php
$connection = new Kitar\Dynamodb\Connection([
    'key'      => env('AWS_ACCESS_KEY_ID'),
    'secret'   => env('AWS_SECRET_ACCESS_KEY'),
    'region'   => env('AWS_DEFAULT_REGION', 'us-east-1'),
    'token'    => env('AWS_SESSION_TOKEN', null),
    'endpoint' => env('DYNAMODB_ENDPOINT', null),
    'prefix'   => '',
]);
```

--------------------------------

### Query Global Secondary Index with index() and keyCondition()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Specifies a Global Secondary Index name and uses key conditions to query against that index.

```php
$response = DB::table('Reply')
    ->index('PostedBy-Message-index')
    ->keyCondition('PostedBy', '=', 'User A')
    ->keyCondition('Message', '=', 'DynamoDB Thread 2 Reply 1 text')
    ->query();
```

--------------------------------

### Connection constructor signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Constructor signature for the Connection class. Accepts a configuration array.

```php
public function __construct($config)
```

--------------------------------

### Paginate next results with exclusiveStartKey()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Passes the LastEvaluatedKey from a previous response to exclusiveStartKey() to fetch the next page of results.

```php
$response = DB::table('ProductCatalog')
    ->exclusiveStartKey($response['LastEvaluatedKey'])
    ->limit(5)
    ->scan();
```

--------------------------------

### Find model with partition and sort key

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Retrieves a model using both partition key and sort key as an array.

```php
Thread::find([
    'ForumName' => 'Amazon DynamoDB', // Partition key
    'Subject' => 'DynamoDB Thread 1' // Sort key
]);
```

--------------------------------

### all() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Static method to retrieve all records with optional column projection.

```php
public static function all($columns = [])
```

--------------------------------

### Get LastEvaluatedKey via model with getLastEvaluatedKey()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

When using the query builder through a model, access the LastEvaluatedKey using the getLastEvaluatedKey() method on the result object.

```php
$products = ProductCatalog::limit(5)->scan();

$products->getLastEvaluatedKey(); // array
```

--------------------------------

### Registering the 'dynamodb' driver in register()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/dynamodb-service-provider.md

Hooks into the container's 'db' resolution to extend it with a 'dynamodb' driver. The closure receives the config array and connection name, sets the 'name' config key, and returns a new Connection instance.

```php
$this->app->resolving('db', function ($db) {
    $db->extend('dynamodb', function ($config, $name) {
        $config['name'] = $name;
        return new Connection($config);
    });
});
```

--------------------------------

### compileKey() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when the key is empty, otherwise returns an array with the Key parameter marshaled by the marshaler.

```php
public function compileKey($key)
```

--------------------------------

### Modify RegisteredUserController for DynamoDB

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Example modification for the registration controller when using Laravel Starter Kits. The email validation uses a closure to check for duplicates instead of the 'unique' rule, and user creation uses the DynamoDB model.

```php
class RegisteredUserController extends Controller
{
    ...

    public function store(Request $request)
    {
        $request->validate([
            'name' => 'required|string|max:255',
            'email' => ['required', 'string', 'lowercase', 'email', 'max:255', function ($attribute, $value, $fail) {
                if (User::find($value)) {
                    $fail('The '.$attribute.' has already been taken.');
                }
            }],
            'password' => ['required', 'confirmed', Rules\Password::defaults()],
        ]);

        $user = User::create([
            'name' => $request->name,
            'email' => $request->email,
            'password' => Hash::make($request->password),
        ]);

        event(new Registered($user));

        Auth::login($user);

        return to_route('dashboard');
    }
}
```

--------------------------------

### find() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Static method to find a model by key. Accepts a partition key value or a full key dictionary.

```php
public static function find($key)
```

--------------------------------

### Find model by partition key only

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Retrieves a model using only the partition key when the model has no sort key.

```php
ProductCatalog::find(101);
```

--------------------------------

### Catch AWS SDK exceptions from DynamoDB operations

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/errors.md

Use this pattern to catch AWS SDK exceptions that propagate from DynamoDB operations. The base class AwsException is from aws/aws-sdk-php ^3.0. This example shows catching an exception when querying a missing table, but the same pattern applies to other conditions like missing credentials or invalid region.

```php
use Aws\Exception\AwsException; // exact base class from aws/aws-sdk-php ^3.0

try {
    DB::table('MissingTable')->getItem(['Id' => 1]);
} catch (AwsException $e) {
    // network/API-level failure surfaced by the SDK
}
```

--------------------------------

### createModel()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/auth-user-provider.md

Creates a new instance of the configured model class.

```APIDOC
## createModel()

### Description
Creates a new instance of the configured model class.

### Method
createModel

### Signature
public function createModel()

### Parameters
None.

### Returns
`Kitar\Dynamodb\Model\Model` — a new instance of the configured model class (`new $class`), with any leading `\` stripped from the configured name.
```

--------------------------------

### getDefaultPostProcessor() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Protected method that returns a new Query\Processor instance.

```php
protected function getDefaultPostProcessor()
```

--------------------------------

### Find model with sortKeyDefault

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Retrieves a model using only the partition key when sortKeyDefault is defined; the default sort key is used automatically.

```php
User::find('foo@bar.com'); // Partition key. sortKeyDefault will be used for Sort key.
```

--------------------------------

### Override getDefaultPostProcessor with custom processor

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-processor.md

Shows how to override Connection::getDefaultPostProcessor() to swap the default Processor with a custom one. The custom processor must implement the three process methods.

```php
class MyConnection extends Kitar\Dynamodb\Connection
{
    protected function getDefaultPostProcessor()
    {
        return new MyProcessor(); // must respond to processSingleItem / processMultipleItems / processBatchGetItems
    }
}
```

--------------------------------

### makeNameKey method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Returns the next '#n' key using the name iterator.

```php
public function makeNameKey()
```

--------------------------------

### setClient() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Signature for setClient, which overrides the client instance.

```php
public function setClient(DynamoDbClient $client)
```

--------------------------------

### Configure DynamoDB auth provider in config/auth.php

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/auth-user-provider.md

Configure the DynamoDB auth provider in config/auth.php. The 'driver' must be 'dynamodb', and 'model' points to the authenticatable model. 'api_token_name' and 'api_token_index' are optional and default to 'api_token' and 'api_token-index' respectively.

```php
'providers' => [
    'users' => [
        'driver' => 'dynamodb',
        'model' => App\User::class,
        'api_token_name' => 'api_token',      // optional
        'api_token_index' => 'api_token-index' // optional
    ],
],
```

--------------------------------

### Scan all models with ProductCatalog::scan()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Retrieves all models from the ProductCatalog table using the scan method. The alternative all() method is also shown.

```php
$products = ProductCatalog::scan();
```

```php
$products = ProductCatalog::all();
```

--------------------------------

### hasName method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Returns whether any name placeholder has been registered.

```php
public function hasName()
```

--------------------------------

### compileItem() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when the item is empty, otherwise returns an array with the Item parameter marshaled by the marshaler.

```php
public function compileItem($item)
```

--------------------------------

### Class declaration for DynamodbServiceProvider

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/dynamodb-service-provider.md

Declares the service provider class extending Illuminate\Support\ServiceProvider. The class has an empty boot() method and a register() method that registers the driver.

```php
class DynamodbServiceProvider extends ServiceProvider
```

```php
public function boot()
```

```php
public function register()
```

--------------------------------

### compileProjectionExpression() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when empty, otherwise adds each column to the registry and returns an array with ProjectionExpression.

```php
public function compileProjectionExpression($columns, $expression_attributes)
```

--------------------------------

### names method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Returns the ['#n' => name] dictionary as a plain array.

```php
public function names()
```

--------------------------------

### ExpressionAttributes::__construct()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Instantiates the Marshaler and two NumberIterator instances for generating name and value placeholder keys.

```APIDOC
## ExpressionAttributes::__construct()

### Description
Instantiates `Aws\DynamoDb\Marshaler` and two `Kitar\Dynamodb\Helpers\NumberIterator` instances: `name_keys_iterator` (start `1`, prefix `'#'`) and `value_keys_iterator` (start `1`, prefix `':'`).

### Method
Constructor

### Signature
```php
public function __construct()
```

### Parameters
None

### Returns
No return value.
```

--------------------------------

### batchPutItem()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Puts multiple items into the table in a batch.

```APIDOC
## batchPutItem()

### Description
Puts multiple items into the table in a batch. Each item is wrapped as `['PutRequest' => ['Item' => $item]]` and delegated to `batchWriteItem()`.

### Method
PHP method

### Endpoint
`public function batchPutItem($items)`

### Parameters
- **$items** (mixed) - Required - The items to put.

### Returns
`\Aws\Result`.
```

--------------------------------

### Set a replacement client

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Replaces the current client with another DynamoDbClient instance.

```php
$connection->setClient($anotherClient);
```

--------------------------------

### Allowed builder methods list

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Exact list of allowed builder methods that can be called on the model via __call(). Methods not in this list, such as orFilter or orCondition, raise BadMethodCallException.

```text
select, take, limit, index, key, exclusiveStartKey, consistentRead, dryRun,
getItem, putItem, deleteItem, updateItem,
batchGetItem, batchPutItem, batchDeleteItem, batchWriteItem,
scan, filter, filterIn, filterBetween,
condition, conditionIn, conditionBetween,
keyCondition, keyConditionIn, keyConditionBetween
```

--------------------------------

### key()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Sets the item key dictionary for the operation.

```APIDOC
## key()

### Description
Sets the item key dictionary used to identify the item in DynamoDB.

### Method
key

### Signature
```php
public function key(array $key)
```

### Parameters
- **$key** (array) - Required - The item key dictionary, e.g. `['ForumName' => '...', 'Subject' => '...']`.

### Returns
`$this` - The builder instance for chaining.
```

--------------------------------

### getClient() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Signature for getClient, which returns the underlying AWS SDK client.

```php
public function getClient()
```

--------------------------------

### meta() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Returns stored response metadata or null if never set.

```php
public function meta()
```

--------------------------------

### makeValueKey method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Returns the next ':n' key using the value iterator.

```php
public function makeValueKey()
```

--------------------------------

### clientQuery()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Executes a raw DynamoDB API call with the given parameters, returning the raw AWS SDK result.

```APIDOC
## clientQuery()

### Description
Executes a raw DynamoDB API call with the given parameters, returning the raw AWS SDK result. This is the single execution funnel used by `Query\Builder::process()`.

### Method
clientQuery

### Signature
`public function clientQuery($params)`

### Parameters
- **$params** (array) - Required - DynamoDB API parameters (TableName, Key, ExpressionAttribute*, ...).

### Returns
`Aws\Result` — the raw AWS SDK response.

### Example
```php
$result = $connection->clientQuery([
    'TableName' => 'ProductCatalog',
    'Key' => $marshaler->marshalItem(['Id' => 101]), // Marshaler instance from the AWS SDK
]);
```
```

--------------------------------

### Data flow diagram

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/index.md

Shows the flow from Connection->table() through the builder, grammar compilation, AWS SDK client query, and processor unmarshalling. dryRun() short-circuits to return method, params, and processor.

```text
Connection->table($name)  →  Query\Builder
   (own Grammar, Processor, ExpressionAttributes)
        │  method chain (key/filter/condition/limit/...)
        ▼
Builder::process()  →  Grammar::compile*()  →  parameter array
        │  dryRun() short-circuits here: returns ['method','params','processor']
        ▼
Connection->clientQuery($params)  →  Aws\DynamoDb\DynamoDbClient  (AWS SDK)
        ▼
Processor::process*()  →  unmarshal items → array | Helpers\Collection | Model instances
```

--------------------------------

### setClient()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Overrides the client instance, useful for testing or swapping endpoints at runtime.

```APIDOC
## setClient()

### Description
Overrides the client instance, useful for testing or swapping endpoints at runtime.

### Method
setClient

### Signature
`public function setClient(DynamoDbClient $client)`

### Parameters
- **$client** (`Aws\DynamoDb\DynamoDbClient`) - Required - Replacement client instance.

### Returns
`void`

### Example
```php
$connection->setClient($anotherClient);
```
```

--------------------------------

### updateItem() with key() and REMOVE/SET

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Update an item using key() and updateItem(). Null values trigger REMOVE, non-null values trigger SET. Only simple SET and REMOVE are supported.

```php
DB::table('Thread')
    ->key([
        'ForumName' => 'Laravel',
        'Subject' => 'Laravel Thread 1'
    ])->updateItem([
        'LastPostedBy' => null, // REMOVE
        'Replies' => null, // REMOVE
        'Message' => 'Updated' // SET
    ]);
```

--------------------------------

### Scan table through model

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Use Thread::scan() to scan a table via the model. Table name is inferred and response contains model instances.

```php
$threads = Thread::scan();
```

--------------------------------

### Compile expression attributes with Grammar

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Shows how the Grammar's compileExpressionAttributes method consumes the ExpressionAttributes to produce request parameters.

```php
$params = (new Kitar\Dynamodb\Query\Grammar)->compileExpressionAttributes($ea);
// ['ExpressionAttributeNames' => ['#1' => 'Price'], 'ExpressionAttributeValues' => [':1' => ['N' => '500']]]
```

--------------------------------

### Builder constructor signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Constructor signature for the Builder. Accepts connection, grammar, processor, optional expression attributes, and a nested query flag. In normal use, Connection::table() builds it.

```php
public function __construct(Connection $connection, Grammar $grammar, Processor $processor, $expression_attributes = null, $is_nested_query = false)
```

--------------------------------

### values method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Returns the [':n' => value] dictionary after marshaling via marshalItem.

```php
public function values()
```

--------------------------------

### Direct clientQuery call with marshaled key

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Calls clientQuery with a marshaled key. Direct use requires already-marshaled values.

```php
$result = $connection->clientQuery([
    'TableName' => 'ProductCatalog',
    'Key' => $marshaler->marshalItem(['Id' => 101]), // Marshaler instance from the AWS SDK
]);
```

--------------------------------

### table() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Signature for the table method that returns a fluent query builder.

```php
public function table($table, $as = null)
```

--------------------------------

### createModel() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/auth-user-provider.md

Signature for the createModel method that returns a new model instance.

```php
public function createModel()
```

--------------------------------

### Builder::__construct

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Constructor for the query builder. It is not intended for direct use; `Connection::table()` builds it.

```APIDOC
## Constructor

### Description
Initializes a new query builder instance with the given connection, grammar, processor, and optional expression attributes. In normal use, this is not called directly; `Connection::table()` builds it.

### Method
Constructor

### Signature
```php
public function __construct(Connection $connection, Grammar $grammar, Processor $processor, $expression_attributes = null, $is_nested_query = false)
```

### Parameters
- **$connection** (`Kitar\Dynamodb\Connection`) - Required - Bound connection (executes the compiled call).
- **$grammar** (`Kitar\Dynamodb\Query\Grammar`) - Required - Compiler for the parameter arrays.
- **$processor** (`Kitar\Dynamodb\Query\Processor`) - Required - Response processor.
- **$expression_attributes** (`ExpressionAttributes`, null) - Optional - Default: `null` - Shared placeholder registry; a new one is created when `null`.
- **$is_nested_query** (bool) - Optional - Default: `false` - When `false`, the three dedicated clause builders (`filter_query`, `condition_query`, `key_condition_query`) are initialized.
```

--------------------------------

### Operators and functions properties

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Defines the supported operators and functions used in whereBasic() compilation.

```php
protected $operators = ['=', '<>', '<', '<=', '>', '>='];
protected $functions = [
    'attribute_exists',
    'attribute_not_exists',
    'attribute_type',
    'begins_with',
    'contains',
    'size'
];
```

--------------------------------

### Handling unknown method call error

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Shows that unknown methods fail with a native PHP Error, not a package exception.

```php
try {
    $connection->nonExistentMethod([]);
} catch (\Error $e) {
    // PHP "Call to undefined method \Aws\DynamoDb\DynamoDbClient::nonExistentMethod()"
}
```

--------------------------------

### Advanced query with keyCondition and filter

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Uses query builder methods on a model to filter by key conditions and a filter expression, then executes the query.

```php
Thread::keyCondition('ForumName', '=', 'Amazon DynamoDB')
    ->keyCondition('Subject', 'begins_with', 'DynamoDB')
    ->filter('Views', '=', 0)
    ->query();
```

--------------------------------

### compileUpdates() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when both buckets are empty, otherwise returns an array with UpdateExpression and ReturnValues parameters. The updates array contains 'set' and 'remove' buckets.

```php
public function compileUpdates($updates)
```

--------------------------------

### batchGetItem() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Defines the batchGetItem method that retrieves multiple items. Returns processed Responses or a Collection of models when usingModel() is set.

```php
public function batchGetItem($keys)
```

--------------------------------

### ExpressionAttributes constructor

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Instantiates the Marshaler and two NumberIterator instances for name and value keys.

```php
public function __construct()
```

--------------------------------

### save() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/model.md

Saves the model using Eloquent-compatible lifecycle, firing events and performing insert or update.

```php
public function save(array $options = [])
```

--------------------------------

### createClient() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Protected method that creates a DynamoDbClient from the constructor config array. It normalizes the config: region defaults to 'us-east-1', version to 'latest', endpoint to null; prepends https:// if endpoint lacks http(s)://; renames access_key/secret_key to key/secret; and passes credentials only when both key and secret are set.

```php
protected function createClient(array $config)
```

--------------------------------

### compileDynamodbLimit() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when the limit is null, otherwise returns an array with the Limit parameter. Note that 0 is a valid limit.

```php
public function compileDynamodbLimit($limit)
```

--------------------------------

### __call()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Dynamically forwards any method call to the underlying AWS SDK client.

```APIDOC
## __call()

### Description
Dynamically forwards any method call to the underlying AWS SDK client.

### Method
__call

### Signature
`public function __call($method, $parameters)`

### Parameters
- **$method** (string) - Required - Any method name.
- **$parameters** (array) - Required - Arguments to forward.

### Returns
`mixed` — whatever the AWS SDK client method returns.

### Example
```php
$result = $connection->scan(['TableName' => 'ProductCatalog']);
// forwards to $connection->getClient()->scan([...])
```
```

--------------------------------

### compileScanIndexForward() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when the boolean is null, otherwise returns an array with the ScanIndexForward parameter.

```php
public function compileScanIndexForward($bool)
```

--------------------------------

### batchWriteItem() - Batch write items (put and delete)

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Performs a batch write operation on the 'Thread' table using the batchWriteItem method. Provide an array of PutRequest and DeleteRequest operations to perform mixed puts and deletes in a single call.

```php
DB::table('Thread')
    ->batchWriteItem([
        [
            'PutRequest' => [
                'Item' => [
                    'ForumName' => 'Amazon DynamoDB',
                    'Subject' => 'DynamoDB Thread 3'
                ]
            ]
        ],
        [
            'DeleteRequest' => [
                'Key' => [
                    'ForumName' => 'Amazon DynamoDB',
                    'Subject' => 'DynamoDB Thread 1'
                ]
            ]
        ]
    ]);
```

--------------------------------

### batchPutItem() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Defines the batchPutItem method that puts multiple items. Wraps each item as ['PutRequest' => ['Item' => $item]] and delegates to batchWriteItem().

```php
public function batchPutItem($items)
```

--------------------------------

### getClient()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/connection.md

Returns the underlying AWS SDK DynamoDB client.

```APIDOC
## getClient()

### Description
Returns the underlying AWS SDK DynamoDB client.

### Method
getClient

### Signature
`public function getClient()`

### Returns
`Aws\DynamoDb\DynamoDbClient` — the underlying AWS SDK client.
```

--------------------------------

### Paginate results with limit() and LastEvaluatedKey

Source: https://github.com/kitar/laravel-dynamodb/blob/main/README.md

Performs a scan with a limit of 5 items and retrieves the LastEvaluatedKey from the response for pagination.

```php
$response = DB::table('ProductCatalog')
    ->limit(5)
    ->scan();

$response['LastEvaluatedKey']; // array
```

--------------------------------

### batchWriteItem()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Performs a batch write operation with raw RequestItems.

```APIDOC
## batchWriteItem()

### Description
Performs a batch write operation with raw `RequestItems`. When `$request_items` is non-empty, it replaces the accumulated value.

### Method
PHP method

### Endpoint
`public function batchWriteItem($request_items = [])`

### Parameters
- **$request_items** (array) - Optional - Raw `RequestItems` array; when non-empty it replaces the accumulated value.

### Returns
`\Aws\Result`.

### Example
```php
DB::table('Thread')->batchWriteItem([
    ['PutRequest'    => ['Item' => ['ForumName' => 'Amazon DynamoDB', 'Subject' => 'Thread 3']]],
    ['DeleteRequest' => ['Key'  => ['ForumName' => 'Amazon DynamoDB', 'Subject' => 'Thread 1']]],
]);
```
```

--------------------------------

### compileBatchGetRequestItems() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when empty, otherwise returns an array with RequestItems containing the table name and marshaled keys.

```php
public function compileBatchGetRequestItems($table_name, $keys)
```

--------------------------------

### compileBatchWriteRequestItems() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns an empty array when empty, otherwise returns an array with RequestItems containing the table name and marshaled request bodies.

```php
public function compileBatchWriteRequestItems($table_name, $request_items)
```

--------------------------------

### batchGetItem()

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Retrieves multiple items from the table in a batch.

```APIDOC
## batchGetItem()

### Description
Retrieves multiple items from the table in a batch.

### Method
PHP method

### Endpoint
`public function batchGetItem($keys)`

### Parameters
- **$keys** (array) - Required - Array of key dictionaries.

### Returns
`array|\Illuminate\Support\Collection` — processed `Responses` (`process('batchGetItem', 'processBatchGetItems')`); a `Collection` of models when `usingModel()` is set.
```

--------------------------------

### addName method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/expression-attributes.md

Adds a raw attribute name and returns a placeholder key like '#1'. Names are deduplicated by strict membership.

```php
public function addName($name)
```

--------------------------------

### getOperators method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-grammar.md

Returns the merged list of operators and functions, totaling 11 entries.

```php
public function getOperators()
```

--------------------------------

### putItem() method signature

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/query-builder.md

Defines the putItem method that puts an item. Returns an unprocessed \Aws\Result.

```php
public function putItem($item)
```

--------------------------------

### NumberIterator key method

Source: https://github.com/kitar/laravel-dynamodb/blob/main/_autodocs/api-reference/helpers.md

Returns the current counter value.

```php
#[\ReturnTypeWillChange]
public function key()
```
Tokens:
Raw