{"Type":"Package","Package":"easydb","Title":"Easily Connect to Common Types of Databases","Version":"1.1.0","Authors@R":"person(given = \"Sam\",\nfamily = \"El-Kamand\",\nrole = c(\"aut\", \"cre\", \"cph\"),\nemail = \"sam.elkamand@gmail.com\",\ncomment = c(ORCID = \"0000-0003-2270-8088\"))","Description":"A unified interface for connecting to databases ('SQLite', 'MySQL', 'PostgreSQL').\nJust provide the database name and the package will ask you questions\nto help you configure the connection and setup your credentials. Once\ndatabase configuration and connection has been set up once, you won't\nhave to do it ever again.","License":"MIT + file LICENSE","URL":"https://github.com/selkamand/easydb,\nhttps://selkamand.github.io/easydb/","BugReports":"https://github.com/selkamand/easydb/issues","Imports":"askpass, assertthat, cli, DBI, keyring, rlang, utils, yaml","Suggests":"knitr, RMariaDB, rmarkdown, RPostgres, RSQLite, testthat (>=\n3.0.0)","VignetteBuilder":"knitr","Config/testthat/edition":"3","Encoding":"UTF-8","RoxygenNote":"7.2.3","NeedsCompilation":"no","Packaged":"2023-03-06 10:05:00 UTC; selkamand","Author":"Sam El-Kamand [aut, cre, cph] ()","Maintainer":"Sam El-Kamand ","Repository":"CRAN","Date/Publication":"2023-03-06 10:20:07 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/easydb_1.1.0.tar.gz","jsonAuthors":[{"name":"Sam El-Kamand","email":"sam.elkamand@gmail.com","maintainer":true}],"readme":"\n\n\n# easydb

\n\n\n\n[![Lifecycle:\nexperimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/easydb)](https://CRAN.R-project.org/package=easydb)\n[![R-CMD-check](https://github.com/selkamand/easydb/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/selkamand/easydb/actions/workflows/R-CMD-check.yaml)\n[![Download\nStats](http://cranlogs.r-pkg.org/badges/easydb)](https://cran.r-project.org/package=easydb)\n\n\nThe goal of easydb is to simplify the process of connecting to databases\nusing R\n\n## Installation\n\nInstall from CRAN\n\n``` r\ninstall.packages('easydb')\n```\n\nYou can install the development version of easydb like so:\n\n``` r\n# install.packages('remotes')\nremotes::install_github('selkamand/easydb')\n```\n\n## Quick start (examples)\n\n``` r\nlibrary(easydb)\n\n# Initialise a config file at '~/.easydb'\neasydb_init(config_file = '~/.easydb')\n\n# sqlite\nsqlitedb <- system.file(package=\"easydb\", \"testdbs/mtcars.sqlite\")\nsqlite_connection <- easydb_connect(sqlitedb, config_file = '~/.easydb')\n\n# mysql\n# Example: connect to the public rfam mysql database\n#\n# See here for connection configuration: \n# https://docs.rfam.org/en/latest/database.html\nrfam_connection <- easydb_connect(dbname = \"Rfam\", config_file = '~/.easydb')\n\n\n# postgresql\n# Example: Connect to public RNAcentral postgres database\n#\n# See here for connection configuration: \n# https://rnacentral.org/help/public-database\nrna_central_connection <- easydb_connect(dbname = 'pfmegrnargs', config_file = '~/.easydb')\n\n\n# Don't forget to disconnect from databases when you finish!\neasydb_disconnect(sqlite_connection)\neasydb_disconnect(rna_central_connection)\neasydb_disconnect(rfam_connection)\n```\n\n### Disconnect\n\nOnce you’ve finished working with a database, its best to disconnect\nfrom the db using `easydb_disconnect(connection_object)`\n\n## Usage (Generalised Workflow)\n\n### Step 1: Initialise Config File\n\nWe need to store your configuration details in a file somewhere on disk.\nYou can choose where.\n\nA common practice is to create a hidden file in your home directory.\n\nWe’ll create our config file: `~/.easydb`\n\n``` r\neasydb_init(config_file = '~/.easydb')\n```\n\nThis only needs to be done once.\n\n### Step 2: Connect to Database\n\nConnect to databases:\n\n`easydb_connect('database_name', '~/.easydb')`\n\n### Step 3: Disconnect when finished\n\nDisconnect from databases:\n\n`easydb_disconnect(connection)`\n\n### What to expect\n\nThe first time you try to connect to a database, you may have to answer\nsome questions about the database (depending on the database type you’re\nconnecting to).\n\nOnce you’ve setup the configuration, you will not have to re-enter\nhost/port/creds unless you set the argument `from_scratch = TRUE`. This\nargument will delete the existing configuration and credentials for the\ngiven database and prompt you to supply updated information.\n\n## Miscellaneous Functionality\n\n``` r\n# List previously configured databases\neasydb_available_databases('~/.easydb')\n```\n\n## How does easydb work?\n\nDatabase configurations (host, port, driver, etc) are stored in a\nconfiguration file that will be created at a user-specified location (we\nrecommend `~/.easydb`).\n\nCredentials are stored separately in your operating systems credential\nstore. This is powered by `keyring`. If you’re on linux you may need to\ninstall the secret service library. See the\n[readme](https://github.com/r-lib/keyring) for details","jobInfo":{"package":"easydb","version":"1.1.0","parsingStatus":"success","parserVersion":2,"parsedAt":"2023-03-06T11:29:48+0000"}}

Description

Usage

Arguments

Value