| Title: | 'Domino Data R SDK' |
| Version: | 0.3.0 |
| Description: | A wrapper on top of the 'Domino Data Python SDK' library. It lets you query and access 'Domino Data Sources' directly from your R environment. Under the hood, 'Domino Data R SDK' leverages the API provided by the 'Domino Data Python SDK', which must be installed as a prerequisite. 'Domino' is a platform that makes it easy to run your code on scalable hardware, with integrated version control and collaboration features designed for analytical workflows. See https://docs.dominodatalab.com/en/latest/api_guide/140b48/domino-data-api for more information. |
| License: | Apache License (≥ 2) |
| URL: | https://github.com/dominodatalab/DominoDataR |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.3.3 |
| Imports: | arrow, ConfigParser, httr, reticulate, urltools, withr |
| Suggests: | testthat (≥ 3.0.0) |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2025-10-21 14:00:36 UTC; ajrossman |
| Author: | Gabriel Haim [aut, cre] |
| Maintainer: | Gabriel Haim <gabriel.haim@dominodatalab.com> |
| Repository: | CRAN |
| Date/Publication: | 2025-10-21 14:30:02 UTC |
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.
Properly escape a URL path
Description
Properly escape a URL path
Usage
encode_url_path(url)
Arguments
url |
URL to properly escape |
Details
Internal only to fix malformed URLs.
Value
escaped url
Get URL for a file in a NetApp volume
Description
Get URL for a file in a NetApp volume
Usage
get_file_url(client, volume_unique_name, file_name)
Arguments
client |
As returned by |
volume_unique_name |
Unique name of the volume |
file_name |
Name of the file |
Value
URL string for the file
Get NetApp volume authentication token
Description
Get NetApp volume authentication token
Usage
get_netapp_token()
Details
Retrieves JWT token for NetApp volume authentication. Checks DOMINO_TOKEN_FILE and DOMINO_API_PROXY environment variables.
Value
JWT token string or NULL if not available
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 |
The name of the datasource to query |
object |
The object to retrieve |
as |
Passed through to |
override |
Configuration values to override ( |
Value
Raw vector representation of the object
Get a NetApp volume by name
Description
Get a NetApp volume by name
Usage
get_volume(client, name)
Arguments
client |
As returned by |
name |
Unique name of the volume |
Value
A Volume object
List files in a NetApp volume
Description
List files in a NetApp volume
Usage
list_files(client, volume_unique_name, prefix = "", page_size = 1000)
Arguments
client |
As returned by |
volume_unique_name |
Unique name of the volume |
prefix |
Optional prefix to filter files |
page_size |
Optional number of files to fetch |
Value
A vector of file paths
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 |
The name of the datasource to query |
prefix |
Prefix to filter keys to list |
override |
Configuration values to override ( |
page_size |
Number of objects to fetch |
Value
A vector or string keys
List snapshots for a NetApp volume
Description
List snapshots for a NetApp volume
Usage
list_snapshots(client, volume_unique_name, offset = NULL, limit = NULL)
Arguments
client |
As returned by |
volume_unique_name |
Unique name of the volume |
offset |
Optional offset for pagination |
limit |
Optional limit for pagination |
Value
A list of RemotefsSnapshot objects
List NetApp volumes
Description
List NetApp volumes
Usage
list_volumes(client, offset = NULL, limit = NULL)
Arguments
client |
As returned by |
offset |
Optional offset for pagination |
limit |
Optional limit for pagination |
Value
A list of RemotefsVolume objects
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(env_var, path)
Arguments
env_var |
the environment variable name containing the API proxy URL |
path |
the API endpoint path for retrieving the token |
Value
named list of override configuration values
Make the HTTP request
Description
Make the HTTP request
Usage
make_request(verb, url, config, headers, request_body, write_disk)
Arguments
verb |
A character string containing an HTTP verb |
url |
Signed URL to download object at. |
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 |
Details
Internal only to enable retry for malformed URLs.
Value
a response object.
Create a client for NetApp volumes
Description
Create a client for NetApp volumes
Usage
netapp_volume_client(token_file = NULL, token_url = NULL, token = NULL)
Arguments
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.netapp_volumes.NetAppVolumeClient.
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 |
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 |
The name of the datasource to query |
object |
The object to retrieve |
what |
character vector, raw vector |
override |
Configuration values to override ( |
Value
Raw vector representation of the object
Upload content to a NetApp volume
Description
Upload content to a NetApp volume
Usage
put_volume_object(client, volume_unique_name, object, what, override = list())
Arguments
client |
As returned by |
volume_unique_name |
Unique name of the volume |
object |
The object key to create/overwrite |
what |
character vector, raw vector |
override |
Configuration values to override ( |
Value
HTTP status message
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 |
The name of the datasource to query |
query |
The query to run against the provided datasource |
override |
Configuration values to 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 |
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 ( |
Value
Raw vector representation of the object
Save an object from a NetApp volume to a local file
Description
Save an object from a NetApp volume to a local file
Usage
save_volume_object(
client,
volume_unique_name,
object,
file = basename(object),
override = list()
)
Arguments
client |
As returned by |
volume_unique_name |
Unique name of the volume |
object |
The object to retrieve |
file |
File path to save object at. Defaults to the object base name. |
override |
Configuration values to override ( |
Value
File path where object was saved
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 |
The name of the datasource to query |
object |
The object to retrieve |
file |
File path to upload.. |
override |
Configuration values to override ( |
Value
Raw vector representation of the object
Upload a file to a NetApp volume
Description
Upload a file to a NetApp volume
Usage
upload_volume_object(
client,
volume_unique_name,
object,
file,
override = list()
)
Arguments
client |
As returned by |
volume_unique_name |
Unique name of the volume |
object |
The object key in the volume |
file |
File path to upload |
override |
Configuration values to override ( |
Value
HTTP status message