Skip to content

Commit 09b459c

Browse files
committed
Merge branch 'latest' of github.com:timescale/docs into milestone-29-elevate-features
2 parents 790d175 + b3a2234 commit 09b459c

37 files changed

+1718
-683
lines changed

.helper-scripts/llms/generate_llms_full.py

Lines changed: 838 additions & 0 deletions
Large diffs are not rendered by default.

_partials/_early_access_2_17_1.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<Tag variant="hollow">Early access: TimescaleDB v2.17.1</Tag>

_partials/_hypercore-conversion-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ Is converted and compressed into arrays in a row in the columnstore:
1717
|-|-|-|-|-|
1818
|[12:00:01, 12:00:01, 12:00:02, 12:00:02, 12:00:03, 12:00:03]|[A, B, A, B, A, B]|[SSD, HDD, SSD, HDD, SSD, HDD]|[70.11, 69.70, 70.12, 69.69, 70.14, 69.70]|[13.4, 20.5, 13.2, 23.4, 13.0, 25.2]|
1919

20-
Because a single row takes up less disk space, you can reduce your chunk size by more than 90%, and can also
20+
Because a single row takes up less disk space, you can reduce your chunk size by up to 98%, and can also
2121
speed up your queries. This saves on storage costs, and keeps your queries operating at lightning speed.

_partials/_livesync-configure-source-database-awsrds.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,59 +23,59 @@ Updating parameters on a $PG instance will cause an outage. Choose a time that w
2323
- `rds.logical_replication` set to `1`: record the information needed for logical decoding.
2424
- `wal_sender_timeout` set to `0`: disable the timeout for the sender process.
2525

26-
1. In RDS, navigate back to your [databases][databases], select the RDS instance to migrate and click `Modify`.
26+
1. In RDS, navigate back to your [databases][databases], select the RDS instance to migrate, and click `Modify`.
2727

28-
1. Scroll down to `Database options` select your new parameter group and click `Continue`.
29-
1. Either `Apply immediately` or choose a maintence window, then click `Modify DB instance`.
28+
1. Scroll down to `Database options`, select your new parameter group, and click `Continue`.
29+
1. Click `Apply immediately` or choose a maintenance window, then click `Modify DB instance`.
3030

3131
Changing parameters will cause an outage. Wait for the database instance to reboot before continuing.
3232
1. Verify that the settings are live in your database.
3333

34-
1. **Create a user for $LIVESYNC and assign permissions**
34+
1. **Create a user for the $PG_CONNECTOR and assign permissions**
3535

36-
1. Create `<livesync username>`:
36+
1. Create `<pg connector username>`:
3737

3838
```sql
39-
psql $SOURCE -c "CREATE USER <livesync username> PASSWORD '<password>'"
39+
psql $SOURCE -c "CREATE USER <pg connector username> PASSWORD '<password>'"
4040
```
4141

4242
You can use an existing user. However, you must ensure that the user has the following permissions.
4343

4444
1. Grant permissions to create a replication slot:
4545

4646
```sql
47-
psql $SOURCE -c "GRANT rds_replication TO <livesync username>"
47+
psql $SOURCE -c "GRANT rds_replication TO <pg connector username>"
4848
```
4949

5050
1. Grant permissions to create a publication:
5151

5252
```sql
53-
psql $SOURCE -c "GRANT CREATE ON DATABASE <database name> TO <livesync username>"
53+
psql $SOURCE -c "GRANT CREATE ON DATABASE <database name> TO <pg connector username>"
5454
```
5555

5656
1. Assign the user permissions on the source database:
5757

5858
```sql
5959
psql $SOURCE <<EOF
60-
GRANT USAGE ON SCHEMA "public" TO <livesync username>;
61-
GRANT SELECT ON ALL TABLES IN SCHEMA "public" TO <livesync username>;
62-
ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT SELECT ON TABLES TO <livesync username>;
60+
GRANT USAGE ON SCHEMA "public" TO <pg connector username>;
61+
GRANT SELECT ON ALL TABLES IN SCHEMA "public" TO <pg connector username>;
62+
ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT SELECT ON TABLES TO <pg connector username>;
6363
EOF
6464
```
6565

