dbFetch() documentation needs more documentation about overall flow

[hadley]

i.e.:

• Use dbSendQuery() to get a result set
• Optionally bind paremeters with dbBind().
• Use dbFetch() to get a page of results
• Use dbHasCompleted() to tell when you're done
• Use dbClearResult() to clean up

And it might be worth linking all these functions together with a common family.

[krlmlr]

Thanks. We have some material in https://dbi.r-dbi.org/articles/dbi-advanced . Would a link to vignette("dbi-advanced") be sufficient for now? Should we reorganize closer to the structure you're suggesting, or perhaps add a new text (directly to the help page and/or in a new vignette)?

[hadley]

I think the docs for those functions could have a shared section called something like "The dbFetch() flow" which basically included the bulleted list above + a link to the vignette. Probably should also link to dbGetQuery() as wrapper that most people will want to use.

Do you want me to propose something?

[hadley]

Oops, I just realised I'll filed this in the wrong repo. I'll move it.

[krlmlr]

Almost forgot, see d2bf235 for a proposal. Releasing today, we can tweak later.

[krlmlr]

Next try: 7abf906.

[krlmlr]

Done and submitted to CRAN, see https://dbi.r-dbi.org/reference/dbbind for the rendered version.

Still happy to take feedback.

CC @hannes.

[hadley]

LGTM.

[github-actions]

This old thread has been automatically locked. If you think you have found something related to this, please open a new issue and link to this old issue if necessary.