README

A data abstraction layer for DynamoDB, as a Symfony bundle.

Entities are plain PHP classes annotated with #[Table] and #[Field]. The bundle compiles them into definitions when the container is built, then reads and writes them through AsyncAws. You work with entities and PHP values; DynamoDB's attribute format stays inside the bundle.

• Typed fields: strings, numbers, booleans, dates, backed enums, Uids, lists and maps, and types of your own
• Get, query, scan and count, with one Filter builder for key conditions, filters and write conditions
• Puts, partial and nested updates, deletes and transactions, batched and retried for you
• Opaque, URL-safe pagination tokens that page forward and backward
• A definition dump, schema baselines for CI and a profiler panel

Getting started

The quick setup covers the requirements, installation, a first entity and how to read and write it.

Documentation

• Quick setup: requirements, installation, a first entity and its use
• Basics: entities, reading by key, queries, scans, counts, puts and deletes
• Updates, conditions and transactions
• Paginated listing: previous and next links, page numbers, and pages merged from several queries
• Custom types, normalizers and filters
• Architecture decisions

Development tooling

In the dev environment, the bundle adds three console commands:

With symfony/web-profiler-bundle installed, the profiler gets a DynamoDB panel. It lists each DynamoDB call a request made, with its caller and duration, and the serializer timings. The panel reads the calls from Symfony's traced HTTP client, so AsyncAws has to send them through a client named aws.base-client:

framework:
    http_client:
        scoped_clients:
            aws.base-client:
                scope: '.*'

async_aws:
    http_client: aws.base-client

Setting async_aws.http_client turns off the retrying HTTP client that AsyncAws builds by default. To keep retries, wrap aws.base-client with AsyncAws\Core\HttpClient\AwsHttpClientFactory::createRetryableClient().

Contributing

Read the guidelines before opening a pull request.

docker compose up -d   # DynamoDB Local on port 8345; point DYNAMODB_ENDPOINT elsewhere to use another
composer phpunit       # the integration suite fails when no DynamoDB answers
composer phpstan
composer ecs