Redivis API
User documentationredivis.com
  • Introduction
  • Referencing resources
  • Client libraries
    • redivis-js
      • Getting started
      • Examples
    • redivis-python
      • Getting started
      • Reference
        • redivis
          • redivis.current_notebook
          • redivis.file
          • redivis.organization
          • redivis.query
          • redivis.table
          • redivis.user
        • Dataset
          • Dataset.add_labels
          • Dataset.create
          • Dataset.create_next_version
          • Dataset.delete
          • Dataset.exists
          • Dataset.get
          • Dataset.list_tables
          • Dataset.list_versions
          • Dataset.query
          • Dataset.release
          • Dataset.remove_labels
          • Dataset.table
          • Dataset.unrelease
          • Dataset.update
          • Dataset.version
        • File
          • File.download
          • File.get
          • File.read
          • File.stream
        • Member
          • Member.add_labels
          • Member.exists
          • Member.get
          • Member.remove_labels
          • Member.update
        • Notebook
          • Notebook.create_output_table
        • Organization
          • Organization.dataset
          • Organization.list_datasets
          • Organization.list_members
          • Organization.member
        • Query
          • Query.download_files
          • Query.get
          • Query.list_files
          • Query.list_rows
          • Query.to_arrow_batch_iterator
          • Query.to_arrow_dataset
          • Query.to_arrow_table
          • Query.to_dataframe
          • Query.to_geopandas_dataframe
          • Query.to_dask_dataframe
          • Query.to_pandas_dataframe
          • Query.to_polars_lazyframe
        • Table
          • Table.add_files
          • Table.create
          • Table.delete
          • Table.download
          • Table.download_files
          • Table.get
          • Table.exists
          • Table.list_files
          • Table.list_rows
          • Table.list_uploads
          • Table.list_variables
          • Table.to_arrow_batch_iterator
          • Table.to_arrow_dataset
          • Table.to_arrow_table
          • Table.to_dataframe
          • Table.to_geopandas_dataframe
          • Table.to_dask_dataframe
          • Table.to_pandas_dataframe
          • Table.to_polars_lazyframe
          • Table.update
          • Table.upload
          • Table.variable
        • Upload
          • Upload.create
          • Upload.delete
          • Upload.exists
          • Upload.get
          • Upload.insert_rows
          • Upload.list_variables
          • Upload.to_*
        • Version
          • Version.dataset
          • Version.delete
          • Version.exists
          • Version.get
          • Version.previous_version
          • Version.next_version
        • User
          • User.dataset
          • User.list_datasets
          • User.workflow
          • User.list_workflows
        • Variable
          • Variable.get
          • Variable.exists
          • Variable.update
        • Workflow
          • Workflow.get
          • Workflow.exists
          • Workflow.list_tables
          • Workflow.query
          • Workflow.table
      • Examples
        • Listing resources
        • Querying data
        • Reading tabular data
        • Uploading data
        • Working with non-tabular files
    • redivis-r
      • Getting started
      • Reference
        • redivis
          • redivis$current_notebook
          • redivis$file
          • redivis$organization
          • redivis$query
          • redivis$table
          • redivis$user
        • Dataset
          • Dataset$create
          • Dataset$create_next_version
          • Dataset$delete
          • Dataset$exists
          • Dataset$get
          • Dataset$list_tables
          • Dataset$query
          • Dataset$release
          • Dataset$table
          • Dataset$unrelease
          • Dataset$update
        • File
          • File$download
          • File$get
          • File$read
          • File$stream
        • Notebook
          • Notebook$create_output_table
        • Organization
          • Organization$dataset
          • Organization$list_datasets
        • Query
          • Query$download_files
          • Query$get
          • Query$list_files
          • Query$to_arrow_batch_reader
          • Query$to_arrow_dataset
          • Query$to_arrow_table
          • Query$to_data_frame
          • Query$to_data_table
          • Query$to_tibble
          • Query$to_sf_tibble
        • Table
          • Table$add_files
          • Table$create
          • Table$delete
          • Table$download
          • Table$download_files
          • Table$get
          • Table$exists
          • Table$list_files
          • Table$list_uploads
          • Table$list_variables
          • Table$to_arrow_batch_reader
          • Table$to_arrow_dataset
          • Table$to_arrow_table
          • Table$to_data_frame
          • Table$to_data_table
          • Table$to_tibble
          • Table$to_sf_tibble
          • Table$update
          • Table$upload
          • Table$variable
        • Upload
          • Upload$create
          • Upload$delete
          • Upload$exists
          • Upload$get
          • Upload$insert_rows
          • Upload$list_variables
          • Upload$to_*
        • User
          • User$dataset
          • User$list_datasets
          • User$workflow
          • User$list_workflows
        • Variable
          • Variable$get
          • Variable$exists
          • Variable$update
        • Workflow
          • Workflow$get
          • Workflow$exists
          • Workflow$list_tables
          • Workflow$query
          • Workflow$table
      • Examples
        • Listing resources
        • Querying data
        • Reading tabular data
        • Uploading data
        • Working with non-tabular data
  • REST API
    • General structure
    • Authorization
    • Access
      • get
      • list
    • Datasets
      • delete
      • get
      • list
      • patch
      • post
    • Exports
      • download
      • get
      • post
    • Files
      • createSignedUrl
      • get
      • head
      • post
    • Members
      • get
      • list
    • Queries
      • get
      • post
      • listRows
    • ReadSessions
      • post
      • getStream
    • Tables
      • createTempUploads
      • delete
      • get
      • list
      • listRows
      • patch
      • post
    • Uploads
      • delete
      • get
      • insertRows
      • list
      • listRows
      • post
    • Variables
      • get
      • list
      • patch
    • Versions
      • delete
      • get
      • list
      • post
      • release
      • unrelease
    • Workflows
      • get
      • list
  • Resource definitions
    • Access
    • Dataset
    • Export
    • Member
    • Organization
    • Query
    • Table
    • Upload
    • User
    • Variable
    • Version
    • Workflow
