redivis

module Redivis

The redivis module, available via import redivis. Through this module and its methods, you can create, update, delete, query, and read from various resources on Redivis.

Attributes

__version__	The current version of this library

Methods

redivis.current_notebook()	Construct a reference to the current notebook. Can only be called within a Redivis notebook.
redivis.current_user()	Construct a reference to the currently authenticated user.
redivis.current_workflow()	Construct a reference to the current workflow. Can only be called within a Redivis notebook, or if a default workflow is set.
redivis.datasource(source)	Construct a new Datasource instance. Can only be called if a default workflow is set. Otherwise, use the workflow.datasource() constructor.
redivis.make_api_request(*, [method, path, ...])	Call the Redivis API directly (for advanced use cases).
redivis.notebook(name)	Construct a new Notebook instance.
redivis.organization(name)	Construct a new Organization instance.
redivis.parameter(name)	Construct a new Parameter instance
redivis.query(query)	Execute a SQL query, returning a Query instance.
redivis.table(name)	Construct a new Table instance.
redivis.transform(name)	Construct a new Transform instance.
redivis.user(name)	Construct a new User instance.

Exceptions

All exceptions raised by Redivis will be of class redivis.exceptions.RedivisError . Subclasses of RedivisError can be used to handle errors around specific events. See redivis.exceptions for full details.

Examples

import redivis

organization = redivis.organization("Demo")
# organization.list_datasets(), organization.dataset("Iris species"), etc...

dataset = organization.dataset("iris_species")
table = dataset.table("iris")  
# table.to_pandas_dataframe(), etc...
# In a notebook, can do redivis.table("_source_") to reference the source table

query = redivis.query("""
    SELECT * 
    FROM demo.iris_species.iris 
    WHERE SepalLengthCm > 5
""")
# query.to_pandas_dataframe(), etc...