feat(glue): default data location for tables is the root of the bucket (

#8999) Fixes #8472 BREAKING CHANGE: The default location of glue data will be the root of an s3 bucket, instead of `/data` ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Jul 13, 2020 · 28949bd · 28949bd
1 parent fcca86e
commit 28949bd
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 24 deletions.
diff --git a/packages/@aws-cdk/aws-glue/README.md b/packages/@aws-cdk/aws-glue/README.md
@@ -55,6 +55,8 @@ new glue.Table(stack, 'MyTable', {
 });
 ```
 
+By default, an S3 bucket will be created to store the table's data and stored in the bucket root. You can also manually pass the `bucket` and `s3Prefix`:
+
 #### Partitions
 
 To improve query performance, a table can specify `partitionKeys` on which data is stored and queried separately. For example, you might partition a table by `year` and `month` to optimize queries based on a time window:

diff --git a/packages/@aws-cdk/aws-glue/lib/table.ts b/packages/@aws-cdk/aws-glue/lib/table.ts
@@ -87,7 +87,7 @@ export interface TableProps {
   /**
    * S3 prefix under which table objects are stored.
    *
-   * @default data/
+   * @default - No prefix. The data will be stored under the root of the bucket.
    */
   readonly s3Prefix?: string;
 
@@ -236,7 +236,7 @@ export class Table extends Resource implements ITable {
 
     this.database = props.database;
     this.dataFormat = props.dataFormat;
-    this.s3Prefix = (props.s3Prefix !== undefined && props.s3Prefix !== null) ? props.s3Prefix : 'data/';
+    this.s3Prefix = props.s3Prefix ?? '';
 
     validateSchema(props.columns, props.partitionKeys);
     this.columns = props.columns;

diff --git a/packages/@aws-cdk/aws-glue/test/integ.table.expected.json b/packages/@aws-cdk/aws-glue/test/integ.table.expected.json
@@ -71,7 +71,7 @@
                   {
                     "Ref": "DataBucketE3889A50"
                   },
-                  "/data/"
+                  "/"
                 ]
               ]
             },
@@ -140,7 +140,7 @@
                   {
                     "Ref": "DataBucketE3889A50"
                   },
-                  "/data/"
+                  "/"
                 ]
               ]
             },
@@ -209,7 +209,7 @@
                   {
                     "Ref": "DataBucketE3889A50"
                   },
-                  "/data/"
+                  "/"
                 ]
               ]
             },
@@ -278,7 +278,7 @@
                   {
                     "Ref": "DataBucketE3889A50"
                   },
-                  "/data/"
+                  "/"
                 ]
               ]
             },
@@ -439,7 +439,7 @@
                   {
                     "Ref": "MyEncryptedTableBucket7B28486D"
                   },
-                  "/data/"
+                  "/"
                 ]
               ]
             },
@@ -532,7 +532,7 @@
                           "Arn"
                         ]
                       },
-                      "/data/"
+                      "/"
                     ]
                   ]
                 }
@@ -609,7 +609,7 @@
                           "Arn"
                         ]
                       },
-                      "/data/"
+                      "/"
                     ]
                   ]
                 }
@@ -721,7 +721,7 @@
                           "Arn"
                         ]
                       },
-                      "/data/"
+                      "/"
                     ]
                   ]
                 }
@@ -827,4 +827,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-glue/test/table.test.ts b/packages/@aws-cdk/aws-glue/test/table.test.ts
@@ -62,7 +62,7 @@ test('unpartitioned JSON table', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -139,7 +139,7 @@ test('partitioned JSON table', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -204,7 +204,7 @@ test('compressed table', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -293,7 +293,7 @@ test('encrypted table: SSE-S3', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -436,7 +436,7 @@ test('encrypted table: SSE-KMS (implicitly created key)', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -569,7 +569,7 @@ test('encrypted table: SSE-KMS (explicitly created key)', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -647,7 +647,7 @@ test('encrypted table: SSE-KMS_MANAGED', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -760,7 +760,7 @@ test('encrypted table: CSE-KMS (implicitly created key)', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -875,7 +875,7 @@ test('encrypted table: CSE-KMS (explicitly created key)', () => {
               {
                 Ref: 'TableBucketDA42407C',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -992,7 +992,7 @@ test('encrypted table: CSE-KMS (explicitly passed bucket and key)', () => {
               {
                 Ref: 'Bucket83908E77',
               },
-              '/data/',
+              '/',
             ],
           ],
         },
@@ -1228,7 +1228,7 @@ test('grants: read only', () => {
                       'Arn',
                     ],
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -1331,7 +1331,7 @@ test('grants: write only', () => {
                       'Arn',
                     ],
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -1444,7 +1444,7 @@ test('grants: read and write', () => {
                       'Arn',
                     ],
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
-Original file line number
+Diff line change
@@ Expand Up / @@ -55,6 +55,8 @@ new glue.Table(stack, 'MyTable', { @@
     });
     ```
+    By default, an S3 bucket will be created to store the table's data and stored in the bucket root. You can also manually pass the `bucket` and `s3Prefix`:
     #### Partitions
     To improve query performance, a table can specify `partitionKeys` on which data is stored and queried separately. For example, you might partition a table by `year` and `month` to optimize queries based on a time window:
@@ Expand Down @@