Make `async/await` the primary examples in the docs

[rijkvanzanten]

Heya! Big fan of all your work ❤️

With async/await getting so ubiquitous nowadays, would it be worth updating the examples in the docs to rely on that primarily, with the "old school" callbacks becoming the footnote "oh if you like callbacks still that'll also work"? Async/await usage together with node-pg is just so nice as compared to callback hell/chained promises, especially with top-level await, for example:

Happy to submit a PR if that's a direction you feel like exploring, no hard feelings if you'd rather close this with a "Take your async/await nonsense elsewhere!" 😄

[k-funk]

i was hoping to find such an example in this issue 😅

[rijkvanzanten]

@k-funk Any particular one you were hoping to see? Happy to help if I can :)

[k-funk]

psql -d my_db_name -c COPY table_name FROM my_file.csv is the cli command I'm hoping to convert to js.

https://github.com/brianc/node-postgres/tree/master/packages/pg-query-stream is the closest example that I've found, to use as a starting place

[rijkvanzanten]

psql -d my_db_name -c COPY table_name FROM my_file.csv is the cli command I'm hoping to convert to js.

https://github.com/brianc/node-postgres/tree/master/packages/pg-query-stream is the closest example that I've found, to use as a starting place

Ah.. I don't think that's an example you'd find in the pg docs itself, as I don't think it's something that's supported by Postgres outside of the psql cli tool 🤔 I think you'll have to write some logic around reading the file in JS, and then generating/executing queries on the fly with pg 👍🏻

[brianc]

With async/await getting so ubiquitous nowadays, would it be worth updating the examples in the docs to rely on that primarily, with the "old school" callbacks becoming the footnote "oh if you like callbacks still that'll also work"?

yeah you're totally right

Async/await usage together with node-pg is just so nice as compared to callback hell/chained promises, especially with top-level await, for example:

agreed - definitely open to an update of the examples!

[k-funk]

I assumed that pg-query-stream would support this as a query, as this library does: https://github.com/brianc/node-pg-copy-streams :

import { pipeline } from 'node:stream/promises'
import fs from 'node:fs'
import pg from 'pg'
import { from as copyFrom } from 'pg-copy-streams'

const pool = new pg.Pool()
const client = await pool.connect()
try {
  const ingestStream = client.query(copyFrom('COPY my_table FROM STDIN'))
  const sourceStream = fs.createReadStream('some_file.tsv')
  await pipeline(sourceStream, ingestStream)
} finally {
  client.release()
}
await pool.end()

No worries, I can switch to that library since I'm early in my project. 🙏

[rijkvanzanten]

@brianc As for a standardized format for examples, would you like to exclusively show async/await, and have a note somewhere in an intro outlining that callbacks are still available as a backup, or have an example for both in every codeblock? 🙂

[brianc]

As for a standardized format for examples, would you like to exclusively show async/await, and have a note somewhere in an intro outlining that callbacks are still available as a backup, or have an example for both in every codeblock? 🙂

I think just async/await is fine honestly...and a note that there are callbacks available as well.