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

3669 docs rfc add new live sync guide to the migration section #3671

Conversation

billy-the-fish
Copy link
Contributor

No description provided.

Copy link

Allow 10 minutes from last push for the staging site to build. If the link doesn't work, try using incognito mode instead. For internal reviewers, check web-documentation repo actions for staging build status. Link to build for this PR: http://docs-dev.timescale.com/docs-3669-docs-rfc-add-new-live-sync-guide-to-the-migration-section

@@ -0,0 +1,282 @@
---
title: Live sync
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest we add Postgres as suffix as its targeted for only Postgres

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


You use the live-sync Docker image to synchronize changes in real-time from a PostgreSQL database
instance to a $SERVICE_LONG. You run live-sync continuously, turning PostgreSQL into a primary database
with a $SERVICE_LONG as a logical replica. This enables you to leverage $CLOUD_LONG’s real-time analytics
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also add a mention that user gets to to choose to replicate all or some of their data with choosen tables.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VineethReddy02 @billy-the-fish We should also highlight the fact that this is not intended for migration, but just to keep synching data for analytics. We expect the primary to be running all the time.

Though it could be a potential migration path, the UX is not ready for that yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@@ -15,6 +15,11 @@ module.exports = [
href: "live-migration",
excerpt: "Migrate a large database with low downtime",
},
{
title: "Live sync",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same "Postgres Livesync", for naming consistency can be name as one word livesync?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above.
Livesync is now a proper noun for this feature. Maybe we can change the name of the image to livesync as well?

</Procedure>


## Limitations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least for now, I would prefer to keep the limitation just after the intro. Because, the user must understand that they need to migrate schema using pg_dump/restore

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

migrate/live-sync.md Outdated Show resolved Hide resolved
migrate/live-sync.md Outdated Show resolved Hide resolved
migrate/live-sync.md Outdated Show resolved Hide resolved
<Highlight type="important">
Avoid using connection strings that route through connection poolers like PgBouncer or similar tools. The live-migration tool requires a direct connection to the database to function properly.
</Highlight>
Avoid using connection strings that route through connection poolers like PgBouncer or similar tools. This tool requires a direct connection to the database to function properly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an important point which I feel must be highlighted. Otherwise users tend to ignore and think using connection pooler is always better and end up in trouble.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


You use the live-sync Docker image to synchronize changes in real-time from a PostgreSQL database
instance to a $SERVICE_LONG. You run live-sync continuously, turning PostgreSQL into a primary database
with a $SERVICE_LONG as a logical replica. This enables you to leverage $CLOUD_LONG’s real-time analytics
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VineethReddy02 @billy-the-fish We should also highlight the fact that this is not intended for migration, but just to keep synching data for analytics. We expect the primary to be running all the time.

Though it could be a potential migration path, the UX is not ready for that yet.

@billy-the-fish billy-the-fish merged commit ae46145 into latest Dec 20, 2024
3 checks passed
@billy-the-fish billy-the-fish deleted the 3669-docs-rfc-add-new-live-sync-guide-to-the-migration-section branch December 20, 2024 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs RFC] Add new live-sync guide to the migration section
3 participants