From c5ff939c78a9ce8c7dc54b978a40f518d889f92c Mon Sep 17 00:00:00 2001 From: atovpeko Date: Thu, 24 Apr 2025 12:28:03 +0300 Subject: [PATCH 1/4] added passwordless data mode + cleanup --- _partials/_cloud-connect-service.md | 31 +++++- _partials/_cloud-intro.md | 2 +- getting-started/run-queries-from-console.md | 103 +++++++++--------- .../try-key-features-timescale-products.md | 26 +++-- 4 files changed, 92 insertions(+), 70 deletions(-) diff --git a/_partials/_cloud-connect-service.md b/_partials/_cloud-connect-service.md index 5647de4f77..29d91a4498 100644 --- a/_partials/_cloud-connect-service.md +++ b/_partials/_cloud-connect-service.md @@ -9,9 +9,33 @@ 1. **Connect to your $SERVICE_SHORT** - Connect using SQL editor in $CONSOLE or with psql in the command line: + Connect using the data mode, SQL editor in $CONSOLE, or psql in the command line: + + + + + + 1. In $CONSOLE, toggle `Data`. + + 1. Select your $SERVICE_SHORT in the connection drop-down in the top right. + + ![Select a connection](https://assets.timescale.com/docs/images/data-mode-connection-dropdown.png) + + 1. Run a test query: + + ```sql + SELECT CURRENT_DATE; + ``` + + This query gives you the current date, you have successfully connected to your $SERVICE_SHORT. + + + + And that is it, you are up and running. Enjoy developing with $COMPANY. + + @@ -55,7 +79,7 @@ SELECT CURRENT_DATE; ``` - This query returns the current date. You have successfully connected to your $SERVICE_SHORT. + This query returns the current date. You have successfully connected to your $SERVICE_SHORT. @@ -66,9 +90,6 @@ - - -You can also use the powerful [data mode][popsql] to connect and run queries on your service. Quick recap. You: - Manage your $SERVICE_SHORTs in the [$OPS_MODE][portal-ops-mode] in $CONSOLE: add $READ_REPLICAs and enable diff --git a/_partials/_cloud-intro.md b/_partials/_cloud-intro.md index 7a8f9d45fe..f8341c0779 100644 --- a/_partials/_cloud-intro.md +++ b/_partials/_cloud-intro.md @@ -12,7 +12,7 @@ use as is, or extend with the capabilities specific to your business needs: - **AI and vector**: $PG with vector extensions. Use $PG as a vector database with purpose built extensions for building AI applications from start to scale. Get fast and accurate similarity search with the pgvector and pgvectorscale extensions. Create vector embeddings and perform LLM reasoning on your data with - the $PGAI_SHORT extension. + the pgai extension. - **PostgreSQL**: the trusted industry-standard RDBMS. Ideal for applications requiring strong data consistency, complex relationships, and advanced querying capabilities. Get ACID compliance, extensive SQL support, JSON handling, and extensibility through custom functions, data types, and extensions. $CLOUD_LONG continuously diff --git a/getting-started/run-queries-from-console.md b/getting-started/run-queries-from-console.md index 51b72b886e..f0af17181f 100644 --- a/getting-started/run-queries-from-console.md +++ b/getting-started/run-queries-from-console.md @@ -9,7 +9,7 @@ import WhereNext from "versionContent/_partials/_where-to-next.mdx"; # Run your queries from $CONSOLE -As $CLOUD_LONG is based on PostgreSQL, you can use lots of [different tools][integrations] to +As $CLOUD_LONG is based on $PG, you can use lots of [different tools][integrations] to connect to your $SERVICE_SHORT and interact with your data. In $CONSOLE you can use the following ways to run SQL queries against your $SERVICE_SHORT: @@ -20,8 +20,7 @@ In $CONSOLE you can use the following ways to run SQL queries against your $SERV - [$SQL_ASSISTANT_SHORT in the $DATA_MODE][sql-assistant]: write, fix, and organize SQL faster and more accurately. - [$SQL_EDITOR in the $OPS_MODE][run-sqleditor]: a simple $SQL_EDITOR in the $OPS_MODE that lets you run ad-hoc ephemeral - queries. This is useful for quick one-off tasks like creating an index on a small table or - inspecting `pg_stat_statements`. + queries. This is useful for quick one-off tasks like creating an index on a small table or inspecting `pg_stat_statements`. If you prefer the command line to the $OPS_MODE $SQL_EDITOR in $CONSOLE, use [psql][install-psql]. @@ -35,17 +34,15 @@ Available features are: - **Real-time collaboration**: work with your team directly in the $DATA_MODE query editor with live presence and multiple cursors. -- **[Schema browser](https://docs.popsql.com/docs/schema)**: understand the structure of your $SERVICE_SHORT and see usage data on tables and columns. +- **[Schema browser][schema-browser]**: understand the structure of your $SERVICE_SHORT and see usage data on tables and columns. - **[$SQL_ASSISTANT_SHORT][sql-assistant]**: write, fix, and organize SQL faster and more accurately using AI. - **Autocomplete**: get suggestions as you type your queries. -- **[Version history](https://docs.popsql.com/docs/version-history)**: access previous versions of a query from the built-in revision history, or connect to a - git repo. -- **[Charts](https://docs.popsql.com/docs/creating-charts)**: visualize data from inside the UI rather than switch to Sheets or Excel. -- **[Schedules](https://docs.popsql.com/docs/scheduled-queries)**: automatically refresh queries and dashboards to create push alerts. -- **[Query variables](https://docs.popsql.com/docs/query-variables)**: use Liquid to parameterize your queries or use `if` statements. -- **Cross-platform**: works from [$CONSOLE][portal-data-mode] or download the - [desktop](https://popsql.com/download) app for macOS, Windows, and Linux. -- **Easy connection**: to $CLOUD_LONG, $PG, Redshift, Snowflake, BigQuery, MySQL, SQL Server, [and more](https://popsql.com/connections). +- **[Version history][version-history]**: access previous versions of a query from the built-in revision history, or connect to a git repo. +- **[Charts][charts]**: visualize data from inside the UI rather than switch to Sheets or Excel. +- **[Schedules][schedules]**: automatically refresh queries and dashboards to create push alerts. +- **[Query variables][query-variables]**: use Liquid to parameterize your queries or use `if` statements. +- **Cross-platform support**: work from [$CONSOLE][portal-data-mode] or download the [desktop app][popsql-desktop] for macOS, Windows, and Linux. +- **Easy connection**: connect to $CLOUD_LONG, $PG, Redshift, Snowflake, BigQuery, MySQL, SQL Server, [and more][popsql-connections]. ### Connect to your $SERVICE_LONG in the $DATA_MODE @@ -55,24 +52,21 @@ To connect to a $SERVICE_SHORT: 1. **Check your $SERVICE_SHORT is running correctly** - In [$CONSOLE][services-portal], check that your $SERVICE_SHORT is marked as `Running`. + In [$CONSOLE][services-portal], check that your $SERVICE_SHORT is marked as `Running`: - ![Check $SERVICE_LONG is running](https://assets.timescale.com/docs/images/console-services-view.png) + ![Check $SERVICE_LONG is running](https://assets.timescale.com/docs/images/timescale-console-services-view.png) 1. **Connect to your $SERVICE_SHORT** - 1. In the [$DATA_MODE][portal-data-mode] in $CONSOLE, select a $SERVICE_SHORT in the connection drop-down. - 1. Click the pencil icon next to the $SERVICE_SHORT name. + In the [$DATA_MODE][portal-data-mode] in $CONSOLE, select a $SERVICE_SHORT in the connection drop-down: - ![Select a connection](https://assets.timescale.com/docs/images/data-mode-connections.png) - - 1. Click `Edit` next to `Username/Password` and enter [your connection details][connection-info] for this $SERVICE_SHORT, then click `Connect`. + ![Select a connection](https://assets.timescale.com/docs/images/data-mode-connection-dropdown.png) 1. **Run a test query** - Type `SELECT CURRENT_DATE;` in `Scratchpad` and press `Run`: + Type `SELECT CURRENT_DATE;` in `Scratchpad` and click `Run`: - ![Run a simple query](https://assets.timescale.com/docs/images/data-mode-scratchpad.png) + ![Run a simple query](https://assets.timescale.com/docs/images/run-query-in-scratchpad.png) Quick recap. You: - Manage your $SERVICE_SHORTs in the [$OPS_MODE in $CONSOLE][portal-ops-mode] @@ -83,15 +77,11 @@ Quick recap. You: Now you have used the $DATA_MODE in $CONSOLE, see how to easily do the following: -- [Write a query](https://docs.popsql.com/docs/writing-a-query) -- [Share a query with your - teammates](https://docs.popsql.com/docs/sharing-a-link-to-your-query-and-results) -- [Create a chart from your - data](https://docs.popsql.com/docs/creating-charts) -- [Create a dashboard of multiple query - results](https://docs.popsql.com/docs/creating-dashboards) -- [Create schedules for your - queries](https://docs.popsql.com/docs/scheduled-queries) +- [Write a query][write-query] +- [Share a query with your teammates][share-query] +- [Create a chart from your data][create-chart] +- [Create a dashboard of multiple query results][create-dashboard] +- [Create schedules for your queries][create-schedule] ### $DATA_MODE_CAP FAQ @@ -99,7 +89,7 @@ Now you have used the $DATA_MODE in $CONSOLE, see how to easily do the following If your $SERVICE_LONG runs inside a $VPC, do one of the following to enable access for the $POPSQL desktop app: -- Use $POPSQL's [bridge connector](https://docs.popsql.com/docs/bridge-connector). +- Use $POPSQL's [bridge connector][bridge-connector]. - Use an SSH tunnel: when you configure the connection in $POPSQL, under `Advanced Options` enable `Connect over SSH`. - Add $POPSQL's static IPs (`23.20.131.72, 54.211.234.135`) to your allowlist. @@ -119,7 +109,7 @@ If you have a small number of users running performant SQL queries against a $SERVICE_SHORT with sufficient resources, then there should be no degradation to performance. However, if you have a large number of users running queries, or if the queries are computationally expensive, best practice is to create -a [$READ_REPLICA][readreplica] and send analytical queries there. +a [$READ_REPLICA][read-replica] and send analytical queries there. If you'd like to prevent write operations such as insert or update, instead of using the `tsdbadmin` user, create a read-only user for your $SERVICE_SHORT and @@ -161,7 +151,6 @@ For best results with $SQL_ASSISTANT_SHORT: * **Business logic**: $SQL_ASSISTANT_SHORT does not inherently know specific business terms such as active user. Define these terms clearly to improve results. - ### Security, privacy, and data usage Security and privacy is prioritized in $CONSOLE. In [$DATA_MODE][portal-data-mode], project members @@ -179,7 +168,6 @@ $SQL_ASSISTANT_SHORT settings are: * **Sample data**: to give the LLM more context so you have better SQL suggestions, enable sample data sharing in the $SQL_ASSISTANT_SHORT preferences. * **Telemetry**: to improve $SQL_ASSISTANT_SHORT, $COMPANY collects telemetry and usage data, including prompts, responses, and query metadata. - ## $OPS_MODE_CAP $SQL_EDITOR $SQL_EDITOR is an integrated secure UI that you use to run queries and see the results @@ -204,10 +192,11 @@ To use $SQL_EDITOR: 1. **Run a test query** - Type your query in the UI, then click `Run`. The results appear in the lower window. + Type `SELECT CURRENT_DATE;` in the UI and click `Run`. The results appear in the lower window: - + ![Run a simple query](https://assets.timescale.com/docs/images/run-query-in-sql-editor.png) + ## Cloud $SQL_EDITOR licenses @@ -215,27 +204,37 @@ To use $SQL_EDITOR: * **Data mode**: the number of seats you are allocated depends on your [$PRICING_PLAN][pricing-plan-features]. [$SQL_ASSISTANT_SHORT][sql-assistant] is currently free for all users. In the future, limits or paid options may be introduced as we work to build the best experience. -* **$POPSQL standalone**: there is a free plan available to everyone, as well as paid plans. See [$POPSQL Pricing][popsql-pricing] for full - details. - +* **$POPSQL standalone**: there is a free plan available to everyone, as well as paid plans. See [$POPSQL Pricing][popsql-pricing] for full details. -[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 +[bridge-connector]: https://docs.popsql.com/docs/bridge-connector +[charts]: https://docs.popsql.com/docs/creating-charts +[connection-info]: /integrations/:currentVersion:/find-connection-details/ +[console]: https://console.cloud.timescale.com +[create-chart]: https://docs.popsql.com/docs/creating-charts +[create-cloud-account]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-account +[create-dashboard]: https://docs.popsql.com/docs/creating-dashboards +[create-schedule]: https://docs.popsql.com/docs/scheduled-queries +[install-psql]: /integrations/:currentVersion:/psql/ [integrations]: /integrations/:currentVersion:/ -[timescale-console]: https://console.cloud.timescale.com/ +[popsql-connections]: https://popsql.com/connections +[popsql-desktop]: https://popsql.com/download +[popsql-pricing]: https://popsql.com/pricing +[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql [portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services [pricing-plan-features]: https://www.timescale.com/pricing#features -[install-psql]: /integrations/:currentVersion:/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 [project-members]: /use-timescale/:currentVersion:/members/ -[console]: https://console.cloud.timescale.com -[sql-editor-settings]: https://console.cloud.timescale.com/dashboard/settings?popsql=%2Fpreferences%2Fai -[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql +[query-variables]: https://docs.popsql.com/docs/query-variables +[read-replica]: /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/#ops-mode-sql-editor +[schedules]: https://docs.popsql.com/docs/scheduled-queries +[schema-browser]: https://docs.popsql.com/docs/schema +[services-portal]: https://console.cloud.timescale.com/dashboard/services +[share-query]: https://docs.popsql.com/docs/sharing-a-link-to-your-query-and-results [sql-assistant]: /getting-started/:currentVersion:/run-queries-from-console/#sql-assistant -[connection-info]: /integrations/:currentVersion:/find-connection-details/ -[popsql-pricing]: https://popsql.com/pricing +[sql-editor-settings]: https://console.cloud.timescale.com/dashboard/settings?popsql=%2Fpreferences%2Fai +[timescale-console]: https://console.cloud.timescale.com/ +[version-history]: https://docs.popsql.com/docs/version-history +[write-query]: https://docs.popsql.com/docs/writing-a-query \ No newline at end of file diff --git a/getting-started/try-key-features-timescale-products.md b/getting-started/try-key-features-timescale-products.md index 0441471283..e51f1a8c32 100644 --- a/getting-started/try-key-features-timescale-products.md +++ b/getting-started/try-key-features-timescale-products.md @@ -36,7 +36,7 @@ is made up of child tables called $CHUNKs. Each $CHUNK is assigned a range of ti contains data from that range. When you run a query, $CLOUD_LONG identifies the correct $CHUNK and runs the query on it, instead of going through the entire table. You can also tune $HYPERTABLEs to increase performance even more. -![Main features and tiered data](https://assets.timescale.com/docs/images/hypertable-structure.png ) +![Main features and tiered data](https://assets.timescale.com/docs/images/hypertable-structure.png) $HYPERTABLE_CAPs exist alongside regular $PG tables. You use regular $PG tables for relational data, and interact with $HYPERTABLEs @@ -106,7 +106,7 @@ relational and time-series data from external files. SELECT create_hypertable('crypto_ticks', by_range('time')); ``` To more fully understand how $HYPERTABLEs work, and how to optimize them for performance by - tuning $CHUNK intervals and enabling $CHUNK_SKIPPING, see [the $HYPERTABLEs documentation][hypertables-section]. + tuning $CHUNK intervals and enabling chunk skipping, see [the $HYPERTABLEs documentation][hypertables-section]. - For the relational data: @@ -133,7 +133,7 @@ relational and time-series data from external files. To more fully understand how $HYPERTABLEs work, and how to optimize them for performance by - tuning $CHUNK intervals and enabling $CHUNK_SKIPPING, see [the $HYPERTABLEs documentation][hypertables-section]. + tuning $CHUNK intervals and enabling chunk skipping, see [the $HYPERTABLEs documentation][hypertables-section]. 1. **Have a quick look at your data** @@ -172,18 +172,20 @@ $CONSOLE. You can also do this using psql. - + -1. **In [$CONSOLE][portal-ops-mode], select the $SERVICE_SHORT you uploaded data to, then click `SQL Editor`** +1. **Connect to your $SERVICE_SHORT** + + In [$CONSOLE][portal-data-mode], select your $SERVICE_SHORT in the connection drop-down in the top right 1. **Create a $CAGG** For a $CAGG, data grouped using a $TIME_BUCKET is stored in a $PG `MATERIALIZED VIEW` in a $HYPERTABLE. `timescaledb.continuous` ensures that this data is always up to date. - In your SQL editor, use the following code to create a $CAGG on the real-time data in + In the data mode editor, use the following code to create a $CAGG on the real-time data in the `crypto_ticks` table: ```sql @@ -228,10 +230,10 @@ $CONSOLE. You can also do this using psql. -1. **In [$CONSOLE][portal-ops-mode], select the $SERVICE_SHORT you uploaded data to**. -1. **Click `Operations` > `Continuous aggregates`, select `crypto_ticks`, then click `Create a Continuous Aggregate`**. +1. **In [$CONSOLE][portal-ops-mode], select the $SERVICE_SHORT you uploaded data to** +1. **Click `Operations` > `Continuous aggregates`, select `crypto_ticks`, then click `Create a Continuous Aggregate`** ![$CAGG wizard](https://assets.timescale.com/docs/images/continuous-aggregate-wizard.png ) -1. **Create a view called `assets_candlestick_daily` on the `time` column with an interval of `1 day`, then click `Next step`**. +1. **Create a view called `assets_candlestick_daily` on the `time` column with an interval of `1 day`, then click `Next step`** 1. **Update the view SQL with the following functions, then click `Run`** ```sql CREATE MATERIALIZED VIEW assets_candlestick_daily @@ -357,7 +359,7 @@ To set up data tiering: 1. **Set the time interval when data is tiered** - In $CONSOLE, click `SQL Editor`, then enable data tiering on a $HYPERTABLE with the following query: + In $CONSOLE, click `Data` to switch to the data mode, then enable data tiering on a $HYPERTABLE with the following query: ```sql SELECT add_tiering_policy('assets_candlestick_daily', INTERVAL '3 weeks'); ``` @@ -386,9 +388,9 @@ To set up data tiering: ## Reduce the risk of downtime and data loss By default, all $SERVICE_LONGs have rapid recovery enabled. However, if your app has very low tolerance -for downtime, $CLOUD_LONG offers $HA_REPLICAs. $HA_REPLICA_SHORTs are exact, up-to-date copies +for downtime, $CLOUD_LONG offers $HA_REPLICAs. HA replicas are exact, up-to-date copies of your database hosted in multiple AWS availability zones (AZ) within the same region as your primary node. -$HA_REPLICA_SHORTa automatically take over operations if the original primary data node becomes unavailable. +HA replicas automatically take over operations if the original primary data node becomes unavailable. The primary node streams its write-ahead log (WAL) to the replicas to minimize the chances of data loss during failover. From b11fd0092eab2b0b021addf443d03be747cbfe7b Mon Sep 17 00:00:00 2001 From: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com> Date: Thu, 24 Apr 2025 21:05:55 +0300 Subject: [PATCH 2/4] Update getting-started/try-key-features-timescale-products.md Co-authored-by: Iain Cox Signed-off-by: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com> --- getting-started/try-key-features-timescale-products.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/try-key-features-timescale-products.md b/getting-started/try-key-features-timescale-products.md index e51f1a8c32..f425c9874b 100644 --- a/getting-started/try-key-features-timescale-products.md +++ b/getting-started/try-key-features-timescale-products.md @@ -178,7 +178,7 @@ $CONSOLE. You can also do this using psql. 1. **Connect to your $SERVICE_SHORT** - In [$CONSOLE][portal-data-mode], select your $SERVICE_SHORT in the connection drop-down in the top right + In [$CONSOLE][portal-data-mode], select your $SERVICE_SHORT in the connection drop-down in the top right. 1. **Create a $CAGG** From d115c78f2a1764ed4f33f5e01128a97f2525358c Mon Sep 17 00:00:00 2001 From: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com> Date: Thu, 24 Apr 2025 21:06:07 +0300 Subject: [PATCH 3/4] Update getting-started/try-key-features-timescale-products.md Co-authored-by: Iain Cox Signed-off-by: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com> --- getting-started/try-key-features-timescale-products.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/try-key-features-timescale-products.md b/getting-started/try-key-features-timescale-products.md index f425c9874b..2e4986dc4b 100644 --- a/getting-started/try-key-features-timescale-products.md +++ b/getting-started/try-key-features-timescale-products.md @@ -185,7 +185,7 @@ $CONSOLE. You can also do this using psql. For a $CAGG, data grouped using a $TIME_BUCKET is stored in a $PG `MATERIALIZED VIEW` in a $HYPERTABLE. `timescaledb.continuous` ensures that this data is always up to date. - In the data mode editor, use the following code to create a $CAGG on the real-time data in + In data mode, use the following code to create a $CAGG on the real-time data in the `crypto_ticks` table: ```sql From 0409eac431e4774536c9cbd231bd312e7f865f88 Mon Sep 17 00:00:00 2001 From: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com> Date: Thu, 24 Apr 2025 21:06:30 +0300 Subject: [PATCH 4/4] Update _partials/_cloud-connect-service.md Co-authored-by: Iain Cox Signed-off-by: Anastasiia Tovpeko <114177030+atovpeko@users.noreply.github.com> --- _partials/_cloud-connect-service.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_partials/_cloud-connect-service.md b/_partials/_cloud-connect-service.md index 29d91a4498..cb02abbf8b 100644 --- a/_partials/_cloud-connect-service.md +++ b/_partials/_cloud-connect-service.md @@ -9,7 +9,7 @@ 1. **Connect to your $SERVICE_SHORT** - Connect using the data mode, SQL editor in $CONSOLE, or psql in the command line: + Connect using data mode or SQL editor in $CONSOLE, or psql in the command line: