Skip to content

Commit d841598

Browse files
DOCSP-11889 doc for additional storage classes (#64)
* DOCSP-11889 doc for additional storage classes DOCSP-11889 fixing links DOCSP-11889 minor fixes * DOCSP-11889 update to limitations page * Apply suggestions from code review updates from copy review Co-authored-by: Melissa Mahoney <[email protected]> * DOCPS-11889 updates for copy review * DOCSP-11889 updates for external review * DOCSP-11889 minor update Co-authored-by: Melissa Mahoney <[email protected]>
1 parent 56bba24 commit d841598

File tree

3 files changed

+62
-5
lines changed

3 files changed

+62
-5
lines changed

source/reference/cli/stores/create-store.txt

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Syntax
5353

5454
.. code-block:: sh
5555

56-
db.runCommand({ createStore: <store-name>, provider: <storage-provider>, region: <region-name>, bucket: <bucket-name>, delimiter: <delimiter>, prefix: <prefix> })
56+
db.runCommand({ createStore: <store-name>, provider: <storage-provider>, region: <region-name>, bucket: <bucket-name>, additionalStorageClasses: [ <storage-classes> ], delimiter: <delimiter>, prefix: <prefix> })
5757

5858
.. tab:: Atlas Configuration
5959
:tabid: atlas
@@ -123,6 +123,28 @@ Parameters
123123
the configured |aws| |iam| credentials.
124124
- yes
125125

126+
* - ``additionalStorageClasses``
127+
- array of strings
128+
- Array of |aws| |s3| `storage classes
129+
<https://aws.amazon.com/s3/storage-classes/>`__. {+adl+} will
130+
include the files in these storage classes in the query results.
131+
Valid values are:
132+
133+
- ``INTELLIGENT_TIERING`` to include files in the `Intelligent
134+
Tiering <https://aws.amazon.com/s3/storage-classes/#Unknown_or_changing_access>`__
135+
storage class.
136+
- ``STANDARD_IA`` to include files in the `Standard-Infrequent Access
137+
<https://aws.amazon.com/s3/storage-classes/#Infrequent_access>`__
138+
storage class.
139+
140+
.. note::
141+
142+
Files in the `Standard
143+
<https://aws.amazon.com/s3/storage-classes/#General_purpose>`__
144+
storage class are supported by default.
145+
146+
- no
147+
126148
* - ``delimiter``
127149
- string
128150
- Character used to separate path segments in the {+data-lake-store+}.
@@ -189,6 +211,7 @@ fails, see :ref:`dl-create-store-cmd-errors` for recommended solutions.
189211
"name": "<store-name>",
190212
"region": "<region-name>",
191213
"bucket": "<bucket-name>",
214+
"additionalStorageClasses": ["<storage-classes>"]
192215
"delimiter": "<delimiter>",
193216
"prefix": "<prefix>",
194217
"provider": "<storage-provider>"
@@ -245,7 +268,7 @@ The following example uses the ``createStore`` command to create a new
245268
.. code-block:: json
246269

247270
use sample
248-
db.runCommand({ createStore: "myStore", provider: "s3", region: "us-east-1", bucket: "my-data-lake", prefix: "/sample" })
271+
db.runCommand({ createStore: "myStore", provider: "s3", region: "us-east-1", bucket: "my-data-lake", "additionalStorageClasses" : ["STANDARD_IA","INTELLIGENT_TIERING"] prefix: "/sample" })
249272

250273
The previous command prints the following:
251274

@@ -258,6 +281,10 @@ The following example uses the ``createStore`` command to create a new
258281
"name": "myStore",
259282
"region": "us-east-1",
260283
"bucket": "my-data-lake",
284+
"additionalStorageClasses" : [
285+
"STANDARD_IA",
286+
"INTELLIGENT_TIERING"
287+
],
261288
"delimiter": "/",
262289
"prefix": "/sample",
263290
"provider": "s3"

source/reference/format/data-lake-configuration.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ Click on the tab below to learn more about the {+dl+} configuration for that dat
7575
"provider" : "s3",
7676
"region" : "us-east-1",
7777
"bucket" : "datacenter-alpha",
78+
"additionalStorageClasses" : [
79+
"STANDARD_IA"
80+
],
7881
"prefix" : "/metrics",
7982
"delimiter" : "/"
8083
}
@@ -253,6 +256,9 @@ to run federated queries.
253256
"provider" : "s3",
254257
"region" : "us-east-1",
255258
"bucket" : "datacenter-alpha",
259+
"additionalStorageClasses" : [
260+
"STANDARD_IA"
261+
],
256262
"prefix" : "/metrics",
257263
"delimiter" : "/"
258264
},
@@ -332,6 +338,7 @@ The {+data-lake-short+} configuration has the following format:
332338
"provider": "<string>",
333339
"region" : "<string>",
334340
"bucket" : "<string>",
341+
"additionalStorageClasses" : ["<string>"],
335342
"prefix" : "<string>",
336343
"includeTags": <boolean>,
337344
"delimiter": "<string>"
@@ -470,6 +477,7 @@ The {+data-lake-short+} configuration has the following format:
470477
"provider" : "<string>",
471478
"region" : "<string>",
472479
"bucket" : "<string>",
480+
"additionalStorageClasses" : ["<string>"],
473481
"prefix" : "<string>",
474482
"delimiter" : "<string>",
475483
"includeTags": <boolean>
@@ -543,6 +551,26 @@ The {+data-lake-short+} configuration has the following format:
543551
bucket which {+data-lake-short+} can access given the
544552
configured |aws| IAM credentials.
545553

554+
.. datalakeconf:: stores.[n].additionalStorageClasses
555+
556+
*Optional.* Array of |aws| |s3| `storage classes
557+
<https://aws.amazon.com/s3/storage-classes/>`__. {+adl+} will
558+
include the files in these storage classes in the query results.
559+
Valid values are:
560+
561+
- ``INTELLIGENT_TIERING`` to include files in the `Intelligent
562+
Tiering <https://aws.amazon.com/s3/storage-classes/#Unknown_or_changing_access>`__
563+
storage class
564+
- ``STANDARD_IA`` to include files in the `Standard-Infrequent Access
565+
<https://aws.amazon.com/s3/storage-classes/#Infrequent_access>`__
566+
storage class
567+
568+
.. note::
569+
570+
Files in the `Standard
571+
<https://aws.amazon.com/s3/storage-classes/#General_purpose>`__
572+
storage class are supported by default.
573+
546574
.. datalakeconf:: stores.[n].prefix
547575

548576
*Optional.* Prefix {+data-lake-short+} applies when searching for

source/supported-unsupported/limitations.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@
77
.. meta::
88
:keywords: |data-lake| limitations
99

10-
|service| |data-lake| only supports `Amazon S3 Standard storage class
11-
<https://aws.amazon.com/s3/storage-classes/?nc=sn&loc=3#General_purpose>`__.
12-
|data-lake| does not support the following features:
10+
|service| |data-lake| only supports Amazon S3 `Standard
11+
<https://aws.amazon.com/s3/storage-classes/?nc=sn&loc=3#General_purpose>`__,
12+
`Intelligent Tiering <https://aws.amazon.com/s3/storage-classes/#Unknown_or_changing_access>`__
13+
and `Standard-Infrequent Access <https://aws.amazon.com/s3/storage-classes/#Infrequent_access>`__
14+
storage classes. |data-lake| does not support the following features:
1315

1416
* Creating Indexes
1517
* Monitoring |data-lakes| with |service| monitoring tools

0 commit comments

Comments
 (0)