Document tt export/import #3737

andreyaksenov · 2023-09-26T14:54:33Z

Created the https://docs.d.tarantool.io/en/doc/tt-export-import/reference/tooling/tt_cli/export page.
Created the https://docs.d.tarantool.io/en/doc/tt-export-import/reference/tooling/tt_cli/import page.
Created the Interacting with the CRUD module page: https://docs.d.tarantool.io/en/doc/tt-export-import/reference/tooling/tt_cli/crud/. This page contains links to the tt export/tt import commands with detailed information.
Added all commands to the index page: https://docs.d.tarantool.io/en/doc/tt-export-import/reference/tooling/tt_cli/commands/.
Added a link to the latest release on GitHub and mentioned tt EE in the intro: https://docs.d.tarantool.io/en/doc/tt-export-import/reference/tooling/tt_cli/
Added a note about tt in the EE package: https://docs.d.tarantool.io/en/doc/tt-export-import/reference/tooling/tt_cli/installation/

p7nov

Some edits and questions from my side.
Some comments from export are applicable to import as well; I didn't duplicate them.

p7nov · 2023-10-03T10:13:30Z

doc/reference/tooling/tt_cli/crud.rst

+
+    $ tt crud COMMAND [COMMAND_OPTION ...]
+
+``tt crud`` enables you to interact with a cluster using the `CRUD <https://github.com/tarantool/crud>`_ module.


Non-personal wording looks better in references.

Suggested change

``tt crud`` enables you to interact with a cluster using the `CRUD <https://github.com/tarantool/crud>`_ module.

``tt crud`` enables the interaction with a cluster using the `CRUD <https://github.com/tarantool/crud>`_ module.

p7nov · 2023-10-03T10:17:42Z

doc/reference/tooling/tt_cli/export.rst

+
+    $ tt [crud] export URI FILE SPACE [EXPORT_OPTION ...]
+
+``tt [crud] export`` exports a space's data to a file.


