Add limitations section to documentation for Go / pgx

[chriscasano]

Chris Casano (chriscasano) commented:

At times, we've directing users to pgx from lib/pq. However, we don't have documentation around pgx, what it's capabilities are and what is lacking. An example would be items like this: cockroachdb/cockroach#19603. Most users wouldn't know this limitation until they hit it.

Jira Issue: DOC-584

[jseldess]

@ericharmeling, @vy-ton, passing to you for triage and prioritization. I have a feeling you're already working on pgx support/docs.

[vy-ton]

Yes, Eric has a in-progress PR. @ericharmeling Can you add a limitations section for pgx?

[ericharmeling]

Yes, Eric has a in-progress PR. @ericharmeling Can you add a limitations section for pgx?

Sure thing. Thanks for the notice!

[ericharmeling]

@chriscasano

I can add a "Limitations" section to our pgx tutorial (not yet published). It would be helpful to have a list of said limitations ahead of creating that PR. cockroachdb/cockroach#19603 seems to be a limitation of lib/pq (i.e., a reason for switching over the pgx), rather than a limitation of pgx.

Re: pgx capabilities, I think we should point to pgx documentation (https://github.com/jackc/pgx#features) for a list of the library's capabilities rather than duplicating that information on our docs. I can add a link to that README.

[chriscasano]

👍

[vy-ton]

cockroachdb/cockroach#19603 seems to be a limitation of lib/pq (i.e., a reason for switching over the pgx), rather than a limitation of pgx.

@ericharmeling It's not a limitation with pgx but instead CockroachDB's usage with pgx since we don't support the COPY BINARY. Probably worth highlighting this so that users using pgx's COPY know that it won't work.

[maddyblue]

We just merged BINARY support, so we should be able to document this better now?