API

This part of the documentation documents all the public classes, functions, and API details in flask-dynamo. This documentation is auto generated, and is always a good up-to-date reference.

Configuration

class flask_dynamo.manager.Dynamo(app=None)

DynamoDB engine manager.

init_app(app)

Initialize this extension.

Parameters:app (obj) – The Flask application.

connection

Our DynamoDB connection.

This will be lazily created if this is the first time this is being accessed. This connection is reused for performance.

DynamoLazyTables = None

get_table(table_name)

create_all(wait=False)

Create all user-specified DynamoDB tables.

We’ll ignore table(s) that already exists. We’ll error out if the tables can’t be created for some reason.

destroy_all(wait=False)

Destroy all user-specified DynamoDB tables.

We’ll error out if the tables can’t be destroyed for some reason.

class flask_dynamo.manager.DynamoLazyTables(connection, table_config)

Manages access to Dynamo Tables.

keys()

The table names in our config.

len()

The number of tables we are configured for.

items()

The table tuples (name, connection.Table()).

wait_exists(table_name)

wait_not_exists(table_name)

create_all(wait=False)

destroy_all(wait=False)

Errors

class flask_dynamo.errors.ConfigurationError

This exception is raised if the user hasn’t properly configured Flask-Dynamo.