Not sure if possessive is correct for this case (space's data).
Maybe rephrase?

Suggested change

``tt [crud] export`` exports a space's data to a file.

``tt [crud] export`` exports data from a given space to a file.

Also, maybe mention the file format in this general description?

a space's data

I believe, possessive works good for our space term.

Also, maybe mention the file format in this general description?

Currently, only CSV is supported but other formats may be added in the future. And given that CSV is the only supported format, for example, CSV will look a bit weird, too.

To be precise, I would write "to a CSV file". If other format appear later, we'll update the description.

p7nov · 2023-10-03T10:20:30Z

doc/reference/tooling/tt_cli/export.rst

+
+..  NOTE::
+
+    You should have :ref:`read access <authentication-owners_privileges>` to the required space to be able to export data.


It's unclear who is you in this sentence. The reader runs tt outside of Tarantool.
Shorter wording: to the required space to be able to export data. > to the space to export its data.

Will update to Read access to the space is required to export its data.

p7nov · 2023-10-03T10:21:27Z

doc/reference/tooling/tt_cli/export.rst

+
+..  NOTE::
+
+    Exporting isn't supported for the :ref:`interval <index-box_interval>` field type.


What exactly does it mean? Export does not work on spaces with such field? Export works but interval fields are lost? Anything else?

I've checked: exporting works, data of this field is exported but looks unreadable and causes an error on an attempt to import it back.

p7nov · 2023-10-03T10:22:08Z

doc/reference/tooling/tt_cli/export.rst

+Exporting compound data
+-----------------------
+
+By default, ``tt`` exports empty values for fields containing compound data like arrays or maps.


Suggested change

By default, ``tt`` exports empty values for fields containing compound data like arrays or maps.

By default, ``tt`` exports empty values for fields containing compound data such as arrays or maps.

like - similar object, such as - actual examples.

p7nov · 2023-10-03T10:29:53Z

doc/reference/tooling/tt_cli/import.rst

+Automatic matching
+~~~~~~~~~~~~~~~~~~
+
+Suppose, you have the ``customers.csv`` file with a header containing field names in the first row:


Suggested change

Suppose, you have the ``customers.csv`` file with a header containing field names in the first row:

Suppose that you have the ``customers.csv`` file with a header containing field names in the first row:

p7nov · 2023-10-03T10:30:51Z

doc/reference/tooling/tt_cli/import.rst

+Manual matching
+~~~~~~~~~~~~~~~
+
+The ``--match`` option enables you to import data by matching field names in the input file and the target space manually.


Suggested change

The ``--match`` option enables you to import data by matching field names in the input file and the target space manually.

The ``--match`` option enables importing data by matching field names in the input file and the target space manually.

p7nov · 2023-10-03T10:31:23Z

doc/reference/tooling/tt_cli/import.rst

+Handling parsing errors
+-----------------------
+
+To skip rows whose data cannot be parsed correctly, you can use the ``--on-error`` option as follows:


Suggested change

To skip rows whose data cannot be parsed correctly, you can use the ``--on-error`` option as follows:

To skip rows whose data cannot be parsed correctly, use the ``--on-error`` option as follows:

p7nov · 2023-10-03T10:33:05Z

doc/reference/tooling/tt_cli/import.rst

+..  option:: -success STRING
+
+    The name of a file with rows that were imported (the default is ``success``).
+    Overrides the file if it already exists.


Can't understand what exactly this means. Overwrites?

p7nov · 2023-10-03T10:34:50Z

doc/reference/tooling/tt_cli/installation.rst

@@ -5,6 +5,11 @@ To install the ``tt`` command-line utility, use a package manager -- Yum or
 APT on Linux, or Homebrew on macOS. If you need a specific build, you can build
 ``tt`` from sources.

+.. NOTE::
+
+    A Tarantool Enterprise's `release package <https://www.tarantool.io/en/enterprise_doc/setup/#package-contents>`_ includes the `tt` utility extended with additional features like :ref:`importing <tt-crud-import>` and :ref:`exporting <tt-crud-export>` data.


Maybe put this (or similar) text on the main tt CLI page to explain the existence/positioning of tt EE in general?

Will add it to the intro

p7nov

LGTM, just a couple more notes.

p7nov · 2023-10-03T11:53:48Z

doc/reference/tooling/tt_cli/export.rst

+
+    $ tt [crud] export URI FILE SPACE [EXPORT_OPTION ...]
+
+``tt [crud] export`` exports a space's data to a file.


To be precise, I would write "to a CSV file". If other format appear later, we'll update the description.

p7nov · 2023-10-03T11:56:13Z

doc/reference/tooling/tt_cli/export.rst

+
+    :ref:`Read access <authentication-owners_privileges>` to the space is required to export its data.
+
+..  NOTE::


Forgot to write in the first review: this should be important or even warning because the data loss is possible.

p7nov · 2023-10-03T11:58:59Z

doc/reference/tooling/tt_cli/index.rst

 ``tt`` is a utility that provides a unified command-line interface for managing
 Tarantool-based applications. It covers a wide range of tasks -- from installing
 a specific Tarantool version to managing remote instances and developing applications.

 ``tt`` is developed in its own `GitHub repository <https://github.com/tarantool/tt>`_.
 Here you can find its source code, changelog, and releases information.
+There is also the Enterprise version of ``tt`` is available in a


Pls add a blank line to separate the new paragraph.

This was linked to issues Sep 26, 2023

tt (crud) export #3274

Closed

TT (crud) import #2561

Closed

andreyaksenov force-pushed the tt-export-import branch 23 times, most recently from 5234413 to 2765071 Compare October 2, 2023 10:49

andreyaksenov requested a review from psergee October 2, 2023 10:49

andreyaksenov force-pushed the tt-export-import branch 3 times, most recently from a012399 to f1dc23e Compare October 2, 2023 11:41

psergee approved these changes Oct 2, 2023

View reviewed changes

andreyaksenov requested a review from p7nov October 2, 2023 18:41

andreyaksenov force-pushed the tt-export-import branch 3 times, most recently from 18d1567 to 395ad98 Compare October 3, 2023 10:08

p7nov suggested changes Oct 3, 2023

View reviewed changes

andreyaksenov force-pushed the tt-export-import branch 2 times, most recently from 29d0ae4 to 07d6e32 Compare October 3, 2023 11:49

andreyaksenov requested a review from p7nov October 3, 2023 11:50

andreyaksenov force-pushed the tt-export-import branch from 07d6e32 to 9513bf5 Compare October 3, 2023 12:07

p7nov approved these changes Oct 3, 2023

View reviewed changes

andreyaksenov force-pushed the tt-export-import branch from 9513bf5 to 9425293 Compare October 3, 2023 12:47

Document tt export/import

5b11aec

andreyaksenov force-pushed the tt-export-import branch from 9425293 to 5b11aec Compare October 3, 2023 13:27

andreyaksenov merged commit 5c9b5e2 into latest Oct 3, 2023

andreyaksenov deleted the tt-export-import branch October 3, 2023 13:47


		$ tt crud COMMAND [COMMAND_OPTION ...]

		``tt crud`` enables you to interact with a cluster using the `CRUD <https://github.com/tarantool/crud>`_ module.

	``tt crud`` enables you to interact with a cluster using the `CRUD <https://github.com/tarantool/crud>`_ module.
	``tt crud`` enables the interaction with a cluster using the `CRUD <https://github.com/tarantool/crud>`_ module.


		$ tt [crud] export URI FILE SPACE [EXPORT_OPTION ...]

		``tt [crud] export`` exports a space's data to a file.

	``tt [crud] export`` exports a space's data to a file.
	``tt [crud] export`` exports data from a given space to a file.


		.. NOTE::

		You should have :ref:`read access <authentication-owners_privileges>` to the required space to be able to export data.


		.. NOTE::

		Exporting isn't supported for the :ref:`interval <index-box_interval>` field type.

	By default, ``tt`` exports empty values for fields containing compound data like arrays or maps.
	By default, ``tt`` exports empty values for fields containing compound data such as arrays or maps.

	Suppose, you have the ``customers.csv`` file with a header containing field names in the first row:
	Suppose that you have the ``customers.csv`` file with a header containing field names in the first row:

	The ``--match`` option enables you to import data by matching field names in the input file and the target space manually.
	The ``--match`` option enables importing data by matching field names in the input file and the target space manually.

	To skip rows whose data cannot be parsed correctly, you can use the ``--on-error`` option as follows:
	To skip rows whose data cannot be parsed correctly, use the ``--on-error`` option as follows:


		:ref:`Read access <authentication-owners_privileges>` to the space is required to export its data.

		.. NOTE::

Document tt export/import #3737

Document tt export/import #3737

Uh oh!

Conversation

andreyaksenov commented Sep 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

p7nov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

p7nov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andreyaksenov commented Sep 26, 2023 •

edited

Loading