Skip to content

pynamodb/PynamoDB

Repository files navigation

PynamoDB

image

image

image

image

A Pythonic interface for Amazon's DynamoDB.

DynamoDB is a great NoSQL service provided by Amazon, but the API is verbose. PynamoDB presents you with a simple, elegant API.

Useful links:

Installation

From PyPi:

$ pip install pynamodb

From GitHub:

$ pip install git+https://github.com/pynamodb/PynamoDB#egg=pynamodb

From conda-forge:

$ conda install -c conda-forge pynamodb

Basic Usage

Create a model that describes your DynamoDB table.

PynamoDB allows you to create the table if needed (it must exist before you can use it!):

Create a new user:

Now, search your table for all users with a last name of 'Denver' and whose first name begins with 'J':

Examples of ways to query your table with filter conditions:

Retrieve an existing user:

Upgrade Warning

The behavior of 'UnicodeSetAttribute' has changed in backwards-incompatible ways as of the 1.6.0 and 3.0.1 releases of PynamoDB.

See UnicodeSetAttribute upgrade docs for detailed instructions on how to safely perform the upgrade.

Advanced Usage

Want to use indexes? No problem:

Now query the index for all items with 0 views:

It's really that simple.

Want to use DynamoDB local? Just add a host name attribute and specify your local server.

Want to enable streams on a table? Just add a stream_view_type name attribute and specify the type of data you'd like to stream.

Features

  • Python >= 3.7 support
  • An ORM-like interface with query and scan filters
  • Compatible with DynamoDB Local
  • Supports the entire DynamoDB API
  • Support for Unicode, Binary, JSON, Number, Set, and UTC Datetime attributes
  • Support for Global and Local Secondary Indexes
  • Provides iterators for working with queries, scans, that are automatically paginated
  • Automatic pagination for bulk operations
  • Complex queries
  • Batch operations with automatic pagination
  • Iterators for working with Query and Scan operations