Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/main/sphinx/connector/accumulo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/bigquery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/blackhole.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/cassandra.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/clickhouse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/delta-lake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/druid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/elasticsearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/googlesheets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The Google Sheets connector allows reading `Google Sheets <https://www.google.co
Configuration
-------------

Create ``etc/catalog/sheets.properties``
to mount the Google Sheets connector as the ``sheets`` catalog,
Create ``etc/catalog/example.properties``
to mount the Google Sheets connector as the ``example`` catalog,
replacing the properties as appropriate:

.. code-block:: text
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/hive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ functionality:
Configuration
-------------

Create ``etc/catalog/hive.properties`` with the following contents
to mount the ``hive`` connector as the ``hive`` catalog,
Create ``etc/catalog/example.properties`` with the following contents
to mount the ``hive`` connector as the ``example`` catalog,
replacing ``example.net:9083`` with the correct host and port
for your Hive metastore Thrift service:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/jmx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Configuration
-------------

To configure the JMX connector, create a catalog properties file
``etc/catalog/jmx.properties`` with the following contents:
``etc/catalog/example.properties`` with the following contents:

.. code-block:: text

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/sphinx/connector/kafka-tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Step 3: Make the Kafka topics known to Trino
---------------------------------------------

In your Trino installation, add a catalog properties file
``etc/catalog/kafka.properties`` for the Kafka connector.
``etc/catalog/example.properties`` for the Kafka connector.
This file lists the Kafka nodes and topics:

.. code-block:: text
Expand All @@ -109,7 +109,7 @@ Now start Trino:

Because the Kafka tables all have the ``tpch.`` prefix in the configuration,
the tables are in the ``tpch`` schema. The connector is mounted into the
``kafka`` catalog, because the properties file is named ``kafka.properties``.
``kafka`` catalog, because the properties file is named ``example.properties``.

Start the :doc:`Trino CLI </client/cli>`:

Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions docs/src/main/sphinx/connector/kinesis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/kudu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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=``,
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/localfile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/sphinx/connector/mariadb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/memory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/memsql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/mongodb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/sphinx/connector/mysql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/sphinx/connector/oracle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/phoenix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/pinot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/sphinx/connector/postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/prometheus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/redis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/redshift.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/sphinx/connector/sqlserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/sphinx/connector/thrift.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading