Skip to content

Commit d84954b

Browse files
DOCSP-10860 doc for storageValidateConfig command (#35)
DOCSP-10860 fix for spacing issue
1 parent f872a3e commit d84954b

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

source/config/config-data-lake.txt

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,10 @@ database commands to set or update the {+data-lake-short+} configuration:
7474

7575
Replace ``<config>`` with the {+data-lake-short+} configuration
7676
file. For complete documentation on the configuration fields and file
77-
format, see :ref:`datalake-configuration-format`.
77+
format, see :ref:`datalake-configuration-format`. You can validate
78+
your :ref:`configuration <datalake-configuration-file>` before setting or
79+
updating the {+data-lake-short+} configuration by running the
80+
:ref:`storageValidateConfig <datalake-validatestorageconfig>` command.
7881

7982
To set or update the storage configuration through the |service| UI:
8083

@@ -87,6 +90,45 @@ To set or update the storage configuration through the |service| UI:
8790

8891
2. Make changes to your storage configuration and click :guilabel:`Save`.
8992

93+
.. _datalake-validatestorageconfig:
94+
95+
Validate {+data-lake-short+} Configuration
96+
------------------------------------------
97+
98+
You can run the following command to validate your {+data-lake-short+}
99+
:ref:`configuration <datalake-configuration-file>`.
100+
101+
.. code-block:: javascript
102+
103+
use admin
104+
db.runCommand( { "storageValidateConfig" : <config> } )
105+
106+
Replace ``<config>`` with the {+data-lake-short+} configuration
107+
file. For complete documentation on the configuration fields and file
108+
format, see :ref:`datalake-configuration-format`.
109+
110+
The command returns the following if your {+dl+} configuration is valid:
111+
112+
.. code-block:: sh
113+
:copyable: false
114+
115+
{ "ok" : 1 }
116+
117+
The command returns the list of errors in the ``errs`` field if your
118+
{+dl+} storage configuration is invalid:
119+
120+
.. code-block:: sh
121+
:copyable: false
122+
123+
{
124+
"ok" : 1,
125+
"errs" : [
126+
"<error>",
127+
"<error>",
128+
...
129+
]
130+
}
131+
90132
.. _datalake-storagegenconfig:
91133

92134
Generate {+data-lake-short+} Configuration

0 commit comments

Comments
 (0)