Introduction

Indexes are a vital a part of correct knowledge modeling for all databases, and DynamoDB isn’t any exception. DynamoDB’s secondary indexes are a robust device for enabling new entry patterns in your knowledge.

On this submit, we’ll have a look at DynamoDB secondary indexes. First, we’ll begin with some conceptual factors about how to consider DynamoDB and the issues that secondary indexes resolve. Then, we’ll have a look at some sensible suggestions for utilizing secondary indexes successfully. Lastly, we’ll shut with some ideas on when you need to use secondary indexes and when you need to search for different options.

Let’s get began.

What’s DynamoDB, and what are DynamoDB secondary indexes?

Earlier than we get into use circumstances and finest practices for secondary indexes, we must always first perceive what DynamoDB secondary indexes are. And to try this, we must always perceive a bit about how DynamoDB works.

This assumes some fundamental understanding of DynamoDB. We’ll cowl the fundamental factors you want to know to know secondary indexes, however should you’re new to DynamoDB, you could need to begin with a extra fundamental introduction.

The Naked Minimal you Have to Learn about DynamoDB

DynamoDB is a novel database. It is designed for OLTP workloads, which means it is nice for dealing with a excessive quantity of small operations — consider issues like including an merchandise to a buying cart, liking a video, or including a touch upon Reddit. In that means, it may deal with related purposes as different databases you might need used, like MySQL, PostgreSQL, MongoDB, or Cassandra.

DynamoDB’s key promise is its assure of constant efficiency at any scale. Whether or not your desk has 1 megabyte of information or 1 petabyte of information, DynamoDB desires to have the identical latency in your OLTP-like requests. This can be a huge deal — many databases will see decreased efficiency as you improve the quantity of information or the variety of concurrent requests. Nonetheless, offering these ensures requires some tradeoffs, and DynamoDB has some distinctive traits that you want to perceive to make use of it successfully.

First, DynamoDB horizontally scales your databases by spreading your knowledge throughout a number of partitions underneath the hood. These partitions usually are not seen to you as a consumer, however they’re on the core of how DynamoDB works. You’ll specify a major key in your desk (both a single component, known as a ‘partition key’, or a mix of a partition key and a form key), and DynamoDB will use that major key to find out which partition your knowledge lives on. Any request you make will undergo a request router that may decide which partition ought to deal with the request. These partitions are small — usually 10GB or much less — to allow them to be moved, cut up, replicated, and in any other case managed independently.

Horizontal scalability through sharding is attention-grabbing however is certainly not distinctive to DynamoDB. Many different databases — each relational and non-relational — use sharding to horizontally scale. Nonetheless, what is distinctive to DynamoDB is the way it forces you to make use of your major key to entry your knowledge. Slightly than utilizing a question planner that interprets your requests right into a collection of queries, DynamoDB forces you to make use of your major key to entry your knowledge. You might be primarily getting a instantly addressable index in your knowledge.

The API for DynamoDB displays this. There are a collection of operations on particular person gadgets (GetItem, PutItem, UpdateItem, DeleteItem) that assist you to learn, write, and delete particular person gadgets. Moreover, there’s a Question operation that means that you can retrieve a number of gadgets with the identical partition key. When you’ve got a desk with a composite major key, gadgets with the identical partition key can be grouped collectively on the identical partition. They are going to be ordered in accordance with the kind key, permitting you to deal with patterns like “Fetch the latest Orders for a Person” or “Fetch the final 10 Sensor Readings for an IoT Gadget”.

For instance, we could say a SaaS utility that has a desk of Customers. All Customers belong to a single Group. We’d have a desk that appears as follows:

We’re utilizing a composite major key with a partition key of ‘Group’ and a form key of ‘Username’. This permits us to do operations to fetch or replace a person Person by offering their Group and Username. We are able to additionally fetch the entire Customers for a single Group by offering simply the Group to a Question operation.

What are secondary indexes, and the way do they work

