Thread: Streaming replication in docs
The post about the dev docs needing more hot standby mentions prompted me to have a look at how streaming replication is documented. Ignore this if this has already been discussed (I couldn't find any posts), but I couldn't find any mention of streaming replication except in the write ahead log configuration. There doesn't seem to be anything in the index linked to a description of this major feature, why you would use it, or how it works. There's also no mention in the release overview. This is probably due to it being a work in progress and hasn't been written yet, but thought I'd raise it just in case. Thanks Thom
On 7 February 2010 10:20, Thom Brown <thombrown@gmail.com> wrote: > The post about the dev docs needing more hot standby mentions prompted > me to have a look at how streaming replication is documented. Ignore > this if this has already been discussed (I couldn't find any posts), > but I couldn't find any mention of streaming replication except in the > write ahead log configuration. There doesn't seem to be anything in > the index linked to a description of this major feature, why you would > use it, or how it works. There's also no mention in the release > overview. > > This is probably due to it being a work in progress and hasn't been > written yet, but thought I'd raise it just in case. > > Thanks > > Thom Okay, after some searching, I found some sections on streaming replication not referenced in the index: http://developer.postgresql.org/pgdocs/postgres/warm-standby.html#STREAMING-REPLICATION Streaming Replication Protocol: http://developer.postgresql.org/pgdocs/postgres/protocol-replication.html Main section about Streaming Replication: Maybe these should get indexed under streaming replication? Thanks Thom
Thom Brown wrote: > On 7 February 2010 10:20, Thom Brown <thombrown@gmail.com> wrote: >> The post about the dev docs needing more hot standby mentions prompted >> me to have a look at how streaming replication is documented. Ignore >> this if this has already been discussed (I couldn't find any posts), >> but I couldn't find any mention of streaming replication except in the >> write ahead log configuration. There doesn't seem to be anything in >> the index linked to a description of this major feature, why you would >> use it, or how it works. There's also no mention in the release >> overview. >> >> This is probably due to it being a work in progress and hasn't been >> written yet, but thought I'd raise it just in case. > > Okay, after some searching, I found some sections on streaming > replication not referenced in the index: > > http://developer.postgresql.org/pgdocs/postgres/warm-standby.html#STREAMING-REPLICATION > > Streaming Replication Protocol: > http://developer.postgresql.org/pgdocs/postgres/protocol-replication.html > > Main section about Streaming Replication: Maybe these should get > indexed under streaming replication? Yeah, as you noticed, the documentation for streaming replication is currently non-existent. That obviously needs to be fixed. I think we need to move the existing sections around, and of course add a lot of documentation for the new streaming replication and hot standby specific stuff. I proposed a new layout here: http://archives.postgresql.org/message-id/4B50A600.3090309@enterprisedb.com which people seemed to agree with. If you want to help with that, perhaps the best starting point would be to start writing text for the new chapters of that new layout. -- Heikki Linnakangas EnterpriseDB http://www.enterprisedb.com
On 7 February 2010 10:49, Heikki Linnakangas <heikki.linnakangas@enterprisedb.com> wrote: > Thom Brown wrote: >> On 7 February 2010 10:20, Thom Brown <thombrown@gmail.com> wrote: >>> The post about the dev docs needing more hot standby mentions prompted >>> me to have a look at how streaming replication is documented. Ignore >>> this if this has already been discussed (I couldn't find any posts), >>> but I couldn't find any mention of streaming replication except in the >>> write ahead log configuration. There doesn't seem to be anything in >>> the index linked to a description of this major feature, why you would >>> use it, or how it works. There's also no mention in the release >>> overview. >>> >>> This is probably due to it being a work in progress and hasn't been >>> written yet, but thought I'd raise it just in case. >> >> Okay, after some searching, I found some sections on streaming >> replication not referenced in the index: >> >> http://developer.postgresql.org/pgdocs/postgres/warm-standby.html#STREAMING-REPLICATION >> >> Streaming Replication Protocol: >> http://developer.postgresql.org/pgdocs/postgres/protocol-replication.html >> >> Main section about Streaming Replication: Maybe these should get >> indexed under streaming replication? > > Yeah, as you noticed, the documentation for streaming replication is > currently non-existent. That obviously needs to be fixed. I think we > need to move the existing sections around, and of course add a lot of > documentation for the new streaming replication and hot standby specific > stuff. I proposed a new layout here: > > http://archives.postgresql.org/message-id/4B50A600.3090309@enterprisedb.com > > which people seemed to agree with. If you want to help with that, > perhaps the best starting point would be to start writing text for the > new chapters of that new layout. > I'm wondering if I "gave it a go", I'd be more of a hindrance than a help, as I'm not really familiar enough with the workings of hot standby to provide this missing information. In fact that's why I looked for the documentation, because I wanted to learn how it works and how to use it. I'd be happy to review any doc changes to ensure enough information is available and that it's clear enough to end-users though. And I do prefer the proposed layout. Thom
On Sun, Feb 7, 2010 at 7:49 PM, Heikki Linnakangas <heikki.linnakangas@enterprisedb.com> wrote: > Yeah, as you noticed, the documentation for streaming replication is > currently non-existent. That obviously needs to be fixed. I think we > need to move the existing sections around, and of course add a lot of > documentation for the new streaming replication and hot standby specific > stuff. I proposed a new layout here: > > http://archives.postgresql.org/message-id/4B50A600.3090309@enterprisedb.com The attached patch changes the layout according to your suggestion (but with a small modification). Here is the new layout: ------------------------------- Chapter 24. Backup and Restore 24.1. SQL Dump 24.1.1. Restoring the dump 24.1.2. Using pg_dumpall 24.1.3. Handling large databases 24.2. File System Level Backup 24.3. Continuous Archiving and Point-In-Time Recovery (PITR) 24.3.1. Setting up WAL archiving 24.3.2. Making a Base Backup 24.3.3. Recovering using a Continuous Archive Backup 24.3.4. Timelines 24.3.5. Tips and Examples 24.3.6. Caveats 24.4. Migration Between Releases Chapter 25. High Availability, Load Balancing, and Replication 25.1. Comparison of different solutions 25.2. File-based Log Shipping 25.2.1. Planning 25.2.2. Implementation 25.2.3. Record-based Log Shipping 25.3. Streaming Replication 25.3.1. Setup 25.3.2. Authentication 25.4. Failover 25.5. Hot Standby 25.5.1. User's Overview 25.5.2. Handling query conflicts 25.5.3. Administrator's Overview 25.5.4. Hot Standby Parameter Reference 25.5.5. Caveats 25.6. Incrementally Updated Backups ------------------------------- I didn't change the content except adjusting the "sect" and the "indexterm" tags to new chapter. If this layout change will have been committed, I'll improve the SR section. Regards, -- Fujii Masao NIPPON TELEGRAPH AND TELEPHONE CORPORATION NTT Open Source Software Center
Attachment
On 9 February 2010 01:57, Fujii Masao <masao.fujii@gmail.com> wrote: > On Sun, Feb 7, 2010 at 7:49 PM, Heikki Linnakangas > <heikki.linnakangas@enterprisedb.com> wrote: >> Yeah, as you noticed, the documentation for streaming replication is >> currently non-existent. That obviously needs to be fixed. I think we >> need to move the existing sections around, and of course add a lot of >> documentation for the new streaming replication and hot standby specific >> stuff. I proposed a new layout here: >> >> http://archives.postgresql.org/message-id/4B50A600.3090309@enterprisedb.com > > The attached patch changes the layout according to your suggestion > (but with a small modification). Here is the new layout: > > ------------------------------- > Chapter 24. Backup and Restore > 24.1. SQL Dump > 24.1.1. Restoring the dump > 24.1.2. Using pg_dumpall > 24.1.3. Handling large databases > 24.2. File System Level Backup > 24.3. Continuous Archiving and Point-In-Time Recovery (PITR) > 24.3.1. Setting up WAL archiving > 24.3.2. Making a Base Backup > 24.3.3. Recovering using a Continuous Archive Backup > 24.3.4. Timelines > 24.3.5. Tips and Examples > 24.3.6. Caveats > 24.4. Migration Between Releases > > Chapter 25. High Availability, Load Balancing, and Replication > 25.1. Comparison of different solutions > 25.2. File-based Log Shipping > 25.2.1. Planning > 25.2.2. Implementation > 25.2.3. Record-based Log Shipping > 25.3. Streaming Replication > 25.3.1. Setup > 25.3.2. Authentication > 25.4. Failover > 25.5. Hot Standby > 25.5.1. User's Overview > 25.5.2. Handling query conflicts > 25.5.3. Administrator's Overview > 25.5.4. Hot Standby Parameter Reference > 25.5.5. Caveats > 25.6. Incrementally Updated Backups > ------------------------------- > > I didn't change the content except adjusting the "sect" and > the "indexterm" tags to new chapter. > > If this layout change will have been committed, I'll improve > the SR section. > > Regards, > > -- > Fujii Masao > NIPPON TELEGRAPH AND TELEPHONE CORPORATION > NTT Open Source Software Center > And can I just correct a couple typo's while we're changing it too? (attached) Thanks Thom
Attachment
Thom Brown wrote: > On 9 February 2010 01:57, Fujii Masao <masao.fujii@gmail.com> wrote: >> The attached patch changes the layout according to your suggestion >> (but with a small modification). Here is the new layout: >> >> ------------------------------- >> Chapter 24. Backup and Restore >> 24.1. SQL Dump >> 24.1.1. Restoring the dump >> 24.1.2. Using pg_dumpall >> 24.1.3. Handling large databases >> 24.2. File System Level Backup >> 24.3. Continuous Archiving and Point-In-Time Recovery (PITR) >> 24.3.1. Setting up WAL archiving >> 24.3.2. Making a Base Backup >> 24.3.3. Recovering using a Continuous Archive Backup >> 24.3.4. Timelines >> 24.3.5. Tips and Examples >> 24.3.6. Caveats >> 24.4. Migration Between Releases >> >> Chapter 25. High Availability, Load Balancing, and Replication >> 25.1. Comparison of different solutions >> 25.2. File-based Log Shipping >> 25.2.1. Planning >> 25.2.2. Implementation >> 25.2.3. Record-based Log Shipping >> 25.3. Streaming Replication >> 25.3.1. Setup >> 25.3.2. Authentication >> 25.4. Failover >> 25.5. Hot Standby >> 25.5.1. User's Overview >> 25.5.2. Handling query conflicts >> 25.5.3. Administrator's Overview >> 25.5.4. Hot Standby Parameter Reference >> 25.5.5. Caveats >> 25.6. Incrementally Updated Backups >> ------------------------------- >> >> I didn't change the content except adjusting the "sect" and >> the "indexterm" tags to new chapter. >> >> If this layout change will have been committed, I'll improve >> the SR section. > > And can I just correct a couple typo's while we're changing it too? (attached) Thanks, committed. -- Heikki Linnakangas EnterpriseDB http://www.enterprisedb.com