Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

pg.connect is undocumented

See original GitHub issue

The pg.connect function is not mentioned in the README or the wiki. But the function exists and it’s present in a lot of example code on the Internet.

Is it deprecated? Is using new pg.Pool() preferred to pg.connect? Or are they both fully supported? Either way, it would be nice to have this function mentioned somewhere, so that people know which way to write their own code.

Issue Analytics

State:
Created 7 years ago
Comments:10 (3 by maintainers)

Top GitHub Comments

2reactions

seishuncommented, Mar 9, 2017

Thank you for the clarification.

SO the thinking goes don’t document it anymore

I think it would be better to document it. A simple mention like “pg.connect is an old thing, don’t use it” would be enough to avoid confusion by newcomers.

0reactions

brianccommented, Jul 24, 2017

👍 definitely good to close

Top Results From Across the Web

PostgreSQL pg_constraint's confupdtype / confdeltype ...

PostgreSQL pg_constraint's confupdtype / confdeltype columns using undocumented letter (space). What does it mean?

pg - UNPKG

10, - Deprecate undocumented but possibly used `query.promise()` method. ... Eventually `pg.connect` itself will be deprecated in favor of instantiating ...

DBD::Pg - PostgreSQL database driver for the DBI module

To connect to a Postgres database with a minimum of parameters, ... NOTE: The undocumented (and invalid) support for the SQL_BINARY data type...

PG County must step up and protect undocumented migrants

For many undocumented immigrants, coming home to an eviction notice is a very possible reality. Landlords in Prince George's County are aware ...

Documentation: 14: E.7. Release 14 - PostgreSQL

Also, the legacy (and undocumented) Boolean-like values which were ... control over whether loss of connection is checked for intra-query.