[CUBRIDMAN-224] Manual for correlated subquery result cache

en/admin/config.rst

@@ -117,7 +117,7 @@
 
 .. note:: If you want to change the value of a parameter permanently, restart all of DB server and broker after changing configuration values of cubrid.conf.
 
 +-------------------------------+-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------------+
 | Category                      | Parameter Name                      | Applied                 | Session | Type     | Default Value                  | Dynamic Change        |
 +===============================+=====================================+=========================+=========+==========+================================+=======================+
 | :ref:`connection-parameters`  | cubrid_port_id                      | client parameter        |         | int      | 1,523                          |                       |
@@ -148,6 +148,8 @@
 |                               | temp_file_memory_size_in_pages      | server parameter        |         | int      | 4                              |                       |
 |                               +-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------------+
 |                               | thread_stacksize                    | server parameter        |         | byte     | 1,048,576                      |                       |
+|                               +-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------------+
+|                               | max_subquery_cache_size             | 서버                     |         | byte     | 2,097,152(2M)                  |                       |
 +-------------------------------+-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------------+
 | :ref:`disk-parameters`        | db_volume_size                      | server parameter        |         | byte     | 512M                           |                       |
 |                               +-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------------+
@@ -683,6 +685,8 @@
 +--------------------------------+--------+---------------------------+---------------------------+---------------------------+
 | thread_stacksize               | byte   | 1,048,576                 | 65,536                    |                           |
 +--------------------------------+--------+---------------------------+---------------------------+---------------------------+
+| max_subquery_cache_size        | byte   | 2,097,152(2M)             | 0                         | 16,777,216(16M)           |
++--------------------------------+--------+---------------------------+---------------------------+---------------------------+
 
 **data_buffer_size**
 
@@ -740,6 +744,12 @@
 
     **thread_stacksize** is a parameter to configure the stack size of a thread. The default value is **1048576** bytes. The value of the **thread_stacksize** parameter must not exceed the stack size allowed by the operating system.
 
+**max_subquery_cache_size**
+
+    **max_subquery_cache_size** is a parameter to configure the size of subquery cache (correlated). 
+    The default value is **2097152** bytes.
+    If there is insufficient storage space, no further subquery caching will be possible.
+
 .. _disk-parameters:
 
 Disk-Related Parameters

en/sql/tuning.rst

@@ -679,6 +679,7 @@
     NO_COVERING_IDX |
     NO_MULTI_RANGE_OPT |
     NO_SORT_LIMIT |
+    NO_SUBQUERY_CACHE |
     NO_PUSH_PRED |
     NO_MERGE |
     NO_ELIMINATE_JOIN |
@@ -724,6 +725,7 @@
 *   **NO_COVERING_IDX**: This is a hint not to use the covering index. For details, see :ref:`covering-index`.
 *   **NO_MULTI_RANGE_OPT**: This is a hint not to use the multi-key range optimization. For details, see :ref:`multi-key-range-opt`.
 *   **NO_SORT_LIMIT**: This is a hint not to use the SORT-LIMIT optimization. For more details, see :ref:`sort-limit-optimization`.
+*   **NO_SUBQUERY_CACHE**: SUBQUERY_CACHE 최적화를 사용하지 않기 위한 힌트이다. 
 *   **NO_PUSH_PRED**: This is a hint not to use the PREDICATE-PUSH optimization.
 *   **NO_MERGE**: This is a hint not to use the VIEW-MERGE optimization.
 *   **NO_ELIMINATE_JOIN**: This is a hint not to use join elimination optimization. For more details, see :ref:`join-elimination-optimization`.
@@ -4189,3 +4191,79 @@
     }
 
 The cached query is shown as **query_string** in the middle of the result screen. Each of the **n_entries** and **n_pages** represents the number of cached queries and the number of pages in the cached results. The **n_entries** is limited to the value of configuration parameter **max_query_cache_entries** and the **n_pages** is limited to the value of **query_cache_size_in_pages**. If the **n_entries** is overflown or the **n_pages** is overflown, some victims among the cache entries are selected and they are uncached. The number of victims is about 20% of **max_query_cache_entries** value and of the **query_cache_size_in_pages** value.
