Skip to content
Merged
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
22 changes: 11 additions & 11 deletions docs/src/main/sphinx/connector/memsql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ To connect to SingleStore, you need:
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.
Create the file with the following contents, replacing the
connection properties as appropriate for your setup:
To configure the SingleStore connector, create a catalog properties file 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:

.. code-block:: text

Expand Down Expand Up @@ -93,25 +93,25 @@ Querying SingleStore
The SingleStore connector provides a schema for every SingleStore *database*.
You can see the available SingleStore databases by running ``SHOW SCHEMAS``::

SHOW SCHEMAS FROM singlestore;
SHOW SCHEMAS FROM example;

If you have a SingleStore database named ``web``, you can view the tables
in this database by running ``SHOW TABLES``::

SHOW TABLES FROM singlestore.web;
SHOW TABLES FROM example.web;

You can see a list of the columns in the ``clicks`` table in the ``web``
database using either of the following::

DESCRIBE singlestore.web.clicks;
SHOW COLUMNS FROM singlestore.web.clicks;
DESCRIBE example.web.clicks;
SHOW COLUMNS FROM example.web.clicks;

Finally, you can access the ``clicks`` table in the ``web`` database::

SELECT * FROM singlestore.web.clicks;
SELECT * FROM example.web.clicks;

If you used a different name for your catalog properties file, use
that catalog name instead of ``singlestore`` in the above examples.
that catalog name instead of ``example`` in the above examples.

.. _singlestore-type-mapping:

Expand Down
22 changes: 11 additions & 11 deletions docs/src/main/sphinx/connector/postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ 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
as appropriate for your setup:
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 @@ -286,25 +286,25 @@ Querying PostgreSQL
The PostgreSQL connector provides a schema for every PostgreSQL schema.
You can see the available PostgreSQL schemas by running ``SHOW SCHEMAS``::

SHOW SCHEMAS FROM postgresql;
SHOW SCHEMAS FROM example;

If you have a PostgreSQL schema named ``web``, you can view the tables
in this schema by running ``SHOW TABLES``::

SHOW TABLES FROM postgresql.web;
SHOW TABLES FROM example.web;

You can see a list of the columns in the ``clicks`` table in the ``web`` database
using either of the following::

DESCRIBE postgresql.web.clicks;
SHOW COLUMNS FROM postgresql.web.clicks;
DESCRIBE example.web.clicks;
SHOW COLUMNS FROM example.web.clicks;

Finally, you can access the ``clicks`` table in the ``web`` schema::