Powered by GitBook
On this page
  • class Table
  • Examples
  • Constructors
  • Attributes
  • Methods

Was this helpful?

  1. Client libraries
  2. redivis-r
  3. Reference

Table

class Table

Tables are the fundamental data-containing entity in Redivis. Various methods on this class allow you to read data from Redivis tables into R.

Examples

library("redivis")

# Specify the table's container, either a dataset or workflow
dataset <- redivis$organization("Demo")$dataset("iris_species")

table <- dataset$table("Iris")
table$to_tibble()
# 	Id	SepalLengthCm	SepalWidthCm	PetalLengthCm	PetalWidthCm	Species
# 0	33	5.2	        4.1	        1.5	        0.1	        Iris-setosa
# ...

# Other methods to read data:
# table$to_arrow_batch_reader()
# table$to_arrow_dataset()
# table$to_arrow_dataset()
# table$to_data_frame()
# table$to_data_table()
# table$to_sf_tibble()
library("redivis")

dataset <- redivis$user("demo")$dataset("Example non-tabular files")
table <- dataset$table("tiffs")

table$download_files("/path/to/directory", overwrite=TRUE)

Constructors

Attributes

properties

Methods

Reading data and metadata

Export a table in a particular format and download it to disk.

Download all files represented in a file index table to a local directory.

Check whether the table exists

Fetch table metadata. Once called, the properties field on the table will be fully populated.

Uploading and modifying data

Upload non-tabular (unstructured) files to an unreleased file index table.

Create a table within a dataset if it doesn't already exist. Table must belong to an unreleased version of the dataset.

Delete a table belonging to an unreleased version of a dataset.

Return a list of all uploads on a table.

Update properties on the table (name, description).

PreviousQuery$to_sf_tibbleNextTable$add_files

Last updated 1 month ago

Was this helpful?

(reference)

Return a Table within the (either a dataset or workflow). In a Redivis notebook, the default scope will always be the notebook's workflow.

(reference)

Return a Table within a specific .

(reference)

Return a Table within a specific .

A named list containing the . This will only be populated after one of the table methods that read data are called.

([path, format, ...])

([path, overwrite, ...])

()

()

([max_results, ...])

Return a list of instances in a file index table.

([max_results])

Return a list of instances associated with this table.

([...])

Returns a reader that mimics the , which can then be consumed to process batches of rows in a streaming fashion.

([max_results, ...])

Return an for the table. Data is backed by disk, allowing for larger-than-memory analysis.

([max_results, ...])

Return an with the table's data. This is the highest-performance option for loading data in-memory.

([max_results, ...])

Return a with the table's data.

([max_results, ...])

Return a with the table's data.

([max_results, variables, ...])

Return a with the table's data.

([max_results, ...])

Return a with a table's data. Used for tables that contain a geography variable.

(name)

Reference a within the table.

([files, directory])

([description, ...])

()

([max_results])

()

(name)

Construct a new , scoped to this table.

redivis$table
Dataset$table
dataset
Workflow$table
workflow
Table$download
Table$download_files
Table$exists
Table$get
Table$list_files
File
Table$list_variables
Variable
Table$to_arrow_batch_reader
Arrow RecordBatchStreamReader
Table$to_arrow_dataset
Arrow Dataset
Table$to_arrow_table
Arrow Table
Table$to_data_frame
data.frame
Table$to_data_table
data.table
Table$to_tibble
tibble
Table$to_sf_tibble
simple features tibble
Table$variable
Variable
Table$add_files
Table$create
Table$delete
Table$list_uploads
Table$update
Table$upload
upload instance
API resource representation of the table
current default scope