Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

redivis

module redivis

The redivis module, available via import redivis from 'redivis' (or import * as redivis from 'redivis'). Through this module and its methods, you can create, update, delete, query, and read from various resources on Redivis, as well as manage authentication and configuration.

Methods

Method
Description

Authenticate with Redivis. Optional, since requests authenticate automatically when needed.

redivis.config([options])

Set library-wide defaults (e.g., a default workflow), and return the current configuration.

Return the currently authenticated User.

Return the default workflow, if one is set.

redivis.dataset(name[, options])

Construct a new Dataset instance.

redivis.datasource(source[, options])

Construct a new Datasource instance.

Clear any credentials, including those cached on disk.

Whether credentials are available, without logging in.

Call the Redivis API directly (for advanced use cases).

redivis.notebook(name[, options])

Construct a new Notebook instance.

Construct a new Organization instance.

redivis.parameter(name[, options])

Construct a new Parameter instance.

redivis.query(query[, options])

Construct a SQL Query.

redivis.setApiProxy(baseUrl[, options])

Send all API requests through a proxy, such as your own server.

redivis.table(name[, options])

Construct a new Table instance.

redivis.transform([name, options])

Construct a new Transform instance.

Construct a new User instance.

redivis.workflow(name[, options])

Construct a new Workflow instance.

Examples

Errors

All errors thrown by this library are instances of redivis.errors.RedivisError. Subclasses of RedivisError can be used to handle errors around specific events. See redivis.errors for full details.

Was this helpful?