6666
If the tables you are syncing are not in the `public` schema, grant the user permissions for each schema you are syncing:
6767
```sql
6868
psql $SOURCE <<EOF
69-
GRANT USAGE ON SCHEMA <schema> TO <livesync username>;
70-
GRANT SELECT ON ALL TABLES IN SCHEMA <schema> TO <livesync username>;
71-
ALTER DEFAULT PRIVILEGES IN SCHEMA <schema> GRANT SELECT ON TABLES TO <livesync username>;
69+
GRANT USAGE ON SCHEMA <schema> TO <pg connector username>;
70+
GRANT SELECT ON ALL TABLES IN SCHEMA <schema> TO <pg connector username>;
71+
ALTER DEFAULT PRIVILEGES IN SCHEMA <schema> GRANT SELECT ON TABLES TO <pg connector username>;
7272
EOF
7373
```
7474

75-
1. On each table you want to sync, make `<livesync username>` the owner:
75+
1. On each table you want to sync, make `<pg connector username>` the owner:
7676

7777
```sql
78-
psql $SOURCE -c 'ALTER TABLE <table name> OWNER TO <livesync username>;'
78+
psql $SOURCE -c 'ALTER TABLE <table name> OWNER TO <pg connector username>;'
7979
```
8080
You can skip this step if the replicating user is already the owner of the tables.
8181

