diff --git a/docs/src/main/sphinx/admin/spill.rst b/docs/src/main/sphinx/admin/spill.rst index 9dac8a4678eb..6461ad6d0890 100644 --- a/docs/src/main/sphinx/admin/spill.rst +++ b/docs/src/main/sphinx/admin/spill.rst @@ -57,7 +57,7 @@ is running and writing logs. Doing so may lead to cluster instability. Additiona it is recommended to monitor the disk saturation of the configured spill paths. Trino treats spill paths as independent disks (see `JBOD -`_), so +`_), so there is no need to use RAID for spill. Spill compression diff --git a/docs/src/main/sphinx/client/cli.rst b/docs/src/main/sphinx/client/cli.rst index 938613998dd8..54ee02e18afe 100644 --- a/docs/src/main/sphinx/client/cli.rst +++ b/docs/src/main/sphinx/client/cli.rst @@ -199,7 +199,7 @@ mode: :doc:`/admin/resource-groups`. * - ``--timezone`` - Sets the time zone for the session using the `time zone name - `_. Defaults + `_. Defaults to the timezone set on your workstation. * - ``--user`` - Sets the username for :ref:`cli-username-password-auth`. Defaults to your diff --git a/docs/src/main/sphinx/client/jdbc.rst b/docs/src/main/sphinx/client/jdbc.rst index d0a9801b3c2a..98ccc4b97028 100644 --- a/docs/src/main/sphinx/client/jdbc.rst +++ b/docs/src/main/sphinx/client/jdbc.rst @@ -2,7 +2,7 @@ JDBC driver =========== -The Trino `JDBC driver `_ allows +The Trino `JDBC driver `_ allows users to access Trino using Java-based applications, and other non-Java applications running in a JVM. Both desktop and server-side applications, such as those used for reporting and database development, use the JDBC driver. diff --git a/docs/src/main/sphinx/connector/bigquery.rst b/docs/src/main/sphinx/connector/bigquery.rst index 3f637b4859b9..f09894a00186 100644 --- a/docs/src/main/sphinx/connector/bigquery.rst +++ b/docs/src/main/sphinx/connector/bigquery.rst @@ -220,7 +220,7 @@ to the following table: - Time zone is UTC * - ``GEOGRAPHY`` - ``VARCHAR`` - - In `Well-known text (WKT) `_ format + - In `Well-known text (WKT) `_ format * - ``ARRAY`` - ``ARRAY`` - diff --git a/docs/src/main/sphinx/connector/hive-azure.rst b/docs/src/main/sphinx/connector/hive-azure.rst index 5a0111bf3077..032ae1544bfd 100644 --- a/docs/src/main/sphinx/connector/hive-azure.rst +++ b/docs/src/main/sphinx/connector/hive-azure.rst @@ -78,7 +78,7 @@ catalog configuration. secret for your ADLS Gen1 account's App Registration, and save this value because you won't able to retrieve the key later. Refer to the Azure `documentation - `_ + `_ for details. .. list-table:: ADLS properties diff --git a/docs/src/main/sphinx/connector/sqlserver.rst b/docs/src/main/sphinx/connector/sqlserver.rst index 0dfc8d9cd17c..3ff776295ac5 100644 --- a/docs/src/main/sphinx/connector/sqlserver.rst +++ b/docs/src/main/sphinx/connector/sqlserver.rst @@ -41,7 +41,7 @@ appropriate for your setup: The ``connection-url`` defines the connection information and parameters to pass to the SQL Server JDBC driver. The supported parameters for the URL are available in the `SQL Server JDBC driver documentation -`_. +`_. The ``connection-user`` and ``connection-password`` are typically required and determine the user credentials for the connection, often a service user. You can @@ -67,7 +67,7 @@ encryption in the connection string with the ``encrypt`` property: Further parameters like ``trustServerCertificate``, ``hostNameInCertificate``, ``trustStore``, and ``trustStorePassword`` are details in the `TLS section of SQL Server JDBC driver documentation -`_. +`_. .. include:: jdbc-authentication.fragment @@ -281,7 +281,7 @@ The connector maps Trino types to the corresponding SQL Server types following t - ``0 <= n <= 7`` Complete list of `SQL Server data types -`_. +`_. .. _sqlserver-numeric-mapping: @@ -444,12 +444,12 @@ Bulk insert ^^^^^^^^^^^ You can optionally use the `bulk copy API -`_ +`_ to drastically speed up write operations. Enable bulk copying and a lock on the destination table to meet `minimal logging requirements -`_. +`_. The following table shows the relevant catalog configuration properties and their default values: @@ -481,7 +481,7 @@ Data compression ---------------- You can specify the `data compression policy for SQL Server tables -`_ +`_ with the ``data_compression`` table property. Valid policies are ``NONE``, ``ROW`` or ``PAGE``. Example:: diff --git a/docs/src/main/sphinx/functions/binary.rst b/docs/src/main/sphinx/functions/binary.rst index 745630157e32..4d444b4bfd15 100644 --- a/docs/src/main/sphinx/functions/binary.rst +++ b/docs/src/main/sphinx/functions/binary.rst @@ -180,7 +180,7 @@ Hashing functions .. function:: murmur3(binary) -> varbinary - Computes the 128-bit `MurmurHash3 `_ + Computes the 128-bit `MurmurHash3 `_ hash of ``binary``. SELECT murmur3(from_base64('aaaaaa')); diff --git a/docs/src/main/sphinx/functions/datetime.rst b/docs/src/main/sphinx/functions/datetime.rst index 7f16a2465141..bea9d12b0a72 100644 --- a/docs/src/main/sphinx/functions/datetime.rst +++ b/docs/src/main/sphinx/functions/datetime.rst @@ -527,7 +527,7 @@ Convenience extraction functions Returns the `ISO week`_ of the year from ``x``. The value ranges from ``1`` to ``53``. - .. _ISO week: https://en.wikipedia.org/wiki/ISO_week_date + .. _ISO week: https://wikipedia.org/wiki/ISO_week_date .. function:: week_of_year(x) -> bigint diff --git a/docs/src/main/sphinx/functions/geospatial.rst b/docs/src/main/sphinx/functions/geospatial.rst index cc4ed118f0dd..8519bfefe533 100644 --- a/docs/src/main/sphinx/functions/geospatial.rst +++ b/docs/src/main/sphinx/functions/geospatial.rst @@ -439,7 +439,7 @@ Bing tiles ---------- These functions convert between geometries and -`Bing tiles `_. +`Bing tiles `_. .. function:: bing_tile(x, y, zoom_level) -> BingTile diff --git a/docs/src/main/sphinx/functions/hyperloglog.rst b/docs/src/main/sphinx/functions/hyperloglog.rst index 387ab46fdf1e..548e4133f456 100644 --- a/docs/src/main/sphinx/functions/hyperloglog.rst +++ b/docs/src/main/sphinx/functions/hyperloglog.rst @@ -3,7 +3,7 @@ HyperLogLog functions ===================== Trino implements the :func:`approx_distinct` function using the -`HyperLogLog `_ data structure. +`HyperLogLog `_ data structure. Data structures --------------- diff --git a/docs/src/main/sphinx/functions/setdigest.rst b/docs/src/main/sphinx/functions/setdigest.rst index 1dca5c41e9f1..24d38cf2c9c6 100644 --- a/docs/src/main/sphinx/functions/setdigest.rst +++ b/docs/src/main/sphinx/functions/setdigest.rst @@ -3,10 +3,10 @@ Set Digest functions ==================== Trino offers several functions that deal with the -`MinHash `_ technique. +`MinHash `_ technique. MinHash is used to quickly estimate the -`Jaccard similarity coefficient `_ +`Jaccard similarity coefficient `_ between two sets. It is commonly used in data mining to detect near-duplicate web pages at scale. @@ -16,7 +16,7 @@ within the search results two pages that are nearly identical. The following example showcases how the Set Digest functions can be used to naively estimate the similarity between texts. The input texts are split by using the function :func:`ngrams` to -`4-shingles `_ which are +`4-shingles `_ which are used as input for creating a set digest of each initial text. The set digests are compared to each other to get an approximation of the similarity of their corresponding @@ -85,8 +85,8 @@ Data structures Trino implements Set Digest data sketches by encapsulating the following components: -- `HyperLogLog `_ -- `MinHash with a single hash function `_ +- `HyperLogLog `_ +- `MinHash with a single hash function `_ The HyperLogLog structure is used for the approximation of the distinct elements in the original set. @@ -152,7 +152,7 @@ Functions .. function:: jaccard_index(x, y) -> double - Returns the estimation of `Jaccard index `_ for + Returns the estimation of `Jaccard index `_ for the two set digests. ``x`` and ``y`` must be of type ``setdigest``. @@ -165,7 +165,7 @@ Functions .. function:: hash_counts(x) -> map(bigint, smallint) - Returns a map containing the `Murmur3Hash128 `_ + Returns a map containing the `Murmur3Hash128 `_ hashed values and the count of their occurences within the internal ``MinHash`` structure belonging to ``x``. diff --git a/docs/src/main/sphinx/functions/string.rst b/docs/src/main/sphinx/functions/string.rst index ba1228e2d2ed..fa374ca62556 100644 --- a/docs/src/main/sphinx/functions/string.rst +++ b/docs/src/main/sphinx/functions/string.rst @@ -98,7 +98,7 @@ String functions .. function:: luhn_check(string) -> boolean Tests whether a ``string`` of digits is valid according to the - `Luhn algorithm `_. + `Luhn algorithm `_. This checksum function, also known as ``modulo 10`` or ``mod 10``, is widely applied on credit card numbers and government identification numbers diff --git a/docs/src/main/sphinx/glossary.rst b/docs/src/main/sphinx/glossary.rst index c040b4946361..acf8156530b2 100644 --- a/docs/src/main/sphinx/glossary.rst +++ b/docs/src/main/sphinx/glossary.rst @@ -23,10 +23,10 @@ Certificate Authority (CA) Certificate A public key `certificate - `_ issued by a - :ref:`CA `, sometimes abbreviated as cert, that verifies the - ownership of a server's private keys. Certificate format is specified in the - `X.509 `_ standard. + `_ issued by a :ref:`CA + `, sometimes abbreviated as cert, that verifies the ownership of a + server's private keys. Certificate format is specified in the `X.509 + `_ standard. Cluster A Trino cluster provides the resources to run queries against numerous data @@ -54,47 +54,47 @@ Container .. _glossDataVirtualization: Data virtualization - `Data virtualization `_ - is a method of abstracting an interaction with multiple - :ref:`heterogeneous data sources `, without needing to know - the distributed nature of the data, its format, or any other technical - details involved in presenting the data. + `Data virtualization `_ is a + method of abstracting an interaction with multiple :ref:`heterogeneous data + sources `, without needing to know the distributed nature + of the data, its format, or any other technical details involved in + presenting the data. .. _glossDataSource: Data source - A system from which data is retrieved, for example, PostgreSQL or Iceberg on S3 - data. In Trino, users query data sources with :ref:`catalogs ` - that connect to each source. See :ref:`trino-concept-data-sources` for more - information. + A system from which data is retrieved, for example, PostgreSQL or Iceberg on + S3 data. In Trino, users query data sources with :ref:`catalogs + ` that connect to each source. See + :ref:`trino-concept-data-sources` for more information. .. _glossGzip: gzip - `gzip `_ is a compression format and + `gzip `_ is a compression format and software that compresses and decompresses files. This format is used several - ways in Trino, including deployment and compressing files in - :ref:`object storage `. The most common extension for - gzip-compressed files is ``.gz``. + ways in Trino, including deployment and compressing files in :ref:`object + storage `. The most common extension for gzip-compressed + files is ``.gz``. .. _glossHDFS: HDFS - `Hadoop Distributed Filesystem (HDFS) `_ - is a scalable :ref:`open source ` filesystem that was one - of the earliest distributed big data systems created to store large amounts - of data for the - `Hadoop ecosystem `_. + `Hadoop Distributed Filesystem (HDFS) + `_ is a scalable :ref:`open + source ` filesystem that was one of the earliest + distributed big data systems created to store large amounts of data for the + `Hadoop ecosystem `_. .. _glossJKS: Java KeyStore (JKS) The system of public key cryptography supported as one part of the Java - security APIs. The legacy JKS system recognizes keys and - :ref:`certificates ` stored in *keystore* files, typically with - the ``.jks`` extension, and by default relies on a system-level list of - :ref:`CAs ` in *truststore* files installed as part of the current - Java installation. + security APIs. The legacy JKS system recognizes keys and :ref:`certificates + ` stored in *keystore* files, typically with the ``.jks`` + extension, and by default relies on a system-level list of :ref:`CAs + ` in *truststore* files installed as part of the current Java + installation. Key A cryptographic key specified as a pair of public and private strings @@ -112,39 +112,37 @@ Load Balancer (LB) .. _glossObjectStorage: Object Storage - `Object storage `_ is a file - storage mechanism that stores data in a flat namespace, as opposed - to hierarchical filesystems. Files written in object storage are immutable, + `Object storage `_ is a file + storage mechanism that stores data in a flat namespace, as opposed to + hierarchical filesystems. Files written in object storage are immutable, meaning you cannot update a file but just overwrite or replace the entire - file. In the context of Trino, object storage commonly refers to - `cloud storage `_ - technologies such as `Amazon S3 `_, - `Google Cloud Storage `_, and - `Azure Blob Storage `_. - In addition to cloud-hosted services, there are also local object storage - options such as `MinIO `_ and - `Ceph `_ that are compatible with S3. Object storage - became a popular replacement to :ref:`HDFS `. + file. In the context of Trino, object storage commonly refers to `cloud + storage `_ + technologies such as `Amazon S3 `_, `Google Cloud + Storage `_, and `Azure Blob Storage + `_. In addition to + cloud-hosted services, there are also local object storage options such as + `MinIO `_ and `Ceph `_ that are + compatible with S3. Object storage became a popular replacement to + :ref:`HDFS `. .. _glossOpenSource: Open-source - Typically refers to - `open-source software `_. - which is software that has the source code made available for others to see, - use, and contribute to. Allowed usage varies depending on the license that - the software is licensed under. Trino is licensed under the - `Apache license `_, and is - therefore maintained by a community of contributors from all across the - globe. + Typically refers to `open-source software + `_. which is software that + has the source code made available for others to see, use, and contribute + to. Allowed usage varies depending on the license that the software is + licensed under. Trino is licensed under the `Apache license + `_, and is therefore maintained + by a community of contributors from all across the globe. .. _glossPlugin: Plugin - A bundle of code implementing the Trino - :doc:`Service Provider Interface (SPI) ` that is used - to add new :ref:`connectors `, - :doc:`data types `, :doc:`functions`, + A bundle of code implementing the Trino :doc:`Service Provider Interface + (SPI) ` that is used to add new :ref:`connectors + `, :doc:`data types `, :doc:`functions`, :doc:`access control implementations `, and other features of Trino. @@ -160,13 +158,14 @@ PEM file format PKCS #12 A binary archive used to store keys and certificates or certificate chains - that validate a key. `PKCS #12 `_ - files have ``.p12`` or ``.pfx`` extensions. This format is a less popular + that validate a key. `PKCS #12 `_ files + have ``.p12`` or ``.pfx`` extensions. This format is a less popular alternative to :ref:`PEM `. Presto and PrestoSQL The old name for Trino. To learn more about the name change to Trino, read - `the history `_. + `the history + `_. Query Federation A type of :ref:`data virtualization ` that provides a @@ -187,17 +186,17 @@ Structured Query Language (SQL) see :doc:`SQL `. Tarball - A common abbreviation for - `TAR file `_, which is a - common software distribution mechanism. This file format is a collection of - multiple files distributed as a single file, commonly compressed using - :ref:`gzip ` compression. + A common abbreviation for `TAR file + `_, which is a common software + distribution mechanism. This file format is a collection of multiple files + distributed as a single file, commonly compressed using :ref:`gzip + ` compression. .. _glossTLS: Transport Layer Security (TLS) - `TLS `_ is a - security protocol designed to provide secure communications over a network. - It is the successor to :ref:`SSL `, and used in many applications - like HTTPS, email, and Trino. These security topics use the term TLS to - refer to both TLS and SSL. + `TLS `_ is a security + protocol designed to provide secure communications over a network. It is the + successor to :ref:`SSL `, and used in many applications like + HTTPS, email, and Trino. These security topics use the term TLS to refer to + both TLS and SSL. diff --git a/docs/src/main/sphinx/installation/kubernetes.rst b/docs/src/main/sphinx/installation/kubernetes.rst index 58228a363bd5..e7b5aeee5b22 100644 --- a/docs/src/main/sphinx/installation/kubernetes.rst +++ b/docs/src/main/sphinx/installation/kubernetes.rst @@ -9,7 +9,7 @@ using tools like `kind `_, to running on a managed Kubernetes service on cloud services like `Amazon Elastic Kubernetes Service `_, `Google Kubernetes Engine `_, -`Azure Kubernetes Service `_, +`Azure Kubernetes Service `_, and others. The fastest way to run Trino on Kubernetes is to use the diff --git a/docs/src/main/sphinx/language/types.rst b/docs/src/main/sphinx/language/types.rst index 57111855a9a9..f4a424e7913c 100644 --- a/docs/src/main/sphinx/language/types.rst +++ b/docs/src/main/sphinx/language/types.rst @@ -377,7 +377,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 `_ data sketch. See :doc:`/functions/hyperloglog`. .. _hyperloglog_type: @@ -404,13 +404,13 @@ SetDigest ^^^^^^^^^^^^^ A SetDigest (setdigest) is a data sketch structure used -in calculating `Jaccard similarity coefficient `_ +in calculating `Jaccard similarity coefficient `_ between two sets. SetDigest encapsulates the following components: -- `HyperLogLog `_ -- `MinHash with a single hash function `_ +- `HyperLogLog `_ +- `MinHash with a single hash function `_ The HyperLogLog structure is used for the approximation of the distinct elements in the original set. diff --git a/docs/src/main/sphinx/security/jwt.rst b/docs/src/main/sphinx/security/jwt.rst index 002a80cceea7..a37b102143ae 100644 --- a/docs/src/main/sphinx/security/jwt.rst +++ b/docs/src/main/sphinx/security/jwt.rst @@ -3,7 +3,7 @@ JWT authentication ================== Trino can be configured to authenticate client access using `JSON web tokens -`_. A JWT is a small, web-safe +`_. A JWT is a small, web-safe JSON file that contains cryptographic information similar to a certificate, including: @@ -125,7 +125,7 @@ either: protocol for short-term testing during development of your cluster. - The path to a local file in :doc:`PEM ` or `HMAC - `_ format that contains a single key. + `_ format that contains a single key. If the file path contains ``$KEYID``, then Trino interpolates the ``keyid`` from the JWT into the file path before loading this key. This enables support for setups with multiple keys. diff --git a/docs/src/main/sphinx/security/tls.rst b/docs/src/main/sphinx/security/tls.rst index f4df47a3a247..141b38ee9658 100644 --- a/docs/src/main/sphinx/security/tls.rst +++ b/docs/src/main/sphinx/security/tls.rst @@ -101,7 +101,7 @@ typically runs with default HTTP configuration on the default port, 8080. When a load balancer accepts a TLS encrypted connection, it adds a `forwarded -`_ +`_ HTTP header to the request, such as ``X-Forwarded-Proto: https``. This tells the Trino coordinator to process the connection as if a TLS