Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/styles/templates/procedure.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ If necessary, a paragraph or two explaining more about how things work.

This section shows you how to:

* [Verb \<what the user will do>](#verb-what-the-user-will-do)
* [Verb \<what the user will do if the procedure is cut into logical sections>](#verb-what-the-user-will-do-if-the-procedure-is-cut-into-logical-sections)
* [Verb \<what the user will do>][verb-what-the-user-will-do-link]
* [Verb \<what the user will do if the procedure is cut into logical sections>][verb-what-the-user-will-do-if-the-procedure-is-cut-into-logical-sections-link]

## Prerequisites

Expand Down Expand Up @@ -104,3 +104,6 @@ You have \<what the user will do in this section>.
[secure-vpc-aws]: /use-timescale/:currentVersion:/vpc/
[install-linux]: /self-hosted/:currentVersion:/install/installation-linux/
[gdsg]: https://developers.google.com/style/highlights

[verb-what-the-user-will-do-link]: /.github/:currentVersion:/styles/templates/procedure/#verb-what-the-user-will-do
[verb-what-the-user-will-do-if-the-procedure-is-cut-into-logical-sections-link]: /.github/:currentVersion:/styles/templates/procedure/#verb-what-the-user-will-do-if-the-procedure-is-cut-into-logical-sections
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Each major doc section has a dedicated directory with `.md` files inside, repres
Beneath the front matter, describe the error and its solution in regular Markdown. You can also use any other components allowed within the docs site.

The entry shows up on the troubleshooting pages for its associated products and topics. If the page doesn't already exist, add an entry for it in the page
index, setting `type` to `placeholder`. See [Navigation tree](#navigation-tree).
index, setting `type` to `placeholder`. See [Navigation tree][navigation-tree-link].

## Edit the navigation hierarchy

Expand Down Expand Up @@ -161,4 +161,6 @@ The previous documentation source is in the deprecated repository called [docs.t
[use-navigation]: use-timescale/page-index/page-index.js
[formatting]: _partials/_formatting_examples.md
[variables]: https://www.tigerdata.com/docs/variables-for-contributors/
[readme]: README.md
[readme]: README.md

[navigation-tree-link]: /CONTRIBUTING/:currentVersion:/#navigation-tree
7 changes: 0 additions & 7 deletions _partials/_data_model_metadata.md

This file was deleted.

4 changes: 3 additions & 1 deletion _partials/_livesync-terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ specifies the tables to synchronize.
ALTER PUBLICATION <publication_name> SET(publish_via_partition_root=true);
```

To convert partitioned table to hypertable, follow [Convert partitions and tables with time-series data into hypertables](#convert-partitions-and-tables-with-time-series-data-into-hypertables).
To convert a partitioned table to a hypertable, follow [Convert partitions and tables with time-series data into hypertables][convert-partitions-and-tables-with-time-series-data-into-hypertables-link].

1. **Stop syncing a table in the `PUBLICATION`, use `DROP TABLE`**

Expand Down Expand Up @@ -347,3 +347,5 @@ EOF
[caggs]: /use-timescale/:currentVersion:/continuous-aggregates/about-continuous-aggregates/
[join-livesync-on-slack]: https://app.slack.com/client/T4GT3N2JK/C086NU9EZ88
[install-psql]: /integrations/:currentVersion:/psql/

[convert-partitions-and-tables-with-time-series-data-into-hypertables-link]: /migrate/:currentVersion:/livesync-for-postgresql/#convert-partitions-and-tables-with-time-series-data-into-hypertables
8 changes: 6 additions & 2 deletions api/administration.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,14 @@ SELECT timescaledb_post_restore();

Perform the required operations so that you can restore the database using `pg_restore`. Specifically, this sets the `timescaledb.restoring` GUC to `on` and stops any background workers which could have been performing tasks.

The background workers are stopped until the [timescaledb_post_restore()](#timescaledb_post_restore) function is run, after the restore operation is complete.
The background workers are stopped until the [timescaledb_post_restore()][timescaledb_post_restore-link] function is run, after the restore operation is complete.

For more information, see [Migrate using pg_dump and pg_restore].

<Highlight type="important">
After using `timescaledb_pre_restore()`, you need to run [`timescaledb_post_restore()`](#timescaledb_post_restore) before you can use the database normally.

After using `timescaledb_pre_restore()`, you need to run [`timescaledb_post_restore()`][timescaledb_post_restore-link] before you can use the database normally.

</Highlight>

### Sample usage
Expand All @@ -72,3 +74,5 @@ SELECT timescaledb_pre_restore();

[Migrate using pg_dump and pg_restore]: /migrate/:currentVersion:/pg-dump-and-restore/
[telemetry]: /self-hosted/:currentVersion:/configuration/telemetry

[timescaledb_post_restore-link]: /api/:currentVersion:/administration/#timescaledb_post_restore
2 changes: 1 addition & 1 deletion api/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ This glossary defines technical terms, concepts, and terminology used in $COMPAN

<a id="tiger-service" href=""></a>

**$SERVICE_LONG**: an instance of optimized [$PG][postgres-link] extended with database engine innovations such as [$TIMESCALE_DB][timescaledb-link], in a cloud infrastructure that delivers speed without sacrifice. You can create [free $SERVICE_SHORTs][free-tiger-service-link] and [standard $SERVICE_SHORTs][standard-tiger-service-link].
**$SERVICE_LONG**: an optimized [$PG][postgres-link] instance extended with database engine innovations such as [$TIMESCALE_DB][timescaledb-link], in a cloud infrastructure that delivers speed without sacrifice. You can create [free $SERVICE_SHORTs][free-tiger-service-link] and [standard $SERVICE_SHORTs][standard-tiger-service-link].

**Time series**: data points indexed and ordered by time, typically representing how values change over time.

Expand Down
7 changes: 5 additions & 2 deletions integrations/telegraf.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ and output of data.
To view metrics gathered by Telegraf and stored in a [hypertable][about-hypertables] in a
$SERVICE_LONG.

- [Link Telegraf to your $SERVICE_LONG](#link-telegraf-to-your-service): create a Telegraf configuration
- [View the metrics collected by Telegraf](#view-the-metrics-collected-by-telegraf): connect to your $SERVICE_SHORT and
- [Link Telegraf to your $SERVICE_LONG][link-telegraf-to-your-service-link]: create a Telegraf configuration
- [View the metrics collected by Telegraf][view-the-metrics-collected-by-telegraf-link]: connect to your $SERVICE_SHORT and
query the metrics table

## Prerequisites
Expand Down Expand Up @@ -156,3 +156,6 @@ see the [PostgreQL output plugin][output-plugin].
[connect-timescaledb]: /integrations/:currentVersion:/find-connection-details/
[grafana]: /integrations/:currentVersion:/grafana/
[about-hypertables]: /use-timescale/:currentVersion:/hypertables/

[link-telegraf-to-your-service-link]: /integrations/:currentVersion:/telegraf/#link-telegraf-to-your-service
[view-the-metrics-collected-by-telegraf-link]: /integrations/:currentVersion:/telegraf/#view-the-metrics-collected-by-telegraf
6 changes: 4 additions & 2 deletions mst/connection-pools.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ connection pooling to.
* In the `Database` field, select a database to connect to. Each pool can
only connect to one database.
* In the `Pool Mode` field, select which
[pool mode](#connection-pooling-modes) to use.
[pool mode][connection-pooling-modes-link] to use.
* In the `Pool Size` field, select the maximum number of server
connections this pool can use at any one time.
* In the `Username` field, select which database username to connect to
Expand All @@ -121,4 +121,6 @@ to use both pooled and un-pooled connections at the same time.
</Highlight>


[mst-login]:https://portal.managed.timescale.com/login
[mst-login]:https://portal.managed.timescale.com/login

[connection-pooling-modes-link]: /mst/:currentVersion:/connection-pools/#connection-pooling-modes
4 changes: 3 additions & 1 deletion mst/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags: [extensions]
# Supported $PG extensions

$MST_LONG supports many $PG extensions. See
[available extensions](#available-extensions) for a full list.
[available extensions][available-extensions-link] for a full list.

## Add an extension

Expand Down Expand Up @@ -134,3 +134,5 @@ language extension is `plpythonu`.
You can contact Support directly from $MST_LONG. Click the
life-preserver icon in the upper-right corner of your dashboard.
</Highlight>

[available-extensions-link]: /mst/:currentVersion:/extensions/#available-extensions
15 changes: 11 additions & 4 deletions mst/ingest-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ tags: [JDB, ODBC, client driver, Kafka, csv]

There are several different ways of ingesting your data into $MST_LONG. This section contains instructions to:

* Bulk upload [from a `.csv` file](#bulk-upload-from-csv-files)
* Bulk upload [from a `.csv` file][bulk-upload-from-csv-files-link]
* Insert data
[directly using a client driver](#insert-data-directly-using-a-client-driver),
[directly using a client driver][insert-data-directly-using-a-client-driver-link],
such as JDBC, ODBC, or Node.js
* Insert data
[directly using a message queue](#insert-data-directly-using-a-message-queue),
[directly using a message queue][insert-data-directly-using-a-message-queue-link],
such as Kafka

Before you begin, make sure you have
Expand Down Expand Up @@ -85,8 +85,10 @@ hypertable. You need to begin by creating the new table, before you
import the data.

<Highlight type="important">

Before you begin, make sure you have
[prepared your new database](#procedure-preparing-your-new-database).
[prepared your new database][procedure-preparing-your-new-database-link].

</Highlight>

<Procedure>
Expand Down Expand Up @@ -159,3 +161,8 @@ See [these instructions][gh-kafkaconnector] for using the Kafka connector.
[postgres-odbc]: https://odbc.postgresql.org/
[create-managed-service]: /mst/:currentVersion:/installation-mst/
[mst-login]:https://portal.managed.timescale.com/login

[bulk-upload-from-csv-files-link]: /mst/:currentVersion:/ingest-data/#bulk-upload-from-csv-files
[insert-data-directly-using-a-client-driver-link]: /mst/:currentVersion:/ingest-data/#insert-data-directly-using-a-client-driver
[insert-data-directly-using-a-message-queue-link]: /mst/:currentVersion:/ingest-data/#insert-data-directly-using-a-message-queue
[procedure-preparing-your-new-database-link]: /mst/:currentVersion:/ingest-data/#preparing-your-new-database
7 changes: 4 additions & 3 deletions self-hosted/install/installation-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ time series and demanding workloads that ingest and query high volumes of data.
instance on any local system from a pre-built Docker container.

This section shows you how to
[Install and configure $TIMESCALE_DB on $PG](#install-and-configure-timescaledb-on-postgresql).
[Install and configure $TIMESCALE_DB on $PG][install-and-configure-timescaledb-on-postgresql-link].

< TestingEnv/>

Expand All @@ -32,7 +32,7 @@ To run, and connect to a $PG installation on Docker, you need to install:
## Install and configure $TIMESCALE_DB on $PG

This section shows you how to install the latest version of $PG and
$TIMESCALE_DB on a [supported platform](#supported-platforms) using containers supplied by $COMPANY.
$TIMESCALE_DB using containers supplied by $COMPANY.

<SelfHostedDocker />

Expand All @@ -44,5 +44,6 @@ And that is it! You have $TIMESCALE_DB running on a database on a self-hosted in
<WhereTo />

[docker-install]: https://docs.docker.com/get-started/get-docker/
[install-psql]: https://www.timescale.com/blog/how-to-install-psql-on-mac-ubuntu-debian-windows/
[install-psql]: /integrations/:currentVersion:/psql/

[install-and-configure-timescaledb-on-postgresql-link]: /self-hosted/:currentVersion:/install/installation-docker/#install-and-configure-timescaledb-on-postgres
10 changes: 7 additions & 3 deletions self-hosted/install/installation-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ time series and demanding workloads that ingest and query high volumes of data.

This section shows you how to:

* [Install and configure $TIMESCALE_DB on $PG](#install-and-configure-timescaledb-on-postgresql) - set up
* [Install and configure $TIMESCALE_DB on $PG][install-and-configure-timescaledb-on-postgresql-link] - set up
a self-hosted $PG instance to efficiently run TimescaleDB.
* [Add the $TIMESCALE_DB extension to your database](#add-the-timescaledb-extension-to-your-database) - enable $TIMESCALE_DB
* [Add the $TIMESCALE_DB extension to your database][add-the-timescaledb-extension-to-your-database-link] - enable $TIMESCALE_DB
features and performance improvements on a database.


Expand All @@ -35,7 +35,7 @@ This section shows you how to:
## Install and configure $TIMESCALE_DB on $PG

This section shows you how to install the latest version of $PG and
$TIMESCALE_DB on a [supported platform](#supported-platforms) using the packages supplied by $COMPANY.
$TIMESCALE_DB on a [supported platform][supported-platforms-link] using the packages supplied by $COMPANY.

<Highlight type="warning">

Expand Down Expand Up @@ -113,3 +113,7 @@ You can deploy $TIMESCALE_DB on the following systems:

[install-from-source]: /self-hosted/:currentVersion:/install/installation-source/
[supported-platforms-self-hosted]: /about/:currentVersion:/supported-platforms/#supported-systems

[add-the-timescaledb-extension-to-your-database-link]: /self-hosted/:currentVersion:/install/installation-linux/#add-the-timescaledb-extension-to-your-database
[install-and-configure-timescaledb-on-postgresql-link]: /self-hosted/:currentVersion:/install/installation-linux/#install-and-configure-timescaledb-on-postgres
[supported-platforms-link]: /self-hosted/:currentVersion:/install/installation-linux/#supported-platforms
10 changes: 7 additions & 3 deletions self-hosted/install/installation-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ macOS device.

This section shows you how to:

* [Install and configure $TIMESCALE_DB on $PG](#install-and-configure-timescaledb-on-postgresql) - set up
* [Install and configure $TIMESCALE_DB on $PG][install-and-configure-timescaledb-on-postgresql-link] - set up
a self-hosted $PG instance to efficiently run TimescaleDB.
* [Add the $TIMESCALE_DB extension to your database](#add-the-timescaledb-extension-to-your-database) - enable $TIMESCALE_DB
* [Add the $TIMESCALE_DB extension to your database][add-the-timescaledb-extension-to-your-database-link] - enable $TIMESCALE_DB
features and performance improvements on a database.

< TestingEnv />
Expand All @@ -46,7 +46,7 @@ To keep your current $PG installation, [Install from source][install-from-source
## Install and configure $TIMESCALE_DB on $PG

This section shows you how to install the latest version of $PG and
$TIMESCALE_DB on a [supported platform](#supported-platforms) using the packages supplied by $COMPANY.
$TIMESCALE_DB on a [supported platform][supported-platforms-link] using the packages supplied by $COMPANY.

<Tabs label="Install TimescaleDB">

Expand Down Expand Up @@ -90,3 +90,7 @@ For the latest functionality, install MacOS 14 Sonoma.
[macports]: https://guide.macports.org/#installing.macports
[install-from-source]: /self-hosted/:currentVersion:/install/installation-source/
[install-postgresql]: https://www.postgresql.org/download/macosx/

[add-the-timescaledb-extension-to-your-database-link]: /self-hosted/:currentVersion:/install/installation-macos/#add-the-timescaledb-extension-to-your-database
[install-and-configure-timescaledb-on-postgresql-link]: /self-hosted/:currentVersion:/install/installation-macos/#install-and-configure-timescaledb-on-postgres
[supported-platforms-link]: /self-hosted/:currentVersion:/install/installation-macos/#supported-platforms
7 changes: 5 additions & 2 deletions self-hosted/install/installation-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ instance on any local system, from source.

This section shows you how to:

* [Install and configure $TIMESCALE_DB on $PG](#install-and-configure-timescaledb-on-postgres) - set up
* [Install and configure $TIMESCALE_DB on $PG][install-and-configure-timescaledb-on-postgres-link] - set up
a self-hosted $PG instance to efficiently run TimescaleDB1.
* [Add the $TIMESCALE_DB extension to your database](#add-the-timescaledb-extension-to-your-database) - enable TimescaleDB features and
* [Add the $TIMESCALE_DB extension to your database][add-the-timescaledb-extension-to-your-database-link] - enable TimescaleDB features and
performance improvements on a database.

< TestingEnv/>
Expand Down Expand Up @@ -79,3 +79,6 @@ And that is it! You have TimescaleDB running on a database on a self-hosted inst
[cmake-download]: https://cmake.org/download/
[compatibility-matrix]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/#plan-your-upgrade-path
[postgres-breaking-change]: https://www.postgresql.org/about/news/postgresql-172-166-1510-1415-1318-and-1222-released-2965/

[add-the-timescaledb-extension-to-your-database-link]: /self-hosted/:currentVersion:/install/installation-source/#add-the-timescaledb-extension-to-your-database
[install-and-configure-timescaledb-on-postgres-link]: /self-hosted/:currentVersion:/install/installation-source/#install-and-configure-timescaledb-on-postgres
4 changes: 2 additions & 2 deletions self-hosted/install/installation-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,6 @@ For release information, see the [GitHub releases page][gh-releases] and the [re
[release-notes]: https://github.com/timescale/timescaledb/releases
[windows-releases]: #windows-releases
[install-from-source]: /self-hosted/:currentVersion:/install/installation-source/
[install-timescaledb]: /self-hosted/:currentVersion:/install/installation-windows/#install-and-configure-timescaledb-on-postgresql
[add-timescledb-extension]: /self-hosted/:currentVersion:/install/installation-windows/#add-the-timescaledb-extension-to-your-database
[install-timescaledb]: /self-hosted/:currentVersion:/install/installation-windows/#install-and-configure-timescaledb-on-postgres
[add-timescledb-extension]: /self-hosted/:currentVersion:/install/installation-windows/#add-the-timescale-db-extension-to-your-database
[supported-platforms]: /self-hosted/:currentVersion:/install/installation-windows/#supported-platforms
Loading