Welcome to PynamoDB’s documentation!

PynamoDB is a Pythonic interface to Amazon’s DynamoDB. By using simple, yet powerful abstractions over the DynamoDB API, PynamoDB allows you to start developing immediately.

Features

• Python 3 support

• Support for Unicode, Binary, JSON, Number, Set, and UTC Datetime attributes

• Support for DynamoDB Local

• Support for all of the DynamoDB API

• Support for Global and Local Secondary Indexes

• Batch operations with automatic pagination

• Iterators for working with Query and Scan operations

• Fully tested

Topics

• Usage
  • Creating a model
  • Changing items
  • Querying
  • Counting Items
  • Batch Operations
• Basic Tutorial
  • Why PynamoDB?
  • Installation
  • Getting Started
  • Using the Model
• Index Queries
  • Index Settings
  • Global Secondary Indexes
  • Local Secondary Indexes
  • Querying an index
  • Pagination and last evaluated key
• Batch Operations
  • Batch Writes
  • Batch Gets
  • Query Filters
  • Scan Filters
  • Limiting results
• Update Operations
  • Update Expressions
  • remove action
  • add action
  • delete action
• Conditional Operations
  • Condition Expressions
  • Conditioning on keys
  • Conditional Model.save
  • Conditional Model.update
  • Conditional Model.delete
  • Conditional Operation Failures
• Polymorphism
  • Discriminator Attributes
  • Model Discriminators
• Custom Attributes
  • Attribute Methods
  • Writing your own attribute
  • Custom Attribute Example
  • List Attributes
  • Map Attributes
• Transaction Operations
  • Transact Writes
  • Transact Gets
  • Error Types
• Optimistic Locking
  • Version Attribute
  • Model.{update, save, delete}
  • Conditioning on the version
  • Transactions
  • Batch Operations
• Rate-Limited Operation
  • Example Usage
  • Query
  • Count
• Use PynamoDB Locally
  • Running dynalite
  • Running DynamoDB Local
• Signals
  • Subscribing to Signals
• PynamoDB Examples
  • Install PynamoDB
  • Getting the examples
  • Running the examples
  • Configuring the examples
  • Running an example
• Settings
  • Settings reference
  • Overriding settings
• Low Level API
  • Creating a connection
  • Modifying tables
  • Modifying items
• AWS Access
• Logging
• Contributing
  • Environment Setup
  • Running Tests
  • Backwards Compatibility
  • The Scope of the Library
  • Pull Requests
  • Changelog
  • Documentation
• Release Notes
  • v6.0.1
  • v6.0.0
  • v5.5.1
  • v5.5.0
  • v5.4.1
  • v5.4.0
  • v5.3.2
  • v5.3.1
  • v5.3.0
  • v5.2.3
  • v5.2.2
  • v5.2.1
  • v5.2.0
  • v5.1.0
  • v5.0.3
  • v5.0.2
  • v5.0.1
  • v5.0.0
  • v4.4.1
  • v4.4.0
  • v4.3.3
  • v4.3.2
  • v4.3.1
  • v4.3.0
  • v4.2.0
  • v4.1.0
  • v4.0.0
  • v3.4.1
  • v3.4.0
  • v3.3.3
  • v3.3.2
  • v3.3.1
  • v3.3.0
  • v3.2.1
  • v3.2.0
  • v3.2.0rc2
  • v3.2.0rc1
  • v3.1.0
  • v3.0.1
  • v2.2.0
  • v2.1.6
  • v2.1.5
  • v2.1.4
  • v2.0.3
  • v2.0.2
  • v2.0.1
  • v2.0.0
  • v1.6.0
  • v1.5.4
  • v1.5.3
  • v1.5.2
  • v1.5.1
  • v1.5.0
  • v1.4.4
  • v1.4.3
  • v1.4.2
  • v1.4.1
  • v1.4.0
  • v1.3.7
  • v1.3.6
  • v1.3.5
  • v1.3.4
  • v1.3.3
  • v1.3.2
  • v1.3.1
  • v1.3.0
  • v1.2.2
  • v1.2.1
  • v1.2.0
  • v1.1.0
  • v1.0.0
  • v0.1.13
  • v0.1.12
  • v0.1.11
• Versioning Scheme
• Upgrading
  • PynamoDB 5.x to 6.x
  • PynamoDB 4.x to 5.x
  • PynamoDB 3.x to 4.x
  • PynamoDB 2.x to 3.x

API docs

• API
  • High Level API
  • Low Level API
  • Exceptions

Indices and tables

• Index

• Module Index

• Search Page