guillermoandrae/php-dynamodb

A PHP library that can be used to interact with Amazon DynamoDB

2.1.1 2022-02-08 20:45 UTC

README

Travis Packagist Scrutinizer Scrutinizer Coverage @guillermoandrae on Twitter

This project provides a PHP library that can be used to interact with Amazon DynamoDB. It provides a layer of abstraction between your code and the DynamoDB-related classes made available by the AWS SDK for PHP.

Installation

The recommended way to install this library is through Composer:

composer require guillermoandrae/php-dynamodb

Getting Started

To get started using this library, you can perform operations such as this one:

<?php declare(strict_types=1);

require dirname(__DIR__) . '/vendor/autoload.php';

use Guillermoandrae\DynamoDb\DynamoDbAdapter;
use Guillermoandrae\DynamoDb\Constant\AttributeTypes;
use Guillermoandrae\DynamoDb\Constant\KeyTypes;

try {

    // create a new table
    $adapter = new DynamoDbAdapter();
    $adapter->useTable('myTable')->createTable([
        'year' => [AttributeTypes::NUMBER, KeyTypes::HASH],
        'title' => [AttributeTypes::STRING, KeyTypes::RANGE],
    ]);

} catch (\Exception $ex) {
    die($ex->getMessage());
}

You can also run the examples found in the examples directory:

php ./examples/tables.php

Docs

More information about this project can be found at the documentation site.

Thanks

Special thanks to Jason McCallister for encouraging me to finish this and providing Docker support; also thanks to Ryan McGovern for his contributions.