Skip to content

Commit

Permalink
Use sentence case in titles consistently
Browse files Browse the repository at this point in the history
  • Loading branch information
mosabua authored and electrum committed Jan 5, 2021
1 parent 39a9945 commit de1cb66
Show file tree
Hide file tree
Showing 371 changed files with 1,501 additions and 1,501 deletions.
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/dist-sort.rst
@@ -1,5 +1,5 @@
================
Distributed Sort
Distributed sort
================

Distributed sort allows to sort data, which exceeds ``query.max-memory-per-node``.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/dynamic-filtering.rst
@@ -1,5 +1,5 @@
=================
Dynamic Filtering
Dynamic filtering
=================

Dynamic filtering optimizations significantly improve the performance of queries
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/admin/graceful-shutdown.rst
@@ -1,5 +1,5 @@
=================
Graceful Shutdown
Graceful shutdown
=================

Trino has a graceful shutdown API that can be used exclusively on workers in
Expand Down Expand Up @@ -27,7 +27,7 @@ Keep the following aspects in mind:
then the user in the HTTP request must have read and write permissions in
the system information rules.

Shutdown Behavior
Shutdown behavior
-----------------

Once the API is called, the worker performs the following steps:
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/sphinx/admin/jmx.rst
Expand Up @@ -36,7 +36,7 @@ JVM
* Heap size: ``java.lang:type=Memory:HeapMemoryUsage.used``
* Thread count: ``java.lang:type=Threading:ThreadCount``

Trino Cluster and Nodes
Trino cluster and nodes
------------------------

* Active nodes:
Expand All @@ -48,7 +48,7 @@ Trino Cluster and Nodes
* Cumulative count (since Trino started) of queries that ran out of memory and were killed:
``trino.memory:name=ClusterMemoryManager:QueriesKilledDueToOutOfMemory``

Trino Queries
Trino queries
--------------

* Active queries currently executing or queued: ``trino.execution:name=QueryManager:RunningQueries``
Expand All @@ -63,7 +63,7 @@ Trino Queries
* Execution latency (P50): ``trino.execution:name=QueryManager:ExecutionTime.FiveMinutes.P50``
* Input data rate (P90): ``trino.execution:name=QueryManager:WallInputBytesRate.FiveMinutes.P90``

Trino Tasks
Trino tasks
------------

* Input data bytes: ``trino.execution:name=TaskManager:InputDataSize.FiveMinute.Count``
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-exchange.rst
@@ -1,5 +1,5 @@
===================
Exchange Properties
Exchange properties
===================

Exchanges transfer data between Trino nodes for different stages of
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-general.rst
@@ -1,5 +1,5 @@
==================
General Properties
General properties
==================

``join-distribution-type``
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-logging.rst
@@ -1,5 +1,5 @@
==================
Logging Properties
Logging properties
==================

``log.path``
Expand Down
@@ -1,5 +1,5 @@
============================
Memory Management Properties
Memory management properties
============================

``query.max-memory-per-node``
Expand Down
8 changes: 4 additions & 4 deletions docs/src/main/sphinx/admin/properties-node-scheduler.rst
@@ -1,5 +1,5 @@
=========================
Node Scheduler Properties
Node scheduler properties
=========================

Splits
Expand Down Expand Up @@ -66,7 +66,7 @@ distribution across all hosts. ``topology`` tries to schedule splits according t
the topology distance between nodes and splits. It is recommended to use ``uniform``
for clusters where distributed storage runs on the same nodes as Trino workers.

Network Topology
Network topology
----------------

``node-scheduler.network-topology.segments``
Expand Down Expand Up @@ -98,7 +98,7 @@ must be set to ``topology``.
and ``node-scheduler.network-topology.subnet.ip-address-protocol`` described
in the following sections.

File Based Network Topology
File based network topology
---------------------------

``node-scheduler.network-topology.file``
Expand Down Expand Up @@ -127,7 +127,7 @@ network location, separated by whitespace. Network location must begin with a le
Controls how often the network topology file is reloaded. To use this option,
``node-scheduler.network-topology.type`` must be set to ``file``.

Subnet Based Network Topology
Subnet based network topology
-----------------------------

``node-scheduler.network-topology.subnet.ip-address-protocol``
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-optimizer.rst
@@ -1,5 +1,5 @@
====================
Optimizer Properties
Optimizer properties
====================

``optimizer.dictionary-aggregation``
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-query-management.rst
@@ -1,5 +1,5 @@
===========================
Query Management Properties
Query management properties
===========================

``query.max-execution-time``
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-regexp-function.rst
@@ -1,5 +1,5 @@
======================================
Regular Expression Function Properties
Regular expression function properties
======================================

These properties allow tuning the :doc:`/functions/regexp`.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-spilling.rst
@@ -1,5 +1,5 @@
===================
Spilling Properties
Spilling properties
===================

These properties control :doc:`spill`.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-task.rst
@@ -1,5 +1,5 @@
===============
Task Properties
Task properties
===============

``task.concurrency``
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-web-interface.rst
@@ -1,4 +1,4 @@
Web UI Properties
Web UI properties
-----------------

The following properties can be used to configure the :doc:`web-interface`.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/admin/properties-writer-scaling.rst
@@ -1,5 +1,5 @@
=========================
Writer Scaling Properties
Writer scaling properties
=========================

By default, the number of writer tasks is static. Enabling writer scaling allows
Expand Down
12 changes: 6 additions & 6 deletions docs/src/main/sphinx/admin/properties.rst
@@ -1,5 +1,5 @@
====================
Properties Reference
Properties reference
====================

This section describes the most important config properties, that
Expand All @@ -9,14 +9,14 @@ may be used to tune Trino or alter its behavior when required.
:titlesonly:

General <properties-general>
Memory Management <properties-memory-management>
Query Management <properties-query-management>
Memory management <properties-memory-management>
Query management <properties-query-management>
Spilling <properties-spilling>
Exchange <properties-exchange>
Task <properties-task>
Writer Scaling <properties-writer-scaling>
Node Scheduler <properties-node-scheduler>
Writer scaling <properties-writer-scaling>
Node scheduler <properties-node-scheduler>
Optimizer <properties-optimizer>
Logging <properties-logging>
Web UI <properties-web-interface>
Regular Expression Function <properties-regexp-function>
Regular expression function <properties-regexp-function>
10 changes: 5 additions & 5 deletions docs/src/main/sphinx/admin/resource-groups.rst
@@ -1,5 +1,5 @@
===============
Resource Groups
Resource groups
===============

Resource groups place limits on resource usage, and can enforce queueing policies on
Expand All @@ -21,7 +21,7 @@ the built-in manager that reads a JSON config file:
Change the value of ``resource-groups.config-file`` to point to a JSON config file,
which can be an absolute path, or a path relative to the Trino data directory.

Resource Group Properties
Resource group properties
-------------------------

* ``name`` (required): name of the group. May be a template (see below).
Expand Down Expand Up @@ -72,7 +72,7 @@ Resource Group Properties

* ``subGroups`` (optional): list of sub-groups.

Selector Rules
Selector rules
--------------

* ``user`` (optional): regex to match against user name.
Expand All @@ -98,12 +98,12 @@ Selector Rules

Selectors are processed sequentially and the first one that matches will be used.

Global Properties
Global properties
-----------------

* ``cpuQuotaPeriod`` (optional): the period in which cpu quotas are enforced.

Providing Selector Properties
Providing selector properties
-----------------------------

The source name can be set as follows:
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/admin/session-property-managers.rst
@@ -1,5 +1,5 @@
=========================
Session Property Managers
Session property managers
=========================

Administrators can add session properties to control the behavior for subsets of their workload.
Expand All @@ -24,7 +24,7 @@ by default. All matching rules contribute to constructing a list of session prop
are applied in the order they are specified. Rules specified later in the file override values
for properties that have been previously encountered.

Match Rules
Match rules
-----------

* ``user`` (optional): regex to match against user name.
Expand Down
16 changes: 8 additions & 8 deletions docs/src/main/sphinx/admin/spill.rst
@@ -1,5 +1,5 @@
=============
Spill to Disk
Spill to disk
=============

