Skip to content

Commit 09717c6

Browse files
DOCSP-13924 Update updateCatalog doc page for stores option (#114)
1 parent b6e742d commit 09717c6

File tree

1 file changed

+52
-7
lines changed

1 file changed

+52
-7
lines changed

source/reference/cli/namespace/updatecatalog.txt

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
:depth: 2
1313
:class: singlecol
1414

15-
The ``updateCatalog`` command updates the :ref:`namespace metadata in the
16-
catalog <manage-ns-catalog-cli>`. You can verify by running the
15+
The ``updateCatalog`` command updates the :ref:`namespace metadata in
16+
the catalog <manage-ns-catalog-cli>`. You can verify by running the
1717
:ref:`catalog-info-cmd` command, which shows the :manual:`ISODate
1818
</reference/glossary/#term-isodate>` when the catalog was last updated.
19-
If you have a large {+data-lake-store+}, it may take a while to update the
20-
catalog.
19+
If you have a large {+data-lake-store+}, it may take a while to update
20+
the catalog.
2121

2222
.. _update-catalog-cmd-syntax:
2323

@@ -26,14 +26,51 @@ Syntax
2626

2727
.. code-block:: text
2828

29-
db.runCommand({ "updateCatalog" : 1, "background" : true })
29+
db.runCommand({ "updateCatalog" : 1, "stores": ["<storeName>"], "background" : true })
30+
31+
.. _update-catalog-cmd-options:
32+
33+
Options
34+
~~~~~~~
35+
36+
.. list-table::
37+
:header-rows: 1
38+
:widths: 20 10 60 10
39+
40+
* - Option
41+
- Type
42+
- Description
43+
- Necessity
44+
45+
* - ``background``
46+
- boolean
47+
- Flag to run command in the background. If omitted, defaults to
48+
``false``. When set to ``true``, {+adl+} runs the command in the
49+
background.
50+
51+
.. code-block:: json
52+
:copyable: false
53+
54+
{ "background" : true }
55+
56+
- Optional
57+
58+
* - ``stores``
59+
- array of strings
60+
- Names of the stores for which to update the catalog. If omitted,
61+
{+adl+} updates the catalog for all the stores in the storage
62+
configuration. If specified, {+adl+} updates the catalog for the
63+
specified stores only. {+adl+} returns an error if a specified
64+
store does not use a catalog.
65+
- Optional
3066

3167
.. _update-catalog-cmd-usage:
3268

3369
Usage
3470
~~~~~
3571

36-
To update the catalog, run the following command:
72+
To update the catalog for all the stores in the storage configuration,
73+
run the following command:
3774

3875
.. code-block:: text
3976

@@ -42,12 +79,20 @@ To update the catalog, run the following command:
4279
The previous command runs in the foreground and is similar to running
4380
the command with ``background`` set to ``false``.
4481

45-
To update the catalog in the background, run the following command:
82+
To update the catalog for all the stores in the storage configuration
83+
in the background, run the following command:
4684

4785
.. code-block:: text
4886

4987
db.runCommand({ "updateCatalog" : 1, "background" : true })
5088

89+
To update the catalog for a list of stores in the background, run the
90+
following command:
91+
92+
.. code-block:: text
93+
94+
db.runCommand({ "updateCatalog" : 1, "stores": ["<storeName>",...], "background" : true })
95+
5196
.. _update-catalog-cmd-output:
5297

5398
Output

0 commit comments

Comments
 (0)