docs: clarify remote SQLite connection entry points#759
Open
LeonidasZhak wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarify the two supported entry points for remote read-only SQLite databases over the HTTP VFS.
Thanks to maintainers
Thanks for adding the HTTP VFS support in #680.
Issue or motivation
Closes #505. The feature now exists, but the most discoverable docs still do not show the current remote-connection entry points together.
Root cause
The package-level
dbConnect()docs only described local paths and memory databases, and the README did not show a minimal current example for eithersqliteRemote()or the explicitfile:https://...?...URI form.Change
dbnamedocumentation fordbConnect()sqliteRemote()and the explicit SQLite URI plusSQLITE_ROman/SQLite.Rdand syncREADME.mdTests
git diff --checkRscript -e 'tools::checkRd("man/SQLite.Rd")'R CMD build --no-build-vignettes ._R_CHECK_FORCE_SUGGESTS_=false R CMD check --no-manual --ignore-vignettes --no-build-vignettes --no-tests RSQLite_3.53.2.9006.tar.gzScope
I did not change HTTP VFS behavior, add new helpers, or touch NEWS/tests. This PR only tightens user-facing documentation around the existing feature.