You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/reference/reference_lua/box_space/_session_settings.rst
+26-19
Original file line number
Diff line number
Diff line change
@@ -8,28 +8,35 @@ box.space._session_settings
8
8
9
9
.. data:: _session_settings
10
10
11
-
``_session_settings`` is a temporary system space with a list of settings that
12
-
may affect behavior, particularly SQL behavior, for the current session.
13
-
It uses a special engine named 'service'.
14
-
Every 'service' tuple is created on the fly, that is, new tuples are made every time ``_session_settings`` is accessed.
11
+
A temporary system space with settings that affect behavior, particularly SQL behavior,
12
+
for the current session. It uses a special engine named 'service'.
13
+
Every 'service' tuple is created on the fly, that is, new tuples are made every
14
+
time ``_session_settings`` is accessed.
15
15
Every settings tuple has two fields: ``name`` (the primary key) and ``value``.
16
-
The tuples' names and default values are: |br|
17
-
``error_marshaling_enabled``: whether
18
-
:doc:`error objects </reference/reference_lua/box_error/new>` have
19
-
a special structure. Default = false. |br|
20
-
``sql_default_engine``: default :ref:`storage engine <engines-chapter>` for new SQL tables. Default = 'memtx'. |br|
21
-
``sql_defer_foreign_keys``: whether foreign-key checks can wait till commit. Default = false. |br|
22
-
``sql_full_column_names``: whether a full column name is used in :ref:`SQL result set metadata <box-sql_result_sets>`. Default = false. |br|
23
-
``sql_full_metadata``: whether :ref:`SQL result set metadata <box-sql_result_sets>` will have more than just name and type. Default = false. |br|
24
-
``sql_parser_debug``: whether to show parser steps for following statements. Default = false. |br|
25
-
``sql_recursive_triggers``: whether a triggered statement can activate a :ref:`trigger <sql_create_trigger>`. Default = true. |br|
26
-
``sql_reverse_unordered_selects``: whether result rows are usually in reverse order if there is no :ref:`ORDER BY clause <sql_order_by>`. Default = false. |br|
27
-
``sql_select_debug``: whether to show execution steps during :ref:`SELECT <sql_select>`. Default = false. |br|
28
-
``sql_vdbe_debug``: for use by Tarantool's developers. Default = false. |br|
29
-
Three requests are possible: :doc:`select </reference/reference_lua/box_space/select>` and :doc:`get </reference/reference_lua/box_space/get>` and :doc:`update </reference/reference_lua/box_space/update>`.
16
+
The tuples' names and default values are:
17
+
18
+
* ``error_marshaling_enabled``: whether :doc:`error objects </reference/reference_lua/box_error/new>` have
19
+
a special structure. Default: ``false``.
20
+
* ``sql_default_engine``: default :ref:`storage engine <engines-chapter>` for new SQL tables. Default: ``memtx``.
21
+
* ``sql_full_column_names``: use full column names in :ref:`SQL result set metadata <box-sql_result_sets>`.
22
+
Default: ``false``.
23
+
* ``sql_full_metadata``: whether :ref:`SQL result set metadata <box-sql_result_sets>` includes more than just name
24
+
and type. Default:``false``.
25
+
* ``sql_parser_debug``: show parser steps for following statements. Default: ``false``.
26
+
* ``sql_recursive_triggers``: whether a triggered statement can activate a :ref:`trigger <sql_create_trigger>`.
27
+
Default: ``true``.
28
+
* ``sql_reverse_unordered_selects``: return result rows in reverse order if there is no :ref:`ORDER BY clause <sql_order_by>`.
29
+
Default: ``false``.
30
+
* ``sql_select_debug``: show execution steps during :ref:`SELECT <sql_select>`. Default:``false``.
31
+
* ``sql_vdbe_debug``: for internal use. Default:``false``.
32
+
* ``sql_defer_foreign_keys``: **(removed in :doc:`2.11.0 </release/2.11.0>`)** whether foreign-key checks can wait till
33
+
commit. Default: ``false``.
34
+
35
+
Three requests are possible: :doc:`select </reference/reference_lua/box_space/select>`, :doc:`get </reference/reference_lua/box_space/get>`
36
+
and :doc:`update </reference/reference_lua/box_space/update>`.
30
37
For example, after ``s = box.space._session_settings``,
31
38
``s:select('sql_default_engine')`` probably returns ``{'sql_default_engine', 'memtx'}``, and
32
39
``s:update('sql_default_engine', {{'=', 'value', 'vinyl'}})`` changes the default engine to 'vinyl'. |br|
33
40
Updating ``sql_parser_debug`` or ``sql_select_debug`` or ``sql_vdbe_debug`` has no effect unless
34
-
Tarantool was built with -DCMAKE_BUILD_TYPE=Debug. To check if this is so, look at
41
+
Tarantool was built with ``-DCMAKE_BUILD_TYPE=Debug``. To check if this is so, look at
0 commit comments