With some fundamentals in thoughts, let’s now have a look at secondary indexes. One of the simplest ways to know the necessity for secondary indexes is to know the issue they resolve. We have seen how DynamoDB partitions your knowledge in accordance with your major key and the way it pushes you to make use of the first key to entry your knowledge. That is all properly and good for some entry patterns, however what if you want to entry your knowledge differently?

In our instance above, we had a desk of customers that we accessed by their group and username. Nonetheless, we might also must fetch a single consumer by their electronic mail handle. This sample would not match with the first key entry sample that DynamoDB pushes us in the direction of. As a result of our desk is partitioned by totally different attributes, there’s not a transparent strategy to entry our knowledge in the best way we wish. We may do a full desk scan, however that is sluggish and inefficient. We may duplicate our knowledge right into a separate desk with a special major key, however that provides complexity.

That is the place secondary indexes are available. A secondary index is mainly a completely managed copy of your knowledge with a special major key. You’ll specify a secondary index in your desk by declaring the first key for the index. As writes come into your desk, DynamoDB will routinely replicate the info to your secondary index.

Notice: All the pieces on this part applies to international secondary indexes. DynamoDB additionally offers native secondary indexes, that are a bit totally different. In nearly all circumstances, you want a world secondary index. For extra particulars on the variations, take a look at this text on selecting a world or native secondary index.

On this case, we’ll add a secondary index to our desk with a partition key of “E mail”. The secondary index will look as follows:

Discover that this is identical knowledge, it has simply been reorganized with a special major key. Now, we are able to effectively lookup a consumer by their electronic mail handle.

In some methods, that is similar to an index in different databases. Each present an information construction that’s optimized for lookups on a specific attribute. However DynamoDB’s secondary indexes are totally different in a number of key methods.

First, and most significantly, DynamoDB’s indexes dwell on completely totally different partitions than your essential desk. DynamoDB desires each lookup to be environment friendly and predictable, and it desires to supply linear horizontal scaling. To do that, it must reshard your knowledge by the attributes you may use to question it.

In different distributed databases, they typically do not reshard your knowledge for the secondary index. They’re going to normally simply preserve the secondary index for all knowledge on the shard. Nonetheless, in case your indexes do not use the shard key, you are shedding among the advantages of horizontally scaling your knowledge as a question with out the shard key might want to do a scatter-gather operation throughout all shards to seek out the info you are on the lookout for.

A second means that DynamoDB’s secondary indexes are totally different is that they (usually) copy the whole merchandise to the secondary index. For indexes on a relational database, the index will usually comprise a pointer to the first key of the merchandise being listed. After finding a related document within the index, the database will then must go fetch the total merchandise. As a result of DynamoDB’s secondary indexes are on totally different nodes than the primary desk, they need to keep away from a community hop again to the unique merchandise. As a substitute, you may copy as a lot knowledge as you want into the secondary index to deal with your learn.

Secondary indexes in DynamoDB are highly effective, however they’ve some limitations. First off, they’re read-only — you may’t write on to a secondary index. Slightly, you’ll write to your essential desk, and DynamoDB will deal with the replication to your secondary index. Second, you’re charged for the write operations to your secondary indexes. Thus, including a secondary index to your desk will usually double the whole write prices in your desk.

Ideas for utilizing secondary indexes

Now that we perceive what secondary indexes are and the way they work, let’s discuss the best way to use them successfully. Secondary indexes are a robust device, however they are often misused. Listed here are some suggestions for utilizing secondary indexes successfully.

Attempt to have read-only patterns on secondary indexes

The primary tip appears apparent — secondary indexes can solely be used for reads, so you need to goal to have read-only patterns in your secondary indexes! And but, I see this error on a regular basis. Builders will first learn from a secondary index, then write to the primary desk. This ends in additional value and further latency, and you may usually keep away from it with some upfront planning.

In the event you’ve learn something about DynamoDB knowledge modeling, you most likely know that you need to consider your entry patterns first. It is not like a relational database the place you first design normalized tables after which write queries to affix them collectively. In DynamoDB, you need to take into consideration the actions your utility will take, after which design your tables and indexes to assist these actions.

