2021.2.1.24

conf.py

@@ -26,7 +26,7 @@
 
 
 # The full version, including alpha/beta/rc tags
-release = '2022.1'
+release = '2021.2.1.24'
 
 
 
@@ -68,7 +68,7 @@
     'css/custom.css', # Relative to the _static path
 ]
 
-html_logo = '_static/images/sqream_logo.png'
+html_logo = '_static/images/SQream_logo_without background-15.png'
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
@@ -90,7 +90,7 @@
    'logo_only': True # Hide "SQream DB" title and only show logo
    , 'display_version': True # Display version at the top
    , 'style_external_links': True # Show little icon next to external links
-   , 'style_nav_header_background': '#0f9790' # SQream teal
+   , 'style_nav_header_background': '#133148' # SQream teal
    , 'navigation_depth': -1
    , 'collapse_navigation': False
    , 'titles_only': True

configuration_guides/admin_cluster_flags.rst

@@ -6,4 +6,4 @@ Cluster Administration Flags
 
 The **Cluster Administration Flags** page describes **Cluster** modification type flags, which can be modified by administrators on a session and cluster basis using the ``ALTER SYSTEM SET`` command:
 
-* `Persisting Your Cache Directory <https://docs.sqream.com/en/latest/configuration_guides/csv_limit_row_length.html>`_
+* `Setting Maximum CSV Row Length <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/csv_limit_row_length.html>`_

configuration_guides/admin_regular_flags.rst

@@ -5,27 +5,28 @@ Regular Administration Flags
 *************************
 The **Regular Administration Flags** page describes **Regular** modification type flags, which can be modified by administrators on a session and cluster basis using the ``ALTER SYSTEM SET`` command:
 
-* `Setting Bin Size <https://docs.sqream.com/en/latest/configuration_guides/bin_sizes.html>`_
-* `Setting CUDA Memory <https://docs.sqream.com/en/latest/configuration_guides/check_cuda_memory.html>`_
-* `Limiting Runtime to Utility Functions <https://docs.sqream.com/en/latest/configuration_guides/compiler_gets_only_ufs.html>`_
-* `Enabling High Bin Control Granularity <https://docs.sqream.com/en/latest/configuration_guides/copy_to_restrict_utf8.html>`_
-* `Reducing CPU Hashtable Sizes <https://docs.sqream.com/en/latest/configuration_guides/cpu_reduce_hashtable_size.html>`_
-* `Setting Chunk Size for Copying from CPU to GPU <https://docs.sqream.com/en/latest/configuration_guides/cuda_mem_cpy_max_size_bytes.html>`_
-* `Indicating GPU Synchronicity <https://docs.sqream.com/en/latest/configuration_guides/cuda_mem_cpy_synchronous.html>`_
-* `Enabling Modification of R&D Flags <https://docs.sqream.com/en/latest/configuration_guides/developer_mode.html>`_
-* `Checking for Post-Production CUDA Errors <https://docs.sqream.com/en/latest/configuration_guides/enable_device_debug_messages.html>`_
-* `Enabling Modification of clientLogger_debug File <https://docs.sqream.com/en/latest/configuration_guides/enable_log_debug.html>`_
-* `Activating the NVidia Profiler Markers <https://docs.sqream.com/en/latest/configuration_guides/enable_nv_prof_markers.html>`_
-* `Appending String at End of Log Lines <https://docs.sqream.com/en/latest/configuration_guides/end_log_message.html>`_
-* `Monitoring and Printing Pinned Allocation Reports <https://docs.sqream.com/en/latest/configuration_guides/gather_mem_stat.html>`_
-* `Increasing Chunk Size to Reduce Query Speed <https://docs.sqream.com/en/latest/configuration_guides/increase_chunk_size_before_reduce.html>`_
-* `Adding Rechunker before Expensing Chunk Producer <https://docs.sqream.com/en/latest/configuration_guides/increase_mem_factors.html>`_
-* `Setting the Buffer Size <https://docs.sqream.com/en/latest/configuration_guides/level_db_write_buffer_size.html>`_
-* `Setting Memory Used to Abort Server <https://docs.sqream.com/en/latest/configuration_guides/memory_reset_trigger_mb.html>`_
-* `Splitting Large Reads for Concurrent Execution <https://docs.sqream.com/en/latest/configuration_guides/mt_read.html>`_
-* `Setting Worker Amount to Handle Concurrent Reads <https://docs.sqream.com/en/latest/configuration_guides/mt_read_workers.html>`_
-* `Setting Implicit Casts in ORC Files <https://docs.sqream.com/en/latest/configuration_guides/orc_implicit_casts.html>`_
-* `Setting Timeout Limit for Locking Objects before Executing Statements <https://docs.sqream.com/en/latest/configuration_guides/statement_lock_timeout.html>`_
-* `Interpreting Decimal Literals as Double Instead of Numeric <https://docs.sqream.com/en/latest/configuration_guides/use_legacy_decimal_literals.html>`_
-* `Interpreting VARCHAR as TEXT <https://docs.sqream.com/en/latest/configuration_guides/use_legacy_string_literals.html>`_
-* `VARCHAR Identifiers <https://docs.sqream.com/en/latest/configuration_guides/varchar_identifiers.html>`_
+* `Setting Bin Size <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/bin_sizes.html>`_
+* `Setting CUDA Memory <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/check_cuda_memory.html>`_
+* `Limiting Runtime to Utility Functions <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/compiler_gets_only_ufs.html>`_
+* `Enabling High Bin Control Granularity <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/copy_to_restrict_utf8.html>`_
+* `Reducing CPU Hashtable Sizes <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/cpu_reduce_hashtable_size.html>`_
+* `Setting Chunk Size for Copying from CPU to GPU <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/cuda_mem_cpy_max_size_bytes.html>`_
+* `Indicating GPU Synchronicity <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/cuda_mem_cpy_synchronous.html>`_
+* `Enabling Modification of R&D Flags <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/developer_mode.html>`_
+* `Checking for Post-Production CUDA Errors <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/enable_device_debug_messages.html>`_
+* `Enabling Modification of clientLogger_debug File <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/enable_log_debug.html>`_
+* `Activating the NVidia Profiler Markers <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/enable_nv_prof_markers.html>`_
+* `Appending String at End of Log Lines <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/end_log_message.html>`_
+* `Monitoring and Printing Pinned Allocation Reports <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/gather_mem_stat.html>`_
+* `Increasing Chunk Size to Reduce Query Speed <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/increase_chunk_size_before_reduce.html>`_
+* `Adding Rechunker before Expensing Chunk Producer <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/increase_mem_factors.html>`_
+* `Setting the Buffer Size <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/level_db_write_buffer_size.html>`_
+* `Maximum Pinned Percentage of Total RAM <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/max_pinned_percentage_of_total_ram.html>`_
+* `Setting Memory Used to Abort Server <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/memory_reset_trigger_mb.html>`_
+* `Splitting Large Reads for Concurrent Execution <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/mt_read.html>`_
+* `Setting Worker Amount to Handle Concurrent Reads <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/mt_read_workers.html>`_
+* `Setting Implicit Casts in ORC Files <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/orc_implicit_casts.html>`_
+* `Setting Timeout Limit for Locking Objects before Executing Statements <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/statement_lock_timeout.html>`_
+* `Interpreting Decimal Literals as Double Instead of Numeric <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/use_legacy_decimal_literals.html>`_
+* `Interpreting VARCHAR as TEXT <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/use_legacy_string_literals.html>`_
+* `VARCHAR Identifiers <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/varchar_identifiers.html>`_

configuration_guides/admin_worker_flags.rst

@@ -5,7 +5,10 @@ Worker Administration Flags
 *************************
 The **Worker Administration Flags** page describes **Worker** modification type flags, which can be modified by administrators on a session and cluster basis using the ``ALTER SYSTEM SET`` command:
 
