refactor(aws-dynamodb): Attribute type for keys (#720)

BREAKING CHANGE: this patch introduces an interface to represent DynamoDB Attributes, in preparation for upcoming GSI and LSI support. It changes the signature of the `addPartitionKey` and `addSortKey` methods to be consistent across the board.
aws · Sep 18, 2018 · e6cc189 · e6cc189
1 parent 72fec36
commit e6cc189
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 81 deletions.
diff --git a/docs/src/examples.rst b/docs/src/examples.rst
@@ -135,8 +135,8 @@ and sort key **Timestamp**.
          writeCapacity: 5
        });
 
-       table.addPartitionKey('Alias', dynamodb.KeyAttributeType.String);
-       table.addSortKey('Timestamp', dynamodb.KeyAttributeType.String);
+       table.addPartitionKey({ name: 'Alias', type: dynamodb.AttributeType.String });
+       table.addSortKey({ name: 'Timestamp', type: dynamodb.AttributeType.String });
      }
    }
 

diff --git a/examples/cdk-examples-typescript/chat-app/dynamodb-posts-table.ts b/examples/cdk-examples-typescript/chat-app/dynamodb-posts-table.ts
@@ -9,7 +9,7 @@ export class DynamoPostsTable extends cdk.Construct {
             readCapacity: 5, writeCapacity: 5
         });
 
-        table.addPartitionKey('Alias', dynamodb.KeyAttributeType.String);
-        table.addSortKey('Timestamp', dynamodb.KeyAttributeType.String);
+        table.addPartitionKey({ name: 'Alias', type: dynamodb.AttributeType.String });
+        table.addSortKey({ name: 'Timestamp', type: dynamodb.AttributeType.String });
     }
 }
diff --git a/examples/cdk-examples-typescript/hello-cdk/index.ts b/examples/cdk-examples-typescript/hello-cdk/index.ts
@@ -10,8 +10,8 @@ class HelloCDK extends cdk.Stack {
             writeCapacity: 1
         });
 
-        table.addPartitionKey('ID', dynamodb.KeyAttributeType.String);
-        table.addSortKey('Timestamp', dynamodb.KeyAttributeType.Number);
+        table.addPartitionKey({ name: 'ID', type: dynamodb.AttributeType.String });
+        table.addSortKey({ name: 'Timestamp', type: dynamodb.AttributeType.Number });
     }
 }
 

diff --git a/packages/@aws-cdk/aws-dynamodb/lib/table.ts b/packages/@aws-cdk/aws-dynamodb/lib/table.ts
@@ -66,6 +66,18 @@ export interface TableProps {
     writeAutoScaling?: AutoScalingProps;
 }
 
+export interface Attribute {
+    /**
+     * The name of an attribute.
+     */
+    name: string;
+
+    /**
+     * The data type of an attribute.
+     */
+    type: AttributeType;
+}
+
 /* tslint:disable:max-line-length */
 export interface AutoScalingProps {
     /**
@@ -150,13 +162,13 @@ export class Table extends Construct {
         }
     }
 
-    public addPartitionKey(name: string, type: KeyAttributeType): this {
-        this.addKey(name, type, HASH_KEY_TYPE);
+    public addPartitionKey(attribute: Attribute): this {
+        this.addKey(attribute.name, attribute.type, HASH_KEY_TYPE);
         return this;
     }
 
-    public addSortKey(name: string, type: KeyAttributeType): this {
-        this.addKey(name, type, RANGE_KEY_TYPE);
+    public addSortKey(attribute: Attribute): this {
+        this.addKey(attribute.name, attribute.type, RANGE_KEY_TYPE);
         return this;
     }
 
@@ -266,7 +278,7 @@ export class Table extends Construct {
         return this.keySchema.find(prop => prop.keyType === keyType);
     }
 
-    private addKey(name: string, type: KeyAttributeType, keyType: string) {
+    private addKey(name: string, type: AttributeType, keyType: string) {
         const existingProp = this.findKey(keyType);
         if (existingProp) {
             throw new Error(`Unable to set ${name} as a ${keyType} key, because ${existingProp.attributeName} is a ${keyType} key`);
@@ -279,7 +291,7 @@ export class Table extends Construct {
         return this;
     }
 
-    private registerAttribute(name: string, type: KeyAttributeType) {
+    private registerAttribute(name: string, type: AttributeType) {
         const existingDef = this.attributeDefinitions.find(def => def.attributeName === name);
         if (existingDef && existingDef.attributeType !== type) {
             throw new Error(`Unable to specify ${name} as ${type} because it was already defined as ${existingDef.attributeType}`);
@@ -293,7 +305,7 @@ export class Table extends Construct {
     }
 }
 
-export enum KeyAttributeType {
+export enum AttributeType {
     Binary = 'B',
     Number = 'N',
     String = 'S',

diff --git a/packages/@aws-cdk/aws-dynamodb/test/integ.dynamodb.ts b/packages/@aws-cdk/aws-dynamodb/test/integ.dynamodb.ts
@@ -1,5 +1,5 @@
 import { App, Stack } from '@aws-cdk/cdk';
-import { KeyAttributeType, StreamViewType, Table } from '../lib';
+import { AttributeType, StreamViewType, Table } from '../lib';
 
 const app = new App(process.argv);
 
@@ -12,7 +12,7 @@ const table = new Table(stack, 'Table', {
     ttlAttributeName: 'timeToLive'
 });
 
-table.addPartitionKey('hashKey', KeyAttributeType.String);
-table.addSortKey('rangeKey', KeyAttributeType.Number);
+table.addPartitionKey({ name: 'hashKey', type: AttributeType.String });
+table.addSortKey({ name: 'rangeKey', type: AttributeType.Number });
 
 process.stdout.write(app.run());