Document `postgresql.include-system-tables` config property #18574

Ankan0011 · 2023-08-07T21:59:32Z

Description

Added in general postgreSQL connector configuration in the documentation for support for reading PostgreSQL system tables, e.g., pg_catalog relations. The functionality is disabled by default.

Additional context and related issues

Fixes #15424
Relates to https://trinodb.slack.com/archives/CGB0QHWSW/p1671165424335919

Release notes

(X) This is not user-visible or is docs only, and no release notes are required.
( ) Release notes are required. Please propose a release note for me.
( ) Release notes are required, with the following suggested text:

# Section
* Fix some things. ({issue}`issuenumber`)

cla-bot · 2023-08-07T21:59:34Z

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

ebyhr · 2023-08-07T23:44:10Z

docs/src/main/sphinx/connector/jdbc-common-configurations.fragment

@@ -51,3 +51,6 @@ connector:
      JDBC query. Using a large timeout can potentially result in more detailed
      dynamic filters. However, it can also increase latency for some queries.
    - ``20s``
+  * - ``postgresql.include-system-tables``


This file is jdbc-common-configurations.fragment which is used from several connectors. Please move to postgresql.rst.

ebyhr · 2023-08-07T23:45:52Z

docs/src/main/sphinx/connector/jdbc-common-configurations.fragment

@@ -51,3 +51,6 @@ connector:
      JDBC query. Using a large timeout can potentially result in more detailed
      dynamic filters. However, it can also increase latency for some queries.
    - ``20s``
+  * - ``postgresql.include-system-tables``
+    - Supports access to postgres system catalog tables(pg_catalog schemas).


"Supports reading PostgreSQL system tables, e.g., pg_catalog relations."

ebyhr · 2023-08-07T23:46:47Z

docs/src/main/sphinx/connector/jdbc-common-configurations.fragment

@@ -51,3 +51,6 @@ connector:
      JDBC query. Using a large timeout can potentially result in more detailed
      dynamic filters. However, it can also increase latency for some queries.
    - ``20s``
+  * - ``postgresql.include-system-tables``
+    - Supports access to postgres system catalog tables(pg_catalog schemas).
+    - ``false``


Please update the commit title as "Document postgresql.include-system-tables config property"
https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md#format-git-commit-messages

cla-bot · 2023-08-08T19:00:23Z

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

ebyhr · 2023-08-08T21:11:45Z

docs/src/main/sphinx/connector/postgresql.rst

@@ -285,7 +285,9 @@ The following values are accepted for this property:
 Querying PostgreSQL
 -------------------

-The PostgreSQL connector provides a schema for every PostgreSQL schema.
+The PostgreSQL connector supports reading PostgreSQL system tables, e.g., ``pg_catalog`` relations. 


Please rebase on master to resolve conflicts. The file was converted to markdown.

cla-bot · 2023-08-08T22:06:37Z

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

cla-bot · 2023-08-08T22:33:06Z

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

cla-bot · 2023-08-09T18:29:41Z

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

mosabua · 2023-08-11T18:02:15Z

docs/src/main/sphinx/connector/postgresql.md

@@ -291,7 +291,9 @@ The following values are accepted for this property:

 ## Querying PostgreSQL

-The PostgreSQL connector provides a schema for every PostgreSQL schema.
+The PostgreSQL connector provides a schema for every PostgreSQL schema. 
+It also supports reading PostgreSQL system tables, e.g., `pg_catalog` relations.


Suggested change

It also supports reading PostgreSQL system tables, e.g., `pg_catalog` relations.

It also supports reading PostgreSQL system tables, such as `pg_catalog`.

mosabua

This content should be moved up into the Configuration section .. maybe under a separate subtitle "Access to system tables"

mosabua · 2023-08-11T18:02:53Z

docs/src/main/sphinx/connector/postgresql.md

-The PostgreSQL connector provides a schema for every PostgreSQL schema.
+The PostgreSQL connector provides a schema for every PostgreSQL schema. 
+It also supports reading PostgreSQL system tables, e.g., `pg_catalog` relations.
+The functionality is disabled by default but this can be enabled using the ``postgresql.include-system-tables`` configuration property.


Suggested change

The functionality is disabled by default but this can be enabled using the ``postgresql.include-system-tables`` configuration property.

The functionality is disabled by default, and can be enabled using the ``postgresql.include-system-tables`` configuration property.

mosabua · 2023-08-11T18:06:13Z

Also .. please rebase and send a signed CLA.

cla-bot · 2023-08-11T19:04:08Z

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

Ankan0011 · 2023-08-11T19:18:06Z

Also .. please rebase and send a signed CLA.

I have send the CLA multiple times. I have changed my email and sent again.

mosabua · 2023-08-11T21:54:02Z

Also .. please rebase and send a signed CLA.

I have send the CLA multiple times. I have changed my email and sent again.

Looks like it was not yet added to https://github.com/trinodb/cla/blob/master/contributors
Did you receive the email @martint ?

docs/src/main/sphinx/connector/postgresql.md

cla-bot · 2023-08-12T18:37:37Z

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

docs/src/main/sphinx/connector/postgresql.md

mosabua · 2023-08-20T03:10:00Z