When designing my desk, I like to start out with the write-based entry patterns first. With my writes, I am usually sustaining some sort of constraint — uniqueness on a username or a most variety of members in a bunch. I need to design my desk in a means that makes this easy, ideally with out utilizing DynamoDB Transactions or utilizing a read-modify-write sample that could possibly be topic to race situations.

As you’re employed by way of these, you may usually discover that there is a ‘major’ strategy to establish your merchandise that matches up together with your write patterns. This may find yourself being your major key. Then, including in extra, secondary learn patterns is simple with secondary indexes.

In our Customers instance earlier than, each Person request will seemingly embrace the Group and the Username. This may permit me to lookup the person Person document in addition to authorize particular actions by the Person. The e-mail handle lookup could also be for much less distinguished entry patterns, like a ‘forgot password’ move or a ‘seek for a consumer’ move. These are read-only patterns, they usually match properly with a secondary index.

Use secondary indexes when your keys are mutable

A second tip for utilizing secondary indexes is to make use of them for mutable values in your entry patterns. Let’s first perceive the reasoning behind it, after which have a look at conditions the place it applies.

DynamoDB means that you can replace an current merchandise with the UpdateItem
operation. Nonetheless, you can not change the first key of an merchandise in an replace. The first secret is the distinctive identifier for an merchandise, and altering the first secret is mainly creating a brand new merchandise. If you wish to change the first key of an current merchandise, you may must delete the outdated merchandise and create a brand new one. This two-step course of is slower and expensive. Typically you may must learn the unique merchandise first, then use a transaction to delete the unique merchandise and create a brand new one in the identical request.

Then again, when you have this mutable worth within the major key of a secondary index, then DynamoDB will deal with this delete + create course of for you throughout replication. You possibly can difficulty a easy UpdateItem request to alter the worth, and DynamoDB will deal with the remainder.

I see this sample come up in two essential conditions. The primary, and most typical, is when you’ve gotten a mutable attribute that you just need to kind on. The canonical examples listed below are a leaderboard for a sport the place individuals are regularly racking up factors, or for a regularly updating record of things the place you need to show essentially the most not too long ago up to date gadgets first. Consider one thing like Google Drive, the place you may kind your information by ‘final modified’.

A second sample the place this comes up is when you’ve gotten a mutable attribute that you just need to filter on. Right here, you may consider an ecommerce retailer with a historical past of orders for a consumer. Chances are you’ll need to permit the consumer to filter their orders by standing — present me all my orders which can be ‘shipped’ or ‘delivered’. You possibly can construct this into your partition key or the start of your kind key to permit exact-match filtering. Because the merchandise adjustments standing, you may replace the standing attribute and lean on DynamoDB to group the gadgets appropriately in your secondary index.

In each of those conditions, transferring this mutable attribute to your secondary index will prevent money and time. You may save time by avoiding the read-modify-write sample, and you may get monetary savings by avoiding the additional write prices of the transaction.

Moreover, be aware that this sample matches properly with the earlier tip. It is unlikely you’ll establish an merchandise for writing primarily based on the mutable attribute like their earlier rating, their earlier standing, or the final time they have been up to date. Slightly, you may replace by a extra persistent worth, just like the consumer’s ID, the order ID, or the file’s ID. Then, you may use the secondary index to kind and filter primarily based on the mutable attribute.

Keep away from the ‘fats’ partition

We noticed above that DynamoDB divides your knowledge into partitions primarily based on the first key. DynamoDB goals to maintain these partitions small — 10GB or much less — and you need to goal to unfold requests throughout your partitions to get the advantages of DynamoDB’s scalability.

This usually means you need to use a high-cardinality worth in your partition key. Consider one thing like a username, an order ID, or a sensor ID. There are giant numbers of values for these attributes, and DynamoDB can unfold the site visitors throughout your partitions.

