{"Package":"nodbi","Title":"'NoSQL' Database Connector","Description":"Simplified document database manipulation and analysis,\nincluding support for many 'NoSQL' databases, including document\ndatabases ('Elasticsearch', 'CouchDB', 'MongoDB'),\n'key-value' databases ('Redis'), and (with limitations)\nSQLite/json1.","Version":"0.3.0","Authors@R":"c(\nperson(\"Scott\", \"Chamberlain\", role = c(\"aut\", \"cre\"),\nemail = \"sckott@protonmail.com\",\ncomment = c(ORCID = \"0000-0003-1444-9135\")),\nperson(\"Rich\", \"FitzJohn\", role = \"aut\"),\nperson(\"Jeroen\", \"Ooms\", role = \"aut\"),\nperson(given = \"Ralf\",\nfamily = \"Herold\",\nrole = \"aut\",\ncomment = c(ORCID = \"0000-0002-8148-6748\"))\n)","License":"MIT + file LICENSE","LazyData":"true","URL":"https://github.com/ropensci/nodbi","BugReports":"https://github.com/ropensci/nodbi/issues","Depends":"R (>= 2.10)","Encoding":"UTF-8","Language":"en-US","Imports":"data.table, jsonlite","Suggests":"sofa (>= 0.3.0), elastic (>= 1.0.0), mongolite (>= 1.6),\nredux, RSQLite (>= 1.1), DBI, testthat","RoxygenNote":"6.1.1","X-schema.org-applicationCategory":"Databases","X-schema.org-keywords":"database, MongoDB, Redis, Elasticsearch,\nCouchDB, SQLite, NoSQL, JSON, documents","X-schema.org-isPartOf":"https://ropensci.org","NeedsCompilation":"no","Packaged":"2019-09-18 21:46:05 UTC; sckott","Author":"Scott Chamberlain [aut, cre] (),\nRich FitzJohn [aut],\nJeroen Ooms [aut],\nRalf Herold [aut] ()","Maintainer":"Scott Chamberlain ","Repository":"CRAN","Date/Publication":"2019-09-18 22:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/nodbi_0.3.0.tar.gz","jsonAuthors":[{"name":"Scott Chamberlain","email":"sckott@protonmail.com","maintainer":true},{"name":"Rich FitzJohn","email":null,"maintainer":false},{"name":"Jeroen Ooms","email":null,"maintainer":false},{"name":"Ralf Herold","email":null,"maintainer":false}],"readme":"nodbi\n=====\n\n\n\n[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)\n[![cran checks](https://cranchecks.info/badges/worst/nodbi)](https://cranchecks.info/pkgs/nodbi)\n[![Build Status](https://travis-ci.org/ropensci/nodbi.svg)](https://travis-ci.org/ropensci/nodbi)\n[![codecov](https://codecov.io/gh/ropensci/nodbi/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/nodbi)\n[![rstudio mirror downloads](http://cranlogs.r-pkg.org/badges/nodbi)](https://github.com/metacran/cranlogs.app)\n[![cran version](https://www.r-pkg.org/badges/version/nodbi)](https://cran.r-project.org/package=nodbi)\n\n\n`nodbi` provides a single user interface for interacting with many NoSQL databases.\n\nSo far we support the following DBs:\n\n* MongoDB\n* Redis (server based)\n* CouchDB\n* Elasticsearch\n* SQLite\n\nCurrently we have support for data.frame's for the following operations\n\n* Create - all DBs\n* Exists - all DBs, except MongoDB\n* Get - all DBs\n* Query - all DBs, except Redis\n* Delete - all DBs\n* Update - just CouchDB\n\n## Install\n\ncran version\n\n\n```r\ninstall.packages(\"nodbi\")\n```\n\ndev version\n\n\n```r\ninstall.packages(\"devtools\")\ndevtools::install_github(\"ropensci/nodbi\")\n```\n\n\n```r\nlibrary(\"nodbi\")\n```\n\n## Initialize connections\n\nStart CouchDB on the cli or with the app\n\n\n```r\nsrc_couchdb()\n```\n\nStart Elasticsearch, e.g.:\n\n```sh\ncd /usr/local/elasticsearch && bin/elasticsearch\n```\n\n\n```r\nsrc_elastic()\n```\n\nIf you want to use classic Redis server, we do that through the [redux][]\npackage, and you'll need to start up Redis by e.g,. `redis-server` in your shell.\n\n\n```r\nsrc_redis()\n```\n\nStart MongoDB: `mongod` (may need to do `sudo mongod`)\n\n\n```r\nsrc_mongo()\n```\n\n## CouchDB\n\n\n```r\nsrc <- src_couchdb()\ndocout <- docdb_create(src, key = \"mtcars\", value = mtcars)\nhead( docdb_get(src, \"mtcars\") )\n```\n\n## Elasticsearch\n\nPut the `iris` dataset into ES\n\n\n\n\n```r\nsrc <- src_elastic()\nff <- docdb_create(src, \"iris\", iris)\nhead( docdb_get(src, \"iris\") )\n#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species\n#> 5.0 3.6 1.4 0.2 setosa\n#> 4.9 3.1 1.5 0.1 setosa\n#> 4.8 3.4 1.6 0.2 setosa\n#> 5.4 3.9 1.3 0.4 setosa\n#> 5.1 3.3 1.7 0.5 setosa\n#> 5.2 3.4 1.4 0.2 setosa\n```\n\n## Redis\n\n\n```r\nsrc <- src_redis()\ndocdb_create(src, \"mtcars\", mtcars)\n```\n\n\n```r\ndocdb_get(src, \"mtcars\")\n```\n\n## MongoDB\n\n\n```r\nlibrary(\"ggplot2\")\nsrc <- src_mongo(verbose = FALSE)\nff <- docdb_create(src, \"diamonds\", diamonds)\ndocdb_get(src, \"diamonds\")\n```\n\n## SQLite\n\n\n```r\nsrc <- src_sqlite(dbname = \":memory:\")\nff <- docdb_create(src, key = \"mtcars\", value = mtcars)\ndocdb_get(src, key = \"mtcars\")\n```\n\nExtension [json1](https://www.sqlite.org/json1.html) is enabled in Package `RSQLite` (since version 1.1). This extension is used to emulate the behaviour of MongoDB with the methods for SQLite: \n\n- Parameter `collection` corresponds to the name of a table (parameter `key`) in the SQLite database `dbname`. \n- Json strings in parameters `query` and `fields` are translated into SQL commands, unless too complex. \n- Tables created by `docdb_create()` are defined as follows, with exactly two columns, an index column named `_id` and a column with json data named `json`: \n``` \nCREATE TABLE mtcars ( _id TEXT PRIMARY_KEY NOT NULL, json JSON );\nCREATE UNIQUE INDEX mtcars_index ON mtcars ( _id );\n```\n\nThe following examples show the maximum level of complexity that can be used at this time with available json operaters (\"\\$eq\", \"\\$gt\", \"\\$gte\", \"\\$lt\", \"\\$lte\", \"\\$ne\"); `query` implies AND of the comma separated expressions in the absence of a prefixed logical operator (available at this time: \"\\$and\", \"\\$or\"). \n\n\n```r\nff <- docdb_create(src, key = \"mtcars\", value = contacts)\ndocdb_query(src, \"mtcars\", \n query = '{\"$or\": {\"eyeColor\": \"blue\", \n \"age\": {\"$lt\": 22}}, \n \"name\": {\"$regex\": \"L%\"} }',\n fields = '{\"age\": 1, \"eyeColor\": 1, \"name\": 1}')\n```\n\n\n## Use with dplyr\n\n\n```r\nlibrary(\"dplyr\")\nsrc <- src_mongo(verbose = FALSE)\n```\n\n\n```r\ndocdb_get(src, \"diamonds\") %>%\n group_by(cut) %>%\n summarise(mean_depth = mean(depth), mean_price = mean(price))\n```\n\n## Meta\n\n* Please [report any issues or bugs](https://github.com/ropensci/nodbi/issues).\n* License: MIT\n* Get citation information for `nodbi` in R doing `citation(package = 'nodbi')`\n* Please note that this project is released with a [Contributor Code of Conduct][coc].\nBy participating in this project you agree to abide by its terms.\n\n[![rofooter](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)\n\n[redux]: https://cran.r-project.org/package=redux\n[coc]: https://github.com/ropensci/nodbi/blob/master/CODE_OF_CONDUCT.md","jobInfo":{"package":"nodbi","version":"0.3.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2019-11-12T00:30:52+0000"}}

Description

Usage

Arguments

Details

Examples