Overview
Expand All @@ -15,7 +15,7 @@ implemented on the application level to address specific needs of Trino.

Properties related to spilling are described in :doc:`properties-spilling`.

Memory Management and Spill
Memory management and spill
---------------------------

By default, Trino kills queries, if the memory requested by the query execution
Expand Down Expand Up @@ -43,7 +43,7 @@ memory intensive queries. It is still possible that the query runner fails
to divide intermediate data into chunks small enough so that every chunk fits into
memory, leading to ``Out of memory`` errors while loading the data from disk.

Spill Disk Space
Spill disk space
----------------

Spilling intermediate results to disk, and retrieving them back, is expensive
Expand All @@ -60,15 +60,15 @@ Trino treats spill paths as independent disks (see `JBOD
<https://en.wikipedia.org/wiki/Non-RAID_drive_architectures#JBOD>`_), so
there is no need to use RAID for spill.

Spill Compression
Spill compression
-----------------

When spill compression is enabled (``spill-compression-enabled`` property in
:doc:`properties-spilling`), spilled pages are compressed, before being
written to disk. Enabling this feature can reduce disk IO at the cost
of extra CPU load to compress and decompress spilled pages.

Spill Encryption
Spill encryption
----------------

When spill encryption is enabled (``spill-encryption-enabled`` property in
Expand All @@ -78,7 +78,7 @@ of spilling to disk, but can protect spilled data from being recovered from spil
Consider reducing the value of ``memory-revoking-threshold`` when spill
encryption is enabled, to account for the increase in latency of spilling.

Supported Operations
Supported operations
--------------------

Not all operations support spilling to disk, and each handles spilling
Expand Down Expand Up @@ -119,15 +119,15 @@ amount of memory may be needed. When spill-to-disk is enabled, if there is not
enough memory, intermediate cumulated aggregation results are written to disk.
They are loaded back and merged with a lower memory footprint.

Order By
Order by
^^^^^^^^

If your trying to sort a larger amount of data, a significant amount of memory
may be needed. When spill to disk for ``order by`` is enabled, if there is not enough
memory, intermediate sorted results are written to disk. They are loaded back and
merged with a lower memory footprint.

Window Functions
Window functions
^^^^^^^^^^^^^^^^

Window functions perform an operator over a window of rows, and return one value
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/admin/tuning.rst
Expand Up @@ -5,12 +5,12 @@ Tuning Trino
The default Trino settings should work well for most workloads. The following
information may help you, if your cluster is facing a specific performance problem.

Config Properties
Config properties
-----------------

See :doc:`/admin/properties`.

JVM Settings
JVM settings
------------

The following can be helpful for diagnosing garbage collection (GC) issues:
Expand Down
8 changes: 4 additions & 4 deletions docs/src/main/sphinx/admin/web-interface.rst
Expand Up @@ -28,7 +28,7 @@ any query. This can be restricted by using :ref:`query rules <query_rules>` with
:doc:`/security/built-in-system-access-control`. Users always have permission to view
or kill their own queries.

Password Authentication
Password authentication
^^^^^^^^^^^^^^^^^^^^^^^

Typically, a :doc:`password authenticator </develop/password-authenticator>`
Expand All @@ -38,7 +38,7 @@ is configured to use a password authenticator, the Web UI authentication type
is automatically set to ``form``. The Web UI will display a login form that accepts
a username and password.

Fixed User Authentication
Fixed user authentication
^^^^^^^^^^^^^^^^^^^^^^^^^

If you require the Web UI to be accessible without authentication, you can set a fixed
Expand All @@ -47,7 +47,7 @@ username that will be used for all Web UI access by setting the authentication t
If there is a system access control installed, this user must have permission to view
(and possibly to kill) queries.

Other Authentication Types
Other authentication types
^^^^^^^^^^^^^^^^^^^^^^^^^^

The following Web UI authentication types are also supported:
Expand All @@ -60,7 +60,7 @@ For these authentication types, the username is defined by :doc:`/security/user-

.. _web-ui-overview:

User Interface Overview
User interface overview
-----------------------

The main page has a list of queries along with information like unique query ID, query text,
Expand Down

0 comments on commit de1cb66

Please sign in to comment.