Skip to content

Commit

Permalink
Add list of supported statements for PostgreSQL connector
Browse files Browse the repository at this point in the history
  • Loading branch information
Jessie212 authored and hashhar committed Jul 9, 2021
1 parent 1364fbb commit f7f5639
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 12 deletions.
49 changes: 37 additions & 12 deletions docs/src/main/sphinx/connector/postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,43 @@ Finally, you can access the ``clicks`` table in the ``web`` schema::
If you used a different name for your catalog properties file, use
that catalog name instead of ``postgresql`` in the above examples.

.. _postgresql-sql-support:

SQL support
-----------

The connector provides **read access and limited write access** to data and
metadata in PostgreSQL. The following section lists all supported SQL statements
and provides further details.

.. important::

No other SQL statements are supported.

Read access:

* :doc:`/sql/select` including:

* :doc:`/sql/match-recognize`
* :doc:`/sql/values`

* :doc:`/sql/show-catalogs`
* :doc:`/sql/show-columns`
* :doc:`/sql/show-schemas`
* :doc:`/sql/show-tables`
* :doc:`/sql/describe`

Write access:

* :doc:`/sql/alter-table`
* :doc:`/sql/delete`
* :doc:`/sql/drop-schema`
* :doc:`/sql/drop-table`
* :doc:`/sql/insert`
* :doc:`/sql/show-create-table`

.. include:: sql-support-others.fragment

.. _postgresql-pushdown:

Pushdown
Expand Down Expand Up @@ -148,15 +185,3 @@ The connector supports pushdown for a number of operations:
* :func:`corr`
* :func:`regr_intercept`
* :func:`regr_slope`

Limitations
-----------

The following SQL statements are not yet supported:

* :doc:`/sql/delete`
* :doc:`/sql/grant`
* :doc:`/sql/revoke`
* :doc:`/sql/show-grants`
* :doc:`/sql/show-roles`
* :doc:`/sql/show-role-grants`
14 changes: 14 additions & 0 deletions docs/src/main/sphinx/connector/sql-support-others.fragment
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Other supported commands:

* :doc:`/sql/deallocate-prepare`
* :doc:`/sql/describe-input`
* :doc:`/sql/describe-output`
* :doc:`/sql/execute`
* :doc:`/sql/explain`
* :doc:`/sql/explain-analyze`
* :doc:`/sql/prepare`
* :doc:`/sql/reset-session`
* :doc:`/sql/set-session`
* :doc:`/sql/show-functions`
* :doc:`/sql/show-session`
* :doc:`/sql/use`

0 comments on commit f7f5639

Please sign in to comment.