README.md

In auth0/rauth0: Tools for data manipulation in Auth0

R for Auth0 (rauth0)

This package defines functions to connect to Auth0's DWH, and some common manipulations of data for internal usage in Auth0.

How to Install

This package relies on a number of dependencies that are not available on CRAN. This means that you will need to install 2 dependencies manually.

1. aws.s3
2. redshiftTools

If the devtools library is installed, you can install directly from GitHub. Open R or RStudio and run:

devtools::install_github("cloudyr/aws.s3")
devtools::install_github("sicarul/redshiftTools")
devtools::install_github("auth0/rauth0")

note: you may need to generate a personal access token and supply that as a parameter to the install function. Consult the help file for install_github for details.

Alternatively, you can clone these repos and then use the following command in the R console using the remotes package:

remotes::install_local("path to aws.s3 directory", dependencies = TRUE)
remotes::install_local("path to redshiftTools directory", dependencies = TRUE)
remotes::install_local("path to rauth0 directory", dependencies = TRUE)

Functions

This package exports the following functions:

• dwh_connect
• dwh_create_view
• dwh_disconnect
• dwh_drop_view
• dwh_metadata_yaml_process
• dwh_query
• dwh_replace_inplace_from_sql
• dwh_replace_table_from_sql
• dwh_replace_table_from_temp_table
• dwh_set_execution_slots
• dwh_statement
• dwh_table_replace
• dwh_table_schema
• dwh_table_upsert
• get_metadata_value
• set_metadata_value
• clean_metadata_value

Constants

This package exports the following constants:

• CONST_LOGIN_TYPES
• CONST_LOGIN_TYPES_STR
• CONST_SOCIAL_CONNECTIONS
• CONST_SOCIAL_CONNECTIONS_STR

Deploy to DWH-*

$ R cmd -e "devtools::install_github('auth0/rauth0')"

Building Docker

CI depends on a docker base image. This image is currently built manually. Whenever core system deps change the image must be rebuilt and pushed before CI will pass.

• Build the Image

$ docker build -t a0us-docker.jfrog.io/docker/data/r-base -f base.Dockerfile .
$ docker push a0us-docker.jfrog.io/docker/data/r-base

• Push the Image to Artifactory

$ docker push a0us-docker.jfrog.io/docker/data/r-base

• Build the CI Image

$ docker build -t rauth0 .

auth0/rauth0 documentation built on July 3, 2021, 4:11 p.m.