feat(glue): implement empty string as s3Prefix

fixes #8472 BREAKING CHANGE: the default location of glue data will be the root of an s3 bucket, instead of /data
aws · Jul 10, 2020 · 04ddd5d · 04ddd5d
1 parent 2386faa
commit 04ddd5d
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', {
 });
 ```
 
+The default for `s3Prefix` is the root of the bucket.
+
 #### 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 empty string
    */
   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 !== undefined && props.s3Prefix !== null) ? 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/test.table.ts b/packages/@aws-cdk/aws-glue/test/test.table.ts
@@ -62,7 +62,7 @@ export = {
                 {
                   Ref: 'TableBucketDA42407C',
                 },
-                '/data/',
+                '/',
               ],
             ],
           },
@@ -140,7 +140,7 @@ export = {
                 {
                   Ref: 'TableBucketDA42407C',
                 },
-                '/data/',
+                '/',
               ],
             ],
           },
@@ -206,7 +206,7 @@ export = {
                 {
                   Ref: 'TableBucketDA42407C',
                 },
-                '/data/',
+                '/',
               ],
             ],
           },
@@ -298,7 +298,7 @@ export = {
                   {
                     Ref: 'TableBucketDA42407C',
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -442,7 +442,7 @@ export = {
                   {
                     Ref: 'TableBucketDA42407C',
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -576,7 +576,7 @@ export = {
                   {
                     Ref: 'TableBucketDA42407C',
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -655,7 +655,7 @@ export = {
                   {
                     Ref: 'TableBucketDA42407C',
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -769,7 +769,7 @@ export = {
                   {
                     Ref: 'TableBucketDA42407C',
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -885,7 +885,7 @@ export = {
                   {
                     Ref: 'TableBucketDA42407C',
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -1003,7 +1003,7 @@ export = {
                   {
                     Ref: 'Bucket83908E77',
                   },
-                  '/data/',
+                  '/',
                 ],
               ],
             },
@@ -1244,7 +1244,7 @@ export = {
                           'Arn',
                         ],
                       },
-                      '/data/',
+                      '/',
                     ],
                   ],
                 },
@@ -1348,7 +1348,7 @@ export = {
                           'Arn',
                         ],
                       },
-                      '/data/',
+                      '/',
                     ],
                   ],
                 },
@@ -1462,7 +1462,7 @@ export = {
                           'Arn',
                         ],
                       },
-                      '/data/',
+                      '/',
                     ],
                   ],
                 },
-Original file line number
+Diff line change
@@ Expand Up / @@ -55,6 +55,8 @@ new glue.Table(stack, 'MyTable', { @@
     });
     ```
+    The default for `s3Prefix` is the root of the bucket.
     #### 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 @@