本日はDynamoDBについて、パーティションキー、ソートキー、ローカルセカンダリインデックス、グローバルセカンダリインデックスを使用した検索の方法についてご紹介いたします。まずは、キーとインデックスについて簡単な説明を行って、テーブルを作成し、クエリを投げていこうと思います。
目次
パーティションキー、ソートキー、各種セカンダリインデックスの基礎知識
パーティションキー・・
テーブルにつき一つのみ設定可。
テーブルに必須。
クエリを投げる際にこのキーを指定して検索や挿入を行う。
ソートキー・・
テーブルにつき一つのみ設定可。
設定しないこともできる。
設定した際はクエリを投げる際にこのキーとパーティションキーを指定して検索や挿入を行わなければならない。
検索や挿入でパーティションキーとソートキーの二つを指定する必要がありますが、パーティションしかないテーブルより細かい指定ができる。
ローカルセカンダリインデックス（LSI）・・ 設定するかしないか自由。
今あるパーティションキーと新たなソートキーの新たな組み合わせを作成できる。
例えば、パーティションキーとソートキーを使用していたテーブルでLSIを使用した場合、以下の二つの方法で検索や挿入が可能になる。
①パーティションキーとソートキー
②パーティションキーとLSIのソートキー
グローバルセカンダリインデックス・・
設定するかしないか自由。
今あるパーティションキーとソートキーとは違う新しいパーティションキーと新しいソートキーの組み合わせを作成できる。
新しいパーティションキーと新しいソートキーの組み合わせで検索が可能になる。
・セカンダリインデックスの注意点
テーブルに書き込みを行った際にインデックスにもデータが反映されるので、その分のWCUを消費するので インデックスを増やすとコストもかかる。
２．テーブルの作成
まずはテーブルの作成を行います。 検索のやり方を紹介する時にLambdaを使用するので、 テーブルの作成もLambdaでやっちゃいます。
Lambdaの作成をデフォルトで作成し、作成の際にIAMロールにてDynamoDBのFullアクセスを付与しました。 Lambdaが作成されたら、Lambdaで以下コードを入力し、test実行します。
ちなみにコードの説明は以下になります。
コード内容：テーブルの作成
テーブルの項目：会社名、予約有無、部署(department)、ホテル、予約した人、日付
キーの種類：
パーティションキー、ハッシュキー・・会社名、部署名
ローカルセカンダリインデックス・・会社名、予約した人の組み合わせ
グローバルセカンダリインデックス・・ホテル、日付
ただの値(非キー属性)・・予約有無
・以下コード内の項目の説明 KeySchemaのKeyTypeのHASH、RANGE・・HASHがパーティションキーで、RANGEがソートキーになります。
AttributeDefinitionsのAttributeType・・SはString(文字列)、Nは数字(Number)の値を入れるキーということです。
ProjectionType・・何のキーの値を取り出すか指定します。今回は全属性を取得するのでALLとしています。
- import json
- import boto3
- resource = boto3.resource("dynamodb")
- def lambda_handler(event, context):
- response = resource.create_table(
- AttributeDefinitions = [
- {
- 'AttributeName': 'company',
- 'AttributeType': 'S'
- },
- {
- 'AttributeName': 'department',
- 'AttributeType': 'S'
- },
- {
- 'AttributeName': 'name',
- 'AttributeType': 'S'
- },
- {
- 'AttributeName': 'hotel',
- 'AttributeType': 'S'
- },
- {
- 'AttributeName': 'date',
- 'AttributeType': 'S'
- },
- ],
- TableName = 'test-hotel-reservation',
- KeySchema = [
- {
- 'AttributeName': 'company',
- 'KeyType': 'HASH'
- },
- {
- 'AttributeName': 'department',
- 'KeyType': 'RANGE'
- },
- ],
- ProvisionedThroughput = {
- 'ReadCapacityUnits': 1,
- 'WriteCapacityUnits': 1
- },
- LocalSecondaryIndexes=[
- {
- 'IndexName': 'departmentLSIndex',
- 'KeySchema': [
- {
- 'AttributeName': 'company',
- 'KeyType': 'HASH'
- },
- {
- 'AttributeName': 'name',
- 'KeyType': 'RANGE'
- }
- ],
- 'Projection': {
- 'ProjectionType': 'ALL',
- }
- },
- ],
- GlobalSecondaryIndexes=[
- {
- 'IndexName': 'hotel-nameGSIndex',
- 'KeySchema': [
- {
- 'AttributeName': 'hotel',
- 'KeyType': 'HASH'
- },
- {
- 'AttributeName': 'date',
- 'KeyType': 'RANGE'
- },
- ],
- 'Projection': {
- 'ProjectionType': 'ALL',
- },
- 'ProvisionedThroughput': {
- 'ReadCapacityUnits': 1,
- 'WriteCapacityUnits': 1
- }
- },
- ],
- )
テーブルが作成されました。インデックスも設定されています。
３．データ（値）を挿入
続いてデータの挿入を行います。 Lambdaを使用し、以下のようにデータの挿入をしました。データ挿入時にLambdaで使用したコードの内容も記載いたします。
・Lambdaのコード
- import json
- import boto3
- resource = boto3.resource("dynamodb")
- def lambda_handler(event, context):
- table = resource.Table("test-hotel-reservation")
- with table.batch_writer() as batch:
- batch.put_item(
- Item={
- 'company': 'A社',
- 'department': '営業部',
- 'name': 'A社鈴木',
- 'hotel': '山のホテル',
- 'date': 202202,
- 'reservation': 'Yes'
- }
- )
- batch.put_item(
- Item={
- 'company': 'A社',
- 'department': '人事部',
- 'name': 'A社山口',
- 'hotel': '川のホテル',
- 'date': 202202,
- 'reservation': 'Yes'
- }
- )
- batch.put_item(
- Item={
- 'company': 'A社',
- 'department': '総務部',
- 'name': 'A社下田',
- 'hotel': '都内ホテル',
- 'date': 202202,
- 'reservation': 'No'
- }
- )
- batch.put_item(
- Item={
- 'company': 'B社',
- 'department': '人事部',
- 'name': 'B社金井',
- 'hotel': '山のホテル',
- 'date': 202204,
- 'reservation': 'Yes'
- }
- )
- batch.put_item(
- Item={
- 'company': 'B社',
- 'department': '経理部',
- 'name': 'B社田川',
- 'hotel': '川のホテル',
- 'date': 202204,
- 'reservation': 'No'
- }
- )
- batch.put_item(
- Item={
- 'company': 'C社',
- 'department': '営業部',
- 'name': 'C社太田',
- 'hotel': '都内ホテル',
- 'date': 202308,
- 'reservation': 'Yes'
- }
- )
（本編）パーティションキー、ソートキーを使用した読み込み
続いてパーティションキー、ソートキーの検索についてです。 まずはパーティションキー（社名）のみで検索をかけてみます。
ではB社の情報を取得してみましょう。
冒頭に「from boto3.dynamodb.conditions import Key」がありますが、これがないと8行目でエラーになります。
- import boto3
- from boto3.dynamodb.conditions import Key
- dynamodb = boto3.resource('dynamodb')
- def lambda_handler(event, context):
- table = dynamodb.Table("test-hotel-reservation")
- response = table.query(
- KeyConditionExpression = Key('company').eq('B社')
- )
- print(response)
2件検索されました。
・出力結果
{'Items': [{'hotel': '山のホテル', 'department': '人事部', 'date': Decimal('202204'), 'company': 'B社', 'name': 'B社金井', 'reservation': 'Yes'}, {'hotel': '川のホテル', 'department': '経理部', 'date': Decimal('202204'), 'company': 'B社', 'name': 'B社田川', 'reservation': 'No'}], 'Count': 2,・・（省略）
整えるとこんな感じです。
{'Items': [
{'hotel': '山のホテル', 'department': '人事部', 'date': Decimal('202204'), 'company': 'B社', 'name': 'B社金井', 'reservation': 'Yes'},
{'hotel': '川のホテル', 'department': '経理部', 'date': Decimal('202204'), 'company': 'B社', 'name': 'B社田川', 'reservation': 'No'}
]
次はパーティションキー（社名）とソートキー(部署)で検索します。
- import boto3
- from boto3.dynamodb.conditions import Key
- dynamodb = boto3.resource('dynamodb')
- def lambda_handler(event, context):
- table = dynamodb.Table("test-hotel-reservation")
- response = table.query(
- KeyConditionExpression = Key('company').eq('A社') & Key('department').eq('営業部')
- )
- print(response)
B社の営業部は一件しかないのでひとつのみ検索されました。
・出力結果
{'Items': [{'hotel': '山のホテル', 'department': '営業部', 'date': Decimal('202202'), 'company': 'A社', 'name': 'A社鈴木', 'reservation': 'Yes'}], 'Count': 1・・（省略）
（本編）ローカルセカンダリインデックス（LSI）を使用した読み込み
ローカルセカンダリインデックスは同じようにqueryコマンドで検索できます。ただ、IndexNameでインデックス作成時に設定したインデックス名を指定しなければなりません。ローカルセカンダリインデックスは社名と予約者名に設定していましたね。
・コード
- import boto3
- from boto3.dynamodb.conditions import Key
- dynamodb = boto3.resource('dynamodb')
- def lambda_handler(event, context):
- table = dynamodb.Table("test-hotel-reservation")
- response = table.query(
- IndexName='departmentLSIndex',
- KeyConditionExpression = Key('company').eq('A社') & Key('name').eq('A社下田')
- )
- print(response)
・出力結果
{'Items': [{'hotel': '都内ホテル', 'department': '総務部', 'date': Decimal('202202'), 'company': 'A社', 'reservation': 'No', 'name': 'A社下田'}], 'Count': 1, 'ScannedCount': 1・・（省略）
（本編）グローバルセカンダリインデックス（GSI）を使用した読み込み
GSIはLSIと同じでインデックス名と検索のコードで検索できます。GSIのパーティションキーはデフォルトで設定した社名と部署名ではなく以下に設定しましたね。
パーティションキー・・hotel (String)
ソートキー・・date (Number)
まずは、パーティションキーだけで検索します。
- import boto3
- from boto3.dynamodb.conditions import Key
- dynamodb = boto3.resource('dynamodb')
- def lambda_handler(event, context):
- table = dynamodb.Table("test-hotel-reservation")
- response = table.query(
- IndexName='hotel-nameGSIndex',
- KeyConditionExpression = Key('hotel').eq('山のホテル')
- )
- print(response)
・出力結果
{'Items': [
{'hotel': '山のホテル', 'department': '営業部', 'date': Decimal('202202'), 'company': 'A社', 'name': 'A社鈴木', 'reservation': 'Yes'},
{'hotel': '山のホテル', 'department': '人事部', 'date': Decimal('202204'), 'company': 'B社', 'name': 'B社金井', 'reservation': 'Yes'}],
'Count': 2, 'ScannedCount': 2,・・（省略）
パーティションキー、ソートキーでの検索は以下になります。 ソートキーのdateは文字列ではなく数字なので、「’」で囲む必要はありません。
- import boto3
- from boto3.dynamodb.conditions import Key
- dynamodb = boto3.resource('dynamodb')
- def lambda_handler(event, context):
- table = dynamodb.Table("test-hotel-reservation")
- response = table.query(
- IndexName='hotel-nameGSIndex',
- KeyConditionExpression = Key('hotel').eq('川のホテル') & Key('date').eq(202202)
- )
- print(response)
・出力結果
{'Items': [{'hotel': '川のホテル', 'department': '人事部', 'date': Decimal('202202'), 'company': 'A社', 'name': 'A社山口', 'reservation': 'Yes'}], 'Count': 1, 'ScannedCount': 1・・（省略）
本記事は以上となります。 最後までご覧いただきありがとうございました。
手順はたった２つ AWS Lambda環境変数の使い方！暗号化についても説明します
