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.

Publish

To publish:

python3 setup.py sdist bdist_wheel
./s3-upload $VERSION
twine upload dist/*

Getting Help

Please use these community resources for getting help.

Project details


Download files

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

Source Distribution

amazon-dax-client-1.0.1.tar.gz (83.3 kB view details)

Uploaded Source

File details

Details for the file amazon-dax-client-1.0.1.tar.gz.

File metadata

File hashes

Hashes for amazon-dax-client-1.0.1.tar.gz
Algorithm Hash digest
SHA256 7cd1ada353c9bb05b48dd00054e66b870aa7578ab7714539931d63af0901a028
MD5 7591ac8b955dcf4504b3d775b93a25a7
BLAKE2b-256 4c20f3284a43894f6843376f7f12f33734e0c8d3248cce8de8e87c6e7e712e63

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