Typically, I see folks perceive this precept of their essential desk, however then fully neglect about it of their secondary indexes. Typically, they need ordering throughout the whole desk for a kind of merchandise. In the event that they need to retrieve customers alphabetically, they will use a secondary index the place all customers have USERS because the partition key and the username as the kind key. Or, if they need ordering of the latest orders in an ecommerce retailer, they will use a secondary index the place all orders have ORDERS because the partition key and the timestamp as the kind key.

This sample can work for small-traffic purposes the place you will not come near the DynamoDB partition throughput limits, however it’s a harmful sample for a heavy-traffic utility. Your whole site visitors could also be funneled to a single bodily partition, and you may rapidly hit the write throughput limits for that partition.

Additional, and most dangerously, this may trigger issues in your essential desk. In case your secondary index is getting write throttled throughout replication, the replication queue will again up. If this queue backs up an excessive amount of, DynamoDB will begin rejecting writes in your essential desk.

That is designed that can assist you — DynamoDB desires to restrict the staleness of your secondary index, so it should forestall you from a secondary index with a considerable amount of lag. Nonetheless, it may be a shocking scenario that pops up whenever you’re least anticipating it.

Use sparse indexes as a world filter

Individuals usually consider secondary indexes as a strategy to replicate all of their knowledge with a brand new major key. Nonetheless, you do not want your whole knowledge to finish up in a secondary index. When you’ve got an merchandise that does not match the index’s key schema, it will not be replicated to the index.

This may be actually helpful for offering a world filter in your knowledge. The canonical instance I take advantage of for it is a message inbox. In your essential desk, you may retailer all of the messages for a specific consumer ordered by the point they have been created.

However should you’re like me, you’ve gotten a whole lot of messages in your inbox. Additional, you may deal with unread messages as a ‘todo’ record, like little reminders to get again to somebody. Accordingly, I normally solely need to see the unread messages in my inbox.

You possibly can use your secondary index to supply this international filter the place unread == true. Maybe your secondary index partition secret is one thing like ${userId}#UNREAD, and the kind secret is the timestamp of the message. Once you create the message initially, it should embrace the secondary index partition key worth and thus can be replicated to the unread messages secondary index. Later, when a consumer reads the message, you may change the standing to READ and delete the secondary index partition key worth. DynamoDB will then take away it out of your secondary index.

I take advantage of this trick on a regular basis, and it is remarkably efficient. Additional, a sparse index will prevent cash. Any updates to learn messages won’t be replicated to the secondary index, and you may save on write prices.

Slender your secondary index projections to cut back index measurement and/or writes

For our final tip, let’s take the earlier level a bit additional. We simply noticed that DynamoDB will not embrace an merchandise in your secondary index if the merchandise would not have the first key parts for the index. This trick can be utilized for not solely major key parts but additionally for non-key attributes within the knowledge!

Once you create a secondary index, you may specify which attributes from the primary desk you need to embrace within the secondary index. That is known as the projection of the index. You possibly can select to incorporate all attributes from the primary desk, solely the first key attributes, or a subset of the attributes.

Whereas it is tempting to incorporate all attributes in your secondary index, this is usually a expensive mistake. Keep in mind that each write to your essential desk that adjustments the worth of a projected attribute can be replicated to your secondary index. A single secondary index with full projection successfully doubles the write prices in your desk. Every extra secondary index will increase your write prices by 1/N + 1, the place N is the variety of secondary indexes earlier than the brand new one.

Moreover, your write prices are calculated primarily based on the scale of your merchandise. Every 1KB of information written to your desk makes use of a WCU. In the event you’re copying a 4KB merchandise to your secondary index, you may be paying the total 4 WCUs on each your essential desk and your secondary index.

Thus, there are two methods which you can get monetary savings by narrowing your secondary index projections. First, you may keep away from sure writes altogether. When you’ve got an replace operation that does not contact any attributes in your secondary index projection, DynamoDB will skip the write to your secondary index. Second, for these writes that do replicate to your secondary index, it can save you cash by lowering the scale of the merchandise that’s replicated.