SELECT * FROM postgresql.web.clicks;
SELECT * FROM example.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 Expand Up @@ -352,7 +352,7 @@ As a simple example, to select an entire table::
*
FROM
TABLE(
postgresql.system.query(
example.system.query(
query => 'SELECT
*
FROM
Expand All @@ -368,7 +368,7 @@ when using window functions::
*
FROM
TABLE(
postgresql.system.query(
example.system.query(
query => 'SELECT
*,
array_agg(week) OVER (
Expand Down
9 changes: 4 additions & 5 deletions docs/src/main/sphinx/connector/prometheus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,8 @@ To query Prometheus, you need:
Configuration
-------------

Create ``etc/catalog/prometheus.properties``
to mount the Prometheus connector as the ``prometheus`` catalog,
replacing the properties as appropriate:
Create ``etc/catalog/example.properties`` to mount the Prometheus connector as
the ``example`` catalog, replacing the properties as appropriate:

.. code-block:: text

Expand Down Expand Up @@ -79,7 +78,7 @@ a relatively small window. For example:

.. code-block:: sql

SELECT * FROM prometheus.default.up WHERE timestamp > (NOW() - INTERVAL '10' second);
SELECT * FROM example.default.up WHERE timestamp > (NOW() - INTERVAL '10' second);

If the query does not include a WHERE clause limit, these config
settings are meant to protect against an unlimited query.
Expand Down Expand Up @@ -123,7 +122,7 @@ represented in Trino:

.. code-block:: sql

SELECT * FROM prometheus.default.up;
SELECT * FROM example.default.up;

.. code-block:: text

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/sphinx/connector/redis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Configuration
-------------

To configure the Redis connector, create a catalog properties file
``etc/catalog/redis.properties`` with the following content,
replacing the properties as appropriate:
``etc/catalog/example.properties`` with the following content, replacing the
properties as appropriate:

.. code-block:: text

Expand Down
26 changes: 13 additions & 13 deletions docs/src/main/sphinx/connector/redshift.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ To connect to Redshift, you need:
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.
Create the file with the following contents, replacing the
connection properties as appropriate for your setup:
To configure the Redshift connector, create a catalog properties file 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:

.. code-block:: text

Expand Down Expand Up @@ -94,25 +94,25 @@ Querying Redshift
The Redshift connector provides a schema for every Redshift schema.
You can see the available Redshift schemas by running ``SHOW SCHEMAS``::

SHOW SCHEMAS FROM redshift;
SHOW SCHEMAS FROM example;

If you have a Redshift schema named ``web``, you can view the tables
in this schema by running ``SHOW TABLES``::

SHOW TABLES FROM redshift.web;
SHOW TABLES FROM example.web;

You can see a list of the columns in the ``clicks`` table in the ``web`` database
using either of the following::

DESCRIBE redshift.web.clicks;
SHOW COLUMNS FROM redshift.web.clicks;
DESCRIBE example.web.clicks;
SHOW COLUMNS FROM example.web.clicks;

Finally, you can access the ``clicks`` table in the ``web`` schema::

SELECT * FROM redshift.web.clicks;
SELECT * FROM example.web.clicks;

If you used a different name for your catalog properties file, use
that catalog name instead of ``redshift`` in the above examples.
If you used a different name for your catalog properties file, use that catalog
name instead of ``example`` in the above examples.

.. _redshift-type-mapping:

Expand Down Expand Up @@ -167,7 +167,7 @@ For example, select the top 10 nations by population::
*
FROM
TABLE(
redshift.system.query(
example.system.query(
query => 'SELECT
TOP 10 *
FROM
Expand Down
27 changes: 14 additions & 13 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 a given 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 @@ -115,30 +115,31 @@ behavior of the connector and the issues queries to the database.
Querying SQL Server
-------------------

The SQL Server connector provides access to all schemas visible to the specified user in the configured database.
For the following examples, assume the SQL Server catalog is ``sqlserver``.
The SQL Server connector provides access to all schemas visible to the specified
user in the configured database. For the following examples, assume the SQL
Server catalog is ``example``.

You can see the available schemas by running ``SHOW SCHEMAS``::

SHOW SCHEMAS FROM sqlserver;
SHOW SCHEMAS FROM example;

If you have a schema named ``web``, you can view the tables
in this schema by running ``SHOW TABLES``::

SHOW TABLES FROM sqlserver.web;
SHOW TABLES FROM example.web;

You can see a list of the columns in the ``clicks`` table in the ``web`` database
using either of the following::

DESCRIBE sqlserver.web.clicks;
SHOW COLUMNS FROM sqlserver.web.clicks;
DESCRIBE example.web.clicks;
SHOW COLUMNS FROM example.web.clicks;

Finally, you can query the ``clicks`` table in the ``web`` schema::

SELECT * FROM sqlserver.web.clicks;
SELECT * FROM example.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 Expand Up @@ -355,7 +356,7 @@ For example, select the top 10 percent of nations by population::
*
FROM
TABLE(
sqlserver.system.query(
example.system.query(
query => 'SELECT
TOP(10) PERCENT *
FROM
Expand Down Expand Up @@ -391,7 +392,7 @@ create them by executing the following statement in SQL Server Database.

.. code-block:: sql

CREATE STATISTICS my_statistics_name ON table_schema.table_name (column_name);
CREATE STATISTICS example_statistics_name ON table_schema.table_name (column_name);

SQL Server Database routinely updates the statistics. In some cases, you may
want to force statistics update (e.g. after defining new column statistics or
Expand Down Expand Up @@ -484,7 +485,7 @@ with the ``data_compression`` table property. Valid policies are ``NONE``, ``ROW

Example::

CREATE TABLE myschema.scientists (
CREATE TABLE example_schema.scientists (
recordkey VARCHAR,
name VARCHAR,
age BIGINT,
Expand Down