diff --git a/.github/styles/templates/integration.md b/.github/styles/templates/integration.md new file mode 100644 index 0000000000..120033bc5c --- /dev/null +++ b/.github/styles/templates/integration.md @@ -0,0 +1,72 @@ +--- +title: Integrate with Timescale Cloud +excerpt: SEO friendly explanation of why the user will do it +keywords: [] +--- + +import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.mdx"; + +# Integrate with $CLOUD_LONG + +// Explain what the third-party tool is and what it does in their own words, link to product docs. + +// Provide context for the integration steps, for example, if an additional connector is used. + +// See https://docs.timescale.com/use-timescale/latest/integrations/grafana/ for an example. + +## Prerequisites + + + +- Install // Mention both server and cloud versions, if present. Link to installation pages. + +## Connect your $SERVICE_LONG + +To connect to $CLOUD_LONG: + + + +1. **Log in to ** + + // Sub-steps, code, screenshots if necessary. + +1. **Configure the connection** + + // Sub-steps, code, screenshots if necessary. Link to [Find your connection details][connection-info]. + + ... + +1. **Test the connection** + + // Sub-steps, code, screenshots if necessary. + + + +## Test the integration with $CLOUD_LONG + +// Add only if there is a simple way to illustrate how the two solutions work together. + +Take the following steps to : + + + +// Steps to test out the integration using a defined dataset. + + + +You have successfully integrated with $CLOUD_LONG. + +[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/ + + + + + + + + + + + + + diff --git a/_partials/_cloud-connect.md b/_partials/_cloud-connect.md index 6045abbf76..4f057c6123 100644 --- a/_partials/_cloud-connect.md +++ b/_partials/_cloud-connect.md @@ -50,8 +50,8 @@ Quick recap. You: [portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql [account-portal]: https://console.cloud.timescale.com/dashboard/account [services-portal]: https://console.cloud.timescale.com/dashboard/services -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode [run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/#hypertable-partitioning diff --git a/_partials/_cloud-create-connect-tutorials.md b/_partials/_cloud-create-connect-tutorials.md index 750d85befc..55bae061e2 100644 --- a/_partials/_cloud-create-connect-tutorials.md +++ b/_partials/_cloud-create-connect-tutorials.md @@ -39,4 +39,4 @@ command-line utility. If you've used PostgreSQL before, you might already have [timescale-portal]: https://console.cloud.timescale.com/ -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ diff --git a/_partials/_create-hypertable.md b/_partials/_create-hypertable.md index ad34f0ba87..99bb23bb4a 100644 --- a/_partials/_create-hypertable.md +++ b/_partials/_create-hypertable.md @@ -40,8 +40,8 @@ To create a hypertable: [services-portal]: https://console.cloud.timescale.com/dashboard/services -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode [run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/#hypertable-partitioning diff --git a/_partials/_grafana-connect.md b/_partials/_grafana-connect.md index afca26fb25..8455d85f8f 100644 --- a/_partials/_grafana-connect.md +++ b/_partials/_grafana-connect.md @@ -6,7 +6,7 @@ import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.md * Install [self-managed Grafana][grafana-self-managed] or sign up for [Grafana Cloud][grafana-cloud]. -## Add your $SERVICE_SHORT or database as a data source +## Add your $SERVICE_SHORT as a data source To connect the data in your $SERVICE_SHORT to Grafana: @@ -37,4 +37,4 @@ To connect the data in your $SERVICE_SHORT to Grafana: [grafana-cloud]: https://grafana.com/get/ [cloud-login]: https://console.cloud.timescale.com/ [create-service]: /getting-started/:currentVersion:/services/ -[connection-info]: /use-timescale/:currentVersion:/integrations/query-admin/find-connection-details/ \ No newline at end of file +[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/ \ No newline at end of file diff --git a/_partials/_integration-prereqs.md b/_partials/_integration-prereqs.md index 069f0044f4..dfe52ab64f 100644 --- a/_partials/_integration-prereqs.md +++ b/_partials/_integration-prereqs.md @@ -6,4 +6,4 @@ Before integrating: [create-service]: /getting-started/:currentVersion:/services/ [enable-timescaledb]: /self-hosted/:currentVersion:/install/ -[connection-info]: /use-timescale/:currentVersion:/integrations/query-admin/find-connection-details/ \ No newline at end of file +[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/ \ No newline at end of file diff --git a/_partials/_usage-based-storage-intro.md b/_partials/_usage-based-storage-intro.md index 415b90fa37..6823fdbb60 100644 --- a/_partials/_usage-based-storage-intro.md +++ b/_partials/_usage-based-storage-intro.md @@ -1,4 +1,4 @@ -Timescale charges are based on how much storage you use. You don't pay for a +$CLOUD_LONG charges are based on the amount of storage you use. You don't pay for fixed storage size, and you don't need to worry about scaling disk size as your data grows; We handle it all for you. To reduce your data costs further, use [compression][compression], a [data retention policy][data-retention], and diff --git a/_troubleshooting/cloud-jdbc-authentication-support.md b/_troubleshooting/cloud-jdbc-authentication-support.md index dbe30a316c..600b53c5a9 100644 --- a/_troubleshooting/cloud-jdbc-authentication-support.md +++ b/_troubleshooting/cloud-jdbc-authentication-support.md @@ -2,7 +2,7 @@ title: JDBC authentication type is not supported section: troubleshooting products: [cloud] -topics: [integrations/query admin] +topics: [integrations] errors: - language: text message: |- diff --git a/getting-started/run-queries-from-console.md b/getting-started/run-queries-from-console.md index e200244f32..2169436b48 100644 --- a/getting-started/run-queries-from-console.md +++ b/getting-started/run-queries-from-console.md @@ -229,11 +229,11 @@ To use SQL editor with Timescale: [readreplica]: /use-timescale/:currentVersion:/ha-replicas/read-scaling/ [run-popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode [run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor -[integrations]: /use-timescale/:currentVersion:/integrations/query-admin/ +[integrations]: /use-timescale/:currentVersion:/integrations/ [timescale-console]: https://console.cloud.timescale.com/ [portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services [pricing-plan-features]: https://www.timescale.com/pricing#features -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [create-cloud-account]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-account [portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql [services-portal]: https://console.cloud.timescale.com/dashboard/services diff --git a/getting-started/services.md b/getting-started/services.md index 105f80f60f..f54ff46159 100644 --- a/getting-started/services.md +++ b/getting-started/services.md @@ -67,7 +67,7 @@ And that is it, you are up and running. Enjoy developing with $COMPANY. [tsc-portal]: https://console.cloud.timescale.com/ [services-how-to]: /use-timescale/:currentVersion:/services/ -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [create-an-account]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-account [create-a-service]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-service [connect-to-your-service]: /getting-started/:currentVersion:/services/#connect-to-your-service diff --git a/lambda/redirects.js b/lambda/redirects.js index 652e7a0eb7..5d4a32958d 100644 --- a/lambda/redirects.js +++ b/lambda/redirects.js @@ -564,7 +564,7 @@ module.exports = [ }, { from: "/tutorials/latest/grafana/", - to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/", }, { from: "/tutorials/latest/howto-monitor-django-prometheus", @@ -605,27 +605,27 @@ module.exports = [ { from: "/tutorials", to: "https://docs.timescale.com/tutorials/latest/" }, { from: "/use-timescale/latest/connecting/", - to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/", }, { from: "/use-timescale/latest/connecting/about-connecting", - to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/about-connecting/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/find-connection-details/", }, { from: "/use-timescale/latest/connecting/about-psql/", - to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/about-psql/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/psql/", }, { from: "/use-timescale/latest/connecting/dbeaver/", - to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/dbeaver/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/dbeaver/", }, { from: "/use-timescale/latest/connecting/pgadmin/", - to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/pgadmin/", }, { from: "/use-timescale/latest/connecting/psql/", - to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/about-psql/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/psql/", }, { from: "/use-timescale/latest/data-tiering/move-data/", @@ -721,7 +721,7 @@ module.exports = [ }, { from: "/using-timescaledb/visualizing-data", - to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/", }, { from: "/use-timescale/latest/account-management/", @@ -759,7 +759,7 @@ module.exports = [ }, { from: "/timescaledb/latest/tutorials/grafana/visualizations/pie-chart/", - to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/", }, { from: "/promscale/latest/about-promscale/#promscale-schema-for-metric-data", @@ -767,7 +767,7 @@ module.exports = [ }, { from: "/promscale/latest/visualize-data/grafana", - to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/", }, { from: "/install/latest/self-hosted/installation-redhat/#where-to-next", @@ -783,7 +783,7 @@ module.exports = [ }, { from: "/timescaledb/latest/tutorials/grafana/grafana-variables/", - to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/", + to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/", }, { from: "/clustering/using-timescaledb/update-db", @@ -821,4 +821,52 @@ module.exports = [ from: "/use-timescale/latest/compression/backfill-historical-data/", to: "https://github.com/timescale/timescaledb-extras/blob/master/backfill.sql", }, + { + from: '/use-timescale/latest/integrations/observability-alerting/grafana/installation/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/grafana/', + }, + { + from: '/use-timescale/latest/integrations/observability-alerting/grafana/geospatial-dashboards/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/grafana/', + }, + { + from: '/use-timescale/latest/integrations/observability-alerting/grafana/create-dashboard-and-panel/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/grafana/', + }, + { + from: '/use-timescale/latest/integrations/query-admin/about-psql/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/psql/', + }, + { + from: '/use-timescale/latest/integrations/query-admin/psql/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/psql/', + }, + { + from: '/use-timescale/latest/integrations/query-admin/about-connecting/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/find-connection-details/', + }, + { + from: '/use-timescale/latest/integrations/query-admin/azure-data-studio/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/azure-data-studio/', + }, + { + from: '/use-timescale/latest/integrations/query-admin/dbeaver/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/dbeaver/', + }, + { + from: '/use-timescale/latest/integrations/query-admin/pgadmin/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/pgadmin/', + }, + { + from: '/use-timescale/latest/integrations/query-admin/qstudio/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/qstudio/', + }, + { + from: '/use-timescale/latest/integrations/config-deploy/terraform/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/terraform/', + }, + { + from: '/use-timescale/latest/integrations/observability-alerting/tableau/', + to: 'https://docs.timescale.com/use-timescale/latest/integrations/tableau/', + }, ]; diff --git a/mst/installation-mst.md b/mst/installation-mst.md index 77fa20a4d8..1bd056029b 100644 --- a/mst/installation-mst.md +++ b/mst/installation-mst.md @@ -122,7 +122,7 @@ You can always [contact us][contact] if you need help working something out, or if you want to have a chat. [contact]: https://www.timescale.com/contact -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [mst-docs]: /mst/:currentVersion:/ [tutorials]: /tutorials/:currentVersion:/ [mst-signup]: https://www.timescale.com/mst-signup diff --git a/mst/migrate-to-mst.md b/mst/migrate-to-mst.md index e8dcc38ed2..00b05c06ba 100644 --- a/mst/migrate-to-mst.md +++ b/mst/migrate-to-mst.md @@ -129,7 +129,7 @@ them. The migration still occurs successfully. [install-mst]: /mst/:currentVersion:/installation-mst/#create-your-first-service [pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html [pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html -[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[psql]: /use-timescale/:currentVersion:/integrations/psql/ [upgrading-postgresql]: https://kb-managed.timescale.com/en/articles/5368016-perform-a-postgresql-major-version-upgrade [upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/ [upgrading-timescaledb]: /self-hosted/:currentVersion:/upgrades/major-upgrade/ \ No newline at end of file diff --git a/quick-start/ruby.md b/quick-start/ruby.md index 842a0f4b3d..79f74951fc 100644 --- a/quick-start/ruby.md +++ b/quick-start/ruby.md @@ -720,7 +720,7 @@ page by page, or all pages together, and group by path or not: [add-performance]: #add-performance-and-path-attributes-to-pageload [explore]: #explore-aggregation-functions [install]: /getting-started/latest/ -[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[psql-install]: /use-timescale/:currentVersion:/integrations/psql/ [rails-guide]: https://guides.rubyonrails.org/getting_started.html [ab]: https://httpd.apache.org/docs/2.4/programs/ab.html [active-record-query]: https://guides.rubyonrails.org/active_record_querying.html diff --git a/self-hosted/install/installation-macos.md b/self-hosted/install/installation-macos.md index 46df6334c7..58fc54cafc 100644 --- a/self-hosted/install/installation-macos.md +++ b/self-hosted/install/installation-macos.md @@ -80,7 +80,7 @@ And that is it! You have TimescaleDB running on a database on a self-hosted inst For the latest functionality, install MacOS 14 Sanoma. The oldest supported version is macOS 10.15 Catalina [homebrew]: https://docs.brew.sh/Installation -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [macports]: https://guide.macports.org/#installing.macports [install-from-source]: /self-hosted/:currentVersion:/install/installation-source/ [install-postgresql]: https://www.postgresql.org/download/macosx/ \ No newline at end of file diff --git a/self-hosted/install/installation-source.md b/self-hosted/install/installation-source.md index 6d98665790..6a317c3b2e 100644 --- a/self-hosted/install/installation-source.md +++ b/self-hosted/install/installation-source.md @@ -73,7 +73,7 @@ And that is it! You have TimescaleDB running on a database on a self-hosted inst -[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[install-psql]: /use-timescale/:currentVersion:/integrations/psql/ [config]: /self-hosted/:currentVersion:/configuration/ [postgres-download]: https://www.postgresql.org/download/ [cmake-download]: https://cmake.org/download/ diff --git a/self-hosted/migration/entire-database.md b/self-hosted/migration/entire-database.md index 66a135f041..4676fcc457 100644 --- a/self-hosted/migration/entire-database.md +++ b/self-hosted/migration/entire-database.md @@ -118,7 +118,7 @@ information about compression and decompression, see [Compression][compression]. [migrate-separately]: /self-hosted/:currentVersion:/migration/schema-then-data/ [pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html [pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html -[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[psql]: /use-timescale/:currentVersion:/integrations/psql/ [timescaledb_pre_restore]: /api/:currentVersion:/administration/#timescaledb_pre_restore [timescaledb_post_restore]: /api/:currentVersion:/administration/#timescaledb_post_restore [upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/ diff --git a/self-hosted/migration/schema-then-data.md b/self-hosted/migration/schema-then-data.md index 0091cec014..20ed4a352c 100644 --- a/self-hosted/migration/schema-then-data.md +++ b/self-hosted/migration/schema-then-data.md @@ -210,7 +210,7 @@ the [compression section](https://docs.timescale.com/use-timescale/latest/compre [install-selfhosted]: /self-hosted/:currentVersion:/install/ [pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html [pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html -[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[psql]: /use-timescale/:currentVersion:/integrations/psql/ [timescaledb-parallel-copy]: https://github.com/timescale/timescaledb-parallel-copy [upgrading-postgresql]: https://kb-managed.timescale.com/en/articles/5368016-perform-a-postgresql-major-version-upgrade [upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/ diff --git a/self-hosted/upgrades/upgrade-pg.md b/self-hosted/upgrades/upgrade-pg.md index d1ebf79494..8f11bf3046 100644 --- a/self-hosted/upgrades/upgrade-pg.md +++ b/self-hosted/upgrades/upgrade-pg.md @@ -16,7 +16,20 @@ TimescaleDB is a PostgreSQL extension. Ensure that you upgrade to compatible ver -## Prerequisites +||PostgreSQL 17|PostgreSQL 16|PostgreSQL 15|PostgreSQL 14|PostgreSQL 13|PostgreSQL 12|PostgreSQL 11|PostgreSQL 10|PostgreSQL 9.6| +|-|-|-|-|-|-|-|-|-| +|TimescaleDB 2.17 and higher|✅|✅|✅|✅|❌|❌|❌|❌|❌| +|TimescaleDB 2.16 and higher|❌|✅|✅|✅|❌|❌|❌|❌|❌|❌| +|TimescaleDB 2.15 and higher|❌|✅|✅|✅|✅|❌|❌|❌|❌|❌| +|TimescaleDB 2.14 and higher|❌|✅|✅|✅|✅|❌|❌|❌|❌|❌| +|TimescaleDB 2.13 and higher|❌|✅|✅|✅|✅|❌|❌|❌|❌| +|TimescaleDB 2.12 and higher|❌|❌|✅|✅|✅|❌|❌|❌|❌| +|TimescaleDB 2.10 and higher|❌|❌|✅|✅|✅|✅|❌|❌|❌| +|TimescaleDB 2.5 to 2.9|❌|❌|❌|✅|✅|✅|❌|❌|❌| +|TimescaleDB 2.4|❌|❌|❌|❌|✅|✅|❌|❌|❌| +|TimescaleDB 2.1 to 2.3|❌|❌|❌|❌|✅|✅|✅|❌|❌| +|TimescaleDB 2.0|❌|❌|❌|❌|❌|✅|✅|❌|❌ +|TimescaleDB 1.7|❌|❌|❌|❌|❌|✅|✅|✅|✅| diff --git a/tutorials/OLD-financial-candlestick-tick-data/index.md b/tutorials/OLD-financial-candlestick-tick-data/index.md index 4d0dea5a07..bce50ffab8 100644 --- a/tutorials/OLD-financial-candlestick-tick-data/index.md +++ b/tutorials/OLD-financial-candlestick-tick-data/index.md @@ -73,4 +73,4 @@ Follow this tutorial and see how to set up your TimescaleDB database to consume [create]: /tutorials/:currentVersion:/financial-candlestick-tick-data/create-candlestick-aggregates [query]: /tutorials/:currentVersion:/financial-candlestick-tick-data/query-candlestick-views [manage]: /tutorials/:currentVersion:/financial-candlestick-tick-data/advanced-data-management -[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[psql]: /use-timescale/:currentVersion:/integrations/psql/ diff --git a/tutorials/OLD_analyze-bitcoin-blockchain/index.md b/tutorials/OLD_analyze-bitcoin-blockchain/index.md index c2506c02d8..a56596e2aa 100644 --- a/tutorials/OLD_analyze-bitcoin-blockchain/index.md +++ b/tutorials/OLD_analyze-bitcoin-blockchain/index.md @@ -47,4 +47,4 @@ this tutorial is to [install-timescale]: /getting-started/latest/ -[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql +[psql-install]: /use-timescale/:currentVersion:/integrations/psql/ diff --git a/tutorials/OLD_analyze-intraday-stocks/index.md b/tutorials/OLD_analyze-intraday-stocks/index.md index 3f0f658ca9..7a75121641 100644 --- a/tutorials/OLD_analyze-intraday-stocks/index.md +++ b/tutorials/OLD_analyze-intraday-stocks/index.md @@ -51,4 +51,4 @@ pip install pandas [explore]: /tutorials/:currentVersion:/ [fetch-ingest]: /tutorials/:currentVersion:/ [install-timescale]: /getting-started/latest/ -[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql +[psql-install]: /use-timescale/:currentVersion:/integrations/psql/ diff --git a/tutorials/OLD_nfl-analytics/index.md b/tutorials/OLD_nfl-analytics/index.md index bd76015aa6..4912ba2857 100644 --- a/tutorials/OLD_nfl-analytics/index.md +++ b/tutorials/OLD_nfl-analytics/index.md @@ -60,6 +60,6 @@ This tutorial has a few sections to help you on your journey: [install-timescale]: /getting-started/latest/ [join-data]: /tutorials/:currentVersion:/nfl-analytics/join-with-relational [kaggle-download]: https://www.kaggle.com/c/nfl-big-data-bowl-2021/data -[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql +[psql-install]: /use-timescale/:currentVersion:/integrations/psql/ [toolkit]: /self-hosted/:currentVersion:/tooling/install-toolkit/ [visualize-plays]: /tutorials/:currentVersion:/nfl-analytics/play-visualization/ diff --git a/tutorials/OLD_nfl-fantasy-league.md b/tutorials/OLD_nfl-fantasy-league.md index 08cc3a2b1f..85447b696a 100644 --- a/tutorials/OLD_nfl-fantasy-league.md +++ b/tutorials/OLD_nfl-fantasy-league.md @@ -588,4 +588,4 @@ draw_play(game_id=2018112900, [extra-download]: https://assets.timescale.com/docs/downloads/nfl_2018.zip [install-timescale]: /getting-started/latest/ [kaggle-download]: https://www.kaggle.com/c/nfl-big-data-bowl-2021/data -[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql +[psql-install]: /use-timescale/:currentVersion:/integrations/psql/ diff --git a/tutorials/OLD_nyc-taxi-cab.md b/tutorials/OLD_nyc-taxi-cab.md index a34b3ab9e5..cabd0c1f17 100644 --- a/tutorials/OLD_nyc-taxi-cab.md +++ b/tutorials/OLD_nyc-taxi-cab.md @@ -828,5 +828,5 @@ querying by time and location. [migrate]: /use-timescale/:currentVersion:/migration/ [parallel-copy]: https://github.com/timescale/timescaledb-parallel-copy [postgis]: http://postgis.net/documentation -[setup-psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql +[setup-psql]: /use-timescale/:currentVersion:/integrations/psql/ [time-series-forecasting]: /tutorials/:currentVersion:/time-series-forecast/ diff --git a/tutorials/blockchain-analyze/index.md b/tutorials/blockchain-analyze/index.md index aad12305f8..d12abea932 100644 --- a/tutorials/blockchain-analyze/index.md +++ b/tutorials/blockchain-analyze/index.md @@ -56,4 +56,4 @@ to graph the output in Grafana. [blockchain-query]: /tutorials/:currentVersion:/blockchain-query/beginner-blockchain-query/ [blockchain-def]: https://www.pcmag.com/encyclopedia/term/blockchain [transactions-def]: https://www.pcmag.com/encyclopedia/term/bitcoin-transaction -[grafana-setup]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#add-your-timescale-cloud-service-as-a-data-source +[grafana-setup]: /use-timescale/:currentVersion:/integrations/grafana/ diff --git a/tutorials/energy-data/index.md b/tutorials/energy-data/index.md index c6be1e2dad..71a30af329 100644 --- a/tutorials/energy-data/index.md +++ b/tutorials/energy-data/index.md @@ -58,4 +58,4 @@ you through the steps to visualize the results in Grafana. [query-energy]: /tutorials/:currentVersion:/energy-data/query-energy/ [compress-energy]: /tutorials/:currentVersion:/energy-data/compress-energy/ [cloud-install]: /getting-started/:currentVersion:/#create-your-timescale-account -[grafana-setup]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#add-your-timescale-cloud-service-as-a-data-source +[grafana-setup]: /use-timescale/:currentVersion:/integrations/grafana/ diff --git a/tutorials/nyc-taxi-geospatial/index.md b/tutorials/nyc-taxi-geospatial/index.md index ca16c2021a..d1fb4c4b84 100644 --- a/tutorials/nyc-taxi-geospatial/index.md +++ b/tutorials/nyc-taxi-geospatial/index.md @@ -63,4 +63,4 @@ information, and plotting the results in Grafana. [cloud-install]: /getting-started/:currentVersion:/#create-your-timescale-account [beginner-fleet]: /tutorials/:currentVersion:/nyc-taxi-cab/ [plot-nyc]: /tutorials/:currentVersion:/nyc-taxi-geospatial/plot-nyc/ -[grafana-setup]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#add-your-timescale-cloud-service-as-a-data-source +[grafana-setup]: /use-timescale/:currentVersion:/integrations/grafana/ diff --git a/use-timescale/ingest-data/import-csv.md b/use-timescale/ingest-data/import-csv.md index 901d1474d4..2893fdcbe5 100644 --- a/use-timescale/ingest-data/import-csv.md +++ b/use-timescale/ingest-data/import-csv.md @@ -79,7 +79,6 @@ To import data from a CSV file: ```bash timescaledb-parallel-copy \ --connection $TARGET \ - --db-name tsdb \ --table \ --file .csv \ --workers \ diff --git a/use-timescale/ingest-data/ingest-telegraf.md b/use-timescale/ingest-data/ingest-telegraf.md index 9874e9ff1f..33392a99c9 100644 --- a/use-timescale/ingest-data/ingest-telegraf.md +++ b/use-timescale/ingest-data/ingest-telegraf.md @@ -157,6 +157,6 @@ see the [PostgreQL output plugin][output-plugin]. [output-plugin]: https://github.com/influxdata/telegraf/blob/release-1.24/plugins/outputs/postgresql/README.md [install-telegraf]: https://docs.influxdata.com/telegraf/v1.21/introduction/installation/ [create-service]: /getting-started/latest/ -[connect-timescaledb]: /use-timescale/:currentVersion:/integrations/query-admin/about-connecting/ -[grafana]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/ +[connect-timescaledb]: /use-timescale/:currentVersion:/integrations/find-connection-details/ +[grafana]: /use-timescale/:currentVersion:/integrations/grafana/ [about-hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/ diff --git a/use-timescale/integrations/apache-airflow.md b/use-timescale/integrations/apache-airflow.md new file mode 100644 index 0000000000..19ebc9cc3a --- /dev/null +++ b/use-timescale/integrations/apache-airflow.md @@ -0,0 +1,150 @@ +--- +title: Integrate Apache Airflow with Timescale Cloud +excerpt: How to install the psql client for PostgreSQL +products: [cloud, mst, self_hosted] +keywords: [connect, integrate, apache, airflow] +--- + +import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.mdx"; + +# Integrate Apache Airflow with $CLOUD_LONG + +Apache Airflow® is a platform created by the community to programmatically author, schedule, and monitor workflows. + +A [DAG (Directed Acyclic Graph)][Airflow-DAG] is the core concept of Airflow, collecting [Tasks][Airflow-Task] together, +organized with dependencies and relationships to say how they should run. You declare a DAG in a Python file +in the `$AIRFLOW_HOME/dags` folder of your Airflow instance. + +This page shows you how to use a Python connector in a DAG to integrate Apache Airflow with a $SERVICE_LONG. + +## Prerequisites + + + +* [Install Python3 and pip3][install-python-pip] +* [Install Apache Airflow][install-apache-airflow] + + Ensure that your Airflow instance has network access to $CLOUD_LONG. + +This example DAG uses the `company` table you create in [Create regular PostgreSQL tables for relational data][create-a-table-in-timescale] + +## Install python connectivity libraries + +To install the Python libraries required to connect to $CLOUD_LONG: + + + +1. **Enable PostgreSQL connections between Airflow and $CLOUD_LONG** + + ```bash + pip install psycopg2-binary + ``` + +1. **Enable PostgreSQL connection types in the Airflow UI** + + ```bash + pip install apache-airflow-providers-postgres + ``` + + + +## Create a connection between Airflow and your $SERVICE_LONG + +In your Airflow instance, securely connect to your $SERVICE_LONG: + + + +1. **Run Airflow** + + On your development machine, run the following command: + + ```bash + airflow standalone + ``` + + The username and password for Airflow UI are displayed in the `standalone | Login with username` + line in the output. + +1. **Add a connection from Airflow to your $SERVICE_LONG** + + 1. In your browser, navigate to `localhost:8080`, then select `Admin` > `Connections`. + 1. Click `+` (Add a new record), then use your [connection info][connection-info] to fill in + the form. The `Connection Type` is `Postgres`. + + + +## Exchange data between Airflow and your $SERVICE_LONG + +To exchange data between Airflow and your $SERVICE_LONG: + + + +1. **Create and execute a DAG** + + To insert data in your $SERVICE_LONG from Airflow: + 1. In `$AIRFLOW_HOME/dags/timescale_dag.py`, add the following code: + + ```python + from airflow import DAG + from airflow.operators.python_operator import PythonOperator + from airflow.hooks.postgres_hook import PostgresHook + from datetime import datetime + + def insert_data_to_timescale(): + hook = PostgresHook(postgres_conn_id='the ID of the connenction you created') + conn = hook.get_conn() + cursor = conn.cursor() + """ + This could be any query. This example inserts data into the table + you create in: + + https://docs.timescale.com/getting-started/latest/tables-hypertables/#create-regular-postgresql-tables-for-relational-data + """ + cursor.execute("INSERT INTO company (symbol, name) VALUES (%s, %s)", + ('new_company_symbol', 'New Company Name')) + conn.commit() + cursor.close() + conn.close() + + default_args = { + 'owner': 'airflow', + 'start_date': datetime(2023, 1, 1), + 'retries': 1, + } + + dag = DAG('timescale_dag', default_args=default_args, schedule_interval='@daily') + + insert_task = PythonOperator( + task_id='insert_data', + python_callable=insert_data_to_timescale, + dag=dag, + ) + ``` + This DAG uses the `company` table created in [Create regular PostgreSQL tables for relational data][create-a-table-in-timescale]. + + 1. In your browser, refresh the [Airflow UI][Airflow_UI]. + 1. In `Search DAGS`, type `timescale_dag` and press ENTER. + 1. Press the play icon and trigger the DAG: + ![daily eth volume of assets](https://assets.timescale.com/docs/images/integrations-apache-airflow.png) +1. **Verify that the data appears in $CLOUD_LONG** + + 1. In [Timescale Console][console], navigate to your service and click `SQL editor`. + 1. Run a query to view your data. For example: `SELECT symbol, name FROM company;`. + + You see the new rows inserted in the table. + + + +You have successfully integrated Apache Airflow with $CLOUD_LONG and created a data pipeline. + + +[create-a-table-in-timescale]: /getting-started/:currentVersion:/tables-hypertables/#create-regular-postgresql-tables-for-relational-data +[install-apache-airflow]: https://airflow.apache.org/docs/apache-airflow/stable/start.html +[install-python-pip]: https://docs.python.org/3/using/index.html +[console]: https://console.cloud.timescale.com/ +[create-service]: /getting-started/:currentVersion:/services/ +[enable-timescaledb]: /self-hosted/:currentVersion:/install/ +[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/ +[Airflow-DAG]: https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/dags.html#dags +[Airflow-Task]:https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/tasks.html +[Airflow_UI]: localhost:8080 diff --git a/use-timescale/integrations/query-admin/azure-data-studio.md b/use-timescale/integrations/azure-data-studio.md similarity index 96% rename from use-timescale/integrations/query-admin/azure-data-studio.md rename to use-timescale/integrations/azure-data-studio.md index 3ade704e63..db300bca30 100644 --- a/use-timescale/integrations/query-admin/azure-data-studio.md +++ b/use-timescale/integrations/azure-data-studio.md @@ -7,8 +7,7 @@ keywords: [connect] # Connect to Timescale using Azure Data Studio -Azure Data Studio is a cross-platform database tool for data professionals using -on-premises and cloud data platforms on Windows, macOS, and Linux. +Azure Data Studio is an open-source, cross-platform hybrid data analytics tool designed to simplify the data landscape. ## Before you begin diff --git a/use-timescale/integrations/config-deploy/index.md b/use-timescale/integrations/config-deploy/index.md deleted file mode 100644 index c5ca96367c..0000000000 --- a/use-timescale/integrations/config-deploy/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Configuration and deployment integrations -excerpt: Integrate your Timescale database with third-party configuration and deployment solutions -products: [cloud] -keywords: [integrations, configuration, deployment] -tags: [integrations, terraform] ---- - -# Configuration and deployment integrations - -* [Terraform][terraform] - -[terraform]: /use-timescale/:currentVersion:/integrations/config-deploy/terraform diff --git a/use-timescale/integrations/query-admin/dbeaver.md b/use-timescale/integrations/dbeaver.md similarity index 94% rename from use-timescale/integrations/query-admin/dbeaver.md rename to use-timescale/integrations/dbeaver.md index a2eafe939c..572e9afc17 100644 --- a/use-timescale/integrations/query-admin/dbeaver.md +++ b/use-timescale/integrations/dbeaver.md @@ -7,9 +7,7 @@ keywords: [connect] # Connect to Timescale using DBeaver -[DBeaver][dbeaver] is a free and open source database tool that is available for -Microsoft Windows, Apple macOS, and many Linux versions. DBeaver provides a -powerful SQL editor, administration features, ability to migrate data and +[DBeaver][dbeaver] is a free cross-platform database tool for developers, database administrators, analysts, and everyone working with data. DBeaver provides a powerful SQL editor, administration features, ability to migrate data and schema, and the ability to monitor database connection sessions. You can connect to Timescale hosted on your local machine or on a remote server or a Timescale service. diff --git a/use-timescale/integrations/query-admin/find-connection-details.md b/use-timescale/integrations/find-connection-details.md similarity index 89% rename from use-timescale/integrations/query-admin/find-connection-details.md rename to use-timescale/integrations/find-connection-details.md index 3fbfac432b..c7c38c060e 100644 --- a/use-timescale/integrations/query-admin/find-connection-details.md +++ b/use-timescale/integrations/find-connection-details.md @@ -15,7 +15,7 @@ To connect to your $SERVICE_SHORT or self-hosted database, you need at least the - Password - Database name -Find the connection details based on your installation type. +Find the connection details based on your deployment type: @@ -51,7 +51,5 @@ In the `Services` page of the $MST_CONSOLE_LONG, click the service you want to c -[about-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ -[tsc-portal]: https://console.cloud.timescale.com/ [console-services]: https://console.cloud.timescale.com/dashboard/services [postgres-config]: https://www.postgresql.org/docs/current/runtime-config-file-locations.html diff --git a/use-timescale/integrations/observability-alerting/grafana.md b/use-timescale/integrations/grafana.md similarity index 89% rename from use-timescale/integrations/observability-alerting/grafana.md rename to use-timescale/integrations/grafana.md index 4d41851c54..3110e0cc3d 100644 --- a/use-timescale/integrations/observability-alerting/grafana.md +++ b/use-timescale/integrations/grafana.md @@ -7,7 +7,7 @@ keywords: [Grafana, visualizations, analytics, monitoring] import GrafanaConnect from "versionContent/_partials/_grafana-connect.mdx"; -# Grafana +# Integrate Grafana and Timescale Cloud [Grafana](https://grafana.com/docs/) enables you to query, visualize, alert on, and explore your metrics, logs, and traces wherever they’re stored. @@ -22,6 +22,8 @@ view into the performance of a system, and each dashboard consists of one or more panels, which represent information about a specific metric related to that system. +To create a new dashboard: + 1. **On the `Dashboards` page, click `New` and select `New dashboard`** @@ -48,7 +50,7 @@ that system. ## Use the time filter function -Grafana time-series panels include a time filter. +Grafana time-series panels include a time filter: @@ -165,17 +167,14 @@ tutorial as a starting point. Add thresholds for 7 and 10, to mark rides over 7 and 10 miles in different colors, respectively. - You now have a visualization that looks like this: + You now have a visualization that looks like this: - ![Timescale and Grafana integration](https://assets.timescale.com/docs/images/timescale-grafana-integration.png) + ![Timescale and Grafana integration](https://assets.timescale.com/docs/images/timescale-grafana-integration.png) [nyc-taxi]: /tutorials/:currentVersion:/nyc-taxi-cab [grafana-website]: https://www.grafana.com -[install-grafana]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/installation -[tutorial-grafana-dashboards]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#create-a-grafana-dashboard-and-panel -[tutorial-grafana-geospatial]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#visualize-geospatial-data [time-buckets]: /use-timescale/:currentVersion:/time-buckets/ diff --git a/use-timescale/integrations/index.md b/use-timescale/integrations/index.md index e0f3e0b59f..b0140a781d 100644 --- a/use-timescale/integrations/index.md +++ b/use-timescale/integrations/index.md @@ -6,35 +6,57 @@ keywords: [integrations] tags: [integrations] --- +# $CLOUD_LONG Integrations -# Integrate tooling with Timescale Cloud - -You can integrate your Timescale database with third-party solutions to expand -and extend what you can do with your data. - -|[Query and administration][query-admin]|[Configuration and deployment][config-deploy]|[Observability and alerting][observability-alerting]| -|-|-|-| -|[PopSQL][popsql]| -|[psql][psql]|[Terraform][terraform]|[Grafana][grafana]| -|[DBeaver][dbeaver]||[Tableau][tableau]| -|[Azure Data Studio][ads]| -|[pgAdmin][pgadmin]| -|[qStudio][qstudio]| - - - -[query-admin]: /use-timescale/:currentVersion:/integrations/query-admin/ -[observability-alerting]: /use-timescale/:currentVersion:/integrations/observability-alerting/ -[data-ingest]: /use-timescale/:currentVersion:/integrations/data-ingest/ -[config-deploy]: /use-timescale/:currentVersion:/integrations/config-deploy/ -[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ -[dbeaver]: /use-timescale/:currentVersion:/integrations/query-admin/dbeaver/ -[ads]: /use-timescale/:currentVersion:/integrations/query-admin/azure-data-studio/ -[pgadmin]: /use-timescale/:currentVersion:/integrations/query-admin/pgadmin/ -[qstudio]: /use-timescale/:currentVersion:/integrations/query-admin/qstudio/ -[grafana]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/ -[telegraf]: /use-timescale/:currentVersion:/integrations/data-ingest/telegraf/ -[tableau]: /use-timescale/:currentVersion:/integrations/observability-alerting/tableau/ -[terraform]: /use-timescale/:currentVersion:/integrations/config-deploy/terraform/ -[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode +You can integrate your $SERVICE_LONG with third-party solutions to expand and extend what you can do with your data. +## Integrates with PostgreSQL? Integrates with your $SERVICE_SHORT! + +A $SERVICE_LONG is a PostgreSQL database instance extended by $COMPANY with custom capabilities. This means that any third-party solution that you can integrate with PostgreSQL, you can also integrate with $CLOUD_LONG. See the full list of PostgreSQL integrations [here][postgresql-integrations]. + +Some of the most in-demand integrations for $CLOUD_LONG are listed below, with links to detailed integration steps. + +## Query and administration + +| Name | Description | +|:------------------------:|-------------------------------------------------------------------------------------------------------------------------------------------------| +| [Azure Data Studio][ads] | An open-source, cross-platform hybrid data analytics tool designed to simplify the data landscape. | +| [DBeaver][dbeaver] | A free cross-platform database tool for developers, database administrators, analysts, and everyone working with data. | +| [pgAdmin][pgadmin] | A feature-rich open-source administration and development platform for PostgreSQL. | +| [psql][psql] | A terminal-based frontend to PostgreSQL that enables you to type in queries interactively, issue them to PostgreSQL, and see the query results. | +| [qStudio][qstudio] | A modern free SQL editor that provides syntax highlighting, code completion, excel export, charting, and more. | + + +## Observability and alerting + +| Name | Description | +|:---------------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Grafana][grafana] | An open-source analytics and monitoring solution that enables you to query, visualize, alert on, and explore your metrics, logs. | +| [Tableau][tableau] | A popular analytics platform that helps you gain greater intelligence about your business. | + + +## Configuration and deployment + +| Name | Description | +|:---------------------------:|-----------------------------------------------------------------------------------------------------------------------------| +| [Terraform][terraform] | An infrastructure-as-code tool that enables you to safely and predictably provision and manage infrastructure in any cloud. | + + +## Data engineering and extract, transform, load + +| Name | Description | +|:--------------------------------:|----------------------------------------------------------| +| [Apache Airflow][apache-airflow] | Programmatically author, schedule, and monitor workflows. | + + + +[psql]: /use-timescale/:currentVersion:/integrations/psql/ +[qstudio]: /use-timescale/:currentVersion:/integrations/qstudio/ +[dbeaver]: /use-timescale/:currentVersion:/integrations/dbeaver/ +[ads]: /use-timescale/:currentVersion:/integrations/azure-data-studio/ +[pgadmin]: /use-timescale/:currentVersion:/integrations/pgadmin/ +[grafana]: /use-timescale/:currentVersion:/integrations/grafana/ +[tableau]: /use-timescale/:currentVersion:/integrations/tableau/ +[terraform]: /use-timescale/:currentVersion:/integrations/terraform +[apache-airflow]: /use-timescale/:currentVersion:/integrations/apache-airflow +[postgresql-integrations]: https://slashdot.org/software/p/PostgreSQL/integrations/ diff --git a/use-timescale/integrations/observability-alerting/index.md b/use-timescale/integrations/observability-alerting/index.md deleted file mode 100644 index 79e490396e..0000000000 --- a/use-timescale/integrations/observability-alerting/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Observability and alerting integrations -excerpt: Integrate your Timescale database with third-party observability and alerting solutions -products: [cloud] -keywords: [integrations, observability, alerting] -tags: [integrations, observability, alerting] ---- - - - -# Observability and alerting - -* [Grafana][grafana] -* [Tableau][tableau] - -[grafana]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/ -[tableau]: /use-timescale/:currentVersion:/integrations/observability-alerting/tableau/ diff --git a/use-timescale/integrations/query-admin/pgadmin.md b/use-timescale/integrations/pgadmin.md similarity index 96% rename from use-timescale/integrations/query-admin/pgadmin.md rename to use-timescale/integrations/pgadmin.md index db508e0f5e..501bb8a9e9 100644 --- a/use-timescale/integrations/query-admin/pgadmin.md +++ b/use-timescale/integrations/pgadmin.md @@ -7,8 +7,7 @@ keywords: [connect] # Connect to Timescale using pgAdmin -The `pgAdmin` tool is a database administration tool that can be run on the -desktop, or in your browser. It is available for Chrome, Firefox, Edge, and +The `pgAdmin` tool is a feature-rich open-source administration and development platform for PostgreSQL. It is available for Chrome, Firefox, Edge, and Safari browsers, or can be installed on Microsoft Windows, Apple macOS, or various Linux flavors. diff --git a/use-timescale/integrations/query-admin/psql.md b/use-timescale/integrations/psql.md similarity index 94% rename from use-timescale/integrations/query-admin/psql.md rename to use-timescale/integrations/psql.md index 9a5680aab7..d014efca11 100644 --- a/use-timescale/integrations/query-admin/psql.md +++ b/use-timescale/integrations/psql.md @@ -9,7 +9,7 @@ import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.md # Connect with psql -`psql` is a terminal-based front-end to PostgreSQL that enables you to type in queries interactively, issue them to Postgres, and see the query results. +[`psql`][psql-docs] is a terminal-based frontend to PostgreSQL that enables you to type in queries interactively, issue them to Postgres, and see the query results. This page shows you how to use the `psql` command line tool to interact with your $SERVICE_LONG. @@ -208,7 +208,7 @@ When you start using `psql`, these are the commands you are likely to use most f |`\x`|Show expanded query results| |`\?`|List all `psql` slash commands| -For more on `psql` commands, see the [Timescale psql cheat sheet][psql-cheat-sheet] and [psql documentation][psql-docs]. +For more on `psql` commands, see the [$COMPANY psql cheat sheet][psql-cheat-sheet] and [psql documentation][psql-docs]. ## Save query results to a file @@ -251,11 +251,11 @@ loaded into the editor. When you have made your changes, press `Esc`, then type edited query by pressing `↑`, and press `Enter` to run it. [psql-cheat-sheet]: https://www.timescale.com/learn/postgres-cheat-sheet -[psql-docs]: https://www.postgresql.org/docs/13/app-psql.html +[psql-docs]: https://www.postgresql.org/docs/current/app-psql.html [ssl-mode]: /use-timescale/:currentVersion:/security/strict-ssl/ [homebrew]: https://docs.brew.sh/Installation [macports]: https://guide.macports.org/#installing.macports [windows-installer]: https://www.postgresql.org/download/windows/ -[connect-database]:/use-timescale/:currentVersion:/integrations/query-admin/psql/#connect-to-your-service -[connection-info]: /use-timescale/:currentVersion:/integrations/query-admin/find-connection-details/ +[connect-database]:/use-timescale/:currentVersion:/integrations/psql/#connect-to-your-service +[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/ diff --git a/use-timescale/integrations/query-admin/qstudio.md b/use-timescale/integrations/qstudio.md similarity index 94% rename from use-timescale/integrations/query-admin/qstudio.md rename to use-timescale/integrations/qstudio.md index 88591eaa29..eb37f52dcf 100644 --- a/use-timescale/integrations/query-admin/qstudio.md +++ b/use-timescale/integrations/qstudio.md @@ -7,8 +7,7 @@ keywords: [connect] # Connect to Timescale using qStudio -You can use [qStudio][qstudio] to run queries, browse tables, and create charts -for your Timescale database. +[qStudio][qstudio] is a modern free SQL editor that provides syntax highlighting, code-completion, excel export, charting, and much more. You can use it to run queries, browse tables, and create charts for your Timescale database. For more information about `qStudio`, including download and installation instructions, see [timestored.com][qstudio-downloads]. diff --git a/use-timescale/integrations/query-admin/index.md b/use-timescale/integrations/query-admin/index.md deleted file mode 100644 index 94eee66a68..0000000000 --- a/use-timescale/integrations/query-admin/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Query and administration integrations -excerpt: Integrate your Timescale database with third-party query and administration solutions -products: [cloud] -keywords: [integrations, queries, administration] -tags: [integrations, psql, dbeaver, azure data studio, pgadmin] ---- - - - -# Query and administration integrations - -* [Azure Data Studio][ads] -* [DBeaver][dbeaver] -* [PGAdmin][pgadmin] -* [psql][psql] -* [qStudio][qstudio] - -[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ -[qstudio]: /use-timescale/:currentVersion:/integrations/query-admin/qstudio/ -[dbeaver]: /use-timescale/:currentVersion:/integrations/query-admin/dbeaver/ -[ads]: /use-timescale/:currentVersion:/integrations/query-admin/azure-data-studio/ -[pgadmin]: /use-timescale/:currentVersion:/integrations/query-admin/pgadmin/ diff --git a/use-timescale/integrations/observability-alerting/tableau.md b/use-timescale/integrations/tableau.md similarity index 98% rename from use-timescale/integrations/observability-alerting/tableau.md rename to use-timescale/integrations/tableau.md index b33414c556..767e8925c2 100644 --- a/use-timescale/integrations/observability-alerting/tableau.md +++ b/use-timescale/integrations/tableau.md @@ -9,7 +9,7 @@ keywords: [visualizations, analytics, Tableau] [Tableau][get-tableau] is a popular analytics platform that helps you gain greater intelligence about your business. It is an ideal tool for visualizing -data stored in Timescale. +data stored in Timescale. ## Prerequisites diff --git a/use-timescale/integrations/config-deploy/terraform.md b/use-timescale/integrations/terraform.md similarity index 63% rename from use-timescale/integrations/config-deploy/terraform.md rename to use-timescale/integrations/terraform.md index 51439b2008..11fb802077 100644 --- a/use-timescale/integrations/config-deploy/terraform.md +++ b/use-timescale/integrations/terraform.md @@ -8,9 +8,7 @@ tags: [terraform, manage] # Terraform -Terraform is an open source infrastructure as code (IaC) tool developed by -HashiCorp. The Timescale Terraform provider allows you to manage Timescale -services through a Terraform configuration. +Terraform is an infrastructure-as-code tool that enables you to safely and predictably provision and manage infrastructure in any cloud. The Timescale Terraform provider allows you to manage Timescale services through a Terraform configuration. For more information about the supported service configurations and operations, see the diff --git a/use-timescale/metrics-logging/service-metrics.md b/use-timescale/metrics-logging/service-metrics.md index 72be7c5ce2..dd974365af 100644 --- a/use-timescale/metrics-logging/service-metrics.md +++ b/use-timescale/metrics-logging/service-metrics.md @@ -136,4 +136,4 @@ performance bottlenecks with `pg_stat_statements`][blog-pg_stat_statements]. [metrics-dashboard]: /use-timescale/:currentVersion:/metrics-logging/service-metrics/ [pg-stat]: /use-timescale/:currentVersion:/metrics-logging/service-metrics/#query-level-statistics-with-pg_stat_statements [blog-pg_stat_statements]: -[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/ +[psql]: /use-timescale/:currentVersion:/integrations/psql/ diff --git a/use-timescale/page-index/page-index.js b/use-timescale/page-index/page-index.js index b95a8b4e0f..af995e7a77 100644 --- a/use-timescale/page-index/page-index.js +++ b/use-timescale/page-index/page-index.js @@ -774,78 +774,59 @@ module.exports = [ excerpt: "Integrate third-party solutions with Timescale Cloud", children: [ { - title: "Query and administration", - href: "query-admin", - excerpt: "Integrate your Timescale database with third-party query and administration solutions", - children: - [ - { - title: "Find your connection details", - href: "find-connection-details", - excerpt: "Learn about using connecting to your Timescale database", - }, - { - title: "Connect with psql", - href: "psql", - excerpt: "Install psql to connect to Timescale", - }, - { - title: "Connect using Azure Data Studio", - href: "azure-data-studio", - excerpt: "Install Azure Data Studio to connect to Timescale", - }, - { - title: "Connect using DBeaver", - href: "dbeaver", - excerpt: "Install DBeaver to connect to Timescale", - }, - { - title: "Connect using pgAdmin", - href: "pgadmin", - excerpt: "Install pgAdmin to connect to Timescale", - }, - { - title: "Connect using qStudio", - href: "qstudio", - excerpt: "Install qstudio to connect to Timescale", - }, - { - title: "Troubleshooting Timescale connections", - href: "troubleshooting", - type: "placeholder", - }, - ] - }, - { - title: "Configuration and deployment", - href: "config-deploy", - excerpt: "Integrate your Timescale account with third-party configuration and deployment solutions", - children: - [ - { - title: "Terraform", - href: "terraform", - excerpt: "Manage your Timescale services via Terraform", - }, - ] - }, - { - title: "Observability and alerting", - href: "observability-alerting", - excerpt: "Integrate your Timescale database with third-party observability and alerting solutions", - children: - [ - { - title: "Grafana", - href: "grafana", - excerpt: "Use Grafana with Timescale", - }, - { - title: "Tableau", - href: "tableau", - excerpt: "Use Tableau with Timescale", - } - ] + title: "Find your connection details", + href: "find-connection-details", + excerpt: "Learn about connecting to your Timescale database", + }, + { + title: "Apache Airflow", + href: "apache-airflow", + excerpt: "Integrate Apache Airflow with Timescale Cloud", + }, + { + title: "Azure Data Studio", + href: "azure-data-studio", + excerpt: "Install Azure Data Studio to connect to Timescale", + }, + { + title: "DBeaver", + href: "dbeaver", + excerpt: "Install DBeaver to connect to Timescale", + }, + { + title: "pgAdmin", + href: "pgadmin", + excerpt: "Install pgAdmin to connect to Timescale", + }, + { + title: "psql", + href: "psql", + excerpt: "Install psql to connect to Timescale", + }, + { + title: "qStudio", + href: "qstudio", + excerpt: "Install qstudio to connect to Timescale", + }, + { + title: "Grafana", + href: "grafana", + excerpt: "Use Grafana with Timescale", + }, + { + title: "Tableau", + href: "tableau", + excerpt: "Use Tableau with Timescale", + }, + { + title: "Terraform", + href: "terraform", + excerpt: "Manage your Timescale services via Terraform", + }, + { + title: "Troubleshooting Timescale integrations", + href: "troubleshooting", + type: "placeholder", }, ], }, @@ -908,7 +889,6 @@ module.exports = [ href: "troubleshoot-timescaledb", excerpt: "Troubleshooting Timescale", }, - ], }, ]; diff --git a/use-timescale/services/change-resources.md b/use-timescale/services/change-resources.md index 8493c97ce7..b9538bbe50 100644 --- a/use-timescale/services/change-resources.md +++ b/use-timescale/services/change-resources.md @@ -11,84 +11,87 @@ cloud_ui: import UsageBasedStorage from "versionContent/_partials/_usage-based-storage-intro.mdx"; -# Resources +# Manually change compute resources -Timescale allows you to resize compute (CPU/RAM) resources independently at any -time. You can resize compute in the Timescale console for any service, with a -short downtime. +You use [$CONSOLE][cloud-login] to resize the compute (CPU/RAM) resources available to your +$SERVICE_LONGs at any time, with a short downtime. -Because compute changes require an interruption to your service, plan -accordingly so that the settings are applied during an appropriate service -window. +## Update compute resources for a $SERVICE_LONG -## Compute resources +You can change the CPU and memory allocation for your $SERVICE_LONG at any time with +minimal downtime, usually less than a minute. The new resources become available as soon as +the service restarts. You can change the CPU and memory allocation up or down, as frequently as required. -You can change the CPU and memory allocation for your service at any time, with -minimal downtime, usually less than thirty seconds. The new resources become -available as soon as the service restarts. You can change the CPU and memory -allocation up or down, as frequently as required. +![Change resources](https://assets.timescale.com/docs/images/console-update-resources.png) -There is momentary downtime while the new compute settings are applied. In most -cases, this downtime is less than 30 seconds. +There is momentary downtime while the new compute settings are applied. In most cases, this is +less than a minute. However, Before making changes to your service, best practice +is to enable [HA replication][high-availability] on the service. When you resize a service with HA enabled, +$CLOUD_LONG: + +1. Resizes the replica. +1. Waits for the replica to catch up. +1. Performs a switchover to the resized replica. +1. Restarts the primary. + +HA reduce downtime in the case of resizes or maintenance window restarts, from a minute or so to a couple of seconds. When you change resource settings, the current and new charges are displayed immediately so that you can verify how the changes impact your costs. -Changing your compute settings usually requires a short downtime. Make sure you -plan for this before you begin. - - +Because compute changes require an interruption to your $SERVICE_LONGs, plan accordingly so that the +settings are applied during an appropriate service window. -### Changing resource allocations manually + -1. In the Timescale console, from the `Services` list, click the name of - the service you want to modify. -1. In the `Service details` page, navigate to the `Operations` tab, and click - `Compute`. -1. In the `Change CPU/Memory` field, select the new CPU and memory - allocation. -1. Review the new allocations and costs in the comparison chart. -1. Click `Apply` to save your changes. Your service goes down briefly while the - changes are applied. + - Changing Timescale service compute size +1. In [$CONSOLE][services-portal], choose the $SERVICE_SHORT to modify. +1. Click `Operations`, then click `Compute`. +1. Select the new `CPU / Memory` allocation. + You see the allocation and costs in the comparison chart +1. Click `Apply`. + Your service goes down briefly while the changes are applied. ## Out of memory errors -If you run intensive queries on your Timescale services, you might +If you run intensive queries on your $SERVICE_LONGs, you might encounter out of memory (OOM) errors. This occurs if your query consumes more memory than is available. When this happens, an `OOM killer` process shuts down PostgreSQL processes using -`SIGKILL` commands, until the memory usage falls below the upper limit. Because -this kills the entire server process, it usually requires a restart. To -prevent service disruption caused by OOM errors, Timescale attempts to +`SIGKILL` commands until the memory usage falls below the upper limit. Because +this kills the entire server process, it usually requires a restart. + +To prevent service disruption caused by OOM errors, $CLOUD_LONG attempts to shut down only the query that caused the problem. This means that the -problematic query does not run, but that your PostgreSQL service continues to +problematic query does not run, but that your $SERVICE_LONG continues to operate normally. -If the normal OOM killer is triggered, the error log looks like this: +* If the normal OOM killer is triggered, the error log looks like this: -```yml -2021-09-09 18:15:08 UTC [560567]:TimescaleDB: LOG: server process (PID 2351983) was terminated by signal 9: Killed -``` + ```yml + 2021-09-09 18:15:08 UTC [560567]:TimescaleDB: LOG: server process (PID 2351983) was terminated by signal 9: Killed + ``` + + Wait for the $SERVICE_LONG to come back online before reconnecting. -Wait for the entire service to come back online before reconnecting. +* $CLOUD_LONG shuts the client connection only + + If $CLOUD_LONG successfully guards the $SERVICE_SHORT against the OOM killer, it shuts + down only the client connection that was using too much memory. This prevents + the entire $SERVICE_LONG from shutting down, so you can reconnect immediately. The error log looks like this: -If Timescale successfully guards the service against the OOM killer, it shuts -down only the client connection that was using too much memory. This prevents -the entire PostgreSQL service from shutting down, so you can reconnect -immediately. The error log looks like this: + ```yml + 2022-02-03 17:12:04 UTC [2253150]:TimescaleDB: tsdbadmin@tsdb,app=psql [53200] ERROR: out of memory + ``` -```yml -2022-02-03 17:12:04 UTC [2253150]:TimescaleDB: tsdbadmin@tsdb,app=psql [53200] ERROR: out of memory -``` +[cloud-login]: https://console.cloud.timescale.com/ +[high-availability]: /use-timescale/:currentVersion:/ha-replicas/high-availability/ +[services-portal]: https://console.cloud.timescale.com/dashboard/services