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 new regions #3038

Closed
wants to merge 11 commits into from
8 changes: 4 additions & 4 deletions about/timescaledb-editions.md
Original file line number Diff line number Diff line change
Expand Up @@ -487,22 +487,22 @@ You can access a hosted version of TimescaleDB Community Edition through
<td><strong>Administration functions</strong></td>
</tr>
<tr>
<td><a href="https://docs.timescale.com/api/latest/administration/timescaledb_pre_restore/">timescaledb_pre_restore</a></td>
<td><a href="https://docs.timescale.com/api/latest/administration/#timescaledb_pre_restore">timescaledb_pre_restore</a></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td><a href="https://docs.timescale.com/api/latest/administration/timescaledb_post_restore/">timescaledb_post_restore</a></td>
<td><a href="https://docs.timescale.com/api/latest/administration/#timescaledb_post_restore">timescaledb_post_restore</a></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td><a href="https://docs.timescale.com/api/latest/administration/get_telemetry_report/">get_telemetry_report</a></td>
<td><a href="https://docs.timescale.com/api/latest/administration/#get_telemetry_report">get_telemetry_report</a></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td><a href="https://docs.timescale.com/api/latest/administration/dump_meta_data/">dump_meta_data</a></td>
<td><a href="https://docs.timescale.com/api/latest/administration/#dump-timescaledb-meta-data">dump_meta_data</a></td>
<td>✅</td>
<td>✅</td>
</tr>
Expand Down
66 changes: 64 additions & 2 deletions api/administration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,67 @@ tags: [backup, restore, set up]

# Administrative Functions

These administrative APIs help you prepare a database before and after a restore
event, and also helps you keep track of your TimescaleDB setup data.
These administrative APIs help you prepare a database before and after a restore event. They also help you keep track of your TimescaleDB setup data.

## Dump TimescaleDB meta data

To help when asking for support and reporting bugs, TimescaleDB includes an SQL dump script. It outputs metadata from the internal TimescaleDB tables, along with version information.

This script is available in the source distribution in `scripts/`. To use it, run:

```bash
psql [your connect flags] -d your_timescale_db < dump_meta_data.sql > dumpfile.txt
```

Inspect `dumpfile.txt` before sending it together with a bug report or support question.

## get_telemetry_report()

Returns the background [telemetry][telemetry] string sent to Timescale servers.

If telemetry is turned off, it sends the string that would be sent if telemetry were enabled.

### Sample usage

View the telemetry report:

```sql
SELECT get_telemetry_report();
```

## timescaledb_post_restore()

Perform the required operations after you have finished restoring the database using `pg_restore`. Specifically, this resets the `timescaledb.restoring` GUC and restarts any background workers.

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

### Sample usage

Prepare the database for normal use after a restore:

```sql
SELECT timescaledb_post_restore();
```

## timescaledb_pre_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.

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.
</Highlight>

### Sample usage

Prepare to restore the database:

```sql
SELECT timescaledb_pre_restore();
```

[Migrate using pg_dump and pg_restore]: /migrate/:currentVersion:/pg-dump-and-restore/
[telemetry]: /self-hosted/:currentVersion:/configuration/telemetry
23 changes: 0 additions & 23 deletions api/dump_meta_data.md

This file was deleted.

26 changes: 0 additions & 26 deletions api/get_telemetry_report.md

This file was deleted.

18 changes: 0 additions & 18 deletions api/page-index/page-index.js
Original file line number Diff line number Diff line change
Expand Up @@ -584,24 +584,6 @@ module.exports = [
href: "administration",
description:
"These administrative APIs help you prepare a database before and after a restore event, and also helps you keep track of your TimescaleDB setup data.",
children: [
{
title: "timescaledb_pre_restore",
href: "timescaledb_pre_restore",
},
{
title: "timescaledb_post_restore",
href: "timescaledb_post_restore",
},
{
title: "get_telemetry_report",
href: "get_telemetry_report",
},
{
title: "dump_meta_data",
href: "dump_meta_data",
},
],
},
{
title: "API Reference Tag Overview",
Expand Down
27 changes: 0 additions & 27 deletions api/timescaledb_post_restore.md

This file was deleted.

38 changes: 0 additions & 38 deletions api/timescaledb_pre_restore.md

This file was deleted.

Loading
Loading