_partials/_livesync-configure-source-database.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,57 +9,57 @@ import EnableReplication from "versionContent/_partials/_migrate_live_setup_enab
99
ALTER SYSTEM SET wal_sender_timeout=0;
1010
EOF
1111
```
12-
* [ GUC “wal_level” as “logical”](https://www.postgresql.org/docs/current/runtime-config-wal.html#GUC-WAL-LEVEL)
12+
* [GUC “wal_level” as “logical”](https://www.postgresql.org/docs/current/runtime-config-wal.html#GUC-WAL-LEVEL)
1313
* [GUC “max_wal_senders” as 10](https://www.postgresql.org/docs/current/runtime-config-replication.html#GUC-MAX-WAL-SENDERS)
1414
* [GUC “wal_sender_timeout” as 0](https://www.postgresql.org/docs/current/runtime-config-replication.html#GUC-WAL-SENDER-TIMEOUT)
1515

1616
This will require a restart of the $PG source database.
1717

18-
1. **Create a user for $LIVESYNC and assign permissions**
18+
1. **Create a user for the connector and assign permissions**
1919

20-
1. Create `<livesync username>`:
20+
1. Create `<pg connector username>`:
2121

2222
```sql
23-
psql $SOURCE -c "CREATE USER <livesync username> PASSWORD '<password>'"
23+
psql $SOURCE -c "CREATE USER <pg connector username> PASSWORD '<password>'"
2424
```
2525

2626
You can use an existing user. However, you must ensure that the user has the following permissions.
2727

2828
1. Grant permissions to create a replication slot:
2929

3030
```sql
31-
psql $SOURCE -c "ALTER ROLE <livesync username> REPLICATION"
31+
psql $SOURCE -c "ALTER ROLE <pg connector username> REPLICATION"
3232
```
3333

3434
1. Grant permissions to create a publication:
3535

3636
```sql
37-
psql $SOURCE -c "GRANT CREATE ON DATABASE <database name> TO <livesync username>"
37+
psql $SOURCE -c "GRANT CREATE ON DATABASE <database name> TO <pg connector username>"
3838
```
3939

4040
1. Assign the user permissions on the source database:
4141

4242
```sql
4343
psql $SOURCE <<EOF
44-
GRANT USAGE ON SCHEMA "public" TO <livesync username>;
45-
GRANT SELECT ON ALL TABLES IN SCHEMA "public" TO <livesync username>;
46-
ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT SELECT ON TABLES TO <livesync username>;
44+
GRANT USAGE ON SCHEMA "public" TO <pg connector username>;
45+
GRANT SELECT ON ALL TABLES IN SCHEMA "public" TO <pg connector username>;
46+
ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT SELECT ON TABLES TO <pg connector username>;
4747
EOF
4848
```
4949

5050
If the tables you are syncing are not in the `public` schema, grant the user permissions for each schema you are syncing:
5151
```sql
5252
psql $SOURCE <<EOF
53-
GRANT USAGE ON SCHEMA <schema> TO <livesync username>;
54-
GRANT SELECT ON ALL TABLES IN SCHEMA <schema> TO <livesync username>;
55-
ALTER DEFAULT PRIVILEGES IN SCHEMA <schema> GRANT SELECT ON TABLES TO <livesync username>;
53+
GRANT USAGE ON SCHEMA <schema> TO <pg connector username>;
54+
GRANT SELECT ON ALL TABLES IN SCHEMA <schema> TO <pg connector username>;
55+
ALTER DEFAULT PRIVILEGES IN SCHEMA <schema> GRANT SELECT ON TABLES TO <pg connector username>;
5656
EOF
5757
```
5858

59-
1. On each table you want to sync, make `<livesync username>` the owner:
59+
1. On each table you want to sync, make `<pg connector username>` the owner:
6060

6161
```sql
62-
psql $SOURCE -c 'ALTER TABLE <table name> OWNER TO <livesync username>;'
62+
psql $SOURCE -c 'ALTER TABLE <table name> OWNER TO <pg connector username>;'
6363
```
6464
You can skip this step if the replicating user is already the owner of the tables.
6565

_partials/_livesync-console.md

Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TuneSourceDatabaseAWSRDS from "versionContent/_partials/_livesync-configu
1111

1212
- Ensure that the source $PG instance and the target $SERVICE_LONG have the same extensions installed.
1313

14-
$LIVESYNC_CAP does not create extensions on the target. If the table uses column types from an extension,
14+
The $PG_CONNECTOR does not create extensions on the target. If the table uses column types from an extension,
1515
first create the extension on the target $SERVICE_LONG before syncing the table.
1616

1717
## Limitations
@@ -28,18 +28,19 @@ import TuneSourceDatabaseAWSRDS from "versionContent/_partials/_livesync-configu
2828

2929
## Set your connection string
3030

31-
This variable holds the connection information for the source database. In Terminal on your migration machine,
31+
This variable holds the connection information for the source database. In the terminal on your migration machine,
3232
set the following:
3333

3434
```bash
3535
export SOURCE="postgres://<user>:<password>@<source host>:<source port>/<db_name>"
3636
```
3737

3838
<Highlight type="important">
39+
3940
Avoid using connection strings that route through connection poolers like PgBouncer or similar tools. This tool
4041
requires a direct connection to the database to function properly.
41-
</Highlight>
4242

43+
</Highlight>
4344

4445
## Tune your source database
4546

@@ -65,7 +66,7 @@ requires a direct connection to the database to function properly.
6566
</Tab>
6667
</Tabs>
6768

68-
## Synchronize data to your Tiger Cloud service
69+
## Synchronize data to your $SERVICE_LONG
6970

7071
To sync data from your $PG database to your $SERVICE_LONG using $CONSOLE:
7172

@@ -74,40 +75,51 @@ To sync data from your $PG database to your $SERVICE_LONG using $CONSOLE:
7475
1. **Connect to your $SERVICE_LONG**
7576

7677
In [$CONSOLE][portal-ops-mode], select the $SERVICE_SHORT to sync live data to.
77-
1. **Start $LIVESYNC**
78-
1. Click `Actions` > `Livesync for PostgreSQL`.
7978

80-
1. **Connect the source database and target $SERVICE_SHORT**
79+
1. **Connect the source database and the target $SERVICE_SHORT**
8180

82-
![Livesync wizard](https://assets.timescale.com/docs/images/tiger-cloud-console/pg-livesync-wizard-tiger-cloud.png)
81+
![Postgres connector wizard](https://assets.timescale.com/docs/images/tiger-cloud-console/pg-connector-wizard-tiger-cloud.png)
8382

84-
In `Livesync for Postgres`:
85-
1. Set the `Livesync Name`.
86-
1. Connect to your database with the credentials or $PG connection string. This is the connection string for [`<livesync username>`][livesync-tune-source-db].
87-
1. Click `Continue`.
88-
$CONSOLE connects to the source database and retrieves the schema information.
83+
1. Click `Connectors` > `PostgreSQL`.
84+
1. Set the name for the new connector by clicking the pencil icon.
85+
1. Check the boxes for `Set wal_level to logical` and `Update your credentials`, then click `Continue`.
86+
1. Enter your database credentials or a $PG connection string, then click `Connect to database`.
87+
This is the connection string for [`<pg connector username>`][livesync-tune-source-db]. $CONSOLE connects to the source database and retrieves the schema information.
8988

90-
1. **Optimize the data to synchronize in hypertables**
89+
1. **Optimize the data to synchronize in $HYPERTABLEs**
9190

92-
![livesync start](https://assets.timescale.com/docs/images/tiger-cloud-console/pg-livesync-start-tiger-cloud.png)
93-
1. Select the table to sync and click `+`.
91+
![Postgres connector start](https://assets.timescale.com/docs/images/tiger-cloud-console/pg-connector-start-tiger-cloud.png)
92+
93+
1. In the `Select table` dropdown, select the tables to sync.
94+
1. Click `Select tables +` .
95+
96+
$CONSOLE checks the table schema and, if possible, suggests the column to use as the time dimension in a $HYPERTABLE.
97+
1. Click `Create Connector`.
9498

95-
$CONSOLE checks the table schema and, if possible, suggests the column to use as the time dimension in a hypertable.
96-
1. Repeat this step for each table you want to sync.
97-
1. Click `Start Livesync`.
99+
$CONSOLE starts $PG_CONNECTOR between the source database and the target $SERVICE_SHORT and displays the progress.
100+
101+
1. **Monitor synchronization**
102+
103+
![Tiger Cloud connectors overview](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-cloud-connector-overview.png)
104+
105+
1. To view the amount of data replicated, click `Connectors`. The diagram in `Connector data flow` gives you an overview of the connectors you have created, their status, and how much data has been replicated.
106+
107+
1. To review the syncing progress for each table, click `Connectors` > `Source connectors`, then select the name of your connector in the table.
108+
109+
1. **Manage the connector**
110+
111+
![Edit a Postgres connector](https://assets.timescale.com/docs/images/tiger-cloud-console/edit-pg-connector.png)
112+
113+
1. To edit the connector, click `Connectors` > `Source connectors`, then select the name of your connector in the table. You can rename the connector, delete or add new tables for syncing.
98114

99-
$CONSOLE starts $LIVESYNC between the source database and the target $SERVICE_SHORT and displays the progress.
115+
1. To pause a connector, click `Connectors` > `Source connectors`, then open the three-dot menu on the right and select `Pause`.
100116

101-
1. **Monitor syncronization**
102-
1. To view the progress of the $LIVESYNC, click the name of the $LIVESYNC process:
103-
![livesync view status](https://assets.timescale.com/docs/images/tiger-cloud-console/pg-livesync-view-status-tiger-cloud.png)
104-
1. To pause and restart $LIVESYNC, click the buttons on the right of the $LIVESYNC process and select an action:
105-
![livesync start stop](https://assets.timescale.com/docs/images/tiger-cloud-console/pg-livesync-start-stop-tiger-cloud.png)
117+
1. To delete a connector, click `Connectors` > `Source connectors`, then open the three-dot menu on the right and select `Delete`. You must pause the connector before deleting it.
106118

107119
</Procedure>
108120

109-
And that is it, you are using $LIVESYNC to synchronize all the data, or specific tables, from a $PG database
110-
instance to your $SERVICE_LONG in real time.
121+
And that is it, you are using the $PG_CONNECTOR to synchronize all the data, or specific tables, from a $PG database
122+
instance to your $SERVICE_LONG, in real time.
111123

112124
[install-psql]: /integrations/:currentVersion:/psql/
113125
[portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services

_partials/_livesync-limitations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99

1010
* Ensure that the source $PG instance and the target $SERVICE_LONG have the same extensions installed.
1111

12-
$LIVESYNC_CAP does not create extensions on the target. If the table uses
12+
The $PG_CONNECTOR does not create extensions on the target. If the table uses
1313
column types from an extension, first create the extension on the
1414
target $SERVICE_LONG before syncing the table.
1515

1616
* There is WAL volume growth on the source $PG instance during large table copy.
1717

18-
* Continuous Aggregates Invalidation
18+
* Continuous aggregate invalidation
1919

20-
LiveSync uses `session_replication_role=replica` during data replication,
20+
The connector uses `session_replication_role=replica` during data replication,
2121
which prevents table triggers from firing. This includes the internal
2222
triggers that mark continuous aggregates as invalid when underlying data
2323
changes.
@@ -35,7 +35,7 @@
3535
- Queries returning incomplete results.
3636

3737
If the continuous aggregate exists in the source database, best
38-
practice is to add it to the live-sync publication. If it only exists on the
38+
practice is to add it to the $PG connector publication. If it only exists on the
3939
target database, manually refresh the continuous aggregate using the `force`
4040
option of [refresh_continuous_aggregate][refresh-caggs].
4141

0 commit comments

Comments
 (0)