Skip to content

Commit 39bb3de

Browse files
authored
Merge branch 'master' into install-docs-updates
2 parents 7e0a17e + e02f183 commit 39bb3de

File tree

1 file changed

+13
-76
lines changed

1 file changed

+13
-76
lines changed

source/manage/command-line-tools.rst

Lines changed: 13 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -232,17 +232,6 @@ Format
232232
233233
mattermost db version
234234
235-
Example
236-
.. code-block:: sh
237-
238-
bin/mattermost export actiance --exportFrom=1513102632
239-
240-
Options
241-
.. code-block:: text
242-
243-
--exportFrom string Unix timestamp (milliseconds since epoch, UTC) to export data from.
244-
--batchSize int The number of posts to export. The default of -1 means no limit.
245-
246235
----
247236

248237
mattermost export
@@ -255,82 +244,26 @@ Description
255244
Commands for exporting data for compliance and for merging multiple Mattermost instances.
256245

257246
Child Commands
258-
- `mattermost export actiance`_ - Export data from Mattermost in Actiance XML format. Requires a Mattermost Enterprise subscription plan.
247+
- `mattermost export actiance`_ - Deprecated from Mattermost v10.5 in favor of `mattermost export schedule`_.
248+
- `mattermost export csv`_ - Deprecated from Mattermost v10.5.
249+
- `mattermost export global-relay-zip`_ - Deprecated from Mattermost v10.5.
250+
- `mattermost export schedule`_ - Schedule a compliance export job.
259251
- `mattermost export bulk`_ - Export data to a file compatible with the Mattermost :doc:`Bulk Import format </onboard/bulk-loading-data>`. Deprecated in favor of :ref:`mmctl export commands <manage/mmctl-command-line-tool:mmctl export>`.
260-
- `mattermost export csv`_ - Export data from Mattermost in CSV format. Requires a Mattermost Enterprise subscription plan.
261-
- `mattermost export global-relay-zip`_ - Export data from Mattermost into a ZIP file containing emails to send to Global Relay for debug and testing purposes only. Requires a Mattermost Enterprise subscription plan.
262-
- `mattermost export schedule`_ - Schedule an export job
263252

264253
mattermost export actiance
265254
~~~~~~~~~~~~~~~~~~~~~~~~~~
266255

267-
Description
268-
Export data from Mattermost in Actiance XML format.
269-
270-
Format
271-
.. code-block:: sh
272-
273-
mattermost export actiance
274-
275-
Example
276-
.. code-block:: sh
277-
278-
bin/mattermost export actiance --exportFrom=1513102632
279-
280-
Options
281-
.. code-block:: text
282-
283-
--exportFrom string Unix timestamp (milliseconds since epoch, UTC) to export data from.
284-
--batchSize int The number of posts to export. The default of -1 means no limit.
285-
286-
mattermost export bulk
287-
~~~~~~~~~~~~~~~~~~~~~~
288-
289-
From Mattermost v6.0, this command has been deprecated in favor of :ref:`mmctl export commands <manage/mmctl-command-line-tool:mmctl export>` as the supported way to export data out of Mattermost.
256+
From Mattermost v10.5, this command has been deprecated. It will be added to the mmctl command line tool in a future version. Until then, please use `mattermost export schedule`_.
290257

291258
mattermost export csv
292259
~~~~~~~~~~~~~~~~~~~~~
293260

294-
Description
295-
Export data from Mattermost in CSV format.
296-
297-
Format
298-
.. code-block:: sh
299-
300-
mattermost export csv
301-
302-
Example
303-
.. code-block:: sh
304-
305-
bin/mattermost export csv --exportFrom=1513102632
306-
307-
Options
308-
.. code-block:: text
309-
310-
--exportFrom string Unix timestamp (seconds since epoch, UTC) to export data from.
311-
--batchSize int The number of posts to export. The default of -1 means no limit.
261+
From Mattermost v10.5, this command has been deprecated. It will be added to the mmctl command line tool in a future version.
312262

313263
mattermost export global-relay-zip
314264
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
315265

316-
Description
317-
Export data from Mattermost into a zip file containing emails to send to Global Relay for debug and testing purposes only. This does not archive any information in Global Relay.
318-
319-
Format
320-
.. code-block:: sh
321-
322-
mattermost export global-relay-zip
323-
324-
Example
325-
.. code-block:: sh
326-
327-
bin/mattermost export global-relay-zip --exportFrom=1513102632
328-
329-
Options
330-
.. code-block:: text
331-
332-
--exportFrom string Unix timestamp (seconds since epoch, UTC) to export data from.
333-
--batchSize int The number of posts to export. The default of -1 means no limit.
266+
From Mattermost v10.5, this command has been deprecated. It will be added to the mmctl command line tool in a future version.
334267

335268
mattermost export schedule
336269
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -346,15 +279,19 @@ Format
346279
Example
347280
.. code-block:: sh
348281
349-
bin/mattermost export schedule --format=actiance --exportFrom=1513102632
282+
bin/mattermost export schedule --exportFrom=1513102632
350283
351284
Options
352285
.. code-block:: text
353286
354-
--format string Output file format. Currently, only ``actiance`` is supported.
355287
--exportFrom string Unix timestamp (seconds since epoch, UTC) to export data from.
356288
--timeoutSeconds string Set how long the export should run for before timing out.
357289
290+
mattermost export bulk
291+
~~~~~~~~~~~~~~~~~~~~~~
292+
293+
From Mattermost v6.0, this command has been deprecated in favor of :ref:`mmctl export commands <manage/mmctl-command-line-tool:mmctl export>` as the supported way to export data out of Mattermost.
294+
358295
----
359296

360297
mattermost help

0 commit comments

Comments
 (0)