/runsplitgraphrun

A quick help for those using Splitgraph

Primary LanguageR

runsplitgraphrun

Installing dependencies

To run splitgraph in your computer you will need some packages that are ideally installed automatically in your computer after installing runsplitgraphrun, However, you may have some problems loading packages like rJava. In this case, make sure that you have rJava before starting this process.

check this link if you need a help with this

When installing the package, R will ask you for updating or installing a bunch of packages, you can skip this process if you have: DBI and RJDBC already installed. You can always install these packages in the same way you installed rJava:

install.packages('rJava')
install.packages('DBI')
install.packages('RJDBC')

The postgresql driver will only work if you have Java 8+

Install the devtools package. On Mac and Linux you will need to first install some additional libraries

  • brew: libgit2 (MacOS)
  • deb: libgit2-dev (Debian, Ubuntu, etc)
  • rpm: libgit2-devel (Fedora, CentOS, RHEL)
install.packages('devtools')

Also install the keyring package: on Mac and Linux you may need additional system libraries, see the instructions here.

install.packages('keyring')

Getting your credentials

Don't forget to Sign in and access Splitgraph to get your credentials Username/Password

Run Splitgraph, Run!

library(devtools) # to use install_github
library(rJava)

install_github('vivirbr/runsplitgraphrun')
library(runsplitgraphrun)

library(DBI)
library(RJDBC)
library(keyring)
download_postgresql() # this step downloads the postgresql directly to you R folder

Adding credentials - you only need to add this once

❗ IMPORTANT: Don't store your credentials in a script - run this function directly in your console

add_credentials(user='YOUR_USER_FROM_SPLITGRAPH',
                password='YOUR_PASSWORD_FROM_SPLITGRAPH',
                host='HOST_FROM_SPLITGRAPH',
                port='PORT_FROM_SPLITGRAPH',
                database_name='DATABASE_NAME_FROM_SPLITGRAPH',
                database='PUBLIC') #you can also set the credentials for the PRIVATE repo

the package keyring will ask you a password, you can use any passwork, this is not really useful

Connection and your first query

conn<-connect(database='PUBLIC') # creating your connection and voilà, you are good to go 
dbGetQuery(conn,'SELECT * FROM "trase/supply-chains"."supply-chains" LIMIT 10') # your first query

In case you need to delete existing credentials you can use:

keyring_delete(keyring = "SPLITGRAPH_PUBLIC") # or "SPLITGRAPH_PRIVATE"