12
12
:depth: 2
13
13
:class: singlecol
14
14
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
17
17
:ref:`catalog-info-cmd` command, which shows the :manual:`ISODate
18
18
</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.
21
21
22
22
.. _update-catalog-cmd-syntax:
23
23
@@ -26,14 +26,51 @@ Syntax
26
26
27
27
.. code-block:: text
28
28
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
30
66
31
67
.. _update-catalog-cmd-usage:
32
68
33
69
Usage
34
70
~~~~~
35
71
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:
37
74
38
75
.. code-block:: text
39
76
@@ -42,12 +79,20 @@ To update the catalog, run the following command:
42
79
The previous command runs in the foreground and is similar to running
43
80
the command with ``background`` set to ``false``.
44
81
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:
46
84
47
85
.. code-block:: text
48
86
49
87
db.runCommand({ "updateCatalog" : 1, "background" : true })
50
88
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
+
51
96
.. _update-catalog-cmd-output:
52
97
53
98
Output
0 commit comments