doc icon indicating copy to clipboard operation
doc copied to clipboard

Please document the new replication API

Open taspeotis opened this issue 3 years ago • 1 comments

Hi,

We have been using the logical replication feature with Npgsql 5.x quite successfully. The release notes for Npgsql 6.x say:

The logical replication API has been redone

As part of the redesign around logical replication support, some major changes to the API had to be done. Applications will have to be changed to use the new API.

It would be helpful if there was some documentation for this API, even a migration guide. I searched the manual and the best I could find is here which is for version 5 and doesn't compile with Npgsql 6.x.

A migration guide would be helpful since PgOutputReplicationOptions now expects a protocol version where previously none was required. I will read the Postgres manual to find out which version of replication is supported by my v13.6 instance but it would be nice if this change (and others) was covered.

I hope to use the logical replication API in Npgsql v6 as successfully as v5 ... I just need a little help.

Sorry if this information exists elsewhere and I have not found it.

Thank you for Npgsql.

taspeotis avatar May 05 '22 07:05 taspeotis

/cc @Brar

Yeah, we should probably make sure at least the docs are up to date for 6.0... Note that the 6.0 API is pretty close to the 5.0 one - it should be easy to migrate.

In the meantime, the API docs as well as Intellisense should be helpful for understanding what the new API looks like.

roji avatar May 05 '22 12:05 roji