_ _ _ _ _ _ _ _ _ _ _ /| |\ / |_ _ _ _ _ _ _ _ _ _| \ \ / \/ \ ___________________ /
An easy interface to CouchDB from R
Note: Check out R4couchdb, another R package to interact with CouchDB.
sofa is built targeting CouchDB v2 or greater.
Go to http://docs.couchdb.org/en/2.0.0/install/index.html for instructions.
This may be starting it on your terminal/shell
couchdbOr opening the CouchDB app on your machine, or running it in docker. Whatever it is, start it up.
You can interact with your CouchDB databases as well in your browser. Navigate to http://localhost:5984/_utils
From CRAN
install.packages("sofa")Development version from GitHub
devtools::install_github("ropensci/sofa")library('sofa')Cushions? What? Since it's couch we gotta use cushions somehow. cushions are a
connection class containing all connection info to a CouchDB instance.
See ?Cushion for help.
As an example, connecting to a Cloudant couch:
z <- Cushion$new(
host = "stuff.cloudant.com",
transport = 'https',
port = NULL,
user = 'foobar',
pwd = 'things'
)Break down of parameters:
host: the base url, without the transport (http/https)transport:httporhttpsport: The port to connect to. Default: 5984. For Cloudant, have to set toNULLuser: User name for the service.pwd: Password for the service, if any.
If you call Cushion$new() with no arguments you get a cushion set up for local
use on your machine, with all defaults used.
x <- Cushion$new()ping(x)
#> $couchdb
#> [1] "Welcome"
#>
#> $version
#> [1] "2.0.0"
#>
#> $vendor
#> $vendor$name
#> [1] "The Apache Software Foundation"Nice, it's working.
#> $ok
#> [1] TRUE
db_create(x, dbname = 'sofadb')
#> $ok
#> [1] TRUEsee if its there now
db_list(x)
#> [1] "acouch" "alm_couchdb" "aqijhfcntb"
#> [4] "auhgmimrls" "avarpnvaia" "bhlhhiwwph"
#> [7] "bulktest" "bvuizcrdoy" "cats"
#> [10] "dpufyoigqf" "drinksdb" "fiadbzwmos"
#> [13] "flxsqfkzdf" "gtogmgbsjx" "helloworld"
#> [16] "jebvagbrqz" "jxdktgmdsb" "leothelion"
#> [19] "leothelion-json" "lgzzmzugkm" "lhkfptkfel"
#> [22] "lyluootgvi" "namcicfbjl" "nqidfcpojk"
#> [25] "omdb" "sofadb" "spyrzxffqv"
#> [28] "sss" "testing123" "trkhxkopvd"
#> [31] "uwvtpnehdu" "vswtlxhcxe" "wqefduwgpu"
#> [34] "xhalvmxmud" "xwrcjghvxx" "zocaqeleye"doc1 <- '{"name":"sofa","beer":"IPA"}'
doc_create(x, doc1, dbname = "sofadb", docid = "a_beer")
#> $ok
#> [1] TRUE
#>
#> $id
#> [1] "a_beer"
#>
#> $rev
#> [1] "1-a48c98c945bcc05d482bc6f938c89882"doc2 <- '{"name":"sofa","icecream":"rocky road"}'
doc_create(x, doc2, dbname = "sofadb")
#> $ok
#> [1] TRUE
#>
#> $id
#> [1] "e6bb43092edaf8fd987434b8a30d08bd"
#>
#> $rev
#> [1] "1-fd0da7fcb8d3afbfc5757d065c92362c"Write an xml document WITH a name (uses PUT). The xml is written as xml in couchdb, just wrapped in json, when you get it out it will be as xml.
write the xml
doc3 <- "<top><a/><b/><c><d/><e>bob</e></c></top>"
doc_create(x, doc3, dbname = "sofadb", docid = "somexml")
#> $ok
#> [1] TRUE
#>
#> $id
#> [1] "somexml"
#>
#> $rev
#> [1] "1-5f06e82103a0d5baa9d5f75226c8dcb8"get the doc back out
doc_get(x, dbname = "sofadb", docid = "somexml")
#> $`_id`
#> [1] "somexml"
#>
#> $`_rev`
#> [1] "1-5f06e82103a0d5baa9d5f75226c8dcb8"
#>
#> $xml
#> [1] "<top><a/><b/><c><d/><e>bob</e></c></top>"get just the xml out
doc_get(x, dbname = "sofadb", docid = "somexml")[["xml"]]
#> [1] "<top><a/><b/><c><d/><e>bob</e></c></top>"- Please report any issues or bugs.
- License: MIT
- Get citation information for
sofain R doingcitation(package = 'sofa') - Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent