Skip to contents

Log in to TileDB Cloud

Source: R/manual_layer_login.R
login.Rd

This function can be used to override the default setup made at package load.

Usage

login(
  username,
  password,
  api_key,
  host,
  remember_me = TRUE,
  write_config = FALSE
)

Arguments

username

A character value with the username, if present password is also needed.

password

A character value with the password, if present username is also needed.

api_key

A character value with the access token, it can be used instead of username and password.

host

A character value with remote host to connect to.

remember_me

A boolean to select a session with for 24 hours instead of 8 hours, used only when a new session is requested.

write_config

A boolean to write the login information to ~/.tiledb/cloud.json from where it can be read for subsequent sessions. This is only done when requested by this parameter, which is FALSE by default.

Value

Nothing is returned; the function is called for a side effect of storing the values in the package environment.

Details

It can operate in two modes. Either a username and a password are supplied as environment variable TILEDB_REST_USERNAME and TILEDB_REST_PASSWORD. As an alternative, an access token can be supplied via TILEDB_REST_TOKEN. The values are used to instantiate a new API client object. If no token was supplied, a new session is requested and the token assigned to that session is used.

Function arguments are optional, and can be used to override the default configuration values obtained by configure from either the environment variables or the configuration file.

See also

Other manual-layer functions: array_info(), compute_sequentially(), compute(), delayed_args<-(), delayed_args(), delayed_array_udf(), delayed_generic_udf(), delayed_sql(), delayed(), deregister_array(), deregister_group(), deregister_udf(), execute_array_udf(), execute_generic_udf(), execute_multi_array_udf(), execute_sql_query(), get_udf_info(), group_info(), list_arrays(), list_groups(), register_array(), register_udf(), update_udf_info(), user_profile()