https://github.com/noamross/doltr

A client for dolt databases
https://github.com/noamross/doltr

Last synced: 2 days ago
JSON representation

A client for dolt databases

• Host: GitHub
• URL: https://github.com/noamross/doltr
• Owner: ecohealthalliance
• License: agpl-3.0
• Created: 2021-09-17T22:14:56.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-12T18:46:55.000Z (almost 2 years ago)
• Last Synced: 2024-08-13T07:11:41.060Z (8 months ago)
• Language: R
• Homepage: https://ecohealthalliance.github.io/doltr
• Size: 1.28 MB
• Stars: 17
• Watchers: 9
• Forks: 1
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - ecohealthalliance/doltr - A client for dolt databases (R)

README

        

# doltr 

[![R-CMD-check](https://github.com/ecohealthalliance/doltr/workflows/R-CMD-check/badge.svg)](https://github.com/ecohealthalliance/doltr/actions)

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![License: MIT](https://img.shields.io/badge/License-AGPLv3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)

[![Codecov test coverage](https://codecov.io/gh/ecohealthalliance/doltr/branch/main/graph/badge.svg)](https://codecov.io/gh/ecohealthalliance/doltr?branch=main)

doltr is a client for [dolt](https://www.dolthub.com), an SQL database with

git-like versioning.  It is a work in progress, not fully documented, and

the API isn't fully baked yet.

## Installation

You will need dolt installed on your machine.  Get it 

[here](https://docs.dolthub.com/getting-started/installation).

Install the R package with 

``` r

remotes::install_github("ecohealthalliance/doltr")

```

# Usage

The package provides two DBI-compliant drivers to connect to a dolt database.

`dolt_remote()` connects to a dolt server via TCP.  `dolt_local()` connects

to a local database directory. (Behind the scenes `dolt_local()` launches and

manages a background server process, which can also be done manually with `dolt_server()`).

`dolt()` serves a connection that is cached during the R session and connects

via default parameters than can be defined via environment variables. (See

`?config`).  

`dolt_pane()` Provides an RStudio connection pane showing the database.

A variety of `dolt_*` functions provide database information and versioning capability.

See help files and [dolt documentation](https://docs.dolthub.com/interfaces/sql).

## Code of Conduct

  

Please note that the dolt project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

[![Created at EcoHealth

Alliance](https://raw.githubusercontent.com/ecohealthalliance/doltr/master/vignettes/figures/eha-footer.png)](https://www.ecohealthalliance.org/)