Skip to main content

A Pythonic Interface to DynamoDB

Project description

Latest Version https://travis-ci.org/jlafon/PynamoDB.png?branch=devel https://coveralls.io/repos/jlafon/PynamoDB/badge.png?branch=devel https://pypip.in/wheel/pynamodb/badge.png https://pypip.in/license/pynamodb/badge.png

A Pythonic interface for Amazon’s DynamoDB that supports Python 2 and 3.

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

See documentation at http://pynamodb.readthedocs.org/

Basic Usage

Create a model that describes your DynamoDB table.

from pynamodb.models import Model
from pynamodb.attributes import UnicodeAttribute

class UserModel(Model):
        """
        A DynamoDB User
        """
        table_name = 'dynamodb-user'
        email = UnicodeAttribute(null=True)
        first_name = UnicodeAttribute(range_key=True)
        last_name = UnicodeAttribute(hash_key=True)

Now, search your table for all users with a last name of ‘Smith’ and whose first name begins with ‘J’:

for user in UserModel.query('Smith', first_name__begins_with='J'):
    print(user.first_name)

Create a new user:

user = UserModel('John', 'Denver')
user.save()

Advanced Usage

Wan’t to use indexes? No problem:

from pynamodb.models import Model
from pynamodb.indexes import GlobalSecondaryIndex, AllProjection
from pynamodb.attributes import NumberAttribute, UnicodeAttribute

class ViewIndex(GlobalSecondaryIndex):
    read_capacity_units = 2
    write_capacity_units = 1
    projection = AllProjection()
    view = NumberAttribute(default=0, hash_key=True)

class TestModel(Model):
    table_name = 'TestModel'
    forum = UnicodeAttribute(hash_key=True)
    thread = UnicodeAttribute(range_key=True)
    view = NumberAttribute(default=0)
    view_index = ViewIndex()

Now query the index for all items with 0 views:

for item in TestModel.view_index.query(0):
    print("Item queried from index: {0}".format(item))

It’s really that simple.

Installation:

$ pip install pynamodb

or install the development version:

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

Features

  • Python 3 support

  • Python 2 support

  • An ORM-like interface with query and scan filters

  • Includes the entire DynamoDB API

  • Supports both unicode and binary DynamoDB attributes

  • Support for global secondary indexes, local secondary indexes, and batch operations

  • Provides iterators for working with queries, scans, that are automatically paginated

  • Automatic pagination for bulk operations

  • Complex queries

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pynamodb-0.1.7.tar.gz (30.7 kB view details)

Uploaded Source

Built Distribution

pynamodb-0.1.7-py2.py3-none-any.whl (37.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pynamodb-0.1.7.tar.gz.

File metadata

  • Download URL: pynamodb-0.1.7.tar.gz
  • Upload date:
  • Size: 30.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pynamodb-0.1.7.tar.gz
Algorithm Hash digest
SHA256 ac9356446e839148cb59279f050a1ade53a8d0a5f086dc27783f53f6cc9ded30
MD5 e38397b1f6ee1ad47130d9e7ba8f372c
BLAKE2b-256 3a06050ae172d4d89a50e4c216a47230062719dc500e803f69bf62b3d3fb0b2f

See more details on using hashes here.

File details

Details for the file pynamodb-0.1.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pynamodb-0.1.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b29d71b816bad1775f2374eb3b318518daba83749e772db525b6f3f907844aa0
MD5 74e21db085974c91c1333f38b1c77f29
BLAKE2b-256 77e0b7c656b60c211800e0bcad5e0f95deb13f4e4b8c910515924471f57035fe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page