Reference

Main interface

redivis.query(query)

Returns: class Query()

redivis.user(name)

Returns: class User()

redivis.organization(name)

Returns: class Organization()

class Query

query.list_rows(max_results)

Waits for query to finish and returns a list of named tuples.
Returns: list(<namedtuple>)

query.to_dataframe(max_results)

Waits for query to finish and returns a pandas DataFrame.
Returns: pandas.DataFrame

class User

user.dataset(name, version="current")

Returns: class Dataset()

user.project(name)

Returns: class Project()

class Organization

organization.dataset(name, version="current")

Returns: class Dataset()

class Dataset

dataset.create()

Returns: self

dataset.create_next_version(ignore_if_exists=False)

Returns: class Dataset()

dataset.delete()

Returns: void

dataset.exists()

Returns: boolean

dataset.get()

Fetches the dataset, after which dataset.properties will contain a dict with entries corresponding to the properties on the dataset resource definition. Will raise an error if the dataset does not exist
Returns: self

dataset.list_tables(max_results)

Returns: list<class Table()>

dataset.query(query)

Execute a query scoped to this dataset
Returns: class Query

dataset.release()

Returns: class Dataset()

dataset.table(name)

Returns: class Table()

dataset.update(*, name, public_access_level, description)

Returns: self

Project

project.list_tables(*, max_results, include_dataset_tables=False)

Returns: list<class Table()>

project.query(query)

Execute a query scoped to this project
Returns: class Query

project.table(name)

Returns: class Table()

Table

table.create(*, description, upload_merge_strategy="append")

Returns: self

table.delete()

Returns: void

table.get()

Fetches the table, after which table.properties will contain a dict with entries corresponding to the properties on the table resource definition. Will raise an error if the table does not exist.
Returns: self

table.exists()

Returns: bool

table.list_rows(max_results)

Returns: list(<namedtuple>)

table.list_uploads(*, max_results)

Returns: list<class Upload()>

table.list_variables(*, max_results)

Returns: list<class Upload()>

table.to_dataframe(max_results)

Returns: pandas.DataFrame

table.update(*, name, description, upload_merge_strategy)

Returns: self

table.upload(*, name, data, type, has_header_row=True, skip_bad_records=False, allow_quoted_newlines=False, quote_character='"', delimiter=None, remove_on_fail=True)

Data can either by a string or file descriptor.
Returns: class Upload()
Last modified 10d ago