AWS CDK で DynamoDB のグローバルセカンダリインデックス（GSI）を使ってみた

			
			users テーブル
プライマリキー: userId (パーティションキーのみ)

userId | name      | age | address  | mailAddress
-------|-----------|-----|----------|-------------
1      | Tanaka    | 20  | Tokyo    | aaa@co.jp
2      | Suzuki    | 30  | Osaka    | bbb@co.jp  
3      | Takahashi | 40  | Nagoya   | ccc@co.jp
4      | Sato      | 30  | Fukuoka  | ddd@co.jp
5      | Tanaka    | 20  | Sapporo  | eee@co.jp

		

			
			// 年齢が30歳のユーザーを検索したい
const scanParams = {
  TableName: 'users',
  FilterExpression: 'age = :age',
  ExpressionAttributeValues: {
    ':age': 30
  }
};
const result = await dynamodb.scan(scanParams).promise();
// 全5件を読み取ってからフィルタリング（ScannedCount: 5, Count: 2）

		

			
			/**
 * able: DynamoDBテーブルを定義するためのクラス
 * AttributeType: DynamoDB属性のデータ型（文字列、数値など）
 * BillingMode: 課金モード（オンデマンド、プロビジョニング済み）
 */
import { Table, AttributeType, BillingMode } from 'aws-cdk-lib/aws-dynamodb';

// UsersTable'というIDで、DynamoDBのテーブルリソースを定義
const usersTable = new Table(this, 'UsersTable', {
  tableName: 'users', // テーブル名を「users」に設定
  partitionKey: { // テーブルのプライマリキーを定義
    name: 'userId', // パーティションキーの名前を「userId」
    type: AttributeType.NUMBER  // データ型を数値に設定
  },
  billingMode: BillingMode.PAY_PER_REQUEST, // 課金モードをオンデマンド（従量課金）に設定

  // グローバルセカンダリインデックス（GSI）を定義
  globalSecondaryIndexes: [{
    indexName: 'age-userId-index', // インデックス名を「age-userId-index」に設定
    // パーティションキーを定義
    partitionKey: {
      name: 'age', 
      type: AttributeType.NUMBER 
    },
    // ソートキーを定義
    sortKey: { 
      name: 'userId', 
      type: AttributeType.NUMBER 
    }       
  }]
});

		

			
			const queryParams = {
  TableName: 'users', // テーブルの指定
  IndexName: 'age-userId-index', // GSI を指定
  KeyConditionExpression: 'age = :age', // パーティションキーの条件。[age」属性が、後で指定する「:age」という値と等しいことを条件
  ExpressionAttributeValues: {
    ':age': 30 // この例では、ageが30であるアイテムを検索する
  }
};

// 特定のuserIdも指定したい場合
const queryWithSortKey = {
  TableName: 'users',
  IndexName: 'age-userId-index',
  KeyConditionExpression: 'age = :age AND userId = :userId', // ソートキーも条件に追加
  ExpressionAttributeValues: {
    ':age': 30,
    ':userId': 2
  }
};
// DynamoDBに対してクエリを実行
const result = await dynamodb.query(queryParams).promise();

		

			
			age-userId-index GSI

パーティション1 (age=20)
age | userId | name      | address  | mailAddress
----|-------|-----------|----------|-------------
20  | 1     | Tanaka    | Tokyo    | aaa@co.jp
20  | 5     | Tanaka    | Sapporo  | eee@co.jp

パーティション2 (age=30) 
age | userId | name      | address  | mailAddress  
----|-------|-----------|----------|-------------
30  | 2     | Suzuki    | Osaka    | bbb@co.jp
30  | 4     | Sato      | Fukuoka  | ddd@co.jp

パーティション3 (age=40)
age | userId | name      | address  | mailAddress
----|-------|-----------|----------|-------------
40  | 3     | Takahashi | Nagoya   | ccc@co.jp