Lesson 2

Creating and Configuring DynamoDB Tables with AWS SDK for Python

Introduction to DynamoDB Table Basics

Welcome back! Previously, we explored Amazon DynamoDB, a NoSQL database provided by AWS, noted for its flexibility in handling schema-less data management. This session deepens our dive into DynamoDB by focusing on the essential components of the database—tables.

In this lesson, we'll concentrate on how data is structured in DynamoDB tables, consisting of items grouped by attributes, such as a name or a date. We'll cover crucial concepts such as primary keys, data types, and capacity modes, equipping you with the knowledge to effectively create and manage tables using Python’s Boto3. Mastering these aspects is essential for building applications that are both scalable and efficient.

Understanding DynamoDB Table Keys

In DynamoDB, each item within a table is uniquely identified by a primary key, which is critical for efficient data retrieval and management. The primary key can consist of either a single attribute, known as a partition key, or a combination of two attributes: a partition key and a sort key.

  • Partition Key: Also known as a Hash Key, this key determines the distribution of data across various physical storage partitions in DynamoDB. Multiple items in the table may have identical values for the partition key. However, if a table uses only the partition key as its primary key, that key value must be unique for each item in the table as it's the sole identifier for the item's location in the table.

  • Sort Key : Also known as a range key, this key allows items with the same partition key to be stored and retrieved in a sorted order. The sort key provides the necessary uniqueness when combined with the partition key, ensuring that no two items in the same partition have the same sort key value.

In a correct setup with a composite primary key, consider a table named BlogPosts where AuthorID serves as the partition key and PostDate as the sort key. This setup allows each post by the same author to be uniquely identified by the date:

AuthorIDPostDateTitle
A12020-01-01New Year Reflections
A12020-01-02Another Day in Life

However, if the same author writes multiple posts on the same date, and the PostDate is not combined with another unique attribute, this can result in incorrect setup as shown below:

AuthorIDPostDateTitle
A12020-01-01Morning Thoughts
A12020-01-01Evening Reflections

In this scenario, both posts from the same day are not uniquely distinguishable solely by the primary key, which could lead to one post overwriting the other if not managed properly. This example emphasizes the importance of ensuring that the primary key, whether simple or composite, effectively distinguishes each item in the table. Understanding these keys and their impact on data distribution and access is fundamental for designing efficient DynamoDB tables.

Data Types

Before defining a table in DynamoDB, understanding the diverse data types it supports is essential. DynamoDB categorizes its data types into three primary groups: Scalar Types, Document Types, and Set Types. Each group addresses specific data structuring requirements, playing a vital role in how data is stored and accessed.

  • Scalar Types: These are the fundamental data types that store a single value.

    • String (S): Suitable for textual data such as names, addresses, or dates. This type supports a broad range of characters, making it versatile for various data, including textual information and encoded data or timestamps.
    • Number (N): Ideal for data that involves numerical operations, such as age, price, or measurements. It can represent both integers and floating-point numbers.
    • Binary (B): Designed for binary data, like encrypted content or images, which are not appropriate in text formats.
    • Boolean (BOOL): Holds a true or false value, commonly used for flags or conditional states.
    • Null (NULL): Indicates a null value, representing attributes that are undefined or not applicable.
  • Document Types: Enable the storage of structured data in a more agile format.

    • Map (M): A collection of attribute name-value pairs, similar to objects in programming languages such as Python or JSON objects.
    • List (L): An ordered list of values, which can include elements of any data type, including mixed types. This flexibility allows for complex data structures to be easily represented within a single attribute.
  • Set Types: Distinct types that store multiple, unique elements. There are three specific Set types:

    • String Set (SS): A set of unique string values.
    • Number Set (NS): A set of unique number values.
    • Binary Set (BS): A set of unique binary values.

The ability to store unique elements in sets underscores DynamoDB's versatility in handling complex data models. However, it's important to note that primary key attributes (both partition and sort keys) can only utilize Scalar Types. This restriction ensures the efficiency and reliability of key operations, reflecting the importance of judicious data type selection to maximize DynamoDB’s scalability and performance capabilities.

Understanding DynamoDB Capacity Modes

Before creating a table in DynamoDB, it's crucial to decide which capacity mode to use, as this will affect how you manage and pay for read and write throughput. DynamoDB offers two main types of capacity modes, each suited to different application needs:

  • Provisioned: In this mode, you specify the amount of reads and writes per second that your application requires. It is ideal for applications with predictable traffic, as it allows you to manage costs effectively by setting specific thresholds for read and write operations. Additionally, the Provisioned capacity mode is eligible for the AWS Free Tier, making it an attractive option for development and testing environments where cost-efficiency is a priority.

    • Read Capacity Unit (RCU): Provides enough capacity to perform one strongly consistent read per second, or two eventually consistent reads per second, for an item up to 4 KB in size.
    • Write Capacity Unit (WCU): Provides enough capacity to perform one write per second for an item up to 1 KB in size.
  • On-Demand: This mode offers flexible billing and does not require you to specify your capacity in advance. You are billed for the reads and writes your application actually performs. This mode is perfect for applications with unpredictable traffic, eliminating the need for capacity planning.

When considering consistency models during read operations, it's important to understand the difference between eventual consistency and strong consistency:

  • Eventual Consistency: Provides the most up-to-date data within a second. Successive read operations might occasionally return old data but usually reach eventual consistency quickly. It costs half the RCU compared to strong consistency and is more suitable for applications where absolute data freshness is not critical.
  • Strong Consistency: Ensures that a read operation returns the most recent write data. Use this for applications requiring up-to-date information at all times.

The default capacity mode is Provisioned, which allows for finer control over costs and performance. However, switching to On-Demand is simple and can be beneficial if your application experiences widely variable load.

