Prismarine Development Skill

This skill provides guidance for using Prismarine, a Pythonic ORM for DynamoDB.

Core Workflow

1. Define Models: Create a models.py file in your cluster package (e.g., common/models.py). Models must be in a file named models.py, not __init__.py.
2. Generate Client: Use the prismarine generate-client CLI command.
3. Extend/Use: Create a db.py file (e.g., common/db.py) to extend the generated client and use it for CRUD operations.

Model Definition

Models define the schema and keys for DynamoDB tables.

• Use @c.model(PK='...', SK='...') to define primary keys.
• Use @c.index(...) for Secondary Indexes (place ABOVE @c.model).
• See model-definition.md for detailed decorator options.

Client Generation

Generate the type-safe client using the CLI. The command expects to import your models from the models submodule.

uv run prismarine generate-client <base_pkg> --base . --model-library pydantic

Example:

uv run prismarine generate-client common --base . --model-library pydantic

CRUD Operations

The generated client provides a high-level API for interacting with DynamoDB.

from common.db import TeamModel

# Create
TeamModel.put({'Foo': 'val1', 'Bar': 'val2'})

# Get
item = TeamModel.get(foo='val1', bar='val2')

# Query (if SK exists)
items = TeamModel.list(foo='val1')

• See crud-api.md for the complete API reference.

EasySAM Integration

Prismarine tables are auto-generated by EasySAM. Do not define tables manually in easysam.yaml.

• Configure the prismarine: section in the root resources.yaml.
• See easysam.md for integration details.