This is usually a difficult steadiness to get proper. Secondary index projections usually are not alterable after the index is created. In the event you discover that you just want extra attributes in your secondary index, you may must create a brand new index with the brand new projection after which delete the outdated index.

Do you have to use a secondary index?

Now that we have explored some sensible recommendation round secondary indexes, let’s take a step again and ask a extra basic query — must you use a secondary index in any respect?

As we have seen, secondary indexes assist you entry your knowledge differently. Nonetheless, this comes at the price of the extra writes. Thus, my rule of thumb for secondary indexes is:

Use secondary indexes when the decreased learn prices outweigh the elevated write prices.

This appears apparent whenever you say it, however it may be counterintuitive as you are modeling. It appears really easy to say “Throw it in a secondary index” with out desirous about different approaches.

To deliver this dwelling, let’s take a look at two conditions the place secondary indexes won’t make sense.

A number of filterable attributes in small merchandise collections

With DynamoDB, you usually need your major keys to do your filtering for you. It irks me a bit at any time when I take advantage of a Question in DynamoDB however then carry out my very own filtering in my utility — why could not I simply construct that into the first key?

Regardless of my visceral response, there are some conditions the place you may need to over-read your knowledge after which filter in your utility.

The commonest place you may see that is whenever you need to present a whole lot of totally different filters in your knowledge in your customers, however the related knowledge set is bounded.

Consider a exercise tracker. You may need to permit customers to filter on a whole lot of attributes, resembling sort of exercise, depth, period, date, and so forth. Nonetheless, the variety of exercises a consumer has goes to be manageable — even an influence consumer will take some time to exceed 1000 exercises. Slightly than placing indexes on all of those attributes, you may simply fetch all of the consumer’s exercises after which filter in your utility.

That is the place I like to recommend doing the mathematics. DynamoDB makes it straightforward to calculate these two choices and get a way of which one will work higher in your utility.

A number of filterable attributes in giant merchandise collections

Let’s change our scenario a bit — what if our merchandise assortment is giant? What if we’re constructing a exercise tracker for a gymnasium, and we need to permit the gymnasium proprietor to filter on the entire attributes we talked about above for all of the customers within the gymnasium?

This adjustments the scenario. Now we’re speaking about a whole bunch and even 1000’s of customers, every with a whole bunch or 1000’s of exercises. It will not make sense to over-read the whole merchandise assortment and do post-hoc filtering on the outcomes.

However secondary indexes do not actually make sense right here both. Secondary indexes are good for recognized entry patterns the place you may rely on the related filters being current. If we wish our gymnasium proprietor to have the ability to filter on quite a lot of attributes, all of that are elective, we might must create a lot of indexes to make this work.

We talked concerning the potential downsides of question planners earlier than, however question planners have an upside too. Along with permitting for extra versatile queries, they’ll additionally do issues like index intersections to have a look at partial outcomes from a number of indexes in composing these queries. You are able to do the identical factor with DynamoDB, however it is going to lead to a whole lot of backwards and forwards together with your utility, together with some advanced utility logic to determine it out.

When I’ve a majority of these issues, I usually search for a device higher fitted to this use case. Rockset and Elasticsearch are my go-to suggestions right here for offering versatile, secondary-index-like filtering throughout your dataset.

Conclusion

On this submit, we discovered about DynamoDB secondary indexes. First, we checked out some conceptual bits to know how DynamoDB works and why secondary indexes are wanted. Then, we reviewed some sensible tricks to perceive the best way to use secondary indexes successfully and to study their particular quirks. Lastly, we checked out how to consider secondary indexes to see when you need to use different approaches.

Secondary indexes are a robust device in your DynamoDB toolbox, however they are not a silver bullet. As with all DynamoDB knowledge modeling, be sure you rigorously take into account your entry patterns and rely the prices earlier than you soar in.

Study extra about how you should utilize Rockset for secondary-index-like filtering in Alex DeBrie’s weblog DynamoDB Filtering and Aggregation Queries Utilizing SQL on Rockset.