From 4394ce9f5a8c549d47c06987f2966e71ef50109e Mon Sep 17 00:00:00 2001 From: Ashhar Hasan Date: Fri, 23 Jul 2021 13:32:07 +0530 Subject: [PATCH] Split general configuration properties to their own fragment --- docs/src/main/sphinx/connector/clickhouse.rst | 2 ++ docs/src/main/sphinx/connector/druid.rst | 2 ++ .../jdbc-common-configurations.fragment | 27 +++++++++++++++++++ .../connector/jdbc-type-mapping.fragment | 14 ---------- docs/src/main/sphinx/connector/memsql.rst | 2 ++ docs/src/main/sphinx/connector/mysql.rst | 2 ++ docs/src/main/sphinx/connector/oracle.rst | 2 ++ docs/src/main/sphinx/connector/phoenix.rst | 9 +++---- docs/src/main/sphinx/connector/postgresql.rst | 2 ++ docs/src/main/sphinx/connector/redshift.rst | 2 ++ docs/src/main/sphinx/connector/sqlserver.rst | 2 ++ 11 files changed, 47 insertions(+), 19 deletions(-) create mode 100644 docs/src/main/sphinx/connector/jdbc-common-configurations.fragment diff --git a/docs/src/main/sphinx/connector/clickhouse.rst b/docs/src/main/sphinx/connector/clickhouse.rst index 18fe94337ab02..c67efe39a40f2 100644 --- a/docs/src/main/sphinx/connector/clickhouse.rst +++ b/docs/src/main/sphinx/connector/clickhouse.rst @@ -34,6 +34,8 @@ appropriate for your setup: connection-user=exampleuser connection-password=examplepassword +.. include:: jdbc-common-configurations.fragment + Multiple ClickHouse servers ^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/connector/druid.rst b/docs/src/main/sphinx/connector/druid.rst index 3e7192abe96db..2428ca4a50e04 100644 --- a/docs/src/main/sphinx/connector/druid.rst +++ b/docs/src/main/sphinx/connector/druid.rst @@ -42,6 +42,8 @@ secured by basic authentication by updating the URL and adding credentials: Now you can access your Druid database in Trino with the ``druiddb`` catalog name from the properties file. +.. include:: jdbc-common-configurations.fragment + .. _druid-type-mapping: Type mapping diff --git a/docs/src/main/sphinx/connector/jdbc-common-configurations.fragment b/docs/src/main/sphinx/connector/jdbc-common-configurations.fragment new file mode 100644 index 0000000000000..0a79ea8fc9a2c --- /dev/null +++ b/docs/src/main/sphinx/connector/jdbc-common-configurations.fragment @@ -0,0 +1,27 @@ +General configuration properties +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following table describes general configuration properties for the +connector: + +.. list-table:: + :widths: 30, 40, 30 + :header-rows: 1 + + * - Property name + - Description + - Default value + * - ``case-insensitive-name-matching`` + - Support case insensitive database and collection names + - False + * - ``case-insensitive-name-matching.cache-ttl`` + - + - 1 minute + * - ``metadata.cache-ttl`` + - Duration for which metadata, including table and column statistics, is + cached + - 0 (disabled caching) + * - ``metadata.cache-missing`` + - Cache the fact that metadata, including table and column statistics, is + not available + - False diff --git a/docs/src/main/sphinx/connector/jdbc-type-mapping.fragment b/docs/src/main/sphinx/connector/jdbc-type-mapping.fragment index 9991af35b0150..fd5c193810d0b 100644 --- a/docs/src/main/sphinx/connector/jdbc-type-mapping.fragment +++ b/docs/src/main/sphinx/connector/jdbc-type-mapping.fragment @@ -24,17 +24,3 @@ cached in Trino. - Allow forced mapping of comma separated lists of data types to convert to unbounded ``VARCHAR`` - - * - ``case-insensitive-name-matching`` - - Support case insensitive database and collection names - - False - * - ``case-insensitive-name-matching.cache-ttl`` - - - - 1 minute - * - ``metadata.cache-ttl`` - - Duration for which metadata, including table and column statistics, is - cached - - 0 (disabled caching) - * - ``metadata.cache-missing`` - - Cache the fact that metadata, including table and column statistics, is - not available - - False diff --git a/docs/src/main/sphinx/connector/memsql.rst b/docs/src/main/sphinx/connector/memsql.rst index d134d656f5f2a..2bc6e6c794cbe 100644 --- a/docs/src/main/sphinx/connector/memsql.rst +++ b/docs/src/main/sphinx/connector/memsql.rst @@ -32,6 +32,8 @@ connection properties as appropriate for your setup: connection-user=root connection-password=secret +.. include:: jdbc-common-configurations.fragment + Multiple SingleStore servers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/connector/mysql.rst b/docs/src/main/sphinx/connector/mysql.rst index 2c883218920b1..8c056ede06386 100644 --- a/docs/src/main/sphinx/connector/mysql.rst +++ b/docs/src/main/sphinx/connector/mysql.rst @@ -50,6 +50,8 @@ determine the user credentials for the connection, often a service user. You can use :doc:`secrets ` to avoid actual values in the catalog properties files. +.. include:: jdbc-common-configurations.fragment + Multiple MySQL servers ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/connector/oracle.rst b/docs/src/main/sphinx/connector/oracle.rst index aa21269fbdbf9..85372f8acc605 100644 --- a/docs/src/main/sphinx/connector/oracle.rst +++ b/docs/src/main/sphinx/connector/oracle.rst @@ -51,6 +51,8 @@ To disable connection pooling, update properties to include the following: oracle.connection-pool.enabled=false +.. include:: jdbc-common-configurations.fragment + Multiple Oracle servers ^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/connector/phoenix.rst b/docs/src/main/sphinx/connector/phoenix.rst index 992e462e0f152..d824de74cfaec 100644 --- a/docs/src/main/sphinx/connector/phoenix.rst +++ b/docs/src/main/sphinx/connector/phoenix.rst @@ -44,10 +44,7 @@ For HBase 2.x and Phoenix 5.x (5.1.0 or later) use: connector.name=phoenix5 -Configuration properties ------------------------- - -The following configuration properties are available: +The following Phoenix-specific configuration properties are available: ================================================== ========== =================================================================================== Property Name Required Description @@ -61,6 +58,8 @@ Property Name Required Description connection properties. These files must exist on the machines running Trino. ================================================== ========== =================================================================================== +.. include:: jdbc-common-configurations.fragment + Querying Phoenix tables ------------------------- @@ -185,4 +184,4 @@ Property Name Default Value Description SQL support ----------- -.. include:: sql-delete-limitation.fragment \ No newline at end of file +.. include:: sql-delete-limitation.fragment diff --git a/docs/src/main/sphinx/connector/postgresql.rst b/docs/src/main/sphinx/connector/postgresql.rst index 900cafab9bef1..4f786985a54c8 100644 --- a/docs/src/main/sphinx/connector/postgresql.rst +++ b/docs/src/main/sphinx/connector/postgresql.rst @@ -46,6 +46,8 @@ determine the user credentials for the connection, often a service user. You can use :doc:`secrets ` to avoid actual values in the catalog properties files. +.. include:: jdbc-common-configurations.fragment + Multiple PostgreSQL databases or servers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/connector/redshift.rst b/docs/src/main/sphinx/connector/redshift.rst index 72d14a24f3519..514a2c6f1f74f 100644 --- a/docs/src/main/sphinx/connector/redshift.rst +++ b/docs/src/main/sphinx/connector/redshift.rst @@ -31,6 +31,8 @@ connection properties as appropriate for your setup: connection-user=root connection-password=secret +.. include:: jdbc-common-configurations.fragment + Multiple Redshift databases or clusters ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/src/main/sphinx/connector/sqlserver.rst b/docs/src/main/sphinx/connector/sqlserver.rst index f8a7b7ef61d20..e795f2b560246 100644 --- a/docs/src/main/sphinx/connector/sqlserver.rst +++ b/docs/src/main/sphinx/connector/sqlserver.rst @@ -44,6 +44,8 @@ determine the user credentials for the connection, often a service user. You can use :doc:`secrets ` to avoid actual values in the catalog properties files. +.. include:: jdbc-common-configurations.fragment + Multiple SQL Server databases or servers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^