Skip to content

Commit b0e9849

Browse files
committed
pkgdown update
1 parent e1b1f88 commit b0e9849

22 files changed

Lines changed: 200 additions & 193 deletions

.github/workflows/check-standard.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,12 @@ jobs:
9595

9696
# for nodbi:
9797

98-
- name: Install duckdb extension library
98+
- name: Try installing duckdb extension library
9999
run: |
100100
library(duckdb)
101101
drv <- duckdb()
102102
con <- dbConnect(drv)
103-
dbExecute(con, 'INSTALL json;')
103+
try(dbExecute(con, 'INSTALL json;'), silent = TRUE)
104104
dbDisconnect(con)
105105
duckdb_shutdown(drv)
106106
shell: Rscript {0}

DESCRIPTION

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
Package: nodbi
2-
Title: 'NoSQL' Database Connector
3-
Description: Simplified JSON document database access and manipulation,
4-
providing a common API across supported 'NoSQL' databases
5-
'Elasticsearch', 'CouchDB', 'MongoDB' as well as
6-
'SQLite/JSON1', 'PostgreSQL', and 'DuckDB'.
2+
Title: 'NoSQL' Database Interface
3+
Description: R database interface for creating, reading (querying and listing
4+
fields), updating and deleting of individual or many JSON documents,
5+
providing a common API across supported databases ('SQLite', 'PostgreSQL',
6+
'DuckDB' and 'NoSQL' databases 'MongoDB', 'CouchDB' and 'Elasticsearch').
77
Version: 0.14.0.9000
88
Authors@R: c(
9-
person(given = "Ralf",
10-
family = "Herold",
11-
role = c("aut", "cre"),
9+
person("Ralf", "Herold", role = c("aut", "cre"),
1210
email = "ralf.herold@mailbox.org",
1311
comment = c(ORCID = "0000-0002-8148-6748")),
14-
person(given = "Scott",
15-
family = "Chamberlain",
16-
role = "aut",
12+
person("Scott", "Chamberlain", role = "aut",
1713
comment = c(ORCID = "0000-0003-1444-9135")),
1814
person("Rich", "FitzJohn", role = "aut"),
1915
person("Jeroen", "Ooms", role = "aut"),

NEWS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# nodbi 0.14.0.9000
22

3-
* Changes to address that package elastic was archived
3+
* Changes to address that package elastic was archived (CI, documentation)
44

55
# nodbi 0.14.0
66

R/src_elastic.R

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@
2828
#' document ID `_id`, otherwise a UUID is created as document ID `_id`.
2929
#' Only lowercase is accepted for container names (in parameter `key`).
3030
#' Opensearch can equally be used.
31-
#' For a benchmark, see <https://github.com/ropensci/nodbi#benchmark>
31+
#' For a benchmark, see <https://github.com/ropensci/nodbi#benchmark>.
32+
#'
33+
#' As of 2026-01-17, the future availability and development of package elastic
34+
#' is not clear after it was recently archived, see also
35+
#' <https://github.com/opensci-archive/elastic>; at this time, it can still be
36+
#' installed by calling `remotes::install_github("ropensci-archive/elastic")`
3237
#'
3338
#' @return A `nodbi` source object
3439
#'

README.Rmd

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,16 @@ src <- nodbi::src_mongo(
108108
src <- nodbi::src_sqlite(dbname = ":memory:", ...)
109109
```
110110

111+
### PostgreSQL
112+
113+
"Container" refers to a PostgreSQL table, with columns `_id` and `json` created and used by package `nodbi`, applying SQL functions and functions as per <https://www.postgresql.org/docs/current/functions-json.html> to the `json` column. With PostgreSQL, a custom `plpgsql` function [jsonb_merge_patch()](https://github.com/ropensci/nodbi/blob/master/R/src_postgres.R#L60) is used for `docdb_update()`. The order of variables in data frames returned by `docdb_get()` and `docdb_query()` can differ from their order the input to `docdb_create()`.
114+
115+
```{r}
116+
src <- nodbi::src_postgres(
117+
dbname = "my_database", host = "127.0.0.1", port = 5432L, ...
118+
)
119+
```
120+
111121
### CouchDB
112122

113123
"Container" refers to a CouchDB database, in which `nodbi` creates JSON documents. See also <https://CRAN.R-project.org/package=sofa>. With CouchDB, function `docdb_update()` uses [jqr](https://cran.r-project.org/package=jqr) to implement patching JSON, in analogy to functions available for the other databases.
@@ -136,16 +146,6 @@ As of 2026-01-17, the future availability and development of package elastic is
136146
remotes::install_github("ropensci-archive/elastic")
137147
```
138148

139-
### PostgreSQL
140-
141-
"Container" refers to a PostgreSQL table, with columns `_id` and `json` created and used by package `nodbi`, applying SQL functions and functions as per <https://www.postgresql.org/docs/current/functions-json.html> to the `json` column. With PostgreSQL, a custom `plpgsql` function [jsonb_merge_patch()](https://github.com/ropensci/nodbi/blob/master/R/src_postgres.R#L60) is used for `docdb_update()`. The order of variables in data frames returned by `docdb_get()` and `docdb_query()` can differ from their order the input to `docdb_create()`.
142-
143-
```{r}
144-
src <- nodbi::src_postgres(
145-
dbname = "my_database", host = "127.0.0.1", port = 5432L, ...
146-
)
147-
```
148-
149149
## Walk-through {#walk-through}
150150

151151
This example is to show how functional `nodbi` is at this time: With any of the six database backends, the functions work in the same way and return the same values.

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,24 @@ indexed on `_id`. See also <https://CRAN.R-project.org/package=RSQLite>.
125125
src <- nodbi::src_sqlite(dbname = ":memory:", ...)
126126
```
127127

128+
### PostgreSQL
129+
130+
“Container” refers to a PostgreSQL table, with columns `_id` and `json`
131+
created and used by package `nodbi`, applying SQL functions and
132+
functions as per
133+
<https://www.postgresql.org/docs/current/functions-json.html> to the
134+
`json` column. With PostgreSQL, a custom `plpgsql` function
135+
[jsonb_merge_patch()](https://github.com/ropensci/nodbi/blob/master/R/src_postgres.R#L60)
136+
is used for `docdb_update()`. The order of variables in data frames
137+
returned by `docdb_get()` and `docdb_query()` can differ from their
138+
order the input to `docdb_create()`.
139+
140+
``` r
141+
src <- nodbi::src_postgres(
142+
dbname = "my_database", host = "127.0.0.1", port = 5432L, ...
143+
)
144+
```
145+
128146
### CouchDB
129147

130148
“Container” refers to a CouchDB database, in which `nodbi` creates JSON
@@ -163,24 +181,6 @@ be installed as follows.
163181
remotes::install_github("ropensci-archive/elastic")
164182
```
165183

166-
### PostgreSQL
167-
168-
“Container” refers to a PostgreSQL table, with columns `_id` and `json`
169-
created and used by package `nodbi`, applying SQL functions and
170-
functions as per
171-
<https://www.postgresql.org/docs/current/functions-json.html> to the
172-
`json` column. With PostgreSQL, a custom `plpgsql` function
173-
[jsonb_merge_patch()](https://github.com/ropensci/nodbi/blob/master/R/src_postgres.R#L60)
174-
is used for `docdb_update()`. The order of variables in data frames
175-
returned by `docdb_get()` and `docdb_query()` can differ from their
176-
order the input to `docdb_create()`.
177-
178-
``` r
179-
src <- nodbi::src_postgres(
180-
dbname = "my_database", host = "127.0.0.1", port = 5432L, ...
181-
)
182-
```
183-
184184
## Walk-through
185185

186186
This example is to show how functional `nodbi` is at this time: With any

codemeta.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
33
"@type": "SoftwareSourceCode",
44
"identifier": "nodbi",
5-
"description": "Simplified JSON document database access and manipulation, providing a common API across supported 'NoSQL' databases 'Elasticsearch', 'CouchDB', 'MongoDB' as well as 'SQLite/JSON1', 'PostgreSQL', and 'DuckDB'.",
6-
"name": "nodbi: 'NoSQL' Database Connector",
5+
"description": "R database interface for creating, reading (querying and listing fields), updating and deleting of individual or many JSON documents, providing a common API across supported databases ('SQLite', 'PostgreSQL', 'DuckDB' and 'NoSQL' databases 'MongoDB', 'CouchDB' and 'Elasticsearch').",
6+
"name": "nodbi: 'NoSQL' Database Interface",
77
"relatedLink": ["https://docs.ropensci.org/nodbi/", "https://CRAN.R-project.org/package=nodbi"],
88
"codeRepository": "https://github.com/ropensci/nodbi",
99
"issueTracker": "https://github.com/ropensci/nodbi/issues",
@@ -316,7 +316,7 @@
316316
"applicationCategory": "Databases",
317317
"isPartOf": "https://ropensci.org",
318318
"keywords": ["database", "MongoDB", "Elasticsearch", "CouchDB", "SQLite", "PostgreSQL", "DuckDB", "NoSQL", "JSON", "documents", "rstats", "nosql", "couchdb", "mongodb", "elasticsearch", "r", "r-package", "sqlite", "postgresql"],
319-
"fileSize": "669.266KB",
319+
"fileSize": "676.108KB",
320320
"releaseNotes": "https://github.com/ropensci/nodbi/blob/main/NEWS.md",
321321
"readme": "https://github.com/ropensci/nodbi/blob/master/README.md",
322322
"contIntegration": ["https://github.com/ropensci/nodbi/actions?query=workflow%3AR-CMD-check", "https://app.codecov.io/gh/rfhb/nodbi"],

docs/articles/nodbi-overview.html

Lines changed: 33 additions & 38 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)