+
+.. _subquery-cache:
+
+SUBQUERY CACHE (correlated)
+------------------------------------
+
+Subquery cache optimization can be used to enhance the performance of queries containing correlated subqueries, and the results of the subqueries are cached in independent spaces for each subquery.
+To disable subquery cache optimization, use the NO_SUBQUERY_CACHE hint on the target subquery.
+
+Subquery cache does not operate in the following scenarios:
+
+* When the correlated subquery contains another correlated subquery.
+* When the subquery is not in the SELECT clause.
+* When the subquery uses CUBRID extended APIs related to classes.
+* When the subquery includes the NO_SUBQUERY_CACHE hint.
+* When storing new results exceeds the set subquery cache size (default: 2MB).
+* When the subquery contains functions that change results with each execution, such as random() or sys_guid().
+When a correlated subquery is in the SELECT clause, the subquery cache is used.
+Among the repeatedly executed correlated subqueries, if the column value of the main query referenced by the correlated subquery is the same, the cached result is used to prevent re-execution.
+If the cached query cannot be found, the subquery is processed, and the column value and query result are cached together.
+If the same column value is found in the cache, the result is retrieved from the cached area.
+In CSQL, as shown in the example below, the improved performance can be easily measured when repeatedly executing queries using the COUNT function.
+The result for the first query's subquery is slow because it is not cached, but the result for the second query's subquery is fetched from the cached area, making the response time much faster than the previous query. ::
+
+    csql> SELECT count(*) from (
+            SELECT /*+ recompile no_merge */
+            (SELECT /*+ NO_SUBQUERY_CACHE */ t1_pk FROM t1 b WHERE b.t1_pk = a.c3)
+            FROM
+            t1 a
+            WHERE a.c2 >= 1);
+    === <Result of SELECT Command in Line 2> ===
+
+                  count(*)
+    ======================
+                     99000
+
+    1 row selected. (0.626199 sec) Committed. (0.000011 sec) 
+
+    1 command(s) successfully processed.
+
+    Trace Statistics:
+      SELECT (time: 621, fetch: 397811, fetch_time: 56, ioread: 0)
+        SCAN (temp time: 7, fetch: 142, ioread: 0, readrows: 99000, rows: 99000)
+        SUBQUERY (uncorrelated)
+          SELECT (time: 607, fetch: 397669, fetch_time: 56, ioread: 0)
+            SCAN (table: dba.t1), (heap time: 98, fetch: 100384, ioread: 0, readrows: 100000, rows: 99000)
+            SUBQUERY (correlated)
+              SELECT (time: 460, fetch: 297000, fetch_time: 0, ioread: 0)
+                SCAN (index: dba.t1.pk_t1), (btree time: 243, fetch: 198000, ioread: 0, readkeys: 99000, filteredkeys: 0, rows: 99000, covered: true)
+
+    csql> SELECT count(*) from (
+            SELECT /*+ recompile no_merge */
+            (SELECT t1_pk FROM t1 b WHERE b.t1_pk = a.c3)
+            FROM
+            t1 a
+            WHERE a.c2 >= 1);
+    === <Result of SELECT Command in Line 6> ===
+
+                  count(*)
+    ======================
+                     99000
+
+    1 row selected. (0.128251 sec) Committed. (0.000010 sec) 
+
+    1 command(s) successfully processed.
+
+    Trace Statistics:
+      SELECT (time: 122, fetch: 103781, fetch_time: 13, ioread: 0)
+        SCAN (temp time: 7, fetch: 142, ioread: 0, readrows: 99000, rows: 99000)
+        SUBQUERY (uncorrelated)
+          SELECT (time: 108, fetch: 103639, fetch_time: 13, ioread: 0)
+            SCAN (table: dba.t1), (heap time: 70, fetch: 100384, ioread: 0, readrows: 100000, rows: 99000)
+            SUBQUERY (correlated)
+              SELECT (time: 4, fetch: 2970, fetch_time: 0, ioread: 0)
+                SCAN (index: dba.t1.pk_t1), (btree time: 2, fetch: 1980, ioread: 0, readkeys: 990, filteredkeys: 0, rows: 990, covered: true)
+                SUBQUERY_CACHE (hit: 98010, miss: 990, size: 269384, status: enabled)

ko/admin/config.rst

@@ -148,6 +148,8 @@ CUBRID는 데이터베이스 서버, 브로커, CUBRID 매니저로 구성된다
 |                               | temp_file_memory_size_in_pages      | 서버                    |         | int      | 4                              |                 |
 |                               +-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------+
 |                               | thread_stacksize                    | 서버                    |         | byte     | 1,048,576                      |                 |
+|                               +-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------+
+|                               | max_subquery_cache_size             | 서버                    |         | byte     | 2,097,152(2M)                  |                 |
 +-------------------------------+-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------+
 | :ref:`disk-parameters`        | db_volume_size                      | 서버                    |         | byte     | 512M                           |                 |
 |                               +-------------------------------------+-------------------------+---------+----------+--------------------------------+-----------------+
