From 71f9cbe71ce49fe396ec59b31543ef6570911ef5 Mon Sep 17 00:00:00 2001 From: Michael Eby Date: Tue, 9 May 2023 13:46:00 -0400 Subject: [PATCH] Make style of anchors consistent across docs Make style of ref links consistent across docs --- .../main/sphinx/admin/dynamic-filtering.rst | 4 +- .../sphinx/admin/event-listeners-http.rst | 10 +-- .../main/sphinx/admin/graceful-shutdown.rst | 2 +- docs/src/main/sphinx/admin/jmx.rst | 2 +- .../main/sphinx/admin/properties-logging.rst | 4 +- .../admin/properties-resource-management.rst | 4 +- .../src/main/sphinx/admin/resource-groups.rst | 2 +- docs/src/main/sphinx/admin/web-interface.rst | 4 +- docs/src/main/sphinx/client/cli.rst | 2 +- docs/src/main/sphinx/connector/bigquery.rst | 4 +- .../main/sphinx/connector/hive-alluxio.rst | 4 +- docs/src/main/sphinx/connector/hive.rst | 36 ++++----- docs/src/main/sphinx/connector/iceberg.rst | 4 +- docs/src/main/sphinx/connector/memory.rst | 2 +- docs/src/main/sphinx/connector/system.rst | 4 +- .../main/sphinx/develop/event-listener.rst | 4 +- .../main/sphinx/develop/table-functions.rst | 18 ++--- docs/src/main/sphinx/functions/array.rst | 4 +- docs/src/main/sphinx/functions/binary.rst | 2 +- docs/src/main/sphinx/functions/comparison.rst | 12 +-- .../src/main/sphinx/functions/conditional.rst | 10 +-- docs/src/main/sphinx/functions/datetime.rst | 2 +- docs/src/main/sphinx/functions/decimal.rst | 2 +- .../src/main/sphinx/functions/hyperloglog.rst | 2 +- docs/src/main/sphinx/functions/ipaddress.rst | 2 +- docs/src/main/sphinx/functions/json.rst | 36 ++++----- docs/src/main/sphinx/functions/lambda.rst | 2 +- .../main/sphinx/functions/list-by-topic.rst | 20 ++--- docs/src/main/sphinx/functions/list.rst | 78 +++++++++---------- docs/src/main/sphinx/functions/logical.rst | 2 +- docs/src/main/sphinx/functions/math.rst | 2 +- docs/src/main/sphinx/functions/string.rst | 2 +- docs/src/main/sphinx/functions/table.rst | 6 +- docs/src/main/sphinx/functions/uuid.rst | 2 +- docs/src/main/sphinx/functions/window.rst | 2 +- .../main/sphinx/installation/deployment.rst | 10 +-- .../main/sphinx/installation/kubernetes.rst | 4 +- docs/src/main/sphinx/language/types.rst | 22 +++--- docs/src/main/sphinx/optimizer/statistics.rst | 2 +- docs/src/main/sphinx/release.rst | 10 +-- .../src/main/sphinx/release/release-0.100.rst | 4 +- .../src/main/sphinx/release/release-0.101.rst | 2 +- .../src/main/sphinx/release/release-0.102.rst | 2 +- .../src/main/sphinx/release/release-0.130.rst | 2 +- .../src/main/sphinx/release/release-0.132.rst | 4 +- .../src/main/sphinx/release/release-0.133.rst | 2 +- .../src/main/sphinx/release/release-0.140.rst | 2 +- .../src/main/sphinx/release/release-0.142.rst | 2 +- .../main/sphinx/release/release-0.152.2.rst | 2 +- .../src/main/sphinx/release/release-0.153.rst | 4 +- .../src/main/sphinx/release/release-0.156.rst | 2 +- .../src/main/sphinx/release/release-0.161.rst | 2 +- .../src/main/sphinx/release/release-0.178.rst | 2 +- .../src/main/sphinx/release/release-0.182.rst | 2 +- .../src/main/sphinx/release/release-0.214.rst | 2 +- docs/src/main/sphinx/release/release-0.69.rst | 2 +- docs/src/main/sphinx/release/release-0.77.rst | 2 +- docs/src/main/sphinx/release/release-0.82.rst | 2 +- docs/src/main/sphinx/release/release-0.87.rst | 2 +- docs/src/main/sphinx/release/release-0.88.rst | 4 +- docs/src/main/sphinx/release/release-312.rst | 2 +- docs/src/main/sphinx/release/release-313.rst | 4 +- docs/src/main/sphinx/release/release-330.rst | 4 +- docs/src/main/sphinx/release/release-331.rst | 2 +- docs/src/main/sphinx/release/release-332.rst | 2 +- docs/src/main/sphinx/release/release-337.rst | 2 +- docs/src/main/sphinx/release/release-341.md | 8 +- docs/src/main/sphinx/release/release-352.md | 2 +- docs/src/main/sphinx/release/release-362.md | 2 +- docs/src/main/sphinx/release/release-365.md | 2 +- docs/src/main/sphinx/release/release-369.md | 2 +- docs/src/main/sphinx/release/release-391.md | 2 +- docs/src/main/sphinx/release/release-412.md | 2 +- docs/src/main/sphinx/release/release-414.md | 6 +- docs/src/main/sphinx/security/certificate.rst | 2 +- .../security/file-system-access-control.rst | 6 +- docs/src/main/sphinx/security/inspect-jks.rst | 6 +- docs/src/main/sphinx/security/inspect-pem.rst | 6 +- .../security/internal-communication.rst | 4 +- docs/src/main/sphinx/security/jwt.rst | 2 +- docs/src/main/sphinx/security/kerberos.rst | 16 ++-- docs/src/main/sphinx/security/ldap.rst | 6 +- docs/src/main/sphinx/security/overview.rst | 10 +-- .../main/sphinx/security/password-file.rst | 2 +- docs/src/main/sphinx/security/tls.rst | 10 +-- .../sphinx/sql/create-materialized-view.rst | 2 +- docs/src/main/sphinx/sql/match-recognize.rst | 50 ++++++------ .../sql/pattern-recognition-in-window.rst | 10 +-- docs/src/main/sphinx/sql/select.rst | 8 +- docs/src/main/sphinx/sql/show-catalogs.rst | 2 +- docs/src/main/sphinx/sql/show-columns.rst | 2 +- docs/src/main/sphinx/sql/show-functions.rst | 2 +- docs/src/main/sphinx/sql/show-schemas.rst | 2 +- docs/src/main/sphinx/sql/show-session.rst | 2 +- docs/src/main/sphinx/sql/show-tables.rst | 2 +- 95 files changed, 294 insertions(+), 294 deletions(-) diff --git a/docs/src/main/sphinx/admin/dynamic-filtering.rst b/docs/src/main/sphinx/admin/dynamic-filtering.rst index 9f64f7f376e2..376465b187b9 100644 --- a/docs/src/main/sphinx/admin/dynamic-filtering.rst +++ b/docs/src/main/sphinx/admin/dynamic-filtering.rst @@ -52,8 +52,8 @@ Dynamic filtering is enabled by default. It can be disabled by setting either th Support for push down of dynamic filters is specific to each connector, and the relevant underlying database or storage system. The documentation for specific connectors with support for dynamic filtering includes further details, -for example the :ref:`Hive connector ` -or the :ref:`Memory connector `. +for example the :ref:`Hive connector ` +or the :ref:`Memory connector `. Analysis and confirmation ------------------------- diff --git a/docs/src/main/sphinx/admin/event-listeners-http.rst b/docs/src/main/sphinx/admin/event-listeners-http.rst index 064c5e989da1..c2fe18c52851 100644 --- a/docs/src/main/sphinx/admin/event-listeners-http.rst +++ b/docs/src/main/sphinx/admin/event-listeners-http.rst @@ -25,9 +25,9 @@ You need to perform the following steps: * Provide an HTTP/S service that accepts POST events with a JSON body. * Configure ``http-event-listener.connect-ingest-uri`` in the event listener properties file with the URI of the service. -* Detail the events to send in the :ref:`http_event_listener_configuration` section. +* Detail the events to send in the :ref:`http-event-listener-configuration` section. -.. _http_event_listener_configuration: +.. _http-event-listener-configuration: Configuration ------------- @@ -43,7 +43,7 @@ as an example: http-event-listener.connect-ingest-uri= And set add ``etc/http-event-listener.properties`` to ``event-listener.config-files`` -in :ref:`config_properties`: +in :ref:`config-properties`: .. code-block:: properties @@ -78,7 +78,7 @@ Configuration properties * - http-event-listener.connect-http-headers - List of custom HTTP headers to be sent along with the events. See - :ref:`http_event_listener_custom_headers` for more details + :ref:`http-event-listener-custom-headers` for more details - Empty * - http-event-listener.connect-retry-count @@ -107,7 +107,7 @@ Configuration properties - Pass configuration onto the HTTP client - -.. _http_event_listener_custom_headers: +.. _http-event-listener-custom-headers: Custom HTTP headers ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/admin/graceful-shutdown.rst b/docs/src/main/sphinx/admin/graceful-shutdown.rst index 32d6eaded40d..49a66c9c5319 100644 --- a/docs/src/main/sphinx/admin/graceful-shutdown.rst +++ b/docs/src/main/sphinx/admin/graceful-shutdown.rst @@ -26,7 +26,7 @@ Keep the following aspects in mind: * The ``default`` :doc:`/security/built-in-system-access-control` does not allow graceful shutdowns. You can use the ``allow-all`` system access control, or configure :ref:`system information rules - ` with the ``file`` system access + ` with the ``file`` system access control. These configuration must be present on all workers. diff --git a/docs/src/main/sphinx/admin/jmx.rst b/docs/src/main/sphinx/admin/jmx.rst index 1eacbf1eb29e..13a403da4a23 100644 --- a/docs/src/main/sphinx/admin/jmx.rst +++ b/docs/src/main/sphinx/admin/jmx.rst @@ -5,7 +5,7 @@ Monitoring with JMX Trino exposes a large number of different metrics via the Java Management Extensions (JMX). You have to enable JMX by setting the ports used by the RMI registry and server -in the :ref:`config.properties file `: +in the :ref:`config.properties file `: .. code-block:: text diff --git a/docs/src/main/sphinx/admin/properties-logging.rst b/docs/src/main/sphinx/admin/properties-logging.rst index 0ba9bab1b45a..6edb5bd3b96c 100644 --- a/docs/src/main/sphinx/admin/properties-logging.rst +++ b/docs/src/main/sphinx/admin/properties-logging.rst @@ -36,7 +36,7 @@ exceptions as singular fields in a logging search system. The path to the log file used by Trino. The path is relative to the data directory, configured to ``var/log/server.log`` by the launcher script as -detailed in :ref:`running_trino`. Alternatively, you can write logs to separate +detailed in :ref:`running-trino`. Alternatively, you can write logs to separate the process (typically running next to Trino as a sidecar process) via the TCP protocol by using a log path of the format ``tcp://host:port``. @@ -89,7 +89,7 @@ Flag to enable or disable compression of the log files of the HTTP server. The path to the log file used by the HTTP server. The path is relative to the data directory, configured by the launcher script as detailed in -:ref:`running_trino`. +:ref:`running-trino`. ``http-server.log.max-history`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/admin/properties-resource-management.rst b/docs/src/main/sphinx/admin/properties-resource-management.rst index ecc496efeaa5..be659d9a0f14 100644 --- a/docs/src/main/sphinx/admin/properties-resource-management.rst +++ b/docs/src/main/sphinx/admin/properties-resource-management.rst @@ -32,7 +32,7 @@ it is killed. The sum of :ref:`prop-resource-query-max-memory-per-node` and :ref:`prop-resource-memory-heap-headroom-per-node` must be less than the - maximum heap size in the JVM on the node. See :ref:`jvm_config`. + maximum heap size in the JVM on the node. See :ref:`jvm-config`. .. note:: @@ -99,7 +99,7 @@ for allocations that are not tracked by Trino. The sum of :ref:`prop-resource-query-max-memory-per-node` and :ref:`prop-resource-memory-heap-headroom-per-node` must be less than the - maximum heap size in the JVM on the node. See :ref:`jvm_config`. + maximum heap size in the JVM on the node. See :ref:`jvm-config`. .. _prop-resource-exchange-deduplication-buffer-size: diff --git a/docs/src/main/sphinx/admin/resource-groups.rst b/docs/src/main/sphinx/admin/resource-groups.rst index aa5ee4f14857..0586949ee78d 100644 --- a/docs/src/main/sphinx/admin/resource-groups.rst +++ b/docs/src/main/sphinx/admin/resource-groups.rst @@ -54,7 +54,7 @@ values in the ``priority`` field. The ``resource_groups`` table also contains an ``environment`` field which is matched with the value contained in the ``node.environment`` property in -:ref:`node_properties`. This allows the resource group configuration for different +:ref:`node-properties`. This allows the resource group configuration for different Trino clusters to be stored in the same database if required. The configuration is reloaded from the database every second, and the changes diff --git a/docs/src/main/sphinx/admin/web-interface.rst b/docs/src/main/sphinx/admin/web-interface.rst index 374973883076..df5d6651a948 100644 --- a/docs/src/main/sphinx/admin/web-interface.rst +++ b/docs/src/main/sphinx/admin/web-interface.rst @@ -5,7 +5,7 @@ Web UI Trino provides a web-based user interface (UI) for monitoring a Trino cluster and managing queries. The Web UI is accessible on the coordinator via HTTP or HTTPS, using the corresponding port number specified in the coordinator -:ref:`config_properties`. It can be configured with :doc:`/admin/properties-web-interface`. +:ref:`config-properties`. It can be configured with :doc:`/admin/properties-web-interface`. The Web UI can be disabled entirely with the ``web-ui.enabled`` property. @@ -20,7 +20,7 @@ allowed. Typically, users login with the same username that they use for running queries. If no system access control is installed, then all users are able to view and kill -any query. This can be restricted by using :ref:`query rules ` with the +any query. This can be restricted by using :ref:`query rules ` with the :doc:`/security/built-in-system-access-control`. Users always have permission to view or kill their own queries. diff --git a/docs/src/main/sphinx/client/cli.rst b/docs/src/main/sphinx/client/cli.rst index 577cfed299c9..e6c916238dcf 100644 --- a/docs/src/main/sphinx/client/cli.rst +++ b/docs/src/main/sphinx/client/cli.rst @@ -369,7 +369,7 @@ enabled. Invoking the CLI with Kerberos support enabled requires a number of additional command line options. You also need the :ref:`Kerberos configuration files -` for your user on the machine running the CLI. The +` for your user on the machine running the CLI. The simplest way to invoke the CLI is with a wrapper script: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/bigquery.rst b/docs/src/main/sphinx/connector/bigquery.rst index e6fe9b58ef9d..5762a1e03200 100644 --- a/docs/src/main/sphinx/connector/bigquery.rst +++ b/docs/src/main/sphinx/connector/bigquery.rst @@ -105,7 +105,7 @@ a few caveats: it, set the ``bigquery.experimental.arrow-serialization.enabled`` configuration property to ``true`` and add ``--add-opens=java.base/java.nio=ALL-UNNAMED`` to the Trino - :ref:`jvm_config`. + :ref:`jvm-config`. Reading from views ^^^^^^^^^^^^^^^^^^ @@ -279,7 +279,7 @@ which exposes BigQuery view definition. Given a BigQuery view ``example_view`` you can send query ``SELECT * example_view$view_definition`` to see the SQL which defines view in BigQuery. -.. _bigquery_special_columns: +.. _bigquery-special-columns: Special columns --------------- diff --git a/docs/src/main/sphinx/connector/hive-alluxio.rst b/docs/src/main/sphinx/connector/hive-alluxio.rst index c9ad97ab6a9e..744cf5588699 100644 --- a/docs/src/main/sphinx/connector/hive-alluxio.rst +++ b/docs/src/main/sphinx/connector/hive-alluxio.rst @@ -19,7 +19,7 @@ Alluxio client-side configuration To configure Alluxio client-side properties on Trino, append the Alluxio configuration directory (``${ALLUXIO_HOME}/conf``) to the Trino JVM classpath, so that the Alluxio properties file ``alluxio-site.properties`` can be loaded as -a resource. Update the Trino :ref:`jvm_config` file ``etc/jvm.config`` +a resource. Update the Trino :ref:`jvm-config` file ``etc/jvm.config`` to include the following: .. code-block:: text @@ -44,7 +44,7 @@ to bypass the network (*short-circuit*). See `Performance Tuning Tips for Presto `_ for more details. -.. _alluxio_catalog_service: +.. _alluxio-catalog-service: Alluxio catalog service ----------------------- diff --git a/docs/src/main/sphinx/connector/hive.rst b/docs/src/main/sphinx/connector/hive.rst index aafa57484977..0d32ea66529b 100644 --- a/docs/src/main/sphinx/connector/hive.rst +++ b/docs/src/main/sphinx/connector/hive.rst @@ -111,7 +111,7 @@ When not using Kerberos with HDFS, Trino accesses HDFS using the OS user of the Trino process. For example, if Trino is running as ``nobody``, it accesses HDFS as ``nobody``. You can override this username by setting the ``HADOOP_USER_NAME`` system property in the -Trino :ref:`jvm_config`, replacing ``hdfs_user`` with the +Trino :ref:`jvm-config`, replacing ``hdfs_user`` with the appropriate username: .. code-block:: text @@ -125,7 +125,7 @@ Whenever you change the user Trino is using to access HDFS, remove ``/tmp/presto-*`` on HDFS, as the new user may not have access to the existing temporary directories. -.. _hive_configuration_properties: +.. _hive-configuration-properties: Hive general configuration properties ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -316,7 +316,7 @@ Hive connector documentation. - ``true`` * - ``hive.auto-purge`` - Set the default value for the auto_purge table property for managed - tables. See the :ref:`hive_table_properties` for more information on + tables. See the :ref:`hive-table-properties` for more information on auto_purge. - ``false`` * - ``hive.partition-projection-enabled`` @@ -581,7 +581,7 @@ properties: - Number of threads for parallel statistic writes to Glue. - ``5`` -.. _partition_projection: +.. _partition-projection: Accessing tables with Athena partition projection metadata ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -600,7 +600,7 @@ you have partition projection enabled, you can set the ``partition_projection_ignore`` table property to ``true`` for a table to bypass any errors. -Refer to :ref:`hive_table_properties` and :ref:`hive_column_properties` for +Refer to :ref:`hive-table-properties` and :ref:`hive-column-properties` for configuration of partition projection. Metastore configuration for Avro @@ -692,7 +692,7 @@ on migrating from Hive to Trino. The following sections provide Hive-specific information regarding SQL support. -.. _hive_examples: +.. _hive-examples: Basic usage examples ^^^^^^^^^^^^^^^^^^^^ @@ -828,7 +828,7 @@ The following procedures are available: ``create_empty_partition``). If ``partition_values`` argument is omitted, stats are dropped for the entire table. -.. _register_partition: +.. _register-partition: * ``system.register_partition(schema_name, table_name, partition_columns, partition_values, location)`` @@ -840,14 +840,14 @@ The following procedures are available: Due to security reasons, the procedure is enabled only when ``hive.allow-register-partition-procedure`` is set to ``true``. -.. _unregister_partition: +.. _unregister-partition: * ``system.unregister_partition(schema_name, table_name, partition_columns, partition_values)`` Unregisters given, existing partition in the metastore for the specified table. The partition data is not deleted. -.. _hive_flush_metadata_cache: +.. _hive-flush-metadata-cache: * ``system.flush_metadata_cache()`` @@ -920,7 +920,7 @@ as Hive. For example, converting the string ``'foo'`` to a number, or converting the string ``'1234'`` to a ``tinyint`` (which has a maximum value of ``127``). -.. _hive_avro_schema: +.. _hive-avro-schema: Avro schema evolution """"""""""""""""""""" @@ -1050,7 +1050,7 @@ session property: to the Trino logs and query failure messages to see which files must be deleted. -.. _hive_table_properties: +.. _hive-table-properties: Table properties """""""""""""""" @@ -1075,7 +1075,7 @@ to the connector using a :doc:`WITH ` clause:: partition is deleted instead of a soft deletion using the trash. - * - ``avro_schema_url`` - - The URI pointing to :ref:`hive_avro_schema` for the table. + - The URI pointing to :ref:`hive-avro-schema` for the table. - * - ``bucket_count`` - The number of buckets to group data into. Only valid if used with @@ -1102,7 +1102,7 @@ to the connector using a :doc:`WITH ` clause:: - ``,`` * - ``external_location`` - The URI for an external Hive table on S3, Azure Blob Storage, etc. See the - :ref:`hive_examples` for more information. + :ref:`hive-examples` for more information. - * - ``format`` - The table file format. Valid values include ``ORC``, ``PARQUET``, @@ -1169,7 +1169,7 @@ to the connector using a :doc:`WITH ` clause:: `storage.location.template `_ - ``${table_location}/${partition_name}`` -.. _hive_special_tables: +.. _hive-special-tables: Metadata tables """"""""""""""" @@ -1183,7 +1183,7 @@ You can inspect the property names and values with a simple query:: SELECT * FROM example.web."page_views$properties"; -.. _hive_column_properties: +.. _hive-column-properties: Column properties """"""""""""""""" @@ -1249,7 +1249,7 @@ Column properties `projection.${columnName}.interval.unit `_. - -.. _hive_special_columns: +.. _hive-special-columns: Metadata columns """""""""""""""" @@ -1422,7 +1422,7 @@ and by default will also collect column level statistics: * - ``BOOLEAN`` - Number of nulls, number of true/false values -.. _hive_analyze: +.. _hive-analyze: Updating table and partition statistics """"""""""""""""""""""""""""""""""""""" @@ -1467,7 +1467,7 @@ You can also drop statistics for selected partitions only:: table_name => 'table', partition_values => ARRAY[ARRAY['p2_value1', 'p2_value2']]) -.. _hive_dynamic_filtering: +.. _hive-dynamic-filtering: Dynamic filtering ^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/connector/iceberg.rst b/docs/src/main/sphinx/connector/iceberg.rst index 5d907f8a7fc0..c0ec222f46ca 100644 --- a/docs/src/main/sphinx/connector/iceberg.rst +++ b/docs/src/main/sphinx/connector/iceberg.rst @@ -1142,7 +1142,7 @@ The output of the query has the following columns: - ``bigint`` - For branch only, the max snapshot age allowed in a branch. Older snapshots in the branch will be expired. -.. _iceberg_metadata_columns: +.. _iceberg-metadata-columns: Metadata columns """""""""""""""" @@ -1422,7 +1422,7 @@ statement. This can be disabled using ``iceberg.extended-statistics.enabled`` catalog configuration property, or the corresponding ``extended_statistics_enabled`` session property. -.. _iceberg_analyze: +.. _iceberg-analyze: Updating table statistics """"""""""""""""""""""""" diff --git a/docs/src/main/sphinx/connector/memory.rst b/docs/src/main/sphinx/connector/memory.rst index 0fe01e5da590..97b819a1543c 100644 --- a/docs/src/main/sphinx/connector/memory.rst +++ b/docs/src/main/sphinx/connector/memory.rst @@ -73,7 +73,7 @@ Upon execution of a ``DROP TABLE`` operation, memory is not released immediately. It is instead released after the next write operation to the catalog. -.. _memory_dynamic_filtering: +.. _memory-dynamic-filtering: Dynamic filtering ----------------- diff --git a/docs/src/main/sphinx/connector/system.rst b/docs/src/main/sphinx/connector/system.rst index 801b84102c4a..edf0c4493154 100644 --- a/docs/src/main/sphinx/connector/system.rst +++ b/docs/src/main/sphinx/connector/system.rst @@ -50,7 +50,7 @@ that can be set when creating a new schema. The table properties table contains the list of available properties that can be set when creating a new table. -.. _system_metadata_materialized_views: +.. _system-metadata-materialized-views: ``metadata.materialized_views`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -107,7 +107,7 @@ The table comments table contains the list of table comment. The nodes table contains the list of visible nodes in the Trino cluster along with their status. -.. _optimizer_rule_stats: +.. _optimizer-rule-stats: ``runtime.optimizer_rule_stats`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/develop/event-listener.rst b/docs/src/main/sphinx/develop/event-listener.rst index 4633e2f8adc9..847eb13fadb7 100644 --- a/docs/src/main/sphinx/develop/event-listener.rst +++ b/docs/src/main/sphinx/develop/event-listener.rst @@ -49,14 +49,14 @@ Example configuration file: custom-property1=custom-value1 custom-property2=custom-value2 -.. _multiple_listeners: +.. _multiple-listeners: Multiple event listeners ------------------------ Trino supports multiple instances of the same or different event listeners. Install and configure multiple instances by setting -``event-listener.config-files`` in :ref:`config_properties` to a comma-separated +``event-listener.config-files`` in :ref:`config-properties` to a comma-separated list of the event listener configuration files: .. code-block:: text diff --git a/docs/src/main/sphinx/develop/table-functions.rst b/docs/src/main/sphinx/develop/table-functions.rst index 9289595ca3b2..70f2547ea3f4 100644 --- a/docs/src/main/sphinx/develop/table-functions.rst +++ b/docs/src/main/sphinx/develop/table-functions.rst @@ -62,7 +62,7 @@ indicated schema, or ignore it. - **list of expected arguments** Three different types of arguments are supported: scalar arguments, descriptor -arguments, and table arguments. See :ref:`tf_argument_types` for details. You can +arguments, and table arguments. See :ref:`tf-argument-types` for details. You can specify default values for scalar and descriptor arguments. The arguments with specified default can be skipped during table function invocation. @@ -93,17 +93,17 @@ pass-through columns, use ``ONLY_PASS_THROUGH`` as the returned row type. A table function must return at least one column. It can either be a proper column, i.e. produced by the function, or a pass-through column. -.. _tf_argument_types: +.. _tf-argument-types: Argument types ^^^^^^^^^^^^^^ Table functions take three types of arguments: -:ref:`scalar arguments`, -:ref:`descriptor arguments`, and -:ref:`table arguments`. +:ref:`scalar arguments`, +:ref:`descriptor arguments`, and +:ref:`table arguments`. -.. _tf_scalar_arguments: +.. _tf-scalar-arguments: Scalar arguments ++++++++++++++++ @@ -125,7 +125,7 @@ They can be of any supported data type. You can specify a default value. .type(INTEGER) .build() -.. _tf_descriptor_arguments: +.. _tf-descriptor-arguments: Descriptor arguments ++++++++++++++++++++ @@ -142,7 +142,7 @@ default values for descriptor arguments. Descriptor argument can be ``null``. .defaultValue(null) .build() -.. _tf_table_arguments: +.. _tf-table-arguments: Table arguments +++++++++++++++ @@ -163,7 +163,7 @@ value for a table argument. .passThroughColumns() .build() -.. _tf_set_or_row_semantics: +.. _tf-set-or-row-semantics: Set or row semantics ==================== diff --git a/docs/src/main/sphinx/functions/array.rst b/docs/src/main/sphinx/functions/array.rst index 87b9f4179665..ca035736fa9c 100644 --- a/docs/src/main/sphinx/functions/array.rst +++ b/docs/src/main/sphinx/functions/array.rst @@ -2,7 +2,7 @@ Array functions and operators ============================= -.. _subscript_operator: +.. _subscript-operator: Subscript operator: [] ---------------------- @@ -11,7 +11,7 @@ The ``[]`` operator is used to access an element of an array and is indexed star SELECT my_array[1] AS first_element -.. _concatenation_operator: +.. _concatenation-operator: Concatenation operator: || -------------------------- diff --git a/docs/src/main/sphinx/functions/binary.rst b/docs/src/main/sphinx/functions/binary.rst index 4d444b4bfd15..3d55d8df1337 100644 --- a/docs/src/main/sphinx/functions/binary.rst +++ b/docs/src/main/sphinx/functions/binary.rst @@ -53,7 +53,7 @@ Binary functions negative starting position is interpreted as being relative to the end of the string. -.. _function_reverse_varbinary: +.. _function-reverse-varbinary: .. function:: reverse(binary) -> varbinary :noindex: diff --git a/docs/src/main/sphinx/functions/comparison.rst b/docs/src/main/sphinx/functions/comparison.rst index 886e08630da0..de376556de01 100644 --- a/docs/src/main/sphinx/functions/comparison.rst +++ b/docs/src/main/sphinx/functions/comparison.rst @@ -2,7 +2,7 @@ Comparison functions and operators ================================== -.. _comparison_operators: +.. _comparison-operators: Comparison operators -------------------- @@ -19,7 +19,7 @@ Operator Description ``!=`` Not equal (non-standard but popular syntax) ======== =========== -.. _range_operator: +.. _range-operator: Range operator: BETWEEN ----------------------- @@ -63,7 +63,7 @@ Note that the value, min, and max parameters to ``BETWEEN`` and ``NOT BETWEEN`` must be the same type. For example, Trino will produce an error if you ask it if John is between 2.3 and 35.2. -.. _is_null_operator: +.. _is-null-operator: IS NULL and IS NOT NULL ----------------------- @@ -78,7 +78,7 @@ But any other constant does not:: SELECT 3.0 IS NULL; -- false -.. _is_distinct_operator: +.. _is-distinct-operator: IS DISTINCT FROM and IS NOT DISTINCT FROM ----------------------------------------- @@ -134,7 +134,7 @@ The following types are supported: Returns the smallest of the provided values. -.. _quantified_comparison_predicates: +.. _quantified-comparison-predicates: Quantified comparison predicates: ALL, ANY and SOME --------------------------------------------------- @@ -169,7 +169,7 @@ Expression Meaning ``ANY`` and ``SOME`` have the same meaning and can be used interchangeably. -.. _like_operator: +.. _like-operator: Pattern comparison: LIKE ------------------------ diff --git a/docs/src/main/sphinx/functions/conditional.rst b/docs/src/main/sphinx/functions/conditional.rst index be57c60e0007..530c955fd70c 100644 --- a/docs/src/main/sphinx/functions/conditional.rst +++ b/docs/src/main/sphinx/functions/conditional.rst @@ -2,7 +2,7 @@ Conditional expressions ======================= -.. _case_expression: +.. _case-expression: CASE ---- @@ -51,7 +51,7 @@ returned if it exists, otherwise null is returned. Example:: ELSE 'ccc' END -.. _if_function: +.. _if-function: IF -- @@ -92,7 +92,7 @@ The following ``IF`` and ``CASE`` expressions are equivalent: END FROM tpch.sf1.orders; -.. _coalesce_function: +.. _coalesce-function: COALESCE -------- @@ -103,7 +103,7 @@ COALESCE Returns the first non-null ``value`` in the argument list. Like a ``CASE`` expression, arguments are only evaluated if necessary. -.. _nullif_function: +.. _nullif-function: NULLIF ------ @@ -112,7 +112,7 @@ NULLIF Returns null if ``value1`` equals ``value2``, otherwise returns ``value1``. -.. _try_function: +.. _try-function: TRY --- diff --git a/docs/src/main/sphinx/functions/datetime.rst b/docs/src/main/sphinx/functions/datetime.rst index 3abff35280f2..e36cbbfb8dfa 100644 --- a/docs/src/main/sphinx/functions/datetime.rst +++ b/docs/src/main/sphinx/functions/datetime.rst @@ -24,7 +24,7 @@ Operator Example Result ``-`` ``interval '3' year - interval '5' month`` ``2-7`` ======== ===================================================== =========================== -.. _at_time_zone_operator: +.. _at-time-zone-operator: Time zone conversion -------------------- diff --git a/docs/src/main/sphinx/functions/decimal.rst b/docs/src/main/sphinx/functions/decimal.rst index df477af3b386..c087ce847c0e 100644 --- a/docs/src/main/sphinx/functions/decimal.rst +++ b/docs/src/main/sphinx/functions/decimal.rst @@ -2,7 +2,7 @@ Decimal functions and operators =============================== -.. _decimal_literal: +.. _decimal-literal: Decimal literals ---------------- diff --git a/docs/src/main/sphinx/functions/hyperloglog.rst b/docs/src/main/sphinx/functions/hyperloglog.rst index 548e4133f456..a724db75f706 100644 --- a/docs/src/main/sphinx/functions/hyperloglog.rst +++ b/docs/src/main/sphinx/functions/hyperloglog.rst @@ -15,7 +15,7 @@ structure starts as the sparse representation, switching to dense when it is more efficient. The P4HyperLogLog structure is initialized densely and remains dense for its lifetime. -:ref:`hyperloglog_type` implicitly casts to :ref:`p4hyperloglog_type`, +:ref:`hyperloglog-type` implicitly casts to :ref:`p4hyperloglog-type`, while one can explicitly cast ``HyperLogLog`` to ``P4HyperLogLog``:: cast(hll AS P4HyperLogLog) diff --git a/docs/src/main/sphinx/functions/ipaddress.rst b/docs/src/main/sphinx/functions/ipaddress.rst index c99232066525..d52157d39f3c 100644 --- a/docs/src/main/sphinx/functions/ipaddress.rst +++ b/docs/src/main/sphinx/functions/ipaddress.rst @@ -2,7 +2,7 @@ IP Address Functions ==================== -.. _ip_address_contains: +.. _ip-address-contains: .. function:: contains(network, address) -> boolean :noindex: diff --git a/docs/src/main/sphinx/functions/json.rst b/docs/src/main/sphinx/functions/json.rst index 47ece363c0d0..c48ad569e83a 100644 --- a/docs/src/main/sphinx/functions/json.rst +++ b/docs/src/main/sphinx/functions/json.rst @@ -12,13 +12,13 @@ binary strings. Although Trino supports ``JSON`` type, it is not used or produced by the following functions. Trino supports three functions for querying JSON data: -:ref:`json_exists`, -:ref:`json_query`, and :ref:`json_value`. Each of them +:ref:`json_exists`, +:ref:`json_query`, and :ref:`json_value`. Each of them is based on the same mechanism of exploring and processing JSON input using JSON path. Trino also supports two functions for generating JSON data -- -:ref:`json_array`, and :ref:`json_object`. +:ref:`json_array`, and :ref:`json_object`. .. _json-path-language: @@ -32,7 +32,7 @@ from SQL. The semantics of predicates, operators, etc. in JSON path expressions generally follow the semantics of SQL. The JSON path language is case-sensitive for keywords and identifiers. -.. _json_path_syntax_and_semantics: +.. _json-path-syntax-and-semantics: JSON path syntax and semantics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -49,7 +49,7 @@ sequences, and returns a sequence as the result. In the lax mode, most path operations first unnest all JSON arrays in the input sequence. Any divergence from this rule is mentioned in the following - listing. Path modes are explained in :ref:`json_path_modes`. + listing. Path modes are explained in :ref:`json-path-modes`. The JSON path language features are divided into: literals, variables, arithmetic binary expressions, arithmetic unary expressions, and a group of @@ -83,7 +83,7 @@ literals - null literal - It has the semantics of the JSON null, not of SQL null. See :ref:`json_comparison_rules`. + It has the semantics of the JSON null, not of SQL null. See :ref:`json-comparison-rules`. .. code-block:: text @@ -225,7 +225,7 @@ The order of values returned from a single JSON object is arbitrary. The sub-sequences from all JSON objects are concatenated in the same order in which the JSON objects appear in the input sequence. -.. _json_descendant_member_accessor: +.. _json-descendant-member-accessor: descendant member accessor '''''''''''''''''''''''''' @@ -442,7 +442,7 @@ example because the compared types are not compatible, the result in the strict mode is ``unknown``. The result in the lax mode depends on whether the ``true`` comparison or the error was found first. -.. _json_comparison_rules: +.. _json-comparison-rules: Comparison rules **************** @@ -602,7 +602,7 @@ Limitations The SQL standard describes the ``datetime()`` JSON path item method and the ``like_regex()`` JSON path predicate. Trino does not support them. -.. _json_path_modes: +.. _json-path-modes: JSON path modes ^^^^^^^^^^^^^^^ @@ -678,7 +678,7 @@ method, the item ``"a"`` causes type mismatch. .floor() --> ERROR -.. _json_exists: +.. _json-exists: json_exists ----------- @@ -711,7 +711,7 @@ a single JSON item. For a binary string, you can specify encoding. ``json_path`` is a string literal, containing the path mode specification, and the path expression, following the syntax rules described in -:ref:`json_path_syntax_and_semantics`. +:ref:`json-path-syntax-and-semantics`. .. code-block:: text @@ -808,7 +808,7 @@ id child_3_above_ten 103 NULL ========== ================== -.. _json_query: +.. _json-query: json_query ---------- @@ -842,7 +842,7 @@ a single JSON item. For a binary string, you can specify encoding. ``json_path`` is a string literal, containing the path mode specification, and the path expression, following the syntax rules described in -:ref:`json_path_syntax_and_semantics`. +:ref:`json-path-syntax-and-semantics`. .. code-block:: text @@ -1023,7 +1023,7 @@ to the ``ON ERROR`` clause are: - JSON path evaluation errors, e.g. division by zero - Output conversion errors -.. _json_value: +.. _json-value: json_value ---------- @@ -1053,7 +1053,7 @@ a single JSON item. For a binary string, you can specify encoding. ``json_path`` is a string literal, containing the path mode specification, and the path expression, following the syntax rules described in -:ref:`json_path_syntax_and_semantics`. +:ref:`json-path-syntax-and-semantics`. .. code-block:: text @@ -1203,7 +1203,7 @@ id child 103 'missing' ========== ================ -.. _json_array: +.. _json-array: json_array ---------- @@ -1305,7 +1305,7 @@ The default encoding is UTF8:: SELECT json_array(true, 1 RETURNING VARBINARY FORMAT JSON ENCODING UTF32) --> X'5b 00 00 00 74 00 00 00 72 00 00 00 75 00 00 00 65 00 00 00 2c 00 00 00 31 00 00 00 5d 00 00 00' -.. _json_object: +.. _json-object: json_object ----------- @@ -1658,7 +1658,7 @@ sections, the following functions are available: SELECT json_extract(json, '$.store[book]'); SELECT json_extract(json, '$.store["book name"]'); - The :ref:`json_query function` provides a more powerful and + The :ref:`json_query function` provides a more powerful and feature-rich alternative to parse and extract JSON data. .. _JSONPath: http://goessner.net/articles/JsonPath/ diff --git a/docs/src/main/sphinx/functions/lambda.rst b/docs/src/main/sphinx/functions/lambda.rst index 66ea4e412b81..ffdb7c9f25ef 100644 --- a/docs/src/main/sphinx/functions/lambda.rst +++ b/docs/src/main/sphinx/functions/lambda.rst @@ -1,4 +1,4 @@ -.. _lambda_expressions: +.. _lambda-expressions: ================== Lambda expressions diff --git a/docs/src/main/sphinx/functions/list-by-topic.rst b/docs/src/main/sphinx/functions/list-by-topic.rst index 0878e371ec3c..f2b4771b1373 100644 --- a/docs/src/main/sphinx/functions/list-by-topic.rst +++ b/docs/src/main/sphinx/functions/list-by-topic.rst @@ -166,10 +166,10 @@ Conditional For more details, see :doc:`conditional` -* :ref:`coalesce ` -* :ref:`if ` -* :ref:`nullif ` -* :ref:`try ` +* :ref:`coalesce ` +* :ref:`if ` +* :ref:`nullif ` +* :ref:`try ` Conversion ---------- @@ -186,7 +186,7 @@ Date and time For more details, see :doc:`datetime` -* :ref:`AT TIME ZONE ` +* :ref:`AT TIME ZONE ` * :data:`current_date` * :data:`current_time` * :data:`current_timestamp` @@ -315,19 +315,19 @@ JSON For more details, see :doc:`json` * :func:`is_json_scalar` -* :ref:`json_array() ` +* :ref:`json_array() ` * :func:`json_array_contains` * :func:`json_array_get` * :func:`json_array_length` -* :ref:`json_exists() ` +* :ref:`json_exists() ` * :func:`json_extract` * :func:`json_extract_scalar` * :func:`json_format` * :func:`json_parse` -* :ref:`json_object() ` -* :ref:`json_query() ` +* :ref:`json_object() ` +* :ref:`json_query() ` * :func:`json_size` -* :ref:`json_value() ` +* :ref:`json_value() ` Lambda ------ diff --git a/docs/src/main/sphinx/functions/list.rst b/docs/src/main/sphinx/functions/list.rst index 9217e852246e..81e8bbbdcb6d 100644 --- a/docs/src/main/sphinx/functions/list.rst +++ b/docs/src/main/sphinx/functions/list.rst @@ -5,31 +5,31 @@ List of functions and operators # - -- :ref:`[] substring operator ` -- :ref:`|| concatenation operator ` -- :ref:`\< comparison operator ` -- :ref:`\> comparison operator ` -- :ref:`<= comparison operator ` -- :ref:`>= comparison operator ` -- :ref:`= comparison operator ` -- :ref:`<> comparison operator ` -- :ref:`\!= comparison operator ` -- :ref:`-> lambda expression ` -- :ref:`+ mathematical operator ` -- :ref:`- mathematical operator ` -- :ref:`* mathematical operator ` -- :ref:`/ mathematical operator ` -- :ref:`% mathematical operator ` +- :ref:`[] substring operator ` +- :ref:`|| concatenation operator ` +- :ref:`\< comparison operator ` +- :ref:`\> comparison operator ` +- :ref:`<= comparison operator ` +- :ref:`>= comparison operator ` +- :ref:`= comparison operator ` +- :ref:`<> comparison operator ` +- :ref:`\!= comparison operator ` +- :ref:`-> lambda expression ` +- :ref:`+ mathematical operator ` +- :ref:`- mathematical operator ` +- :ref:`* mathematical operator ` +- :ref:`/ mathematical operator ` +- :ref:`% mathematical operator ` A - - :func:`abs` - :func:`acos` -- :ref:`ALL ` +- :ref:`ALL ` - :func:`all_match` -- :ref:`AND ` -- :ref:`ANY ` +- :ref:`AND ` +- :ref:`ANY ` - :func:`any_match` - :func:`approx_distinct` - :func:`approx_most_frequent` @@ -49,7 +49,7 @@ A - :func:`array_union` - :func:`arrays_overlap` - :func:`asin` -- :ref:`AT TIME ZONE ` +- :ref:`AT TIME ZONE ` - :func:`at_timezone` - :func:`atan` - :func:`atan2` @@ -60,7 +60,7 @@ B - :func:`bar` - :func:`beta_cdf` -- :ref:`BETWEEN ` +- :ref:`BETWEEN ` - :func:`bing_tile` - :func:`bing_tile_at` - :func:`bing_tile_coordinates` @@ -85,7 +85,7 @@ C - - :func:`cardinality` -- :ref:`CASE ` +- :ref:`CASE ` - :func:`cast` - :func:`cbrt` - :func:`ceil` @@ -94,7 +94,7 @@ C - :func:`checksum` - :func:`chr` - :func:`classify` -- :ref:`coalesce ` +- :ref:`coalesce ` - :func:`codepoint` - :func:`color` - :func:`combinations` @@ -133,7 +133,7 @@ D - :func:`day_of_month` - :func:`day_of_week` - :func:`day_of_year` -- :ref:`DECIMAL ` +- :ref:`DECIMAL ` - :func:`degrees` - :func:`dense_rank` - :func:`dow` @@ -208,7 +208,7 @@ H I - -- :ref:`if ` +- :ref:`if ` - :func:`index` - :func:`infinity` - :func:`intersection_cardinality` @@ -218,28 +218,28 @@ I - :func:`is_infinite` - :func:`is_json_scalar` - :func:`is_nan` -- :ref:`IS NOT DISTINCT ` -- :ref:`IS NOT NULL ` -- :ref:`IS DISTINCT ` -- :ref:`IS NULL ` +- :ref:`IS NOT DISTINCT ` +- :ref:`IS NOT NULL ` +- :ref:`IS DISTINCT ` +- :ref:`IS NULL ` J - - :func:`jaccard_index` -- :ref:`json_array() ` +- :ref:`json_array() ` - :func:`json_array_contains` - :func:`json_array_get` - :func:`json_array_length` -- :ref:`json_exists() ` +- :ref:`json_exists() ` - :func:`json_extract` - :func:`json_extract_scalar` - :func:`json_format` -- :ref:`json_object() ` +- :ref:`json_object() ` - :func:`json_parse` -- :ref:`json_query() ` +- :ref:`json_query() ` - :func:`json_size` -- :ref:`json_value() ` +- :ref:`json_value() ` K - @@ -312,12 +312,12 @@ N - :func:`none_match` - :func:`normal_cdf` - :func:`normalize` -- :ref:`NOT ` -- :ref:`NOT BETWEEN ` +- :ref:`NOT ` +- :ref:`NOT BETWEEN ` - :func:`now` - :func:`nth_value` - :func:`ntile` -- :ref:`nullif ` +- :ref:`nullif ` - :func:`numeric_histogram` O @@ -325,7 +325,7 @@ O - ``objectid`` - :func:`objectid_timestamp` -- :ref:`OR ` +- :ref:`OR ` P - @@ -389,7 +389,7 @@ S - :func:`sinh` - :func:`skewness` - :func:`slice` -- :ref:`SOME ` +- :ref:`SOME ` - :func:`soundex` - ``spatial_partitioning`` - ``spatial_partitions`` @@ -502,7 +502,7 @@ T - :func:`trim` - :func:`trim_array` - :func:`truncate` -- :ref:`try ` +- :ref:`try ` - :func:`try_cast` - :func:`typeof` diff --git a/docs/src/main/sphinx/functions/logical.rst b/docs/src/main/sphinx/functions/logical.rst index 2f1a96c623d6..f72920d33c34 100644 --- a/docs/src/main/sphinx/functions/logical.rst +++ b/docs/src/main/sphinx/functions/logical.rst @@ -1,4 +1,4 @@ -.. _logical_operators: +.. _logical-operators: ================= Logical operators diff --git a/docs/src/main/sphinx/functions/math.rst b/docs/src/main/sphinx/functions/math.rst index c6b6d31318c0..50b65b57deca 100644 --- a/docs/src/main/sphinx/functions/math.rst +++ b/docs/src/main/sphinx/functions/math.rst @@ -2,7 +2,7 @@ Mathematical functions and operators ==================================== -.. _mathematical_operators: +.. _mathematical-operators: Mathematical operators ---------------------- diff --git a/docs/src/main/sphinx/functions/string.rst b/docs/src/main/sphinx/functions/string.rst index fa374ca62556..0f6eed598c10 100644 --- a/docs/src/main/sphinx/functions/string.rst +++ b/docs/src/main/sphinx/functions/string.rst @@ -8,7 +8,7 @@ String operators The ``||`` operator performs concatenation. The ``LIKE`` statement can be used for pattern matching and is documented in -:ref:`like_operator`. +:ref:`like-operator`. String functions ---------------- diff --git a/docs/src/main/sphinx/functions/table.rst b/docs/src/main/sphinx/functions/table.rst index c06186210aa8..9f1b065ac892 100644 --- a/docs/src/main/sphinx/functions/table.rst +++ b/docs/src/main/sphinx/functions/table.rst @@ -16,7 +16,7 @@ within the SQL query. They can be used for working with external systems as well as for enhancing Trino with capabilities going beyond the SQL standard. For the list of built-in table functions available in Trino, see :ref:`built in -table functions`. +table functions`. Trino supports adding custom table functions. They are declared by connectors through implementing dedicated interfaces. For guidance on adding new table @@ -26,7 +26,7 @@ Connectors offer support for different functions on a per-connector basis. For more information about supported table functions, refer to the :doc:`connector documentation <../../connector>`. -.. _built_in_table_functions: +.. _built-in-table-functions: Built-in table functions ------------------------ @@ -122,7 +122,7 @@ You can pass a table name, or a query. Use the keyword ``TABLE``:: input => TABLE(orders) data => TABLE(SELECT * FROM region, nation WHERE region.regionkey = nation.regionkey) -If the table argument is declared as :ref:`set semantics`, +If the table argument is declared as :ref:`set semantics`, you can specify partitioning and ordering. Each partition is processed independently by the table function. If you do not specify partitioning, the argument is processed as a single partition. You can also specify diff --git a/docs/src/main/sphinx/functions/uuid.rst b/docs/src/main/sphinx/functions/uuid.rst index 046319546f05..e70e08faa12a 100644 --- a/docs/src/main/sphinx/functions/uuid.rst +++ b/docs/src/main/sphinx/functions/uuid.rst @@ -4,4 +4,4 @@ UUID functions .. function:: uuid() -> uuid - Returns a pseudo randomly generated :ref:`uuid_type` (type 4). + Returns a pseudo randomly generated :ref:`uuid-type` (type 4). diff --git a/docs/src/main/sphinx/functions/window.rst b/docs/src/main/sphinx/functions/window.rst index 65e855cc094c..2948967fbbf9 100644 --- a/docs/src/main/sphinx/functions/window.rst +++ b/docs/src/main/sphinx/functions/window.rst @@ -14,7 +14,7 @@ For example, the following query ranks orders for each clerk by price:: FROM orders ORDER BY clerk, rnk -The window can be specified in two ways (see :ref:`window_clause`): +The window can be specified in two ways (see :ref:`window-clause`): * By a reference to a named window specification defined in the ``WINDOW`` clause, * By an in-line window specification which allows to define window components diff --git a/docs/src/main/sphinx/installation/deployment.rst b/docs/src/main/sphinx/installation/deployment.rst index b56f8a618b61..343655d3e1c0 100644 --- a/docs/src/main/sphinx/installation/deployment.rst +++ b/docs/src/main/sphinx/installation/deployment.rst @@ -76,7 +76,7 @@ This holds the following configuration: The available catalog configuration properties for a connector are described in the respective connector documentation. -.. _node_properties: +.. _node-properties: Node properties ^^^^^^^^^^^^^^^ @@ -112,7 +112,7 @@ The above properties are described below: The location (filesystem path) of the data directory. Trino stores logs and other data here. -.. _jvm_config: +.. _jvm-config: JVM config ^^^^^^^^^^ @@ -177,7 +177,7 @@ list of JVM options. We enable ``-XX:+UnlockDiagnosticVMOptions`` and ``-XX:+UseAESCTRIntrinsics`` to improve AES performance for S3, etc. on ARM64 (`JDK-8271567 `_) We disable Preventive GC (``-XX:-G1UsePreventiveGC``) for performance reasons (see `JDK-8293861 `_) -.. _config_properties: +.. _config-properties: Config properties ^^^^^^^^^^^^^^^^^ @@ -275,7 +275,7 @@ The default minimum level is ``INFO``, thus the above example does not actually change anything. There are four levels: ``DEBUG``, ``INFO``, ``WARN`` and ``ERROR``. -.. _catalog_properties: +.. _catalog-properties: Catalog properties ^^^^^^^^^^^^^^^^^^ @@ -298,7 +298,7 @@ contents to mount the ``jmx`` connector as the ``jmx`` catalog: See :doc:`/connector` for more information about configuring connectors. -.. _running_trino: +.. _running-trino: Running Trino -------------- diff --git a/docs/src/main/sphinx/installation/kubernetes.rst b/docs/src/main/sphinx/installation/kubernetes.rst index e7b5aeee5b22..d47bc2a42497 100644 --- a/docs/src/main/sphinx/installation/kubernetes.rst +++ b/docs/src/main/sphinx/installation/kubernetes.rst @@ -258,10 +258,10 @@ deployed in this cluster and the size of the cluster nodes. workers, in this case, a coordinator and three worker nodes are deployed. #. ``.coordinator.jvm.maxHeapSize`` is set to ``8GB``. This sets the maximum heap size in the JVM of the coordinator. See - :ref:`jvm_config`. + :ref:`jvm-config`. #. ``.worker.jvm.maxHeapSize`` is set to ``8GB``. This sets the maximum heap size in the JVM of the worker. See - :ref:`jvm_config`. + :ref:`jvm-config`. .. warning:: diff --git a/docs/src/main/sphinx/language/types.rst b/docs/src/main/sphinx/language/types.rst index f4a424e7913c..00c1361bafa1 100644 --- a/docs/src/main/sphinx/language/types.rst +++ b/docs/src/main/sphinx/language/types.rst @@ -303,7 +303,7 @@ Example: ``INTERVAL '2' DAY`` Structural ---------- -.. _array_type: +.. _array-type: ``ARRAY`` ^^^^^^^^^ @@ -312,7 +312,7 @@ An array of the given component type. Example: ``ARRAY[1, 2, 3]`` -.. _map_type: +.. _map-type: ``MAP`` ^^^^^^^ @@ -321,7 +321,7 @@ A map between the given component types. Example: ``MAP(ARRAY['foo', 'bar'], ARRAY[1, 2])`` -.. _row_type: +.. _row-type: ``ROW`` ^^^^^^^ @@ -345,7 +345,7 @@ Example: ``ROW(1, 2.0)[1]`` Network address --------------- -.. _ipaddress_type: +.. _ipaddress-type: ``IPADDRESS`` ^^^^^^^^^^^^^ @@ -363,7 +363,7 @@ Examples: ``IPADDRESS '10.0.0.1'``, ``IPADDRESS '2001:db8::1'`` UUID ---- -.. _uuid_type: +.. _uuid-type: ``UUID`` ^^^^^^^^ @@ -379,7 +379,7 @@ HyperLogLog Calculating the approximate distinct count can be done much more cheaply than an exact count using the `HyperLogLog `_ data sketch. See :doc:`/functions/hyperloglog`. -.. _hyperloglog_type: +.. _hyperloglog-type: ``HyperLogLog`` ^^^^^^^^^^^^^^^ @@ -387,18 +387,18 @@ Calculating the approximate distinct count can be done much more cheaply than an A HyperLogLog sketch allows efficient computation of :func:`approx_distinct`. It starts as a sparse representation, switching to a dense representation when it becomes more efficient. -.. _p4hyperloglog_type: +.. _p4hyperloglog-type: ``P4HyperLogLog`` ^^^^^^^^^^^^^^^^^ -A P4HyperLogLog sketch is similar to :ref:`hyperloglog_type`, but it starts (and remains) +A P4HyperLogLog sketch is similar to :ref:`hyperloglog-type`, but it starts (and remains) in the dense representation. SetDigest --------- -.. _setdigest_type: +.. _setdigest-type: ``SetDigest`` ^^^^^^^^^^^^^ @@ -423,7 +423,7 @@ SetDigests are additive, meaning they can be merged together. Quantile digest --------------- -.. _qdigest_type: +.. _qdigest-type: ``QDigest`` ^^^^^^^^^^^ @@ -446,7 +446,7 @@ daily, and quickly merged to retrieve the 99th percentile value. T-Digest -------- -.. _tdigest_type: +.. _tdigest-type: ``TDigest`` ^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/optimizer/statistics.rst b/docs/src/main/sphinx/optimizer/statistics.rst index 5fac98f50592..016dc82716e0 100644 --- a/docs/src/main/sphinx/optimizer/statistics.rst +++ b/docs/src/main/sphinx/optimizer/statistics.rst @@ -31,5 +31,5 @@ Hive connector does not currently provide statistics on data size. Table statistics can be displayed via the Trino SQL interface using the :doc:`/sql/show-stats` command. For the Hive connector, refer to the -:ref:`Hive connector ` documentation to learn how to update table +:ref:`Hive connector ` documentation to learn how to update table statistics. diff --git a/docs/src/main/sphinx/release.rst b/docs/src/main/sphinx/release.rst index 4424985d73d7..1a2827873120 100644 --- a/docs/src/main/sphinx/release.rst +++ b/docs/src/main/sphinx/release.rst @@ -2,7 +2,7 @@ Release notes ************* -.. _releases_2023: +.. _releases-2023: 2023 ==== @@ -22,7 +22,7 @@ Release notes release/release-407 release/release-406 -.. _releases_2022: +.. _releases-2022: 2022 ==== @@ -69,7 +69,7 @@ Release notes release/release-369 release/release-368 -.. _releases_2021: +.. _releases-2021: 2021 ==== @@ -95,7 +95,7 @@ Release notes release/release-352 release/release-351 -.. _releases_2020: +.. _releases-2020: 2020 ==== @@ -127,7 +127,7 @@ Release notes release/release-329 release/release-328 -.. _releases_2019: +.. _releases-2019: 2019 ==== diff --git a/docs/src/main/sphinx/release/release-0.100.rst b/docs/src/main/sphinx/release/release-0.100.rst index d832c8298c0e..91076ab9d565 100644 --- a/docs/src/main/sphinx/release/release-0.100.rst +++ b/docs/src/main/sphinx/release/release-0.100.rst @@ -23,7 +23,7 @@ General * Rename config property ``task.shard.max-threads`` to ``task.max-worker-threads``. This property sets the number of threads used to concurrently process splits. The old property name is deprecated and will be removed in a future release. -* Fix referencing ``NULL`` values in :ref:`row_type`. -* Make :ref:`map_type` comparable. +* Fix referencing ``NULL`` values in :ref:`row-type`. +* Make :ref:`map-type` comparable. * Fix leak of tasks blocked during query teardown. * Improve query queue config validation. diff --git a/docs/src/main/sphinx/release/release-0.101.rst b/docs/src/main/sphinx/release/release-0.101.rst index 8d86f6ea5b91..e35f6cba0e95 100644 --- a/docs/src/main/sphinx/release/release-0.101.rst +++ b/docs/src/main/sphinx/release/release-0.101.rst @@ -15,7 +15,7 @@ General * Fix excessive memory usage in :func:`map_agg`. * Fix excessive memory usage in queries that perform partitioned top-N operations with :func:`row_number`. -* Optimize :ref:`array_type` comparison operators. +* Optimize :ref:`array-type` comparison operators. * Fix analysis of ``UNION`` queries for tables with hidden columns. * Fix ``JOIN`` associativity to be left-associative instead of right-associative. * Add ``source`` column to ``runtime.queries`` table in :doc:`/connector/system`. diff --git a/docs/src/main/sphinx/release/release-0.102.rst b/docs/src/main/sphinx/release/release-0.102.rst index b0dfd48a4aa2..506858b7fd8d 100644 --- a/docs/src/main/sphinx/release/release-0.102.rst +++ b/docs/src/main/sphinx/release/release-0.102.rst @@ -32,7 +32,7 @@ General * Add support for full outer joins. * Support returning booleans as numbers in JDBC driver * Fix :func:`contains` to return ``NULL`` if the value was not found, but a ``NULL`` was. -* Fix nested :ref:`row_type` rendering in ``DESCRIBE``. +* Fix nested :ref:`row-type` rendering in ``DESCRIBE``. * Add :func:`array_join`. * Optimize map subscript operator. * Add :func:`from_utf8` and :func:`to_utf8` functions. diff --git a/docs/src/main/sphinx/release/release-0.130.rst b/docs/src/main/sphinx/release/release-0.130.rst index 38b2c3e087aa..eb362213f849 100644 --- a/docs/src/main/sphinx/release/release-0.130.rst +++ b/docs/src/main/sphinx/release/release-0.130.rst @@ -13,5 +13,5 @@ General ``optimizer.columnar-processing-dictionary`` config property or the ``columnar_processing_dictionary`` session property. * Improve performance of aggregation queries with large numbers of groups. -* Improve performance for queries that use :ref:`array_type` type. +* Improve performance for queries that use :ref:`array-type` type. * Fix querying remote views in MySQL and PostgreSQL connectors. diff --git a/docs/src/main/sphinx/release/release-0.132.rst b/docs/src/main/sphinx/release/release-0.132.rst index 96e8d6ab5c63..c2858a9cc894 100644 --- a/docs/src/main/sphinx/release/release-0.132.rst +++ b/docs/src/main/sphinx/release/release-0.132.rst @@ -4,7 +4,7 @@ Release 0.132 .. warning:: - :func:`concat` on :ref:`array_type`, or enabling ``columnar_processing_dictionary`` + :func:`concat` on :ref:`array-type`, or enabling ``columnar_processing_dictionary`` may cause queries to fail in this release. This is fixed in :doc:`/release/release-0.133`. General @@ -28,7 +28,7 @@ General * Perform bounds checks when evaluating :func:`abs`. * Improve accuracy of memory accounting for :func:`map_agg` and :func:`array_agg`. These functions will now appear to use more memory than before. -* Various performance optimizations for functions operating on :ref:`array_type`. +* Various performance optimizations for functions operating on :ref:`array-type`. * Add server version to web UI. CLI diff --git a/docs/src/main/sphinx/release/release-0.133.rst b/docs/src/main/sphinx/release/release-0.133.rst index 8e5f2b8e3e70..5f720db2be2b 100644 --- a/docs/src/main/sphinx/release/release-0.133.rst +++ b/docs/src/main/sphinx/release/release-0.133.rst @@ -15,6 +15,6 @@ General ``optimizer.dictionary-aggregation`` config property or the ``dictionary_aggregation`` session property. * Fix race which could cause queries to fail when using :func:`concat` on - :ref:`array_type`, or when enabling ``columnar_processing_dictionary``. + :ref:`array-type`, or when enabling ``columnar_processing_dictionary``. * Add sticky headers and the ability to sort the tasks table on the query page in the web interface. diff --git a/docs/src/main/sphinx/release/release-0.140.rst b/docs/src/main/sphinx/release/release-0.140.rst index cb2f65c7f303..118a0c0c979b 100644 --- a/docs/src/main/sphinx/release/release-0.140.rst +++ b/docs/src/main/sphinx/release/release-0.140.rst @@ -13,7 +13,7 @@ General ``QueryCompletionEvent``. * Fix race which can cause queries to fail with a ``REMOTE_TASK_ERROR``. * Optimize :func:`array_distinct` for ``array(bigint)``. -* Optimize ``>`` operator for :ref:`array_type`. +* Optimize ``>`` operator for :ref:`array-type`. * Fix an optimization issue that could result in non-deterministic functions being evaluated more than once producing unexpected results. * Fix incorrect result for rare ``IN`` lists that contain certain combinations diff --git a/docs/src/main/sphinx/release/release-0.142.rst b/docs/src/main/sphinx/release/release-0.142.rst index 0629cf8a30c3..1363a908115a 100644 --- a/docs/src/main/sphinx/release/release-0.142.rst +++ b/docs/src/main/sphinx/release/release-0.142.rst @@ -9,7 +9,7 @@ General * Fix planning bug when the output of ``UNION`` doesn't match the table column order in ``INSERT`` queries. * Fix error when ``ORDER BY`` clause in window specification refers to the same column multiple times. -* Add support for :ref:`complex grouping operations` +* Add support for :ref:`complex grouping operations` - ``CUBE``, ``ROLLUP`` and ``GROUPING SETS``. * Add support for ``IF NOT EXISTS`` in ``CREATE TABLE AS`` queries. * Add :func:`substring` function. diff --git a/docs/src/main/sphinx/release/release-0.152.2.rst b/docs/src/main/sphinx/release/release-0.152.2.rst index 38fcaa0a97f2..086ebd540b56 100644 --- a/docs/src/main/sphinx/release/release-0.152.2.rst +++ b/docs/src/main/sphinx/release/release-0.152.2.rst @@ -5,4 +5,4 @@ Release 0.152.2 Hive ---- -* Improve performance of ORC reader when decoding dictionary encoded :ref:`map_type`. +* Improve performance of ORC reader when decoding dictionary encoded :ref:`map-type`. diff --git a/docs/src/main/sphinx/release/release-0.153.rst b/docs/src/main/sphinx/release/release-0.153.rst index a1c7530668ea..81790058daec 100644 --- a/docs/src/main/sphinx/release/release-0.153.rst +++ b/docs/src/main/sphinx/release/release-0.153.rst @@ -28,7 +28,7 @@ General * Fix query completion event to log final stats for the query. * Fix spurious log messages when queries are torn down. * Remove broken ``%w`` specifier for :func:`date_format` and :func:`date_parse`. -* Improve performance of :ref:`array_type` when underlying data is dictionary encoded. +* Improve performance of :ref:`array-type` when underlying data is dictionary encoded. * Improve performance of outer joins with non-equality criteria. * Require task concurrency and task writer count to be a power of two. * Use nulls-last ordering for :func:`array_sort`. @@ -84,7 +84,7 @@ Hive ---- * Fix permissions for new tables when using SQL-standard authorization. -* Improve performance of ORC reader when decoding dictionary encoded :ref:`map_type`. +* Improve performance of ORC reader when decoding dictionary encoded :ref:`map-type`. * Allow certain combinations of queries to be executed in a transaction-ish manner, for example, when dropping a partition and then recreating it. Atomicity is not guaranteed due to fundamental limitations in the design of Hive. diff --git a/docs/src/main/sphinx/release/release-0.156.rst b/docs/src/main/sphinx/release/release-0.156.rst index b169bbe527d6..6fc1539d3d41 100644 --- a/docs/src/main/sphinx/release/release-0.156.rst +++ b/docs/src/main/sphinx/release/release-0.156.rst @@ -14,7 +14,7 @@ General * Fix potential correctness issue in queries that contain correlated scalar aggregation subqueries. * Fix query failure when using ``AT TIME ZONE`` in ``VALUES`` list. * Add support for quantified comparison predicates: ``ALL``, ``ANY``, and ``SOME``. -* Add support for :ref:`array_type` and :ref:`row_type` that contain ``NULL`` +* Add support for :ref:`array-type` and :ref:`row-type` that contain ``NULL`` in :func:`checksum` aggregation. * Add support for filtered aggregations. Example: ``SELECT sum(a) FILTER (WHERE b > 0) FROM ...`` * Add a variant of :func:`from_unixtime` function that takes a timezone argument. diff --git a/docs/src/main/sphinx/release/release-0.161.rst b/docs/src/main/sphinx/release/release-0.161.rst index 4190d406e900..ae98cffb32a0 100644 --- a/docs/src/main/sphinx/release/release-0.161.rst +++ b/docs/src/main/sphinx/release/release-0.161.rst @@ -23,7 +23,7 @@ General * Remove ``/v1/execute`` resource. * Add new column to :doc:`/sql/show-columns` (and :doc:`/sql/describe`) to show extra information from connectors. -* Add :func:`map` to construct an empty :ref:`map_type`. +* Add :func:`map` to construct an empty :ref:`map-type`. Hive connector -------------- diff --git a/docs/src/main/sphinx/release/release-0.178.rst b/docs/src/main/sphinx/release/release-0.178.rst index 63f080e65d51..c8e55e33944b 100644 --- a/docs/src/main/sphinx/release/release-0.178.rst +++ b/docs/src/main/sphinx/release/release-0.178.rst @@ -9,7 +9,7 @@ General * Fix a regression that causes queries that use the keyword "stats" to fail to parse. * Fix an issue where a query does not get cleaned up on the coordinator after query failure. * Add ability to cast to ``JSON`` from ``REAL``, ``TINYINT`` or ``SMALLINT``. -* Add support for ``GROUPING`` operation to :ref:`complex grouping operations`. +* Add support for ``GROUPING`` operation to :ref:`complex grouping operations`. * Add support for correlated subqueries in ``IN`` predicates. * Add :func:`to_ieee754_32` and :func:`to_ieee754_64` functions. diff --git a/docs/src/main/sphinx/release/release-0.182.rst b/docs/src/main/sphinx/release/release-0.182.rst index 7082e5255874..6a2d92b4662c 100644 --- a/docs/src/main/sphinx/release/release-0.182.rst +++ b/docs/src/main/sphinx/release/release-0.182.rst @@ -15,7 +15,7 @@ General * Improve the performance of joins with only non-equality conditions by using a nested loops join instead of a hash join. * Improve the performance of casting from ``JSON`` to ``ARRAY`` or ``MAP`` types. -* Add a new :ref:`ipaddress_type` type to represent IP addresses. +* Add a new :ref:`ipaddress-type` type to represent IP addresses. * Add :func:`to_milliseconds` function to convert intervals (day to second) to milliseconds. * Add support for column aliases in ``CREATE TABLE AS`` statements. * Add a config option to reject queries during cluster initialization. diff --git a/docs/src/main/sphinx/release/release-0.214.rst b/docs/src/main/sphinx/release/release-0.214.rst index 9fa708745be9..88611c972fd3 100644 --- a/docs/src/main/sphinx/release/release-0.214.rst +++ b/docs/src/main/sphinx/release/release-0.214.rst @@ -23,7 +23,7 @@ General ``optimizer.optimize-top-n-row-number`` to toggle the top N row number optimization. * Add :func:`ngrams` function to generate N-grams from an array. -* Add :ref:`qdigest ` type and associated :doc:`/functions/qdigest`. +* Add :ref:`qdigest ` type and associated :doc:`/functions/qdigest`. * Add functionality to delay query execution until a minimum number of workers nodes are available. The minimum number of workers can be set with the ``query-manager.required-workers`` configuration property, and the max wait diff --git a/docs/src/main/sphinx/release/release-0.69.rst b/docs/src/main/sphinx/release/release-0.69.rst index 4db24ed8101f..4ab0d4d26aba 100644 --- a/docs/src/main/sphinx/release/release-0.69.rst +++ b/docs/src/main/sphinx/release/release-0.69.rst @@ -25,7 +25,7 @@ available for the critical task of scheduling, managing and monitoring query execution. We recommend setting this property to ``false`` for the coordinator. -See :ref:`config_properties` for an example. +See :ref:`config-properties` for an example. Datasource configuration ------------------------ diff --git a/docs/src/main/sphinx/release/release-0.77.rst b/docs/src/main/sphinx/release/release-0.77.rst index 4a7c2df3a6a8..d7c8c57eaf0d 100644 --- a/docs/src/main/sphinx/release/release-0.77.rst +++ b/docs/src/main/sphinx/release/release-0.77.rst @@ -5,7 +5,7 @@ Release 0.77 Parametric types ---------------- Presto now has a framework for implementing parametric types and functions. -Support for :ref:`array_type` and :ref:`map_type` types has been added, including the element accessor +Support for :ref:`array-type` and :ref:`map-type` types has been added, including the element accessor operator ``[]``, and new :doc:`/functions/array`. Streaming index joins diff --git a/docs/src/main/sphinx/release/release-0.82.rst b/docs/src/main/sphinx/release/release-0.82.rst index c6d9312fb4aa..6f2eccf1172f 100644 --- a/docs/src/main/sphinx/release/release-0.82.rst +++ b/docs/src/main/sphinx/release/release-0.82.rst @@ -2,7 +2,7 @@ Release 0.82 ============ -* Presto now supports the :ref:`row_type` type, and all Hive structs are +* Presto now supports the :ref:`row-type` type, and all Hive structs are converted to ROWs, instead of JSON encoded VARCHARs. * Add :func:`current_timezone` function. * Improve planning performance for queries with thousands of columns. diff --git a/docs/src/main/sphinx/release/release-0.87.rst b/docs/src/main/sphinx/release/release-0.87.rst index 71e7e0977b96..1e46b4b196bd 100644 --- a/docs/src/main/sphinx/release/release-0.87.rst +++ b/docs/src/main/sphinx/release/release-0.87.rst @@ -5,5 +5,5 @@ Release 0.87 General ------- -* Fixed a bug where :ref:`row_type` types could have the wrong field names. +* Fixed a bug where :ref:`row-type` types could have the wrong field names. * Changed the minimum JDK version to 1.8. diff --git a/docs/src/main/sphinx/release/release-0.88.rst b/docs/src/main/sphinx/release/release-0.88.rst index 6806bbcefc40..95492556a986 100644 --- a/docs/src/main/sphinx/release/release-0.88.rst +++ b/docs/src/main/sphinx/release/release-0.88.rst @@ -10,8 +10,8 @@ General * Support specifying window frames and correctly implement frames for all :doc:`/functions/window`. * Allow :func:`approx_distinct` aggregation function to accept a standard error parameter. * Implement :func:`least` and :func:`greatest` with variable number of arguments. -* :ref:`array_type` is now comparable and can be used as ``GROUP BY`` keys or in ``ORDER BY`` expressions. -* Implement ``=`` and ``<>`` operators for :ref:`row_type`. +* :ref:`array-type` is now comparable and can be used as ``GROUP BY`` keys or in ``ORDER BY`` expressions. +* Implement ``=`` and ``<>`` operators for :ref:`row-type`. * Fix excessive garbage creation in the ORC reader. * Fix an issue that could cause queries using :func:`row_number()` and ``LIMIT`` to never terminate. * Fix an issue that could cause queries with :func:`row_number()` and specific filters to produce incorrect results. diff --git a/docs/src/main/sphinx/release/release-312.rst b/docs/src/main/sphinx/release/release-312.rst index f659bb44037a..f5d0addb31f0 100644 --- a/docs/src/main/sphinx/release/release-312.rst +++ b/docs/src/main/sphinx/release/release-312.rst @@ -21,7 +21,7 @@ General ``optimizer.skip-redundant-sort`` configuration property. (:issue:`818`) * Improve performance of ``IN`` predicates that contain subqueries. (:issue:`767`) * Improve support for correlated subqueries containing redundant ``LIMIT`` clauses. (:issue:`441`) -* Add a new :ref:`uuid_type` type to represent UUIDs. (:issue:`755`) +* Add a new :ref:`uuid-type` type to represent UUIDs. (:issue:`755`) * Add :func:`uuid` function to generate random UUIDs. (:issue:`786`) * Add :doc:`/connector/phoenix`. (:issue:`672`) * Make semantic error name available in client protocol. (:issue:`790`) diff --git a/docs/src/main/sphinx/release/release-313.rst b/docs/src/main/sphinx/release/release-313.rst index 0d9062c17ef3..137ebc533e3f 100644 --- a/docs/src/main/sphinx/release/release-313.rst +++ b/docs/src/main/sphinx/release/release-313.rst @@ -12,12 +12,12 @@ General CLI --- -* Fix failure when selecting a value of type :ref:`uuid_type`. (:issue:`854`) +* Fix failure when selecting a value of type :ref:`uuid-type`. (:issue:`854`) JDBC driver ----------- -* Fix failure when selecting a value of type :ref:`uuid_type`. (:issue:`854`) +* Fix failure when selecting a value of type :ref:`uuid-type`. (:issue:`854`) Phoenix connector ------------------- diff --git a/docs/src/main/sphinx/release/release-330.rst b/docs/src/main/sphinx/release/release-330.rst index 15ed1fa3c2f8..39f28886c699 100644 --- a/docs/src/main/sphinx/release/release-330.rst +++ b/docs/src/main/sphinx/release/release-330.rst @@ -32,7 +32,7 @@ Server ------ * Require running on :ref:`Java 11 or above `. This requirement may be temporarily relaxed by adding - ``-Dpresto-temporarily-allow-java8=true`` to the Presto :ref:`jvm_config`. + ``-Dpresto-temporarily-allow-java8=true`` to the Presto :ref:`jvm-config`. This fallback will be removed in future versions of Presto after March 2020. (:issue:`2751`) * Add experimental support for running on Linux aarch64 (ARM64). (:issue:`2809`) @@ -104,7 +104,7 @@ Hive connector * Add support for Azure WASB, ADLS Gen1 (ADL) and ADLS Gen2 (ABFS) file systems. (:issue:`2494`) * Add experimental support for executing basic Hive views. To enable this feature, the ``hive.views-execution.enabled`` configuration property must be set to ``true``. (:issue:`2715`) -* Add :ref:`register_partition ` and :ref:`unregister_partition ` +* Add :ref:`register_partition ` and :ref:`unregister_partition ` procedures for adding partitions to and removing partitions from a partitioned table. (:issue:`2692`) * Allow running :doc:`/sql/analyze` collecting only basic table statistics. (:issue:`2762`) diff --git a/docs/src/main/sphinx/release/release-331.rst b/docs/src/main/sphinx/release/release-331.rst index d93075a5fe48..14cb20a54923 100644 --- a/docs/src/main/sphinx/release/release-331.rst +++ b/docs/src/main/sphinx/release/release-331.rst @@ -28,7 +28,7 @@ Security * Remove unused ``internal-communication.jwt.enabled`` configuration property. (:issue:`2709`) * Rename JWT configuration properties from ``http.authentication.jwt.*`` to ``http-server.authentication.jwt.*``. (:issue:`2712`) * Add access control checks for query execution, view query, and kill query. This can be - configured using :ref:`query_rules` in :doc:`/security/file-system-access-control`. (:issue:`2213`) + configured using :ref:`query-rules` in :doc:`/security/file-system-access-control`. (:issue:`2213`) * Hide columns of tables for which the user has no privileges in :doc:`/security/file-system-access-control`. (:issue:`2925`) JDBC driver diff --git a/docs/src/main/sphinx/release/release-332.rst b/docs/src/main/sphinx/release/release-332.rst index f29b52fdfe02..36198ecadf41 100644 --- a/docs/src/main/sphinx/release/release-332.rst +++ b/docs/src/main/sphinx/release/release-332.rst @@ -68,7 +68,7 @@ Hive connector ``hive.metastore.glue.endpoint-url`` configuration property. (:issue:`3239`) * Add experimental file system caching. This can be enabled with the ``hive.cache.enabled`` configuration property. (:issue:`2679`) * Support reading files compressed with newer versions of LZO. (:issue:`3209`) -* Add support for :ref:`alluxio_catalog_service`. (:issue:`2116`) +* Add support for :ref:`alluxio-catalog-service`. (:issue:`2116`) * Remove unnecessary ``hive.metastore.glue.use-instance-credentials`` configuration property. (:issue:`3265`) * Remove unnecessary ``hive.s3.use-instance-credentials`` configuration property. (:issue:`3265`) * Add flexible :ref:`hive-s3-security-mapping`, allowing for separate credentials diff --git a/docs/src/main/sphinx/release/release-337.rst b/docs/src/main/sphinx/release/release-337.rst index 54a761d9af0b..8b9865ba7c0d 100644 --- a/docs/src/main/sphinx/release/release-337.rst +++ b/docs/src/main/sphinx/release/release-337.rst @@ -29,7 +29,7 @@ Security * Disable insecure authentication over HTTP by default when HTTPS with authentication is enabled. This can be overridden via the ``http-server.authentication.allow-insecure-over-http`` configuration property. (:issue:`4199`) * Add support for insecure authentication over HTTPS to the Web UI. (:issue:`4199`) -* Add :ref:`system-file-auth-system_information` which control the ability of a +* Add :ref:`system-file-auth-system-information` which control the ability of a user to access to read and write system management information. (:issue:`4199`) * Disable user impersonation in default system security. (:issue:`4082`) diff --git a/docs/src/main/sphinx/release/release-341.md b/docs/src/main/sphinx/release/release-341.md index 00ed37d22bfe..456368a678a2 100644 --- a/docs/src/main/sphinx/release/release-341.md +++ b/docs/src/main/sphinx/release/release-341.md @@ -6,10 +6,10 @@ * Add support for variable precision `TIME WITH TIME ZONE` type. ({issue}`4905`) * Add {doc}`/connector/iceberg`. * Add {func}`human_readable_seconds` function. ({issue}`4344`) -* Add [`reverse()`](function_reverse_varbinary) function for `VARBINARY`. ({issue}`4741`) +* Add [`reverse()`](function-reverse-varbinary) function for `VARBINARY`. ({issue}`4741`) * Add support for {func}`extract` for `timestamp(p) with time zone` with values of `p` other than 3. ({issue}`4867`) * Add support for correlated subqueries in recursive queries. ({issue}`4877`) -* Add [](optimizer_rule_stats) system table. ({issue}`4659`) +* Add [](optimizer-rule-stats) system table. ({issue}`4659`) * Report dynamic filters statistics. ({issue}`4440`) * Improve query scalability when new nodes are added to cluster. ({issue}`4294`) * Improve error message when JSON parsing fails. ({issue}`4616`) @@ -68,11 +68,11 @@ * Use a temporary staging directory for temporary files when writing to sorted bucketed tables. This allows using a more efficient file system for temporary files. ({issue}`3434`) * Fix metastore cache invalidation for `GRANT` and `REVOKE`. ({issue}`4768`) -* Add Parquet and RCBinary [configuration properties](hive_configuration_properties) `hive.parquet.time-zone` +* Add Parquet and RCBinary [configuration properties](hive-configuration-properties) `hive.parquet.time-zone` and `hive.rcfile.time-zone` to adjust binary timestamp values to a specific time zone. For Hive 3.1+, this should be set to UTC. The default value is the JVM default time zone, for backwards compatibility with earlier versions of Hive. ({issue}`4799`) -* Add ORC [configuration property](hive_configuration_properties) `hive.orc.time-zone` to set the default +* Add ORC [configuration property](hive-configuration-properties) `hive.orc.time-zone` to set the default time zone for legacy ORC files that did not declare a time zone. ({issue}`4799`) * Replace the `hive.time-zone` configuration property with format specific properties: `hive.orc.time-zone`, `hive.parquet.time-zone`, `hive.rcfile.time-zone`. ({issue}`4799`) diff --git a/docs/src/main/sphinx/release/release-352.md b/docs/src/main/sphinx/release/release-352.md index 26af4a4cc822..3c1f7b8a811e 100644 --- a/docs/src/main/sphinx/release/release-352.md +++ b/docs/src/main/sphinx/release/release-352.md @@ -2,7 +2,7 @@ ## General -* Add support for [`WINDOW` clause](window_clause). ({issue}`651`) +* Add support for [`WINDOW` clause](window-clause). ({issue}`651`) * Add support for {doc}`/sql/update`. ({issue}`5861`) * Add {func}`version` function. ({issue}`4627`) * Allow prepared statement parameters for `SHOW STATS`. ({issue}`6582`) diff --git a/docs/src/main/sphinx/release/release-362.md b/docs/src/main/sphinx/release/release-362.md index 6c0167a5e56f..fe6ca261ab96 100644 --- a/docs/src/main/sphinx/release/release-362.md +++ b/docs/src/main/sphinx/release/release-362.md @@ -14,7 +14,7 @@ * Fix query failure when query contains a cast from `varchar` to a shorter `char`. ({issue}`9036`) * Fix planning failure of `INSERT` statement when source table has hidden columns. ({issue}`9150`) * Fix planning of recursive queries when the recursion, the base plan, or the recursion step plan produce duplicate outputs. ({issue}`9153`) -* Fix failure when querying the [optimizer_rule_stats](optimizer_rule_stats) system table. ({issue}`8700`) +* Fix failure when querying the [optimizer_rule_stats](optimizer-rule-stats) system table. ({issue}`8700`) * Fix failure for queries that push projections into connectors. ({issue}`6200`) * Fix planning timeout for queries containing `IS NULL`, `AND`, and `OR` predicates in the `WHERE` clause. ({issue}`9250`) * Fix failure for queries containing `ORDER BY ... LIMIT` when columns in the subquery are known to be constant. ({issue}`9171`) diff --git a/docs/src/main/sphinx/release/release-365.md b/docs/src/main/sphinx/release/release-365.md index 615181154479..6fbb9d1905b9 100644 --- a/docs/src/main/sphinx/release/release-365.md +++ b/docs/src/main/sphinx/release/release-365.md @@ -6,7 +6,7 @@ * Add support for aggregate functions in row pattern recognition context. ({issue}`8738`) * Add support for time travel queries. ({issue}`8773`) * Add support for spilling aggregations containing `ORDER BY` or `DISTINCT` clauses. ({issue}`9723`) -* Add [`contains`](ip_address_contains) function to check whether a CIDR contains an IP address. ({issue}`9654`) +* Add [`contains`](ip-address-contains) function to check whether a CIDR contains an IP address. ({issue}`9654`) * Report connector metrics in `EXPLAIN ANALYZE VERBOSE`. ({issue}`9858`) * Report operator input row count distribution in `EXPLAIN ANALYZE VERBOSE`. ({issue}`10133`) * Allow executing `INSERT` or `DELETE` statements on tables restricted with a row filter. ({issue}`8856`) diff --git a/docs/src/main/sphinx/release/release-369.md b/docs/src/main/sphinx/release/release-369.md index d4354bf00335..f99b8ed8dc66 100644 --- a/docs/src/main/sphinx/release/release-369.md +++ b/docs/src/main/sphinx/release/release-369.md @@ -73,7 +73,7 @@ * Add support for writing Bloom filters in ORC files. ({issue}`3939`) * Allow flushing the metadata cache for specific schemas, tables, or partitions - with the [flush_metadata_cache](hive_flush_metadata_cache) system procedure. + with the [flush_metadata_cache](hive-flush-metadata-cache) system procedure. ({issue}`10385`) * Add support for long lived AWS Security Token Service (STS) credentials for authentication with Glue catalog. ({issue}`10735`) diff --git a/docs/src/main/sphinx/release/release-391.md b/docs/src/main/sphinx/release/release-391.md index ac3876a475b8..7c5fa77561ff 100644 --- a/docs/src/main/sphinx/release/release-391.md +++ b/docs/src/main/sphinx/release/release-391.md @@ -31,7 +31,7 @@ ## Hive connector -* Add support for [AWS Athena partition projection](partition_projection). ({issue}`11305`) +* Add support for [AWS Athena partition projection](partition-projection). ({issue}`11305`) * Improve optimized Parquet writer performance. ({issue}`13203`, {issue}`13208`) * Fix potential failure when creating empty ORC bucket files while using ZSTD compression. ({issue}`9775`) diff --git a/docs/src/main/sphinx/release/release-412.md b/docs/src/main/sphinx/release/release-412.md index 3cdc3738c3ae..4c9030d8c7db 100644 --- a/docs/src/main/sphinx/release/release-412.md +++ b/docs/src/main/sphinx/release/release-412.md @@ -3,7 +3,7 @@ ## General * Add support for aggregate functions and parameters as arguments for the - [`json_object()`](json_object) and [`json_array()`](json_array) + [`json_object()`](json-object) and [`json_array()`](json-array) functions. ({issue}`16489`, {issue}`16523`, {issue}`16525`) * Expose optimizer rule execution statistics in query statistics. The number of rules for which statistics are collected can be limited with the diff --git a/docs/src/main/sphinx/release/release-414.md b/docs/src/main/sphinx/release/release-414.md index 1bde1ed950ee..c6bb51b85aa7 100644 --- a/docs/src/main/sphinx/release/release-414.md +++ b/docs/src/main/sphinx/release/release-414.md @@ -2,9 +2,9 @@ ## General -* Add [recursive member access](json_descendant_member_accessor) to the +* Add [recursive member access](json-descendant-member-accessor) to the [JSON path language](json-path-language). ({issue}`16854`) -* Add the [`sequence()`](built_in_table_functions) table function. ({issue}`16716`) +* Add the [`sequence()`](built-in-table-functions) table function. ({issue}`16716`) * Add support for progress estimates when [fault-tolerant execution](/admin/fault-tolerant-execution) is enabled. ({issue}`13072`) * Add support for `CUBE` and `ROLLUP` with composite sets. ({issue}`16981`) @@ -23,7 +23,7 @@ * Disallow [graceful shutdown](/admin/graceful-shutdown) with the `default` [system access control](/security/built-in-system-access-control). Shutdowns can be re-enabled by using the `allow-all` system access control, or by - configuring [system information rules](system-file-auth-system_information) + configuring [system information rules](system-file-auth-system-information) with the `file` system access control. ({issue}`17105`) ## Delta Lake connector diff --git a/docs/src/main/sphinx/security/certificate.rst b/docs/src/main/sphinx/security/certificate.rst index dadecfada6e0..505a1529dd1f 100644 --- a/docs/src/main/sphinx/security/certificate.rst +++ b/docs/src/main/sphinx/security/certificate.rst @@ -66,7 +66,7 @@ Certificate authentication configuration Enable certificate authentication by setting the :doc:`Certificate authentication type ` in :ref:`etc/config.properties -`: +`: .. code-block:: properties diff --git a/docs/src/main/sphinx/security/file-system-access-control.rst b/docs/src/main/sphinx/security/file-system-access-control.rst index a0e091b8e647..67dd69754e7b 100644 --- a/docs/src/main/sphinx/security/file-system-access-control.rst +++ b/docs/src/main/sphinx/security/file-system-access-control.rst @@ -463,7 +463,7 @@ function from any catalog: ] } -.. _verify_rules: +.. _verify-rules: Verify configuration ^^^^^^^^^^^^^^^^^^^^ @@ -526,7 +526,7 @@ The example below defines the following table access policy: .. literalinclude:: session-property-access.json :language: json -.. _query_rules: +.. _query-rules: Query rules ----------- @@ -678,7 +678,7 @@ as ``group@example.net``, you can use the following rules. ] } -.. _system-file-auth-system_information: +.. _system-file-auth-system-information: System information rules ------------------------ diff --git a/docs/src/main/sphinx/security/inspect-jks.rst b/docs/src/main/sphinx/security/inspect-jks.rst index f4aac6e9a128..6aa78fd251fa 100644 --- a/docs/src/main/sphinx/security/inspect-jks.rst +++ b/docs/src/main/sphinx/security/inspect-jks.rst @@ -17,7 +17,7 @@ name. If you receive a keystore file from your site's network admin group, verify that it shows the correct information for your Trino cluster, as described next. -.. _troubleshooting_keystore: +.. _troubleshooting-keystore: Inspect and validate keystore ----------------------------- @@ -65,7 +65,7 @@ the Trino server, as described in :ref:`cert-placement` and The rest of this page describes additional steps that may apply in certain circumstances. -.. _import_to_keystore: +.. _import-to-keystore: Extra: add PEM to keystore -------------------------- @@ -95,7 +95,7 @@ The ``alias`` name is an arbitrary string used as a handle for the certificate you are adding. A keystore can contain multiple keys and certs, so ``keytool`` uses the alias to address individual entries. -.. _cli_java_truststore: +.. _cli-java-truststore: Extra: Java truststores ----------------------- diff --git a/docs/src/main/sphinx/security/inspect-pem.rst b/docs/src/main/sphinx/security/inspect-pem.rst index faa74a7ea32a..42d880fa0d97 100644 --- a/docs/src/main/sphinx/security/inspect-pem.rst +++ b/docs/src/main/sphinx/security/inspect-pem.rst @@ -17,10 +17,10 @@ information, or both in the same file. Certified keys can contain a chain of certificates from successive certificate authorities. Follow the steps in this topic to inspect and validate PEM-encoded key and -certificate files. See :ref:`troubleshooting_keystore` to validate JKS +certificate files. See :ref:`troubleshooting-keystore` to validate JKS keystores. -.. _inspect_pems: +.. _inspect-pems: Inspect PEM file ---------------- @@ -76,7 +76,7 @@ The certificate section looks like the following example: The file can show a single certificate section, or more than one to express a chain of authorities, each certifying the previous. -.. _validate_pems: +.. _validate-pems: Validate PEM key section ------------------------ diff --git a/docs/src/main/sphinx/security/internal-communication.rst b/docs/src/main/sphinx/security/internal-communication.rst index 1aaea9fdb1cd..1130a12375c1 100644 --- a/docs/src/main/sphinx/security/internal-communication.rst +++ b/docs/src/main/sphinx/security/internal-communication.rst @@ -18,7 +18,7 @@ cluster. Use this configuration under the following conditions: between clients and the coordinator Set the shared secret to the same value in :ref:`config.properties -` on all nodes of the cluster: +` on all nodes of the cluster: .. code-block:: text @@ -31,7 +31,7 @@ command: openssl rand 512 | base64 -.. _verify_secrets: +.. _verify-secrets: Verify configuration ^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/security/jwt.rst b/docs/src/main/sphinx/security/jwt.rst index a37b102143ae..41e5ff18b806 100644 --- a/docs/src/main/sphinx/security/jwt.rst +++ b/docs/src/main/sphinx/security/jwt.rst @@ -60,7 +60,7 @@ JWT authentication configuration -------------------------------- Enable JWT authentication by setting the :doc:`JWT authentication type -` in :ref:`etc/config.properties `, and +` in :ref:`etc/config.properties `, and specifying a URL or path to a key file: .. code-block:: properties diff --git a/docs/src/main/sphinx/security/kerberos.rst b/docs/src/main/sphinx/security/kerberos.rst index e08fde97e77e..f26a9a380877 100644 --- a/docs/src/main/sphinx/security/kerberos.rst +++ b/docs/src/main/sphinx/security/kerberos.rst @@ -17,13 +17,13 @@ Environment configuration .. |subject_node| replace:: Trino coordinator -.. _server_kerberos_services: +.. _server-kerberos-services: .. include:: kerberos-services.fragment -.. _server_kerberos_configuration: +.. _server-kerberos-configuration: .. include:: kerberos-configuration.fragment -.. _server_kerberos_principals: +.. _server-kerberos-principals: Kerberos principals and keytab files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -69,9 +69,9 @@ following environment changes, you can make the changes to the Trino configuration files. * :doc:`/security/tls` -* :ref:`server_kerberos_services` -* :ref:`server_kerberos_configuration` -* :ref:`server_kerberos_principals` +* :ref:`server-kerberos-services` +* :ref:`server-kerberos-configuration` +* :ref:`server-kerberos-principals` * :doc:`System Access Control Plugin ` config.properties @@ -189,7 +189,7 @@ Java keystore file verification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Verify the password for a keystore file and view its contents using -:ref:`troubleshooting_keystore`. +:ref:`troubleshooting-keystore`. .. _kerberos-debug: @@ -222,7 +222,7 @@ flag, and `Troubleshooting `_ for more details about the Java GSS-API and Kerberos issues. -.. _server_additional_resources: +.. _server-additional-resources: Additional resources ^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/security/ldap.rst b/docs/src/main/sphinx/security/ldap.rst index 475f6adeb29c..884990d74739 100644 --- a/docs/src/main/sphinx/security/ldap.rst +++ b/docs/src/main/sphinx/security/ldap.rst @@ -3,7 +3,7 @@ LDAP authentication =================== Trino can be configured to enable frontend LDAP authentication over -HTTPS for clients, such as the :ref:`cli_ldap`, or the JDBC and ODBC +HTTPS for clients, such as the :ref:`cli-ldap`, or the JDBC and ODBC drivers. At present, only simple LDAP authentication mechanism involving username and password is supported. The Trino client sends a username and password to the coordinator, and the coordinator validates these @@ -238,7 +238,7 @@ property may be set as follows: ldap.group-auth-pattern=(&(|(memberOf=CN=normal_group,DC=corp,DC=com)(memberOf=CN=another_group,DC=com))(objectClass=inetOrgPerson)(uid=${USER})) -.. _cli_ldap: +.. _cli-ldap: Trino CLI ---------- @@ -287,7 +287,7 @@ Java keystore file verification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Verify the password for a keystore file and view its contents using -:ref:`troubleshooting_keystore`. +:ref:`troubleshooting-keystore`. Debug Trino to LDAP server issues ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/security/overview.rst b/docs/src/main/sphinx/security/overview.rst index 0c7cce75c81a..a8e41047355a 100644 --- a/docs/src/main/sphinx/security/overview.rst +++ b/docs/src/main/sphinx/security/overview.rst @@ -30,11 +30,11 @@ order of steps. Do not skip or combine steps. HTTPS, if possible. * Use a globally trusted TLS certificate. - :ref:`Verify this step is working correctly.` + :ref:`Verify this step is working correctly.` #. **Configure** a :doc:`a shared secret ` - :ref:`Verify this step is working correctly.` + :ref:`Verify this step is working correctly.` #. **Enable authentication** @@ -44,14 +44,14 @@ order of steps. Do not skip or combine steps. `. * Avoid the complexity of Kerberos for client authentication, if possible. - :ref:`Verify this step is working correctly.` + :ref:`Verify this step is working correctly.` #. **Enable authorization and access control** * Start with :doc:`file-based rules `. * Then configure another access control method as required. - :ref:`Verify this step is working correctly. ` + :ref:`Verify this step is working correctly. ` Configure one step at a time. Always restart the Trino server after each change, and verify the results before proceeding. @@ -140,7 +140,7 @@ denying access to any inaccessible columns. You can change this behavior to silently hide inaccessible columns with the global property ``hide-inaccessible-columns`` configured in -:ref:`config_properties`: +:ref:`config-properties`: .. code-block:: properties diff --git a/docs/src/main/sphinx/security/password-file.rst b/docs/src/main/sphinx/security/password-file.rst index 18c59aad578a..e481d68b7ef8 100644 --- a/docs/src/main/sphinx/security/password-file.rst +++ b/docs/src/main/sphinx/security/password-file.rst @@ -90,7 +90,7 @@ Add or update the password for the user ``test``: htpasswd -B -C 10 password.db test -.. _verify_authentication: +.. _verify-authentication: Verify configuration ^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/security/tls.rst b/docs/src/main/sphinx/security/tls.rst index 9f49ae08c169..e3fe88bcfe90 100644 --- a/docs/src/main/sphinx/security/tls.rst +++ b/docs/src/main/sphinx/security/tls.rst @@ -110,7 +110,7 @@ not need to configure ``http-server.https.enabled=true`` for a coordinator behind a load balancer. However, to enable processing of such forwarded headers, the server's -:ref:`config properties file ` *must* include the following: +:ref:`config properties file ` *must* include the following: .. code-block:: text @@ -154,7 +154,7 @@ following types of certificates: * **Generated self-signed certificates** — A certificate generated just for Trino that is not automatically trusted by any client. Before using, make sure you understand the :ref:`limitations of self-signed certificates - `. + `. The most convenient option and strongly recommended option is a globally trusted certificate. It may require a little more work up front, but it is worth it to @@ -213,7 +213,7 @@ Configure the coordinator ^^^^^^^^^^^^^^^^^^^^^^^^^ On the coordinator, add the following lines to the :ref:`config properties file -` to enable TLS/HTTPS support for the server. +` to enable TLS/HTTPS support for the server. .. note:: @@ -261,7 +261,7 @@ re-enable it by setting: http-server.authentication.allow-insecure-over-http=true -.. _verify_tls: +.. _verify-tls: Verify configuration ^^^^^^^^^^^^^^^^^^^^ @@ -297,7 +297,7 @@ Send a query to test the connection: Splits: 1 total, 1 done (100.00%) 0.12 [0 rows, 0B] [0 rows/s, 0B/s] -.. _self_signed_limits: +.. _self-signed-limits: Limitations of self-signed certificates --------------------------------------- diff --git a/docs/src/main/sphinx/sql/create-materialized-view.rst b/docs/src/main/sphinx/sql/create-materialized-view.rst index b2dd6526fde3..99a338c15b0f 100644 --- a/docs/src/main/sphinx/sql/create-materialized-view.rst +++ b/docs/src/main/sphinx/sql/create-materialized-view.rst @@ -55,7 +55,7 @@ operation. The supported properties are different for each connector and detailed in the SQL support section of the specific connector's documentation. After successful creation, all metadata about the materialized view is available -in a :ref:`system table `. +in a :ref:`system table `. Examples -------- diff --git a/docs/src/main/sphinx/sql/match-recognize.rst b/docs/src/main/sphinx/sql/match-recognize.rst index 284a00739609..7cc0480a4186 100644 --- a/docs/src/main/sphinx/sql/match-recognize.rst +++ b/docs/src/main/sphinx/sql/match-recognize.rst @@ -76,7 +76,7 @@ The ``PARTITION BY`` clause allows you to break up the input table into separate sections, that are independently processed for pattern matching. Without a partition declaration, the whole input table is used. This behavior is analogous to the semantics of ``PARTITION BY`` clause in :ref:`window -specification`. In the example, the ``orders`` table is +specification`. In the example, the ``orders`` table is partitioned by the ``custkey`` value, so that pattern matching is performed for all orders of a specific customer independently from orders of other customers. @@ -89,7 +89,7 @@ The optional ``ORDER BY`` clause is generally useful to allow matching on an ordered data set. For example, sorting the input by ``orderdate`` allows for matching on a trend of changes over time. -.. _row_pattern_measures: +.. _row-pattern-measures: Row pattern measures -------------------- @@ -117,16 +117,16 @@ final row of the match. Measure expressions can refer to the columns of the input table. They also allow special syntax to combine the input information with the details of the -match (see :ref:`pattern_recognition_expressions`). +match (see :ref:`pattern-recognition-expressions`). Each measure defines an output column of the pattern recognition. The column can be referenced with the ``measure_name``. The ``MEASURES`` clause is optional. When no measures are specified, certain -input columns (depending on :ref:`ROWS PER MATCH` clause) are +input columns (depending on :ref:`ROWS PER MATCH` clause) are the output of the pattern recognition. -.. _rows_per_match: +.. _rows-per-match: Rows per match -------------- @@ -149,7 +149,7 @@ Rows that are unmatched (that is, neither included in some non-empty match, nor being the starting row of an empty match), are not included in the output. For ``ALL ROWS PER MATCH``, every row of a match produces an output row, unless -it is excluded from the output by the :ref:`exclusion_syntax`. Output consists +it is excluded from the output by the :ref:`exclusion-syntax`. Output consists of ``PARTITION BY`` columns, ``ORDER BY`` columns, measures and remaining columns from the input table. By default, empty matches are shown and unmatched rows are skipped, similarly as with the ``ONE ROW PER MATCH`` option. However, @@ -173,7 +173,7 @@ shows empty matches and produces additional output row for each unmatched row. There are special rules for computing row pattern measures for empty matches and unmatched rows. They are explained in -:ref:`empty_matches_and_unmatched_rows`. +:ref:`empty-matches-and-unmatched-rows`. Unmatched rows can only occur when the pattern does not allow an empty match. Otherwise, they are considered as starting rows of empty matches. The option @@ -181,7 +181,7 @@ Otherwise, they are considered as starting rows of empty matches. The option recognition is expected to pass all input rows, and it is not certain whether the pattern allows an empty match. -.. _after_match_skip: +.. _after-match-skip: After match skip ---------------- @@ -210,8 +210,8 @@ The following ``AFTER MATCH SKIP`` options allow to resume pattern matching based on the components of the pattern. Pattern matching starts from the last (default) or first row matched to a certain row pattern variable. It can be either a primary pattern variable (they are explained in -:ref:`row_pattern_syntax`) or a -:ref:`union variable`:: +:ref:`row-pattern-syntax`) or a +:ref:`union variable`:: AFTER MATCH SKIP TO [ FIRST | LAST ] pattern_variable @@ -226,7 +226,7 @@ detection of overlapping matches. The combination of ``ALL ROWS PER MATCH WITH UNMATCHED ROWS`` with ``AFTER MATCH SKIP PAST LAST ROW`` is the only configuration that guarantees exactly one output row for each input row. -.. _row_pattern_syntax: +.. _row-pattern-syntax: Row pattern syntax ------------------ @@ -241,7 +241,7 @@ The basic element of row pattern is a primary pattern variable. Like pattern matching in character strings searches for characters, pattern matching in row sequences searches for rows which can be "labeled" with certain primary pattern variables. A primary pattern variable has a form of an identifier and is -:ref:`defined` by a boolean condition. This +:ref:`defined` by a boolean condition. This condition determines whether a particular input row can be mapped to this variable and take part in the match. @@ -313,7 +313,7 @@ empty pattern () -.. _exclusion_syntax: +.. _exclusion-syntax: exclusion syntax ^^^^^^^^^^^^^^^^ @@ -392,12 +392,12 @@ repetitions is the least desired option and 5 repetitions -- the most desired. With ``{3, 5}?``, 3 repetitions are most desired. Similarly, ``?`` prefers 1 repetition, while ``??`` prefers 0 repetitions. -.. _row_pattern_union_variables: +.. _row-pattern-union-variables: Row pattern union variables --------------------------- -As explained in :ref:`row_pattern_syntax`, primary pattern variables are the +As explained in :ref:`row-pattern-syntax`, primary pattern variables are the basic elements of row pattern. In addition to primary pattern variables, you can define union variables. They are introduced in the ``SUBSET`` clause:: @@ -417,7 +417,7 @@ access the last row matched to either ``A`` or ``B``. Define ``SUBSET U = failure if ``A`` or ``B`` is not present in the match. ``AFTER MATCH SKIP TO LAST U`` does not fail. -.. _row_pattern_variable_definitions: +.. _row-pattern-variable-definitions: Row pattern variable definitions -------------------------------- @@ -452,15 +452,15 @@ matched to every row. Boolean expressions in the ``DEFINE`` clause allow the same special syntax as expressions in the ``MEASURES`` clause. Details are explained in -:ref:`pattern_recognition_expressions`. +:ref:`pattern-recognition-expressions`. -.. _pattern_recognition_expressions: +.. _pattern-recognition-expressions: Row pattern recognition expressions ----------------------------------- -Expressions in :ref:`MEASURES` and -:ref:`DEFINE` clauses are scalar expressions +Expressions in :ref:`MEASURES` and +:ref:`DEFINE` clauses are scalar expressions evaluated over rows of the input table. They support special syntax, specific to pattern recognition context. They can combine input information with the information about the current match. Special syntax allows to access pattern @@ -618,7 +618,7 @@ Aggregate functions It is allowed to use aggregate functions in a row pattern recognition context. Aggregate functions are evaluated over all rows of the current match or over a subset of rows based on the matched pattern variables. The -:ref:`running and final semantics` are supported, with +:ref:`running and final semantics` are supported, with ``running`` as the default. The following expression returns the average value of the ``totalprice`` column @@ -713,7 +713,7 @@ to support the ``count(*)`` behavior over a limited set of rows:: count(U.*) /* count rows matched to pattern variables from subset U */ -.. _running_and_final: +.. _running-and-final: ``RUNNING`` and ``FINAL`` semantics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -754,7 +754,7 @@ With the option ``ONE ROW PER MATCH``, row pattern measures are evaluated from the position of the final row in the match. Therefore, ``running`` and ``final`` semantics are the same. -.. _empty_matches_and_unmatched_rows: +.. _empty-matches-and-unmatched-rows: Evaluating expressions in empty matches and unmatched rows ---------------------------------------------------------- @@ -779,13 +779,13 @@ When evaluating row pattern measures for an empty match: Like every match, an empty match has its starting row. All input values which are to be output along with the measures (as explained in -:ref:`rows_per_match`), are the values from the starting row. +:ref:`rows-per-match`), are the values from the starting row. An unmatched row is a row that is neither part of any non-empty match nor the starting row of an empty match. With the option ``ALL ROWS PER MATCH WITH UNMATCHED ROWS``, a single output row is produced. In that row, all row pattern measures are ``null``. All input values which are to be output along with the -measures (as explained in :ref:`rows_per_match`), are the values from the +measures (as explained in :ref:`rows-per-match`), are the values from the unmatched row. Using the ``match_number`` function as a measure can help differentiate between an empty match and unmatched row. diff --git a/docs/src/main/sphinx/sql/pattern-recognition-in-window.rst b/docs/src/main/sphinx/sql/pattern-recognition-in-window.rst index a7e6684f9b5e..472d9a96cee0 100644 --- a/docs/src/main/sphinx/sql/pattern-recognition-in-window.rst +++ b/docs/src/main/sphinx/sql/pattern-recognition-in-window.rst @@ -83,18 +83,18 @@ Besides the ``frame_extent``, pattern matching requires the ``PATTERN`` and The ``PATTERN`` clause specifies a row pattern, which is a form of a regular expression with some syntactical extensions. The row pattern syntax is similar -to the :ref:`row pattern syntax in MATCH_RECOGNIZE`. +to the :ref:`row pattern syntax in MATCH_RECOGNIZE`. However, the anchor patterns ``^`` and ``$`` are not allowed in a window specification. The ``DEFINE`` clause defines the row pattern primary variables in terms of boolean conditions that must be satisfied. It is similar to the -:ref:`DEFINE clause of MATCH_RECOGNIZE`. +:ref:`DEFINE clause of MATCH_RECOGNIZE`. The only difference is that the window syntax does not support the ``MATCH_NUMBER`` function. The ``MEASURES`` clause is syntactically similar to the -:ref:`MEASURES clause of MATCH_RECOGNIZE`. The only +:ref:`MEASURES clause of MATCH_RECOGNIZE`. The only limitation is that the ``MATCH_NUMBER`` function is not allowed. However, the semantics of this clause differs between ``MATCH_RECOGNIZE`` and window. While in ``MATCH_RECOGNIZE`` every measure produces an output column, the @@ -127,7 +127,7 @@ performed from the position of the final row of the match, so the semantics is effectively ``FINAL``. The ``AFTER MATCH SKIP`` clause has the same syntax as the -:ref:`AFTER MATCH SKIP clause of MATCH_RECOGNIZE`. +:ref:`AFTER MATCH SKIP clause of MATCH_RECOGNIZE`. The ``INITIAL`` or ``SEEK`` modifier is specific to row pattern recognition in window. With ``INITIAL``, which is the default, the pattern match for an input @@ -137,7 +137,7 @@ from subsequent rows within the frame. As a result, it is possible to associate an input row with a match which is detached from that row. The ``SUBSET`` clause is used to define :ref:`union variables -` as sets of primary pattern variables. You can +` as sets of primary pattern variables. You can use union variables to refer to a set of rows matched to any primary pattern variable from the subset:: diff --git a/docs/src/main/sphinx/sql/select.rst b/docs/src/main/sphinx/sql/select.rst index ad41bfcf71ad..92f4459a3a5e 100644 --- a/docs/src/main/sphinx/sql/select.rst +++ b/docs/src/main/sphinx/sql/select.rst @@ -308,7 +308,7 @@ When a ``GROUP BY`` clause is used in a ``SELECT`` statement all output expressions must be either aggregate functions or columns present in the ``GROUP BY`` clause. -.. _complex_grouping_operations: +.. _complex-grouping-operations: Complex grouping operations ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -635,7 +635,7 @@ with an account balance greater than the specified value:: 1247 | FURNITURE | 8 | 5701952 (7 rows) -.. _window_clause: +.. _window-clause: WINDOW clause ------------- @@ -1031,7 +1031,7 @@ Using sampling with joins:: UNNEST ------ -``UNNEST`` can be used to expand an :ref:`array_type` or :ref:`map_type` into a relation. +``UNNEST`` can be used to expand an :ref:`array-type` or :ref:`map-type` into a relation. Arrays are expanded into a single column:: SELECT * FROM UNNEST(ARRAY[1,2]) AS t(number); @@ -1065,7 +1065,7 @@ Maps are expanded into two columns (key, value):: Java | 1995 (2 rows) -``UNNEST`` can be used in combination with an ``ARRAY`` of :ref:`row_type` structures for expanding each +``UNNEST`` can be used in combination with an ``ARRAY`` of :ref:`row-type` structures for expanding each field of the ``ROW`` into a corresponding column:: SELECT * diff --git a/docs/src/main/sphinx/sql/show-catalogs.rst b/docs/src/main/sphinx/sql/show-catalogs.rst index 75fe7118ce0c..e1bb73b594ac 100644 --- a/docs/src/main/sphinx/sql/show-catalogs.rst +++ b/docs/src/main/sphinx/sql/show-catalogs.rst @@ -14,7 +14,7 @@ Description List the available catalogs. -:ref:`Specify a pattern ` in the optional ``LIKE`` clause to +:ref:`Specify a pattern ` in the optional ``LIKE`` clause to filter the results to the desired subset. For example, the following query allows you to find catalogs that begin with ``t``:: diff --git a/docs/src/main/sphinx/sql/show-columns.rst b/docs/src/main/sphinx/sql/show-columns.rst index 771157be604c..1bed307fd123 100644 --- a/docs/src/main/sphinx/sql/show-columns.rst +++ b/docs/src/main/sphinx/sql/show-columns.rst @@ -14,7 +14,7 @@ Description List the columns in a ``table`` along with their data type and other attributes. -:ref:`Specify a pattern ` in the optional ``LIKE`` clause to +:ref:`Specify a pattern ` in the optional ``LIKE`` clause to filter the results to the desired subset. For example, the following query allows you to find columns ending in ``key``:: diff --git a/docs/src/main/sphinx/sql/show-functions.rst b/docs/src/main/sphinx/sql/show-functions.rst index 62525eee4320..b27a56849d18 100644 --- a/docs/src/main/sphinx/sql/show-functions.rst +++ b/docs/src/main/sphinx/sql/show-functions.rst @@ -22,7 +22,7 @@ the following information is displayed: * Deterministic * Description -:ref:`Specify a pattern ` in the optional ``LIKE`` clause to +:ref:`Specify a pattern ` in the optional ``LIKE`` clause to filter the results to the desired subset. For example, the following query allows you to find functions beginning with ``array``:: diff --git a/docs/src/main/sphinx/sql/show-schemas.rst b/docs/src/main/sphinx/sql/show-schemas.rst index 06c66b0feda7..8b25ca6fbb1d 100644 --- a/docs/src/main/sphinx/sql/show-schemas.rst +++ b/docs/src/main/sphinx/sql/show-schemas.rst @@ -14,7 +14,7 @@ Description List the schemas in ``catalog`` or in the current catalog. -:ref:`Specify a pattern ` in the optional ``LIKE`` clause to +:ref:`Specify a pattern ` in the optional ``LIKE`` clause to filter the results to the desired subset. For example, the following query allows you to find schemas that have ``3`` as the third character:: diff --git a/docs/src/main/sphinx/sql/show-session.rst b/docs/src/main/sphinx/sql/show-session.rst index 211a0136613d..72aee1cf7bbc 100644 --- a/docs/src/main/sphinx/sql/show-session.rst +++ b/docs/src/main/sphinx/sql/show-session.rst @@ -14,7 +14,7 @@ Description List the current :ref:`session properties `. -:ref:`Specify a pattern ` in the optional ``LIKE`` clause to +:ref:`Specify a pattern ` in the optional ``LIKE`` clause to filter the results to the desired subset. For example, the following query allows you to find session properties that begin with ``query``:: diff --git a/docs/src/main/sphinx/sql/show-tables.rst b/docs/src/main/sphinx/sql/show-tables.rst index d0f1365be675..e4bbe3447eba 100644 --- a/docs/src/main/sphinx/sql/show-tables.rst +++ b/docs/src/main/sphinx/sql/show-tables.rst @@ -14,7 +14,7 @@ Description List the tables in ``schema`` or in the current schema. -:ref:`Specify a pattern ` in the optional ``LIKE`` clause to +:ref:`Specify a pattern ` in the optional ``LIKE`` clause to filter the results to the desired subset.. For example, the following query allows you to find tables that begin with ``p``::