[GitHub] [superset] zseta commented on a diff in pull request #21128: docs: added timescaledb

[GitBox <gi...@apache.org>]

zseta commented on code in PR #21128:
URL: https://github.com/apache/superset/pull/21128#discussion_r949406656


##########
docs/docs/databases/timescaledb.mdx:
##########
@@ -0,0 +1,36 @@
+---
+title: TimescaleDB
+hide_title: true
+sidebar_position: 31
+version: 1
+---
+
+## TimescaleDB
+[TimescaleDB](https://www.timescale.com) is the open-source relational database for time-series and analytics to build powerful data-intensive applications.
+

Review Comment:
   ```suggestion
   TimescaleDB is a PostgreSQL extension, and you can use the standard PostgreSQL connector library, [psycopg2](https://www.psycopg.org/docs/), to connect to the database.
   
   If you're using docker-compose, psycopg2 comes out of the box with Superset.
   ```



##########
docs/docs/databases/timescaledb.mdx:
##########
@@ -0,0 +1,36 @@
+---
+title: TimescaleDB
+hide_title: true
+sidebar_position: 31
+version: 1
+---
+
+## TimescaleDB
+[TimescaleDB](https://www.timescale.com) is the open-source relational database for time-series and analytics to build powerful data-intensive applications.
+
+
+TimescaleDB sample connection parameters:
+
+- **User Name**: User
+- **Password**: Password
+- **Database Host**:
+  - For Localhost: localhost or 127.0.0.1
+  - For On Prem: IP address or Host name
+  - For Timescale Cloud service: Host name
+  - For Managed Service for TimescaleDB service: Host name
+- **Database Name**: Database Name
+- **Port**: default 5432 or Port number of the service
+
+The connection string looks like:
+
+```
+postgresql://{username}:{password}@{host}:{port}/{database name}
+```
+
+You can require SSL by adding `?sslmode=require` at the end:
+
+```
+postgresql://{username}:{password}@{host}:{port}/{database name}?sslmode=require
+```
+
+For information about Postgres connector library [psycopg2](https://www.psycopg.org/docs/) with TimescaleDB, see [TimescaleDB Documentation](https://docs.timescale.com/timescaledb/latest/quick-start/python/).

Review Comment:
   ```suggestion
   [Learn more about TimescaleDB!](https://docs.timescale.com/)
   ```
   Honestly, I'd just link to the docs home page from here because Superset users will likely use the Superset UI (which uses psycopg2 under the hood) to connect to the DB and not python/psycopg2 directly.



##########
docs/docs/databases/timescaledb.mdx:
##########
@@ -0,0 +1,36 @@
+---
+title: TimescaleDB
+hide_title: true
+sidebar_position: 31
+version: 1
+---
+
+## TimescaleDB
+[TimescaleDB](https://www.timescale.com) is the open-source relational database for time-series and analytics to build powerful data-intensive applications.
+
+
+TimescaleDB sample connection parameters:
+
+- **User Name**: User
+- **Password**: Password
+- **Database Host**:
+  - For Localhost: localhost or 127.0.0.1
+  - For On Prem: IP address or Host name
+  - For Timescale Cloud service: Host name
+  - For Managed Service for TimescaleDB service: Host name
+- **Database Name**: Database Name
+- **Port**: default 5432 or Port number of the service
+
+The connection string looks like:
+
+```
+postgresql://{username}:{password}@{host}:{port}/{database name}
+```
+
+You can require SSL by adding `?sslmode=require` at the end:

Review Comment:
   ```suggestion
   You can require SSL by adding `?sslmode=require` at the end (e.g. in case you use [Timescale Cloud](https://www.timescale.com/cloud)):
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org