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

Add an intro about account/service/connection #3490

Open
wants to merge 10 commits into
base: latest
Choose a base branch
from
2 changes: 2 additions & 0 deletions _partials/_cloud-installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## Create a Timescale Cloud account

You create a $CLOUD_LONG account to manage your services and data in a centralized and efficient manner. From $CONSOLE you can create and delete services, run queries, manage access and billing, integrate other services, contact support, and more.

<Procedure>

To set up Timescale:
Expand Down
40 changes: 26 additions & 14 deletions getting-started/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,34 @@ import Connect from "versionContent/_partials/_cloud-connect.mdx";
import CreateAHypertable from "versionContent/_partials/_create-hypertable.mdx";
import ServiceOverview from "versionContent/_partials/_service-overview.mdx";

# Create your first Timescale service
# Create your first $SERVICE_LONG

Timescale Cloud offers the following PostgreSQL optimized database services:
$CLOUD_LONG offers the following PostgreSQL optimized database services:

- **Time-series and Analytics**: a Timescale DB instance optimized for your
- **Time-series and Analytics**: a $TIMESCALE_DB instance optimized for your
[time-series and analytics][what-is-time-series] workloads.
- **Dynamic PostgreSQL**: for all other workloads. A PostgreSQL instance with a
atovpeko marked this conversation as resolved.
Show resolved Hide resolved
[dynamic compute range][what-is-dynamic-postgres] aligned to your business needs.
- **Vector and AI**: for apps that require fast search on vector embeddings and metadata, like semantic search, image
search, RAG and Agents. Powered by Timescale Vector and available on Time-series and Dynamic PostgreSQL services.
- **Vector and AI**: for apps that require fast search on vector embeddings and metadata, like semantic search, image search, RAG and Agents. Powered by $COMPANY Vector and available on Time-series and Dynamic PostgreSQL services.

<ServiceOverview />

This section shows you how to create a service, connect to it, create a standard PostgreSQL table, then
convert it into a [Hypertable][hypertables]. Anything you can do with regular PostgreSQL tables, you can
do with hypertables, just with better performance and improved an user experience for time-series data.
To start using $CLOUD_LONG for your data:

1. [Create a $COMPANY account][create-an-account]: register in $CONSOLE to get a centralized point to administer and interact with your data.
1. [Create a $SERVICE_LONG][create-a-service]: that is, a PostgreSQL database instance, powered by [$TIMESCALE_DB][timescaledb], built for production, and extended with cloud features like transparent data tiering to object storage.
1. [Connect to your $SERVICE_LONG][connect-to-your-service]: to run queries, add and migrate your data from other sources.
1. [Create a hypertable][create-a-hypertable]: create a standard PostgreSQL table in your service, then convert it into a [hypertable][hypertables].

atovpeko marked this conversation as resolved.
Show resolved Hide resolved
Anything you can do with regular PostgreSQL tables, you can do with hypertables, just with better performance and improved user experience for time-series data.

<Install />

## Create a Timescale Cloud service
## Create a $SERVICE_LONG

<Procedure>
Now that you have an active $COMPANY account, you create and manage your services in $CONSOLE. When you create a service, you give a structure for your future data, which you then add manually or migrate from other services. All relevant $CLOUD_LONG features under your pricing plan are automatically available when you create a service.

Now that you have an active Timescale account, you create and manage your services in Timescale Console:
<Procedure>

1. In the [service creation page][create-service], choose **Time Series and Analytics**.
![Create Timescale Cloud service](https://assets.timescale.com/docs/images/console-create-service.png)
Expand All @@ -47,30 +51,38 @@ Now that you have an active Timescale account, you create and manage your servic
secure location.

This file contains the passwords and configuration information you need to connect to your service using the
Timescale Console Cloud SQL editors, from the command line, or using third party database administration tools.
$CONSOLE Cloud SQL editors, from the command line, or using third party database administration tools.

1. Follow the service creation wizard.

If you choose to go directly to the service overview, [Check your service and connect to it][connect-to-your-service]
If you choose to go directly to the service overview, [Connect to your service][connect-to-your-service]
shows you how to connect.

</Procedure>

## Connect to your service

A Timescale service comes with access control to its data. To be able to run queries and perform other operations, connect to the service with credentials generated during its creation.

<Connect />

## Create a hypertable

<CreateAHypertable />

And that is it, you are up and running. Enjoy developing with Timescale.
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/

[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
[create-a-hypertable]: /getting-started/:currentVersion:/services/#create-a-hypertable
[create-service]: https://console.cloud.timescale.com/dashboard/create_services
[what-is-time-series]: https://www.timescale.com/blog/what-is-a-time-series-database/#what-is-a-time-series-database
[what-is-dynamic-postgres]: https://www.timescale.com/dynamic-postgresql
[hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/#hypertable-partitioning
[timescaledb]: https://docs.timescale.com/#TimescaleDB

2 changes: 1 addition & 1 deletion use-timescale/hypertables/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ available](/api/:currentVersion:/hypertable/create_hypertable_old/).

## Create a hypertable

To create a hypertable, you need to create a standard PostgreSQL table, and then
To create a hypertable, you create a standard PostgreSQL table and then
convert it into a hypertable.

Hypertables are designed for real-time analytics and typically partitioned by columns that hold time values. These can be of the `timestamptz`, `date`, or `integer` types. While `timestamp` is also supported, best practice is to use `timestamptz` instead. [PostgreSQL timestamp](https://wiki.postgresql.org/wiki/Don't_Do_This#Don.27t_use_timestamp_.28without_time_zone.29) explains why using `timestamp` is discouraged.
Expand Down
Loading