diff --git a/docs/src/main/sphinx/connector/accumulo.rst b/docs/src/main/sphinx/connector/accumulo.rst index 9e9f3c3ca7a8..9fff1e764842 100644 --- a/docs/src/main/sphinx/connector/accumulo.rst +++ b/docs/src/main/sphinx/connector/accumulo.rst @@ -37,8 +37,8 @@ To connect to Accumulo, you need: Connector configuration ----------------------- -Create ``etc/catalog/accumulo.properties`` -to mount the ``accumulo`` connector as the ``accumulo`` catalog, +Create ``etc/catalog/example.properties`` +to mount the ``accumulo`` connector as the ``example`` catalog, replacing the ``accumulo.xxx`` properties as required: .. code-block:: text @@ -463,7 +463,7 @@ Session properties You can change the default value of a session property by using :doc:`/sql/set-session`. Note that session properties are prefixed with the catalog name:: - SET SESSION accumulo.column_filter_optimizations_enabled = false; + SET SESSION example.column_filter_optimizations_enabled = false; ============================================= ============= ======================================================================================================= Property name Default value Description diff --git a/docs/src/main/sphinx/connector/bigquery.rst b/docs/src/main/sphinx/connector/bigquery.rst index 12e5dda837a3..02f9ac34e44a 100644 --- a/docs/src/main/sphinx/connector/bigquery.rst +++ b/docs/src/main/sphinx/connector/bigquery.rst @@ -65,8 +65,8 @@ Configuration ------------- To configure the BigQuery connector, create a catalog properties file in -``etc/catalog`` named, for example, ``bigquery.properties``, to mount the -BigQuery connector as the ``bigquery`` catalog. Create the file with the +``etc/catalog`` named, for example, ``example.properties``, to mount the +BigQuery connector as the ``example`` catalog. Create the file with the following contents, replacing the connection properties as appropriate for your setup: diff --git a/docs/src/main/sphinx/connector/blackhole.rst b/docs/src/main/sphinx/connector/blackhole.rst index e9ae0c8f8923..a8364b856619 100644 --- a/docs/src/main/sphinx/connector/blackhole.rst +++ b/docs/src/main/sphinx/connector/blackhole.rst @@ -25,7 +25,7 @@ Configuration ------------- To configure the Black Hole connector, create a catalog properties file -``etc/catalog/blackhole.properties`` with the following contents: +``etc/catalog/example.properties`` with the following contents: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/cassandra.rst b/docs/src/main/sphinx/connector/cassandra.rst index 474ba262d7a8..2bbe49c1c389 100644 --- a/docs/src/main/sphinx/connector/cassandra.rst +++ b/docs/src/main/sphinx/connector/cassandra.rst @@ -22,7 +22,7 @@ Configuration ------------- To configure the Cassandra connector, create a catalog properties file -``etc/catalog/cassandra.properties`` with the following contents, +``etc/catalog/example.properties`` with the following contents, replacing ``host1,host2`` with a comma-separated list of the Cassandra nodes, used to discovery the cluster topology: diff --git a/docs/src/main/sphinx/connector/clickhouse.rst b/docs/src/main/sphinx/connector/clickhouse.rst index 8914df2d9c73..23731de62716 100644 --- a/docs/src/main/sphinx/connector/clickhouse.rst +++ b/docs/src/main/sphinx/connector/clickhouse.rst @@ -27,8 +27,8 @@ The connector can query a ClickHouse server. Create a catalog properties file that specifies the ClickHouse connector by setting the ``connector.name`` to ``clickhouse``. -For example, to access a server as ``clickhouse``, create the file -``etc/catalog/clickhouse.properties``. Replace the connection properties as +For example, to access a server as ``example``, create the file +``etc/catalog/example.properties``. Replace the connection properties as appropriate for your setup: .. code-block:: none diff --git a/docs/src/main/sphinx/connector/delta-lake.rst b/docs/src/main/sphinx/connector/delta-lake.rst index 3f333037e01e..51941f6bab7a 100644 --- a/docs/src/main/sphinx/connector/delta-lake.rst +++ b/docs/src/main/sphinx/connector/delta-lake.rst @@ -44,7 +44,7 @@ runtime. If non-Delta tables are present in the metastore, as well, they are not visible to the connector. To configure the Delta Lake connector, create a catalog properties file, for -example ``etc/catalog/delta.properties``, that references the ``delta-lake`` +example ``etc/catalog/example.properties``, that references the ``delta-lake`` connector. Update the ``hive.metastore.uri`` with the URI of your Hive metastore Thrift service: diff --git a/docs/src/main/sphinx/connector/druid.rst b/docs/src/main/sphinx/connector/druid.rst index 07f716f0b82b..2a3ee9720d4c 100644 --- a/docs/src/main/sphinx/connector/druid.rst +++ b/docs/src/main/sphinx/connector/druid.rst @@ -25,8 +25,8 @@ Create a catalog properties file that specifies the Druid connector by setting the ``connector.name`` to ``druid`` and configuring the ``connection-url`` with the JDBC string to connect to Druid. -For example, to access a database as ``druid``, create the file -``etc/catalog/druid.properties``. Replace ``BROKER:8082`` with the correct +For example, to access a database as ``example``, create the file +``etc/catalog/example.properties``. Replace ``BROKER:8082`` with the correct host and port of your Druid broker. .. code-block:: properties diff --git a/docs/src/main/sphinx/connector/elasticsearch.rst b/docs/src/main/sphinx/connector/elasticsearch.rst index ea1b2cf70984..5f19b8282001 100644 --- a/docs/src/main/sphinx/connector/elasticsearch.rst +++ b/docs/src/main/sphinx/connector/elasticsearch.rst @@ -17,7 +17,7 @@ Configuration ------------- To configure the Elasticsearch connector, create a catalog properties file -``etc/catalog/elasticsearch.properties`` with the following contents, +``etc/catalog/example.properties`` with the following contents, replacing the properties as appropriate: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/googlesheets.rst b/docs/src/main/sphinx/connector/googlesheets.rst index 97042c9be4aa..d61671803fbd 100644 --- a/docs/src/main/sphinx/connector/googlesheets.rst +++ b/docs/src/main/sphinx/connector/googlesheets.rst @@ -11,8 +11,8 @@ The Google Sheets connector allows reading `Google Sheets `: @@ -409,7 +409,7 @@ Setup a live Twitter feed Create a tweets table on Trino ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Add the tweets table to the ``etc/catalog/kafka.properties`` file: +Add the tweets table to the ``etc/catalog/example.properties`` file: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/kafka.rst b/docs/src/main/sphinx/connector/kafka.rst index f474a879233d..b3d164866029 100644 --- a/docs/src/main/sphinx/connector/kafka.rst +++ b/docs/src/main/sphinx/connector/kafka.rst @@ -39,13 +39,13 @@ Configuration ------------- To configure the Kafka connector, create a catalog properties file -``etc/catalog/kafka.properties`` with the following content, +``etc/catalog/example.properties`` with the following contents, replacing the properties as appropriate. In some cases, such as when using specialized authentication methods, it is necessary to specify additional Kafka client properties in order to access your Kafka cluster. To do so, add the ``kafka.config.resources`` property to reference your Kafka config files. Note that configs -can be overwritten if defined explicitly in ``kafka.properties``: +can be overwritten if defined explicitly in ``example.properties``: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/kinesis.rst b/docs/src/main/sphinx/connector/kinesis.rst index 78959072d99f..ce11ef92779c 100644 --- a/docs/src/main/sphinx/connector/kinesis.rst +++ b/docs/src/main/sphinx/connector/kinesis.rst @@ -23,8 +23,9 @@ stored on Amazon S3 (preferred), or stored in a local directory on each Trino no This connector is a **read-only** connector. It can only fetch data from Kinesis streams, but cannot create streams or push data into existing streams. -To configure the Kinesis connector, create a catalog properties file ``etc/catalog/kinesis.properties`` -with the following contents, replacing the properties as appropriate: +To configure the Kinesis connector, create a catalog properties file +``etc/catalog/example.properties`` with the following contents, replacing the +properties as appropriate: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/kudu.rst b/docs/src/main/sphinx/connector/kudu.rst index d7bf385f6660..24aa321fc58d 100644 --- a/docs/src/main/sphinx/connector/kudu.rst +++ b/docs/src/main/sphinx/connector/kudu.rst @@ -23,7 +23,7 @@ Configuration ------------- To configure the Kudu connector, create a catalog properties file -``etc/catalog/kudu.properties`` with the following contents, +``etc/catalog/example.properties`` with the following contents, replacing the properties as appropriate: .. code-block:: properties @@ -149,7 +149,7 @@ Example Behavior with schema emulation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If schema emulation has been enabled in the connector properties, i.e. ``etc/catalog/kudu.properties``, +If schema emulation has been enabled in the connector properties, i.e. ``etc/catalog/example.properties``, tables are mapped to schemas depending on some conventions. * With ``kudu.schema-emulation.enabled=true`` and ``kudu.schema-emulation.prefix=``, diff --git a/docs/src/main/sphinx/connector/localfile.rst b/docs/src/main/sphinx/connector/localfile.rst index 37a7be154f2a..29817115afeb 100644 --- a/docs/src/main/sphinx/connector/localfile.rst +++ b/docs/src/main/sphinx/connector/localfile.rst @@ -9,7 +9,7 @@ Configuration ------------- To configure the local file connector, create a catalog properties file -under ``etc/catalog`` named, for example, ``localfile.properties`` with the following contents: +under ``etc/catalog`` named, for example, ``example.properties`` with the following contents: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/mariadb.rst b/docs/src/main/sphinx/connector/mariadb.rst index 5c5a994b299e..20227ab2b1c9 100644 --- a/docs/src/main/sphinx/connector/mariadb.rst +++ b/docs/src/main/sphinx/connector/mariadb.rst @@ -22,8 +22,8 @@ Configuration ------------- To configure the MariaDB connector, create a catalog properties file -in ``etc/catalog`` named, for example, ``mariadb.properties``, to -mount the MariaDB connector as the ``mariadb`` catalog. +in ``etc/catalog`` named, for example, ``example.properties``, to +mount the MariaDB connector as the ``example`` catalog. Create the file with the following contents, replacing the connection properties as appropriate for your setup: @@ -67,7 +67,7 @@ Finally, you can access the ``clicks`` table in the ``web`` database:: SELECT * FROM mariadb.web.clicks; If you used a different name for your catalog properties file, use -that catalog name instead of ``mariadb`` in the above examples. +that catalog name instead of ``example`` in the above examples. .. mariadb-type-mapping: diff --git a/docs/src/main/sphinx/connector/memory.rst b/docs/src/main/sphinx/connector/memory.rst index 920c6c00c25d..dac2212bf084 100644 --- a/docs/src/main/sphinx/connector/memory.rst +++ b/docs/src/main/sphinx/connector/memory.rst @@ -9,7 +9,7 @@ Configuration ------------- To configure the Memory connector, create a catalog properties file -``etc/catalog/memory.properties`` with the following contents: +``etc/catalog/example.properties`` with the following contents: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/memsql.rst b/docs/src/main/sphinx/connector/memsql.rst index 3e4cb21fb6da..1c077e2f1672 100644 --- a/docs/src/main/sphinx/connector/memsql.rst +++ b/docs/src/main/sphinx/connector/memsql.rst @@ -24,8 +24,8 @@ Configuration ------------- To configure the SingleStore connector, create a catalog properties file -in ``etc/catalog`` named, for example, ``singlestore.properties``, to -mount the SingleStore connector as the ``singlestore`` catalog. +in ``etc/catalog`` named, for example, ``example.properties``, to +mount the SingleStore connector as the ``example`` catalog. Create the file with the following contents, replacing the connection properties as appropriate for your setup: diff --git a/docs/src/main/sphinx/connector/mongodb.rst b/docs/src/main/sphinx/connector/mongodb.rst index b327d609e566..e222ae9cb762 100644 --- a/docs/src/main/sphinx/connector/mongodb.rst +++ b/docs/src/main/sphinx/connector/mongodb.rst @@ -24,7 +24,7 @@ Configuration ------------- To configure the MongoDB connector, create a catalog properties file -``etc/catalog/mongodb.properties`` with the following contents, +``etc/catalog/example.properties`` with the following contents, replacing the properties as appropriate: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/mysql.rst b/docs/src/main/sphinx/connector/mysql.rst index 8b33a5204646..4fd3797d08d8 100644 --- a/docs/src/main/sphinx/connector/mysql.rst +++ b/docs/src/main/sphinx/connector/mysql.rst @@ -23,8 +23,8 @@ Configuration ------------- To configure the MySQL connector, create a catalog properties file -in ``etc/catalog`` named, for example, ``mysql.properties``, to -mount the MySQL connector as the ``mysql`` catalog. +in ``etc/catalog`` named, for example, ``example.properties``, to +mount the MySQL connector as the ``example`` catalog. Create the file with the following contents, replacing the connection properties as appropriate for your setup: @@ -296,7 +296,7 @@ Finally, you can access the ``clicks`` table in the ``web`` database:: SELECT * FROM mysql.web.clicks; If you used a different name for your catalog properties file, use -that catalog name instead of ``mysql`` in the above examples. +that catalog name instead of ``example`` in the above examples. .. _mysql-sql-support: diff --git a/docs/src/main/sphinx/connector/oracle.rst b/docs/src/main/sphinx/connector/oracle.rst index 9d72e7222c40..c88240bd41f1 100644 --- a/docs/src/main/sphinx/connector/oracle.rst +++ b/docs/src/main/sphinx/connector/oracle.rst @@ -22,8 +22,8 @@ To connect to Oracle, you need: Configuration ------------- -To configure the Oracle connector as the ``oracle`` catalog, create a file named -``oracle.properties`` in ``etc/catalog``. Include the following connection +To configure the Oracle connector as the ``example`` catalog, create a file named +``example.properties`` in ``etc/catalog``. Include the following connection properties in the file: .. code-block:: text @@ -104,7 +104,7 @@ Run ``SHOW SCHEMAS`` to see the available Oracle databases:: SHOW SCHEMAS FROM oracle; If you used a different name for your catalog properties file, use that catalog -name instead of ``oracle``. +name instead of ``example``. .. note:: The Oracle user must have access to the table in order to access it from Trino. diff --git a/docs/src/main/sphinx/connector/phoenix.rst b/docs/src/main/sphinx/connector/phoenix.rst index 470dfe603df2..9e856a121098 100644 --- a/docs/src/main/sphinx/connector/phoenix.rst +++ b/docs/src/main/sphinx/connector/phoenix.rst @@ -23,7 +23,7 @@ Configuration ------------- To configure the Phoenix connector, create a catalog properties file -``etc/catalog/phoenix.properties`` with the following contents, +``etc/catalog/example.properties`` with the following contents, replacing ``host1,host2,host3`` with a comma-separated list of the ZooKeeper nodes used for discovery of the HBase cluster: @@ -90,7 +90,7 @@ Finally, you can access the ``clicks`` table in the ``web`` schema:: SELECT * FROM phoenix.web.clicks; If you used a different name for your catalog properties file, use -that catalog name instead of ``phoenix`` in the above examples. +that catalog name instead of ``example`` in the above examples. .. _phoenix-type-mapping: diff --git a/docs/src/main/sphinx/connector/pinot.rst b/docs/src/main/sphinx/connector/pinot.rst index 9aecd3069169..eac1a0f038ef 100644 --- a/docs/src/main/sphinx/connector/pinot.rst +++ b/docs/src/main/sphinx/connector/pinot.rst @@ -22,7 +22,7 @@ Configuration ------------- To configure the Pinot connector, create a catalog properties file -e.g. ``etc/catalog/pinot.properties`` with at least the following contents: +e.g. ``etc/catalog/example.properties`` with at least the following contents: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/postgresql.rst b/docs/src/main/sphinx/connector/postgresql.rst index 3d31a32ce4de..2339c0f47e5b 100644 --- a/docs/src/main/sphinx/connector/postgresql.rst +++ b/docs/src/main/sphinx/connector/postgresql.rst @@ -27,8 +27,8 @@ The connector can query a database on a PostgreSQL server. Create a catalog properties file that specifies the PostgreSQL connector by setting the ``connector.name`` to ``postgresql``. -For example, to access a database as the ``postgresql`` catalog, create the -file ``etc/catalog/postgresql.properties``. Replace the connection properties +For example, to access a database as the ``example`` catalog, create the +file ``etc/catalog/example.properties``. Replace the connection properties as appropriate for your setup: .. code-block:: text @@ -314,7 +314,7 @@ Finally, you can access the ``clicks`` table in the ``web`` schema:: SELECT * FROM postgresql.web.clicks; If you used a different name for your catalog properties file, use -that catalog name instead of ``postgresql`` in the above examples. +that catalog name instead of ``example`` in the above examples. .. _postgresql-sql-support: diff --git a/docs/src/main/sphinx/connector/prometheus.rst b/docs/src/main/sphinx/connector/prometheus.rst index 5d379e872869..62c31368fa00 100644 --- a/docs/src/main/sphinx/connector/prometheus.rst +++ b/docs/src/main/sphinx/connector/prometheus.rst @@ -28,8 +28,8 @@ To query Prometheus, you need: Configuration ------------- -Create ``etc/catalog/prometheus.properties`` -to mount the Prometheus connector as the ``prometheus`` catalog, +Create ``etc/catalog/example.properties`` +to mount the Prometheus connector as the ``example`` catalog, replacing the properties as appropriate: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/redis.rst b/docs/src/main/sphinx/connector/redis.rst index f681760655f2..e0e3c012120a 100644 --- a/docs/src/main/sphinx/connector/redis.rst +++ b/docs/src/main/sphinx/connector/redis.rst @@ -29,7 +29,7 @@ Configuration ------------- To configure the Redis connector, create a catalog properties file -``etc/catalog/redis.properties`` with the following content, +``etc/catalog/example.properties`` with the following content, replacing the properties as appropriate: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/redshift.rst b/docs/src/main/sphinx/connector/redshift.rst index 3f22072da32d..4c542291663f 100644 --- a/docs/src/main/sphinx/connector/redshift.rst +++ b/docs/src/main/sphinx/connector/redshift.rst @@ -23,8 +23,8 @@ Configuration ------------- To configure the Redshift connector, create a catalog properties file -in ``etc/catalog`` named, for example, ``redshift.properties``, to -mount the Redshift connector as the ``redshift`` catalog. +in ``etc/catalog`` named, for example, ``example.properties``, to +mount the Redshift connector as the ``example`` catalog. Create the file with the following contents, replacing the connection properties as appropriate for your setup: diff --git a/docs/src/main/sphinx/connector/sqlserver.rst b/docs/src/main/sphinx/connector/sqlserver.rst index ee8932350437..4e1b13330b34 100644 --- a/docs/src/main/sphinx/connector/sqlserver.rst +++ b/docs/src/main/sphinx/connector/sqlserver.rst @@ -27,8 +27,8 @@ The connector can query a single database on an SQL server instance. Create a catalog properties file that specifies the SQL server connector by setting the ``connector.name`` to ``sqlserver``. -For example, to access a database as ``sqlserver``, create the file -``etc/catalog/sqlserver.properties``. Replace the connection properties as +For example, to access a database as ``example``, create the file +``etc/catalog/example.properties``. Replace the connection properties as appropriate for your setup: .. code-block:: properties @@ -136,7 +136,7 @@ Finally, you can query the ``clicks`` table in the ``web`` schema:: SELECT * FROM sqlserver.web.clicks; If you used a different name for your catalog properties file, use -that catalog name instead of ``sqlserver`` in the above examples. +that catalog name instead of ``example`` in the above examples. .. _sqlserver-type-mapping: diff --git a/docs/src/main/sphinx/connector/thrift.rst b/docs/src/main/sphinx/connector/thrift.rst index fba5efa3d373..b30c4ce1b8dc 100644 --- a/docs/src/main/sphinx/connector/thrift.rst +++ b/docs/src/main/sphinx/connector/thrift.rst @@ -28,7 +28,7 @@ Configuration ------------- To configure the Thrift connector, create a catalog properties file -``etc/catalog/thrift.properties`` with the following content, +``etc/catalog/example.properties`` with the following content, replacing the properties as appropriate: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/tpcds.rst b/docs/src/main/sphinx/connector/tpcds.rst index dbb1a6f6bd45..77b5048ad019 100644 --- a/docs/src/main/sphinx/connector/tpcds.rst +++ b/docs/src/main/sphinx/connector/tpcds.rst @@ -15,7 +15,7 @@ Configuration ------------- To configure the TPCDS connector, create a catalog properties file -``etc/catalog/tpcds.properties`` with the following contents: +``etc/catalog/example.properties`` with the following contents: .. code-block:: text diff --git a/docs/src/main/sphinx/connector/tpch.rst b/docs/src/main/sphinx/connector/tpch.rst index 58176853a4fc..7004b45b86c0 100644 --- a/docs/src/main/sphinx/connector/tpch.rst +++ b/docs/src/main/sphinx/connector/tpch.rst @@ -15,7 +15,7 @@ Configuration ------------- To configure the TPCH connector, create a catalog properties file -``etc/catalog/tpch.properties`` with the following contents: +``etc/catalog/example.properties`` with the following contents: .. code-block:: text