docs/src/main/sphinx/connector/postgresql.md

+```
+
+More details about the PostgreSQL system tables, see the [PostgreSQL system 
+catalog documentation](https://www.postgresql.org/docs/current/catalogs.html).


According to that URL there is no pg_tables table...

mosabua

Fixed the last issues and the commit message. Merging.

ebyhr reviewed Aug 7, 2023

View reviewed changes

ebyhr changed the title ~~#15424 Documentation for postgres general connector config.~~ Document postgresql.include-system-tables config property Aug 7, 2023

github-actions bot added the docs label Aug 7, 2023

ebyhr reviewed Aug 8, 2023

View reviewed changes

Ankan0011 requested a review from ebyhr August 9, 2023 16:16

ebyhr requested review from mosabua and removed request for ebyhr August 9, 2023 23:40

mosabua reviewed Aug 11, 2023

View reviewed changes

mosabua requested changes Aug 11, 2023

View reviewed changes

docs/src/main/sphinx/connector/postgresql.md Outdated Show resolved Hide resolved

docs/src/main/sphinx/connector/postgresql.md Outdated Show resolved Hide resolved

docs/src/main/sphinx/connector/postgresql.md Outdated Show resolved Hide resolved

Ankan0011 force-pushed the #15424_issue_doc_update branch from eb9bd24 to 3974b73 Compare August 19, 2023 22:17

cla-bot bot added the cla-signed label Aug 19, 2023

mosabua reviewed Aug 20, 2023

View reviewed changes

docs/src/main/sphinx/connector/postgresql.md Outdated Show resolved Hide resolved

mosabua reviewed Aug 20, 2023

View reviewed changes

Ankan0011 force-pushed the #15424_issue_doc_update branch from 3974b73 to fc69718 Compare August 20, 2023 10:15

Document PostgreSQL system catalogs access

4fe0877

mosabua force-pushed the #15424_issue_doc_update branch from fc69718 to 4fe0877 Compare August 21, 2023 16:44

mosabua approved these changes Aug 21, 2023

View reviewed changes

mosabua merged commit 5d8824e into trinodb:master Aug 21, 2023

github-actions bot added this to the 425 milestone Aug 21, 2023

Ankan0011 deleted the #15424_issue_doc_update branch August 21, 2023 19:25

colebow mentioned this pull request Aug 23, 2023

Add Trino 425 release notes #18782

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document `postgresql.include-system-tables` config property #18574

Document `postgresql.include-system-tables` config property #18574

Ankan0011 commented Aug 7, 2023 •

edited by ebyhr

Loading

cla-bot bot commented Aug 7, 2023

ebyhr Aug 7, 2023

ebyhr Aug 7, 2023

ebyhr Aug 7, 2023

cla-bot bot commented Aug 8, 2023

ebyhr Aug 8, 2023

cla-bot bot commented Aug 8, 2023

cla-bot bot commented Aug 8, 2023

cla-bot bot commented Aug 9, 2023

mosabua Aug 11, 2023

mosabua left a comment

mosabua Aug 11, 2023

mosabua commented Aug 11, 2023

cla-bot bot commented Aug 11, 2023

Ankan0011 commented Aug 11, 2023

mosabua commented Aug 11, 2023

cla-bot bot commented Aug 12, 2023

mosabua Aug 20, 2023

mosabua left a comment

	It also supports reading PostgreSQL system tables, e.g., `pg_catalog` relations.
	It also supports reading PostgreSQL system tables, such as `pg_catalog`.

	The functionality is disabled by default but this can be enabled using the ``postgresql.include-system-tables`` configuration property.
	The functionality is disabled by default, and can be enabled using the ``postgresql.include-system-tables`` configuration property.

Document postgresql.include-system-tables config property #18574

Document postgresql.include-system-tables config property #18574

Conversation

Ankan0011 commented Aug 7, 2023 • edited by ebyhr Loading

Description

Additional context and related issues

Release notes

cla-bot bot commented Aug 7, 2023

ebyhr Aug 7, 2023

Choose a reason for hiding this comment

ebyhr Aug 7, 2023

Choose a reason for hiding this comment

ebyhr Aug 7, 2023

Choose a reason for hiding this comment

cla-bot bot commented Aug 8, 2023

ebyhr Aug 8, 2023

Choose a reason for hiding this comment

cla-bot bot commented Aug 8, 2023

cla-bot bot commented Aug 8, 2023

cla-bot bot commented Aug 9, 2023

mosabua Aug 11, 2023

Choose a reason for hiding this comment

mosabua left a comment

Choose a reason for hiding this comment

mosabua Aug 11, 2023

Choose a reason for hiding this comment

mosabua commented Aug 11, 2023

cla-bot bot commented Aug 11, 2023

Ankan0011 commented Aug 11, 2023

mosabua commented Aug 11, 2023

cla-bot bot commented Aug 12, 2023

mosabua Aug 20, 2023

Choose a reason for hiding this comment

mosabua left a comment

Choose a reason for hiding this comment

Document `postgresql.include-system-tables` config property #18574

Document `postgresql.include-system-tables` config property #18574

Ankan0011 commented Aug 7, 2023 •

edited by ebyhr

Loading