Skip to content

Commit 4402be2

Browse files
Document 'sql' configuration settings (#4372)
1 parent 24547d9 commit 4402be2

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

doc/reference/configuration/configuration_reference.rst

+29
Original file line numberDiff line numberDiff line change
@@ -4302,6 +4302,35 @@ snapshot.by.*
43024302
| Default: 10^18
43034303
| Environment variable: TT_SNAPSHOT_BY_WAL_SIZE
43044304
4305+
4306+
4307+
.. _configuration_reference_sql:
4308+
4309+
sql
4310+
---
4311+
4312+
The ``sql`` section defines configuration parameters related to :ref:`SQL <reference_sql>`.
4313+
4314+
.. NOTE::
4315+
4316+
``sql`` can be defined in any :ref:`scope <configuration_scopes>`.
4317+
4318+
- :ref:`sql.cache_size <configuration_reference_sql_cache_size>`
4319+
4320+
.. _configuration_reference_sql_cache_size:
4321+
4322+
.. confval:: sql.cache_size
4323+
4324+
The maximum cache size (in bytes) for all :ref:`SQL prepared statements <box-sql_box_prepare>`.
4325+
To see the actual cache size, use :ref:`box.info.sql().cache.size <box_introspection-box_info>`.
4326+
4327+
|
4328+
| Type: integer
4329+
| Default: 5242880
4330+
| Environment variable: TT_SQL_CACHE_SIZE
4331+
4332+
4333+
43054334
.. _configuration_reference_vinyl:
43064335

43074336
vinyl

doc/reference/reference_lua/box_sql/prepare.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ box.prepare()
3838
is "shared", that is, there is one cache for
3939
all sessions. However, session X cannot execute a statement prepared by session Y. |br|
4040
For monitoring the cache, see :ref:`box.info().sql <box_introspection-box_info>`. |br|
41-
For changing the cache, see :ref:`(Configuration reference) sql_cache_size <cfg_basic-sql_cache_size>`.
41+
For changing the cache size, use :ref:`sql.cache_size <configuration_reference_sql_cache_size>`.
4242

4343
Prepared statements will "expire" (become invalid) if
4444
any database object is dropped or created or altered --

0 commit comments

Comments
 (0)