Package 'DominoDataR'

Add credentials override for the right datasources

Description

Add credentials override for the right datasources

Usage

add_credentials(auth_type, config = list())

Arguments

auth_type	Datasource Authentication type
config	existing config override to extend

Value

named list of override configuration values

---

Add override configuration values

Description

Add override configuration values

Usage

add_override(..., .override = character())

Arguments

...	named configuration values.
.override	a named character vector

Value

named list of override configuration values

---

Create a client to Domino datasources

Description

Create a client to Domino datasources

Usage

datasource_client(api_key = NULL, token_file = NULL, token_url = NULL, token =  NULL)

Arguments

api_key	string key to override the environment variable
token_file	location of file to read token from
token_url	url of the location to read the token from
token	token to be used to authenticate

Value

A domino_data.data_sources.DataSourceClient.

---

Retrieve an object from a datasource

Description

Retrieve an object from a datasource

Usage

get_object(client, datasource, object, as = "raw", override = list())

Arguments

client	As returned by datasource_client()
datasource	The name of the datasource to query
object	The object to retrieve
as	Passed through to content
override	Configuration values to override (add_override())

Value

Raw vector representation of the object

---

List the keys starting with prefix in an object store

Description

List the keys starting with prefix in an object store

Usage

list_keys(client, datasource, prefix = "", override = list(), page_size = 50)

Arguments

client	As returned by datasource_client()
datasource	The name of the datasource to query
prefix	Prefix to filter keys to list
override	Configuration values to override (add_override())
page_size	Number of objects to fetch

Value

A vector or string keys

---

Load AWS Credentials

Description

Load AWS Credentials

Usage

load_aws_credentials(location, profile = NULL)

Arguments

location	file path where AWS credentials are located
profile	AWS profile or section to use

Value

named list of override configuration values

---

Load OAuth Credentials

Description

Load OAuth Credentials

Usage

load_oauth_credentials(location)

Arguments

location

file path where token is located

Value

named list of override configuration values

---

HTTP requests for Object Stores

Description

HTTP requests for Object Stores

Usage

object_http(
  verb = "GET",
  url,
  datasource_type,
  config = list(),
  headers = list(),
  request_body = "",
  write_disk = NULL
)

Arguments

verb	A character string containing an HTTP verb, defaulting to “GET”.
url	Signed URL to download object at.
datasource_type	Type of datasource the object is stored in.
config	A list of config values for the REST call.
headers	A list of request headers for the REST call.
request_body	A character string containing request body data.
write_disk	An argument like write_disk to write the result directly to disk.

Details

This is mostly for internal use by object store APIs.

Value

a response object.

---

Upload an object to a datasource

Description

Upload an object to a datasource

Usage

put_object(client, datasource, object, what, override = list())

Arguments

client	As returned by datasource_client()
datasource	The name of the datasource to query
object	The object to retrieve
what	character vector, raw vector
override	Configuration values to override (add_override())

Value

Raw vector representation of the object

---

Install domino_data Python package

Description

Install domino_data Python package

Usage

py_domino_data_install(version)

Arguments

version

Version of the domino_data package to install.

Value

TRUE if installation was successful, FALSE otherwise.

---

Tell reticulate to use Python Conda version available on Domino Data Lab.

Description

Provide other options in case the package is used for local development.

Usage

py_select_interpreter()

Value

TRUE if a python binary was bound to reticulate, FALSE otherwise

---

Query a datasource and returns an arrow Table

Description

Query a datasource and returns an arrow Table

Usage

query(client, datasource, query, override = list())

Arguments

client	As returned by datasource_client()
datasource	The name of the datasource to query
query	The query to run against the provided datasource
override	Configuration values to override (add_override())

Value

An arrow::Table

---

Save an object from a datasource to a local file

Description

Save an object from a datasource to a local file

Usage

save_object(
  client,
  datasource,
  object,
  file = basename(object),
  override = list()
)

Arguments

client	As returned by datasource_client()
datasource	The name of the datasource to query
object	The object to retrieve
file	File path to save object at. Defaults to the object base name.
override	Configuration values to override (add_override())

Value

Raw vector representation of the object

---

Upload a file to a datasource

Description

Upload a file to a datasource

Usage

upload_object(client, datasource, object, file, override = list())

Arguments

client	As returned by datasource_client()
datasource	The name of the datasource to query
object	The object to retrieve
file	File path to upload..
override	Configuration values to override (add_override())

Value

Raw vector representation of the object

---