Driver: Add page about R #405
Merged
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
amotl
added
the
cross linking
WalkthroughAdds R driver documentation: inserts an R driver card into the "Drivers by language" grid on Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🧠 Learnings (21)📓 Common learnings📚 Learning: 2025-10-19T19:21:49.864ZApplied to files:
📚 Learning: 2025-09-25T19:31:54.320ZApplied to files:
📚 Learning: 2025-10-07T10:19:41.866ZApplied to files:
📚 Learning: 2025-10-10T17:58:26.545ZApplied to files:
📚 Learning: 2025-08-10T17:09:32.616ZApplied to files:
📚 Learning: 2025-10-20T21:49:18.785ZApplied to files:
📚 Learning: 2025-08-09T21:40:46.154ZApplied to files:
📚 Learning: 2025-09-22T22:05:05.734ZApplied to files:
📚 Learning: 2025-08-10T18:17:49.380ZApplied to files:
📚 Learning: 2025-08-22T18:11:12.776ZApplied to files:
📚 Learning: 2025-08-09T11:00:03.578ZApplied to files:
📚 Learning: 2025-08-06T02:11:46.794ZApplied to files:
📚 Learning: 2025-08-09T11:03:33.178ZApplied to files:
📚 Learning: 2025-10-06T13:45:25.891ZApplied to files:
📚 Learning: 2025-10-06T16:40:16.322ZApplied to files:
📚 Learning: 2025-09-17T14:31:04.228ZApplied to files:
📚 Learning: 2025-08-14T19:02:43.308ZApplied to files:
📚 Learning: 2025-06-05T14:29:15.512ZApplied to files:
📚 Learning: 2025-10-16T10:58:18.401ZApplied to files:
📚 Learning: 2025-10-08T01:34:18.867ZApplied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
amotl
force-pushed
the
r-ng
branch
2 times, most recently
from
b5dd4a8 to
afad979
Compare
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
amotl
commented
Oct 16, 2025
docs/connect/r.md
Outdated
Comment on lines
17
to
30
| ```r | ||
| # Install driver on demand. | ||
| # RPostgreSQL: R Interface to the 'PostgreSQL' Database System | ||
| # https://cran.r-project.org/web/packages/RPostgreSQL/ | ||
|
|
||
| # Optionally install the PostgreSQL library. | ||
| if (!requireNamespace("RPostgreSQL", quietly = TRUE)) { | ||
| install.packages("RPostgreSQL", repos="https://cran.r-project.org") | ||
| } | ||
|
|
||
| # Load the DBI and PostgreSQL libraries. | ||
| library(DBI) | ||
| library(RPostgreSQL) | ||
| drv <- RPostgreSQL::PostgreSQL() |
Member
Author
There was a problem hiding this comment.
@coderabbitai suggested:
17-31: Optional: mention RPostgres as the modern alternative.RPostgres (PostgreSQL DBI driver) is actively maintained and often preferred; it also works with the PG wire protocol.
Member
Author
There was a problem hiding this comment.
Indeed, two driver variants exist. Let's re-evaluate which one to present, or otherwise present both separately.
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
RPostgres vs RPostgreSQL comparison 2024 2025 which is better actively maintained
💡 Result:
Short answer: RPostgres is the more actively maintained and recommended driver in 2024–2025 (modern C++ backend, DBI‑feature support); RPostgreSQL still exists and receives occasional updates but is older and less featureful. [1][2][3]
Quick evidence
- RPostgres: actively maintained, CRAN/dev releases in 2024–2025, maintained by Kirill Müller and r-dbi with GitHub/CRAN activity and documentation. [1][4][5]
- RPostgreSQL: older, C-backed driver with its last CRAN release notes in 2024 (and occasional 2025 packaging updates), but it is not the modern DBI implementation and lacks some features (e.g. full parameterized-query support) found in RPostgres. [6][2]
Recommendation
- Use RPostgres for new projects (better performance, parameterised queries, automatic cleanup, active r-dbi maintenance). Use RPostgreSQL only if you have legacy code that depends on it. [1][4][6]
Sources
- RPostgres project page / r-dbi documentation (features, design, maintainer). [rpostgres.r-dbi.org].
- CRAN package page / CRAN-e listing for RPostgres (recent releases/versions).
- CRAN checks and r-universe/manual pages showing 2024–2025 builds and versions.
- RPostgres GitHub / r-dbi (source/docs/activity).
- RPostgreSQL CRAN/CRAN-e package page and release history (last upstream releases in 2024; occasional packaging updates in 2025).
If you want I can list the exact CRAN/GitHub release dates and links (with numbered citations).
🌐 Web query:
RPostgreSQL maintenance status CRAN last update
💡 Result:
RPostgreSQL is currently maintained; the latest CRAN release is version 0.7-8 (released March 28, 2025). Maintainer: Tomoaki Nishiyama. [1][2]
Sources:
- CRAN update notice (RPostgreSQL 0.7-8, 2025-03-28). [1]
- Package reference/manual (version 0.7-8; built 2025-07-29). [2]
🌐 Web query:
RPostgres modern R PostgreSQL driver best practices
💡 Result:
Quick best-practices for using RPostgres (concise):
- Use the DBI + RPostgres API (DBI::dbConnect(RPostgres::Postgres())) and prefer RPostgres over RPostgreSQL (modern C++ backend, safer cleanup). (rpostgres.r-dbi.org)
- Use parameterized queries / prepared statements (dbSendQuery() + dbBind() or dbExecute()/params) to prevent SQL injection and reuse plans. (dbi.r-dbi.org)
- Manage transactions explicitly when needed: DBI::dbBegin()/dbCommit()/dbRollback() (or savepoints) to ensure atomicity. Use on.exit()/withr::defer() to always close/rollback on error. (rpostgres.r-dbi.org)
- Use a connection pool (pool::dbPool) in long‑running apps (Shiny, Plumber) rather than opening ad‑hoc connections; tune minSize/maxSize and idleTimeout and always poolClose() on shutdown. (rstudio.github.io)
- Fetch large results in chunks: dbSendQuery() → dbFetch(n) → dbClearResult() to avoid OOM. Use dbGetQuery() only if result fits memory. (r-dbi.r-universe.dev)
- Bulk writes: prefer DBI::dbWriteTable(..., copy = TRUE) or COPY-based approaches for large data loads (use server-side COPY where supported). Validate types (bigint → integer64) and cast params if needed (e.g. "$1::bigint"). (r-dbi.r-universe.dev)
- Enforce TLS/SSL and least-privilege DB credentials for production; supply host/sslmode and use managed secrets (env vars, keyvault) rather than hardcoding. (rpostgres.r-dbi.org)
- Clean up: always dbClearResult(), dbDisconnect() (or poolClose()); use on.exit() / withr::defer() to avoid leaks. RPostgres auto-cleans more than older drivers but explicit cleanup is still best practice. (rpostgres.r-dbi.org)
- Monitor & right-size: monitor active connections on Postgres side, set pool max below DB max_connections, add retry/backoff for transient failures. (compilenrun.com)
- Use dbplyr for pushdown where appropriate (let the DB do filtering/aggregation); ensure proper indexing and examine query plans for hotspots. (rstudio.github.io)
If you want, I can produce copy‑pasteable example snippets for: (a) secure dbPool usage, (b) parameterized dbBind pattern, or (c) a safe transaction pattern. Which one first?
Citations:
- 1: https://rpostgres.r-dbi.org/?utm_source=openai
- 2: https://dbi.r-dbi.org/reference/dbBind.html?utm_source=openai
- 3: https://rpostgres.r-dbi.org/reference/postgres-transactions.html?utm_source=openai
- 4: https://rstudio.github.io/pool/reference/dbPool.html?utm_source=openai
- 5: https://r-dbi.r-universe.dev/RPostgres/doc/manual.html?utm_source=openai
- 6: https://r-dbi.r-universe.dev/RPostgres/doc/manual.html?utm_source=openai
- 7: https://rpostgres.r-dbi.org/?utm_source=openai
- 8: https://rpostgres.r-dbi.org/?utm_source=openai
- 9: https://www.compilenrun.com/docs/database/postgresql/postgresql-best-practices/postgresql-connection-pooling/?utm_source=openai
- 10: https://rstudio.github.io/pool/reference/tbl.Pool.html?utm_source=openai
@amotl, based on current information, here's my recommendation:
Key Differences
RPostgres (recommended):
- Modern, actively maintained by the r-dbi team
- C++ backend with better performance
- Full DBI feature support including parameterized queries
- Automatic connection cleanup
- Preferred for new projects in 2024-2025
RPostgreSQL:
- Older C-backed driver
- Still maintained (v0.7-8 released March 2025)
- Less featureful than RPostgres
- Typically only used for legacy code compatibility
Recommendation
I suggest switching to RPostgres as the primary driver in your documentation since:
- This is new documentation (not maintaining legacy code)
- RPostgres is the community-recommended modern approach
- Both work with the PostgreSQL wire protocol, so both should work with CrateDB
You could optionally add a brief note mentioning RPostgreSQL as an alternative for users with existing code, but keeping the main example with RPostgres would be clearer and more helpful.
Would you like me to help update the code example to use RPostgres instead? The changes would be minimal:
# Install RPostgres instead
if (!requireNamespace("RPostgres", quietly = TRUE)) {
install.packages("RPostgres", repos="https://cran.r-project.org")
}
library(DBI)
library(RPostgres)
# No need to create drv object - use RPostgres::Postgres() directly in dbConnect()There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check the commit referenced by the user
git show cdbcf938561 --stat
echo "---"
# Show the actual changes in the R documentation file
git show cdbcf938561 -- docs/connect/r.md
Length of output: 3373
@amotl Perfect! The changes look excellent. You've successfully switched to RPostgres as the primary driver while thoughtfully keeping RPostgreSQL mentioned as an alternative.
The implementation is clean and follows best practices:
- ✅ Uses
RPostgres::Postgres()directly indbConnect()(no need for the intermediatedrvobject) - ✅ Clear explanation that RPostgres is actively maintained and preferred
- ✅ Still mentions RPostgreSQL for users who might need it
- ✅ Updated all references, comments, and examples consistently
The documentation now provides modern, recommended guidance for R users connecting to CrateDB. Great work!
♪┏(・o･)┛♪┗ ( ･o･) ┓♪
Member
Author
There was a problem hiding this comment.
@coderabbitai: Thank you for pointing out RPostgres, so we have been able to improve our docs. 💯
There was a problem hiding this comment.
@amotl You're very welcome! I'm glad the suggestion was helpful. The documentation now reflects the modern best practices for R users, which will benefit the community. Happy to assist anytime! 🚀
amotl
force-pushed
the
r-ng
branch
2 times, most recently
from
3ace5ab to
cdbcf93
Compare
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
amotl
force-pushed
the
r-ng
branch
2 times, most recently
from
2756c81 to
08b6054
Compare
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
amotl
commented
Oct 21, 2025
amotl
force-pushed
the
r-ng
branch
2 times, most recently
from
ef4562c to
cde4c11
Compare
amotl
commented
Oct 21, 2025
seut
approved these changes
Oct 30, 2025
This was referenced Oct 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
About
What the title says.
Preview
https://cratedb-guide--405.org.readthedocs.build/connect/r/