Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added timescaledb #21128

Merged
merged 6 commits into from
Aug 22, 2022
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
4 changes: 2 additions & 2 deletions docs/docs/databases/installing-database-drivers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ A list of some of the recommended packages.
| SQLite | No additional library needed | `sqlite://` |
| [SQL Server](/docs/databases/sql-server) | `pip install pymssql` | `mssql://` |
| [Teradata](/docs/databases/teradata) | `pip install teradatasqlalchemy ` | `teradata://{user}:{password}@{host}` |
| [TimescaleDB](/docs/databases/timescaledb) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>:<Port>/<Database Name>` |
| [Vertica](/docs/databases/vertica) | `pip install sqlalchemy-vertica-python` | `vertica+vertica_python://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [YugabyteDB](/docs/databases/yugabytedb) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |

| [YugabyteDB](/docs/databases/yugabytedb) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
---

Note that many other databases are supported, the main criteria being the existence of a functional
Expand Down
38 changes: 38 additions & 0 deletions docs/docs/databases/timescaledb.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
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 is a PostgreSQL extension, and you can use the standard PostgreSQL connector library, [psycopg2](https://www.psycopg.org/docs/), to connect to the database.

Rajakavitha1 marked this conversation as resolved.
Show resolved Hide resolved
If you're using docker-compose, psycopg2 comes out of the box with Superset.

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](https://console.cloud.timescale.com) service: Host name
- For [Managed Service for TimescaleDB](https://portal.managed.timescale.com) 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 (e.g. in case you use [Timescale Cloud](https://www.timescale.com/cloud)):

```
postgresql://{username}:{password}@{host}:{port}/{database name}?sslmode=require
```

[Learn more about TimescaleDB!](https://docs.timescale.com/)
5 changes: 5 additions & 0 deletions docs/src/resources/data.js
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ export const Databases = [
href: "www.teradata.com",
imgName: 'teradata.png'
},
{
title: 'TimescaleDB',
href: "www.timescale.com",
imgName: 'timescale.png'
},
{
title: 'YugabyteDB',
href: "www.yugabyte.com",
Expand Down