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

Stubs update move to branch #3013

Merged
merged 65 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
59e3525
Merging up stubs into main documents, editing, formatting
ujmediaservices Nov 30, 2023
b69a0df
Oops typo
ujmediaservices Nov 30, 2023
174f29f
Merge branch 'latest' into stub-merge-1
jamessewell Dec 14, 2023
58e579c
Update for linter
billy-the-fish Feb 18, 2024
935bf1e
Update administration.md
billy-the-fish Feb 18, 2024
1c67c89
Merge branch 'latest' into stub-merge-1
billy-the-fish Feb 18, 2024
6c8c0b7
fix: update navigation and links for page merge.
billy-the-fish Feb 18, 2024
9813e4a
Merge branch 'latest' into stub-merge-1
billy-the-fish Feb 19, 2024
403f11f
fix: clean up de-chunking.
billy-the-fish Feb 20, 2024
4efd9e4
fix: clean up de-chunking.
billy-the-fish Feb 21, 2024
2ef3eb0
Merge branch 'latest' into stubs-update-move-to-branch
billy-the-fish Feb 25, 2024
ee87a01
Merge branch 'latest' into stubs-update-move-to-branch
billy-the-fish Mar 4, 2024
43f6eea
Merge branch 'latest' into stubs-update-move-to-branch
billy-the-fish Mar 6, 2024
04b0713
feat: unite stubs.
billy-the-fish Mar 6, 2024
48d362f
Merge branch 'latest' into stubs-update-move-to-branch
billy-the-fish Mar 9, 2024
662a89f
Merge branch 'latest' into stubs-update-move-to-branch
billy-the-fish Mar 9, 2024
b201dae
feat: unite stubs.
billy-the-fish Mar 9, 2024
5c8a8b8
Merge branch 'latest' into stubs-update-move-to-branch
billy-the-fish Mar 14, 2024
2f48d3c
Fix typo (#3052)
Mar 14, 2024
0885261
Fix typo in troubleshooting section (#3073)
antekresic Mar 18, 2024
2f35b63
Update live-migration to v0.0.9 (#3071)
JamesGuthrie Mar 18, 2024
5ebe956
Copy Nit (#3078)
alai97 Mar 19, 2024
248174c
Update import-csv.md (#3080)
solugebefola Mar 21, 2024
f0ff048
Update new about compression (#3012)
antekresic Mar 25, 2024
8e02f37
live-migration: Add docs changes for v0.0.10 (#3091)
arajkumar Mar 25, 2024
83ff074
Add Google CA (#3090)
minkimipt Mar 25, 2024
f56118c
Update ruby.md (#3065)
solugebefola Mar 25, 2024
807c2a2
live-migration: Add docs changes for v0.0.11 (#3096)
arajkumar Mar 26, 2024
fd165c2
Move multinode migration under playbooks (#3110)
giokostis Apr 2, 2024
ec4e131
3113 docs rfc add new editor (#3115)
billy-the-fish Apr 4, 2024
a5567e1
fix: numbering and full stop. (#3120)
billy-the-fish Apr 4, 2024
e382c46
missing word in add_reorder_policy (#3106)
sdebruyn Apr 5, 2024
15d3b82
Restrict usage of time_bucket_ng in CAggs (#3112)
jnidzwetzki Apr 5, 2024
4cf8c75
fix: broken links. (#3123)
billy-the-fish Apr 8, 2024
c6539cd
Update CAgg add_continuous_aggregate_policy documentation (#3128)
jnidzwetzki Apr 11, 2024
62a4f89
fix: deprecate distributed hypertables from the API reference. (#3134)
billy-the-fish Apr 15, 2024
af98fd1
fix: update API reference for set_integer_now_func. (#3135)
billy-the-fish Apr 16, 2024
94af0a0
Add compression settings information views (#3142)
antekresic Apr 18, 2024
eff2cf2
fix: using the public API to check the chunk time interval for a hyp…
billy-the-fish Apr 18, 2024
beac116
3144 docs rfc be more clear about tiered storage being on timescale n…
billy-the-fish Apr 22, 2024
c92b6ff
Update alter_job.md (#3103)
fabriziomello Apr 22, 2024
522fc26
fix: some broken links. A couple of text updates. (#3151)
billy-the-fish Apr 22, 2024
a6dfda8
feat: FAQ for live migration (#3139)
Harkishen-Singh Apr 23, 2024
c204187
chore: update live-migration to v0.0.13 (#3150)
Harkishen-Singh Apr 23, 2024
b62ca3c
Add pgstattuple to list of available extensions (#3154)
JamesGuthrie Apr 25, 2024
d21d172
fix: clarify that each service hosts a single service only. (#3161)
billy-the-fish Apr 25, 2024
0067534
fix: change link in Migrate the entire database at once to the live m…
billy-the-fish Apr 25, 2024
fed5f12
Add warning about SERIAL types and dual-write (#3162)
JamesGuthrie Apr 25, 2024
4e5a692
Address possible installation issues regarding psycopg2 (#3165)
jgpruitt Apr 29, 2024
e2d4580
Add troubleshooting note about partial continuous aggregates (#3164)
JamesGuthrie Apr 30, 2024
531ce93
2829 obsolete restriction on replication factor 1 still in the docs 1…
billy-the-fish May 1, 2024
37135e5
Recommend live-migration instead of dual-writes (#3173)
alejandrodnm May 6, 2024
909f7c8
Refer to live-migration 0.0.14 (#3179)
arajkumar May 7, 2024
8687e8c
feat: add version downgrade for live-migration FAQ (#3163)
Harkishen-Singh May 7, 2024
470672b
Make some changes to refresh cagg note (#3146)
RobAtticus May 7, 2024
62e1443
Add role based auth to CloudWatch exporter doc (#3156)
minkimipt May 7, 2024
0b1bfba
fix: document actual behavior of add_continuous_aggregate_policy when…
dtext May 7, 2024
1a886f0
fix: add verb to sentence. (#3131)
billy-the-fish May 7, 2024
73a6f5f
fix: update navigation and links for page merge.
billy-the-fish Feb 18, 2024
3def1be
fix: clean up de-chunking.
billy-the-fish Feb 21, 2024
08ec6dd
chore: migrate changes in future versions back to this PR.
billy-the-fish May 7, 2024
dded382
Merge remote-tracking branch 'origin/latest' into stubs-update-move-t…
billy-the-fish May 10, 2024
50188fa
fix: my fatal weakness.
billy-the-fish May 10, 2024
b34a899
fix: one broken link fixed.
billy-the-fish May 10, 2024
839aa1d
fix: more link fixing after manual check.
billy-the-fish May 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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.

14 changes: 0 additions & 14 deletions migrate/page-index/page-index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,6 @@ module.exports = [
href: "pg-dump-and-restore",
excerpt:
"Migrate a hypertable or entire database with native PostgreSQL commands",
children: [
{
title: "pg_dump/restore from TimescaleDB",
href: "pg-dump-restore-from-timescaledb",
excerpt:
"Migrate from TimescaleDB using pg_dump/restore",
},
{
title: "pg_dump/restore from PostgreSQL",
href: "pg-dump-restore-from-postgres",
excerpt:
"Migrate from PostgreSQL using pg_dump/restore",
},
]
},
{
title: "With downtime: Multi-node to TimescaleDB service",
Expand Down