Creating DynamoDB Tables

Now that we've covered the basics of data types and key structures, we have all the information needed to create DynamoDB tables. This section demonstrates how to set up tables using different configurations, including varied key schemas and capacity modes, to suit specific application needs.

The first example illustrates setting up a table using Provisioned Throughput with a composite primary key. This configuration is suitable for applications with predictable traffic, where specific read and write capacities are set according to expected load.

Python
1import boto3 2 3dynamodb = boto3.resource('dynamodb') # Initialize the DynamoDB service 4 5# Create a table with Provisioned Throughput and a composite primary key 6table_provisioned = dynamodb.create_table( 7 TableName='Users', 8 KeySchema=[ 9 {'AttributeName': 'username', 'KeyType': 'HASH'}, # Partition key 10 {'AttributeName': 'signup_date', 'KeyType': 'RANGE'} # Sort key 11 ], 12 AttributeDefinitions=[ 13 {'AttributeName': 'username', 'AttributeType': 'S'}, # String type 14 {'AttributeName': 'signup_date', 'AttributeType': 'S'} # String type 15 ], 16 ProvisionedThroughput={'ReadCapacityUnits': 5, 'WriteCapacityUnits': 5} # Specify capacity 17)

Please note that only attributes used as part of the primary key (either as a partition key or sort key) must be included in the AttributeDefinitions. Attributes that are not part of the primary key need not be defined in AttributeDefinitions unless they are involved in indexing or require specific type validation for operations. This approach allows DynamoDB to maintain a flexible schema while ensuring that key attributes have defined data types for efficient indexing and querying.

The second example shows how to create a table using the On-Demand capacity mode with a simple primary key. This mode is ideal for applications with unpredictable or variable traffic, as it requires no upfront capacity planning and you are billed for the read and write operations that you actually perform.

Python
1import boto3 2 3dynamodb = boto3.resource('dynamodb') 4 5table_on_demand = dynamodb.create_table( 6 TableName='Customers', 7 KeySchema=[{'AttributeName': 'customer_id', 'KeyType': 'HASH'}], 8 AttributeDefinitions=[{'AttributeName': 'customer_id', 'AttributeType': 'S'}], 9 BillingMode='PAY_PER_REQUEST' 10)

These examples illustrate the flexibility of DynamoDB in table creation, catering to different application requirements and helping optimize costs based on actual usage. Whether dealing with stable or variable workloads, DynamoDB provides the necessary tools to efficiently manage your data storage needs.

Attribute Naming Conventions

It's important to address best practices for naming attributes in your DynamoDB tables. Attribute names are case-sensitive, and their consistent naming can significantly impact the readability and maintainability of your database. While DynamoDB allows for a variety of naming styles, choosing one and sticking to it is crucial. Whether you opt for camelCase, snake_case, PascalCase, or simply lowercase, ensure uniformity across all attribute names. This practice not only prevents confusion but also aids in creating a more organized database schema that is easier for your team to navigate and manage.

Utilizing DynamoDB Waiters in Boto3

Waiters in Boto3 are useful for managing the state of DynamoDB operations, ensuring that resources like tables are fully operational before proceeding with further actions. They check the status of a resource repeatedly until a specified condition is met. There are two main approaches to using waiters for ensuring a table is ready for use after its creation: a more configurable method and a simpler, less configurable one.

For a more configurable approach, you can specify the wait time and polling frequency:

Python
1import boto3 2 3# Initialize the boto3 DynamoDB service 4dynamodb = boto3.resource('dynamodb') 5 6waiter = dynamodb.meta.client.get_waiter('table_exists') 7 8# Configure the waiter to wait for up to 300 seconds (5 minutes), polling every 20 seconds 9waiter.wait(TableName='ExampleTable', WaiterConfig={'Delay': 20, 'MaxAttempts': 15}) 10 11print("Table is now active and ready for use.")

In this example, the WaiterConfig parameter allows customization of the waiting behavior, where Delay sets the time in seconds between attempts, and MaxAttempts defines the maximum number of polling attempts. This is suitable when you need fine control over how long your application waits for a table to become active.

Alternatively, for a simpler approach without configuration, you can use the wait_until_exists method which uses default settings for delay and attempts:

Python
1import boto3 2 3# Initialize the boto3 DynamoDB service 4dynamodb = boto3.resource('dynamodb') 5 6table = dynamodb.Table('ExampleTable') 7 8# Wait until the table exists, using default settings 9table.wait_until_exists() 10 11print("Table is now active and ready for use.")

This method provides an easy way to wait for a table to become active with less granular control over the wait configuration. It's ideal for straightforward use-cases where the default settings are sufficient for your needs.

Listing All DynamoDB Tables

Finally, we can list all available tables in our DynamoDB using the tables.all() method:

Python
1import boto3 2 3# Initialize the boto3 DynamoDB service 4dynamodb = boto3.resource('dynamodb') 5 6print("Existing tables:", [table.name for table in dynamodb.tables.all()])

The output should display the names of the tables created: Users and Customers.

Review and Upcoming Practice Exercises

Great job mastering table creation in DynamoDB using Python and Boto3! We've covered table basics, keys, data types, and capacity modes, and also demonstrated how to create tables with different configurations. You've learned how to use waiters to ensure operations complete before proceeding, enhancing the reliability of your applications.

In the following exercises, you'll practice these skills to reinforce your learning. Looking ahead, we'll delve into DynamoDB CRUD operations, beginning with creating data in DynamoDB. Keep up the good work and see you in the next lesson!

Enjoy this lesson? Now it's time to practice with Cosmo!

Practice is how you turn knowledge into actual skills.