Skip to main content

Amazon DAX Client for Python

Project description

The Amazon DAX Client for Python is used to access Amazon DAX clusters from Python. It is nearly source-compatible with Boto3, with only a small change needed to the client initialization to use DAX instead of DynamoDB.

Installation

Install Amazon DAX Client using pip:

$ pip install amazon-dax-client

Quick Start

Boto3 has two different interfaces, the resource interface and the botocore client interface. Both are supported by the Amazon DAX client, with slightly different client initialization.

For the resource API, change from:

ddb = boto3.resource('dynamodb')

to

dax = AmazonDaxClient.resource(
    endpoint_url='dax.abcdef.us-east-1.amazon.com')

All other boto3.resource() arguments are accepted.

For the botocore client API, change from:

session = botocore.session.get_session()
ddb = session.create_client('dynamodb', ...)

to

session = botocore.session.get_session()
dax = AmazonDaxClient(session, ...)

For Boto3 client API, change from:

ddb = boto3.client('dynamodb')

to

dax = AmazonDaxClient(endpoint_url='dax.abcdef.us-east-1.amazon.com')

The Boto3 and botocore client APIs are exactly the same.

Unsupported Features

The Amazon DAX client does not support table operations. Any table manipulation operations must use the regular Boto3 or botocore DynamoDB client.

Paginators are not currently supported for DAX.

Documentation

Once created, the interface is the same as the Boto3/botocore DynamoDB clients.

For acomplete example, follow the guide to create a sample app.

Getting Help

Please use these community resources for getting help.

Changes

v1.1.0

  • Adds support for transact-get-items and transact-write-items APIs for DyanamoDB transactions.
  • Improved efficiency of connection pooling.

v1.0.7

  • Fix scheduling of background tasks.

v1.0.6

  • Properly de-anonymize UnprocessedItems results from BatchWrite.
  • Raise a proper error if no backends are available.

v1.0.5

  • Fix UpdateItem result parsing with a subset of attributes changed

v1.0.4

  • Use user-specified timeouts
  • Fix issue with update response if the item is not changed
  • Fix error decoding BatchWrite UnprocessedItems.

v1.0.3

  • Fix AmazonDaxClient.resource() when using batch_get_items or batch_write_items.

v1.0.2

  • Fix Python 2 encoding issues
  • Fix decoding of ConsumedCapacity, ItemCollectionMetrics in batch operations

v1.0.1

  • Initial release

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
amazon-dax-client-1.1.0.tar.gz (91.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page