Skip to content

Commit 02be11e

Browse files
committed
Getting started: net.box - update per TW review
1 parent f7bc9b6 commit 02be11e

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

doc/how-to/getting_started_db.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Creating your first Tarantool database
55

66
**Example on GitHub**: `create_db <https://github.com/tarantool/doc/tree/latest/doc/code_snippets/snippets/config/instances.enabled/create_db>`_
77

8-
In this tutorial, you create a Tarantool database, write data to and select data from this database.
8+
In this tutorial, you create a Tarantool database, write data to it, and select data from this database.
99

1010

1111
.. _getting_started_db_prerequisites:
@@ -15,8 +15,8 @@ Prerequisites
1515

1616
Before starting this tutorial:
1717

18-
* :ref:`Install the tt <tt-installation>` utility.
19-
* `Install tarantool <https://www.tarantool.io/en/download/os-installation/>`_.
18+
* Install the :ref:`tt <tt-installation>` utility.
19+
* Install `Tarantool <https://www.tarantool.io/en/download/os-installation/>`_.
2020

2121
.. NOTE::
2222

doc/how-to/getting_started_net_box.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ You can find the full example on GitHub: `sample_db <https://github.com/tarantoo
4040
Making net.box requests interactively
4141
-------------------------------------
4242

43-
To try out ``net.box`` requests in the interactive console, you need to start the :ref:`sample_db <getting_started_net_box_sample_db>` application using ``tt start``:
43+
To try out ``net.box`` requests in the interactive console, start the :ref:`sample_db <getting_started_net_box_sample_db>` application using ``tt start``:
4444

4545
.. code-block:: console
4646
@@ -72,15 +72,15 @@ To load the ``net.box`` module, use the ``require()`` directive:
7272
:end-before: net_box.connect
7373
:dedent:
7474

75-
To create a connection, pass a database URI to the ``connect()`` method:
75+
To create a connection, pass a database URI to the :ref:`net_box.connect() <net_box-connect>` method:
7676

7777
.. literalinclude:: /code_snippets/snippets/connectors/net_box/myapp.lua
7878
:language: lua
7979
:start-at: net_box.connect
8080
:end-before: conn:ping
8181
:dedent:
8282

83-
``ping()`` can be used to check the connection status:
83+
:ref:`connection:ping() <conn-ping>` can be used to check the connection status:
8484

8585
.. literalinclude:: /code_snippets/snippets/connectors/net_box/myapp.lua
8686
:language: lua
@@ -144,7 +144,7 @@ You can also get a tuple by the value of the specified index as follows:
144144
Updating data
145145
*************
146146

147-
``space_object.update`` updates a tuple identified by the primary key.
147+
:ref:`space_object.update() <box_space-update>` updates a tuple identified by the primary key.
148148
This method accepts a full key and an operation to execute:
149149

150150
.. literalinclude:: /code_snippets/snippets/connectors/net_box/myapp.lua
@@ -153,7 +153,7 @@ This method accepts a full key and an operation to execute:
153153
:end-before: conn.space.bands:upsert
154154
:dedent:
155155

156-
``space_object.upsert`` updates an existing tuple or inserts a new one.
156+
:ref:`space_object.upsert() <box_space-upsert>` updates an existing tuple or inserts a new one.
157157
In the example below, a new tuple is inserted:
158158

159159
.. literalinclude:: /code_snippets/snippets/connectors/net_box/myapp.lua
@@ -163,7 +163,7 @@ In the example below, a new tuple is inserted:
163163
:dedent:
164164

165165

166-
In this example, ``space_object.replace`` is used to delete the existing tuple and insert a new one:
166+
In this example, :ref:`space_object.replace() <box_space-replace>` is used to delete the existing tuple and insert a new one:
167167

168168
.. literalinclude:: /code_snippets/snippets/connectors/net_box/myapp.lua
169169
:language: lua
@@ -179,7 +179,7 @@ In this example, ``space_object.replace`` is used to delete the existing tuple a
179179
Deleting data
180180
*************
181181

182-
The ``space_object.delete`` call in the example below deletes a tuple whose primary key value is ``5``:
182+
The :ref:`space_object.delete() <box_space-delete>` call in the example below deletes a tuple whose primary key value is ``5``:
183183

184184
.. literalinclude:: /code_snippets/snippets/connectors/net_box/myapp.lua
185185
:language: lua
@@ -194,7 +194,7 @@ The ``space_object.delete`` call in the example below deletes a tuple whose prim
194194
Executing stored procedures
195195
~~~~~~~~~~~~~~~~~~~~~~~~~~~
196196

197-
To execute a stored procedure, use the ``connection:call()`` method:
197+
To execute a stored procedure, use the :ref:`connection:call() <net_box-call>` method:
198198

199199
.. literalinclude:: /code_snippets/snippets/connectors/net_box/myapp.lua
200200
:language: lua
@@ -208,7 +208,7 @@ To execute a stored procedure, use the ``connection:call()`` method:
208208
Closing the connection
209209
~~~~~~~~~~~~~~~~~~~~~~
210210

211-
The ``connection:close()`` method can be used to close the connection when it is no longer needed:
211+
The :ref:`connection:close() <conn-close>` method can be used to close the connection when it is no longer needed:
212212

213213
.. literalinclude:: /code_snippets/snippets/connectors/net_box/myapp.lua
214214
:language: lua

0 commit comments

Comments
 (0)