Skip to content

Commit f8a130d

Browse files
DOCSP-19323 doc support for setting read preference without tag sets for sharded clusters (#214)
* DOCSP-19323 doc support for setting read preference without tag sets sharded clusters * DOCSP-19323 fix for indentation issue
1 parent ae96421 commit f8a130d

File tree

3 files changed

+53
-34
lines changed

3 files changed

+53
-34
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 27 10 53 10
4+
5+
* - Parameter
6+
- Type
7+
- Description
8+
- Required?
9+
10+
* - ``createStore``
11+
- string
12+
- Name of the new {+data-lake-store+}. The {+data-lake-store+}
13+
name must be unique.
14+
15+
.. include:: /includes/fact-atlas-data-source.rst
16+
17+
- yes
18+
19+
* - ``provider``
20+
- string
21+
- Name of the service where the data is stored.
22+
Value can be one of the following:
23+
24+
- ``s3`` for an |aws| |s3| bucket.
25+
- ``atlas`` for |service| cluster.
26+
- ``http`` for files hosted at publicly accessible |url|\s.
27+
28+
- yes
29+

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

Lines changed: 20 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -74,41 +74,14 @@ Syntax
7474
Parameters
7575
----------
7676

77-
.. list-table::
78-
:header-rows: 1
79-
:widths: 27 10 53 10
80-
81-
* - Parameter
82-
- Type
83-
- Description
84-
- Required?
85-
86-
* - ``createStore``
87-
- string
88-
- Name of the new {+data-lake-store+}. The {+data-lake-store+}
89-
name must be unique.
90-
91-
.. include:: /includes/fact-atlas-data-source.rst
92-
93-
- yes
94-
95-
* - ``provider``
96-
- string
97-
- Name of the service where the data is stored.
98-
Value can be one of the following:
99-
100-
- ``s3`` for an |aws| |s3| bucket.
101-
- ``atlas`` for |service| cluster.
102-
- ``http`` for files hosted at publicly accessible |url|\s.
103-
104-
- yes
105-
10677
.. tabs::
10778
:hidden:
10879

10980
.. tab:: S3 Configuration
11081
:tabid: s3
11182

83+
.. include:: /includes/list-table-create-store-cli-common-params.rst
84+
11285
.. list-table::
11386
:widths: 27 10 53 10
11487

@@ -177,8 +150,10 @@ Parameters
177150
.. tab:: Atlas Configuration
178151
:tabid: atlas
179152

153+
.. include:: /includes/list-table-create-store-cli-common-params.rst
154+
180155
.. list-table::
181-
:widths: 27 10 53 10
156+
:widths: 27 15 48 10
182157

183158
* - ``clusterName``
184159
- string
@@ -198,7 +173,8 @@ Parameters
198173
read requests to the cluster.
199174
- no
200175

201-
* - ``readPreference.mode``
176+
* - | ``readPreference``
177+
| ``.mode``
202178
- string
203179
- :manual:`Read preference mode
204180
</core/read-preference/#read-preference-modes>` that
@@ -208,7 +184,8 @@ Parameters
208184
.. include:: /includes/fact-read-preference-modes.rst
209185
- no
210186

211-
* - ``readPreference.tagSets``
187+
* - | ``readPreference``
188+
| ``.tagSets``
212189
- array of strings
213190
- Arrays of :manual:`tag sets </core/read-preference-tags/>`
214191
or tag specification documents that contain name and value
@@ -217,9 +194,16 @@ Parameters
217194
are associated with the specified tags. To learn more, see
218195
:manual:`Read Preference Tag Sets
219196
</manual/core/read-preference-tags/>`.
197+
198+
.. note::
199+
200+
{+adl+} doesn't support this parameter for sharded
201+
clusters.
202+
220203
- no
221204

222-
* - ``readPreference.maxStalenessSeconds``
205+
* - | ``readPreference``
206+
| ``.maxStalenessSeconds``
223207
- int
224208
- Maximum replication lag, or “staleness”, for reads from
225209
secondaries. To learn more about ``maxStalenessSeconds``,
@@ -230,8 +214,10 @@ Parameters
230214
.. tab:: HTTP Configuration
231215
:tabid: http
232216

217+
.. include:: /includes/list-table-create-store-cli-common-params.rst
218+
233219
.. list-table::
234-
:widths: 27 10 53 10
220+
:widths: 27 15 48 10
235221

236222
* - ``allowInsecure``
237223
- boolean

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,10 @@ The {+data-lake-short+} configuration has the following format:
588588
member or members that are associated with the specified tags.
589589
To learn more, :manual:`Read Preference Tag Sets
590590
</core/read-preference-tags/>`.
591+
592+
.. note::
593+
594+
{+adl+} doesn't support ``tagSets`` for sharded clusters.
591595

592596
.. datalakeconf:: stores.[n].readPreference.maxStalenessSeconds
593597

0 commit comments

Comments
 (0)