@@ -682,6 +684,8 @@ CUBRID 설치 시 생성되는 기본 데이터베이스 환경 설정 파일(**
 +--------------------------------+--------+---------------------------+---------------------------+---------------------------+
 | thread_stacksize               | byte   | 1,048,576                 | 65,536                    |                           |
 +--------------------------------+--------+---------------------------+---------------------------+---------------------------+
+| max_subquery_cache_size        | byte   | 2,097,152(2M)             | 0                         | 16,777,216(16M)           |
++--------------------------------+--------+---------------------------+---------------------------+---------------------------+
 
 **data_buffer_size**
 
@@ -739,6 +743,11 @@ CUBRID 설치 시 생성되는 기본 데이터베이스 환경 설정 파일(**
 
     **thread_stacksize**\ 는 스레드의 스택 크기를 설정하기 위한 파라미터로 기본값은 **1048576** 바이트이다. **thread_stacksize** 파라미터의 설정값은 운영체제가 허용하는 스택 크기를 초과할 수 없다.
 
+**max_subquery_cache_size**
+
+    **max_subquery_cache_size**\ 는 서브 쿼리 캐시의 크기를 설정하기 위한 파라미터로 기본값은 **2097152** 바이트이다. 
+    저장공간이 부족한 경우 더 이상 서브 쿼리 캐시를 사용할 수 없다.
+
 .. _disk-parameters:
 
 디스크 관련 파라미터

ko/conf.py

@@ -163,8 +163,7 @@
 html_static_path = ['_static']
 
 def setup(app):
-  #app.add_css_file('style.css')
-  app.add_stylesheet('style.css')
+  app.add_css_file('style.css')
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = '%b %d, %Y'

ko/sql/tuning.rst

@@ -680,6 +680,7 @@
     NO_COVERING_IDX |
     NO_MULTI_RANGE_OPT |
     NO_SORT_LIMIT |
+    NO_SUBQUERY_CACHE |
     NO_PUSH_PRED |
     NO_MERGE |
     NO_ELIMINATE_JOIN |
@@ -726,6 +727,7 @@
 *   **NO_COVERING_IDX**: 커버링 인덱스 기능을 사용하지 않도록 하는 힌트이다. 자세한 내용은 :ref:`covering-index`\를 참고한다.
 *   **NO_MULTI_RANGE_OPT**: 다중 키 범위 최적화 기능을 사용하지 않도록 하는 힌트이다. 자세한 내용은 :ref:`multi-key-range-opt`\를 참고한다.
 *   **NO_SORT_LIMIT**: SORT-LIMIT 최적화를 사용하지 않기 위한 힌트이다. 자세한 내용은 :ref:`sort-limit-optimization`\를 참고한다.
+*   **NO_SUBQUERY_CACHE**: SUBQUERY_CACHE 최적화를 사용하지 않기 위한 힌트이다. 
 *   **NO_PUSH_PRED**: PREDICATE-PUSH 최적화를 사용하지 않기 위한 힌트이다.
 *   **NO_MERGE**: VIEW-MERGE 최적화를 사용하지 않기 위한 힌트이다.
 *   **NO_ELIMINATE_JOIN**: 조인 제거 최적화를 사용하지 않기 위한 힌트이다. 자세한 내용은 :ref:`join-elimination-optimization`\를 참고한다.
@@ -783,7 +785,7 @@
         FROM a INNER JOIN b ON a.col=b.col
         INNER JOIN c ON b.col=c.col INNER JOIN d ON c.col=d.col;
 
     위와 같은 질의를 수행한다면 **LEADING** 힌트는 무시되며, **ORDERED** 힌트에 따라서 **FROM**절의 순서인, 테이블 a, b, c, d의 순서로 조인된다.
 
     .. code-block:: sql
 
@@ -4191,3 +4193,80 @@
     }
 
 캐시 된 질의는 결과 화면 중간에 **query_string** 으로 표시되며 각 **n_entries** 및 **n_pages** 는 캐시된 질의 수와 캐시 된 결과의 페이지 수를 나타낸다. **n_entries** 는 파라미터 **max_query_cache_entries** 의 값으로 제한되고 **n_pages** 는 **query_cache_size_in_pages** 의 값으로 제한된다. **n_entries** 가 초과되거나 **n_pages** 가 초과되면 캐시 항목 중 일부가 삭제될 후보로 선택되어 삭제되고, 삭제되는 캐시는 **max_query_cache_entries** 값과 **query_cache_size_in_pages** 값의 약 20% 이다.
+
+.. _subquery-cache:
+
+서브 쿼리 캐시 (correlated)
+------------------------------------
+
+서브 쿼리 캐시 최적화는 상관 부질의(correlated subquery)를 포함한 질의의 성능을 향상시키는데 사용할 수 있으며, 부질의의 결과는 부질의마다 독립적인 공간에 캐시된다. 
+서브 쿼리 캐시 최적화를 하지 않으려면 **NO_SUBQUERY_CACHE** 힌트를 해당 부질의에 사용해야 한다.
+
+서브 쿼리 캐시는 다음과 같은 상황에 동작하지 않는다:
+
+* 상관 부질의가 상관 부질의를 포함한 경우.
+* 부질의가 SELECT 절에 있지 않은 경우. 
+* 부질의에 클래스 관련 큐브리드 확장 API를 사용하는 경우.
+* 부질의가 **NO_SUBQUERY_CACHE** 힌트를 포함한 경우.
+* 새로운 결과를 저장할 때 설정한 서브 쿼리 캐시 크기(기본값: 2MB)를 초과하는 경우.
+* random (), sys_guid ()와 같이 실행 시마다 결과가 바뀌는 함수가 포함된 경우.
+
+상관 부질의가 SELECT 절에 있는 경우 서브 쿼리 캐시를 사용한다. 
+매번 재실행되는 상관 부질의 중, 상관 부질의에서 참조한 본 질의의 컬럼 값이 같은 경우 캐시된 결과를 사용하여 재실행을 방지한다. 
+캐시된 질의를 찾을 수 없는 경우 부질의가 처리된 다음 결과와 함께 컬럼 값과 질의 결과를 캐시한다. 
+같은 컬럼 값이 캐시에서 발견되면 캐시된 영역에서 결과를 가져온다. 
+CSQL에서는 아래 예제와 같이 COUNT 함수를 사용하여 질의를 반복적으로 실행할 때 개선된 성능을 쉽게 측정할 수 있다. 
+첫 번째 부질의에 대한 결과는 캐시가 되어 있지 않아서 느리지만, 두 번째 부질의의 결과는 캐시된 영역에서 가져오므로 응답 시간이 이전 질의보다 훨씬 빠르다. ::
+
+    csql> SELECT count(*) from (
+            SELECT /*+ recompile no_merge */
+            (SELECT /*+ NO_SUBQUERY_CACHE */ t1_pk FROM t1 b WHERE b.t1_pk = a.c3)
+            FROM
+            t1 a
+            WHERE a.c2 >= 1);
+    === <Result of SELECT Command in Line 2> ===
+
+                  count(*)
+    ======================
+                     99000
+
+    1 row selected. (0.626199 sec) Committed. (0.000011 sec) 
+
+    1 command(s) successfully processed.
+
+    Trace Statistics:
+      SELECT (time: 621, fetch: 397811, fetch_time: 56, ioread: 0)
+        SCAN (temp time: 7, fetch: 142, ioread: 0, readrows: 99000, rows: 99000)
+        SUBQUERY (uncorrelated)
+          SELECT (time: 607, fetch: 397669, fetch_time: 56, ioread: 0)
+            SCAN (table: dba.t1), (heap time: 98, fetch: 100384, ioread: 0, readrows: 100000, rows: 99000)
+            SUBQUERY (correlated)
+              SELECT (time: 460, fetch: 297000, fetch_time: 0, ioread: 0)
+                SCAN (index: dba.t1.pk_t1), (btree time: 243, fetch: 198000, ioread: 0, readkeys: 99000, filteredkeys: 0, rows: 99000, covered: true)
+
+    csql> SELECT count(*) from (
+            SELECT /*+ recompile no_merge */
+            (SELECT t1_pk FROM t1 b WHERE b.t1_pk = a.c3)
+            FROM
+            t1 a
+            WHERE a.c2 >= 1);
+    === <Result of SELECT Command in Line 6> ===
+
+                  count(*)
+    ======================
+                     99000
+
+    1 row selected. (0.128251 sec) Committed. (0.000010 sec) 
+
+    1 command(s) successfully processed.
+
+    Trace Statistics:
+      SELECT (time: 122, fetch: 103781, fetch_time: 13, ioread: 0)
+        SCAN (temp time: 7, fetch: 142, ioread: 0, readrows: 99000, rows: 99000)
+        SUBQUERY (uncorrelated)
+          SELECT (time: 108, fetch: 103639, fetch_time: 13, ioread: 0)
+            SCAN (table: dba.t1), (heap time: 70, fetch: 100384, ioread: 0, readrows: 100000, rows: 99000)
+            SUBQUERY (correlated)
+              SELECT (time: 4, fetch: 2970, fetch_time: 0, ioread: 0)
+                SCAN (index: dba.t1.pk_t1), (btree time: 2, fetch: 1980, ioread: 0, readkeys: 990, filteredkeys: 0, rows: 990, covered: true)
+                SUBQUERY_CACHE (hit: 98010, miss: 990, size: 269384, status: enabled)