dynobase-icon
Dynobase

DynamoDB Keys - Everything You Need To Know

Written by Rafal Wilinski

What are keys in DynamoDB?

Keys, like in many other NoSQL and SQL databases, act as a unique identifier of a record or item. If you want to access an item in the DynamoDB table fast (with O(1) complexity), you'll need to know its key. In DynamoDB there are two types of primary keys:

Different DynamoDB Key Types

DynamoDB Simple Key

DynamoDB simple key consists only of one value - the partition/hash key. Each record needs to have one of these, and it needs to be unique. With simple key, DynamoDB essentially works just like a Key-Value store. You lose the ability to perform a Query, to fetch data from a table with such key, you can use Scan or GetItem operation.

DynamoDB Table with simple key

DynamoDB Composite Key

Another option is to use a composite key, which is composed of partition key, also known as hash key, and sort key, also known as range key. Choosing this option allows items to share the same partition/hash key, but the combination of hash key and sort key must be unique.

DynamoDB Table with composite key

As a consequence, you can now use Query, which allows to fetch a collection of items with the same partition key. Thanks to that (and GSIs + LSIs, more on that later), our Key-Value store becomes much more sophisticated because it allows for more complex query access patterns.

DynamoDB Global Secondary Key (GSI)

But what if you want to fetch an item without knowing its key, you only know other attribute, let's say authorId of the Book. If you index that attribute using Global Secondary Index, you don't have to use scan operation.

DynamoDB Table with Global secondary index

With GSIs, you can use GetItem and query operations using non-primary key attributes. In the background, DynamoDB keeps each of the GSIs automatically in sync with the base table. When a mutation is made against the table, any of the global secondary indexes on that table are updated asynchronously in an eventually consistent manner.

DynamoDB Local Secondary Key (LSI)

Another variation of secondary key is the Local Secondary Key. It works similar to the GSI but with one difference. In LSIs, the partition key must remain the same as the primary key's partition key. However, you can change the sort key. This is useful if you need to be able to fetch a collection of items sorted based on more than one attribute, e.g. updatedAt and createdAt.

DynamoDB Table with Local secondary index

Generally speaking, you should rather avoid LSIs for two reasons:

  • Unlike GSIs, you cannot update or delete them after table creation. All LSIs must be specified on table creation. This makes them rather unflexible.
  • If you create a table with Local Secondary Index, that table is going to have a 10GB size limit per partition key value.

DynamoDB Hot Key

Choosing the right keys is essential to keep your DynamoDB tables fast and performant. If your application will not access the keyspace uniformly, you might encounter the hot partition problem also known as hot key.

What is a hot key? It's an item with the key that is accessed much more frequently than the rest of the items. It causes an intensified load on one of the partitions, while others are accessed much less often.

DynamoDB Keys Best Practices

  • Favor composite keys over simple keys. They offer more functionality without downsides
  • Use keys with high cardinality to avoid hot keys/partitions problem. Isolate frequently accessed items so they won't reside on the same partition. This will reduce the likelihood of throttling
  • Plan your access patterns first, so you'll know what GSIs to create.
  • Maintain as low GSIs as possible. For most applications, three are enough.
  • Prefer generic GSI attribute names, something like gsi1_pk, gsi2_sk, etc.

Frequently Asked Questions

What can be a key in DynamoDB?

From all of the DynamoDB Types, only String, Binary and Number can be used as the key attribute type.

Is it possible to change partition key in DynamoDB?

No. Once the table is setup, you cannot modify its Key Schema. You can only provision a new table, move data there, and then remove the first table.

Can DynamoDB sort key be updated?

No. Similarly to the partition key, sort key cannot be changed after the table is provisioned.

Are DynamoDB keys case sensitive?

Yes. All the attribute names, values, and keys are case sensitive. E.g. ID is different than id.

How do I use numeric id for DynamoDB key?

Yes! Number is supported type as DynamoDB key.

What is the maximum length of sort key in DynamoDB?

The minimum length of a partition key and sort key is 1 byte, while the maximum length is 2048 bytes (2048 characters when using String type).

Should every attribute be a key in DynamoDB?

Technically, it is possible by adding multiple global secondary indexes, which will cover all the attributes. However, this is highly inefficient and not cost-effective.

DynamoDB query without key, is that possible?

No. You cannot run a query without specifying the partition key. If you don't know the partition key of the item you're looking for, you either need to create a global secondary index on a known attribute or use Scan.

Dynobase is a Professional GUI Client for DynamoDB

Start your 7-day free trial today

Product Features

© 2020 Dynobase

+
Still using AWS DynamoDB Console?
Try Dynobase to accelerate your DynamoDB workflow. Start your 7-day free trial today.