-* `Setting Total Device Memory Usage in SQream Instance <https://docs.sqream.com/en/latest/configuration_guides/cuda_mem_quota.html>`_
-* `Enabling Manually Setting Reported IP <https://docs.sqream.com/en/latest/configuration_guides/machine_ip.html>`_
-* `Setting Port Used for Metadata Server Connection <https://docs.sqream.com/en/latest/configuration_guides/metadata_server_port.html>`_
-* `Assigning Local Network IP <https://docs.sqream.com/en/latest/configuration_guides/use_config_ip.html>`_
+* `Setting Total Device Memory Usage in SQream Instance <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/cuda_mem_quota.html>`_
+* `Enabling Manually Setting Reported IP <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/machine_ip.html>`_
+* `Setting Port Used for Metadata Server Connection <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/metadata_server_port.html>`_
+* `Assigning Local Network IP <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/use_config_ip.html>`_
+* `Enabling the Query Healer <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/is_healer_on.html>`_
+* `Configuring the Query Healer <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/healer_max_inactivity_hours.html>`_
+* `Adjusting Permitted Log-in Attempts <https://docs.sqream.com/en/v2021.2.1.24/configuration_guides/login_max_retries.html>`_

configuration_guides/check_cuda_memory.rst

@@ -8,4 +8,5 @@ The ``checkCudaMemory`` flag sets the pad device memory allocation with safety b
 The following describes the ``checkCudaMemory`` flag:
 
 * **Data type** - boolean
-* **Default value** - ``FALSE``
+* **Default value** - ``false``
+* **Allowed values** - ``true``, ``false``

configuration_guides/compiler_gets_only_ufs.rst

@@ -8,4 +8,5 @@ The ``compilerGetsOnlyUFs`` flag sets the runtime to pass only utility functions
 The following describes the ``compilerGetsOnlyUFs`` flag:
 
 * **Data type** - boolean
-* **Default value** - ``FALSE``
+* **Default value** - ``false``
+* **Allowed values** - ``true``, ``false``

configuration_guides/configuring_sqream.rst

@@ -0,0 +1,22 @@
+.. _configuring_sqream:
+
+*************************
+Configuring SQream
+*************************
+The **Configuring SQream** page describes the following configuration topics:
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :titlesonly:
+
+   current_method_configuration_levels
+   current_method_flag_types
+   current_method_configuration_roles
+   current_method_modification_methods
+   current_method_configuring_your_parameter_values
+   current_method_command_examples
+   current_method_showing_all_flags_in_the_catalog_table
+   current_method_all_configurations
+
+

configuration_guides/cpu_reduce_hashtable_size.rst

@@ -1,11 +1,12 @@
 .. _cpu_reduce_hashtable_size:
 
 *************************
-Enabling High Bin Control Granularity
+Setting Hashtable Size for GROUP BY Queries
 *************************
-The ``copyToRestrictUtf8`` flag sets the custom bin size in the cache to enable high bin control granularity.
+The ``cpuReduceHashtableSize`` flag sets the size of the hashtable in your CPU while running a ``GROUP BY`` query. 
 
-The following describes the ``checkCudaMemory`` flag:
+The following describes the ``cpuReduceHashtableSize`` flag:
 
-* **Data type** - boolean
-* **Default value** - ``FALSE``
+* **Data type** - uint
+* **Default value** - ``10000``
+* **Allowed values** - 1-4000000000

configuration_guides/csv_limit_row_length.rst

@@ -8,4 +8,5 @@ The ``csvLimitRowLength`` flag sets the maximum supported CSV row length.
 The following describes the ``csvLimitRowLength`` flag:
 
 * **Data type** - uint
-* **Default value** - ``100000``
+* **Default value** - ``100000``
+* **Allowed values** - 1-4000000000

configuration_guides/cuda_mem_cpy_max_size_bytes.rst

@@ -8,4 +8,5 @@ The ``cudaMemcpyMaxSizeBytes`` flag sets the chunk size for copying from CPU to
 The following describes the ``cudaMemcpyMaxSizeBytes`` flag:
 
 * **Data type** - uint
-* **Default value** - ``0``
+* **Default value** - ``0``
+* **Allowed values** - 0-4000000000

configuration_guides/cuda_mem_cpy_synchronous.rst

@@ -8,4 +8,5 @@ The ``CudaMemcpySynchronous`` flag indicates if copying from/to GPU is synchrono
 The following describes the ``CudaMemcpySynchronous`` flag:
 
 * **Data type** - boolean
-* **Default value** - ``FALSE``
+* **Default value** - ``false``
+* **Allowed values** - ``true``, ``false``

configuration_guides/cuda_mem_quota.rst

@@ -9,3 +9,4 @@ The following describes the ``cudaMemQuota`` flag:
 
 * **Data type** - uint
 * **Default value** - ``90``
+* **Allowed values** - 0-100