File

class File

An interface for working with files on Redivis. When the constructor is called directly, a file_id must be provided. Also returned by listing files associated with a particular table or query result.

Constructors

query$list_files([max_results, *, ...])	List files contained within a query result. The query result must contain at least one file_id variable.
redivis::file(file_id)	Construct a reference to a file based on its globally unique id.
table$list_files([max_results, *, ...])	List files contained within a file index table. The table must contain at least one file_id variable.

Examples

Download

f = redivis::file("4c10-d8rqhswh8.zz7AB9NJB2ctNpDGKbRD7w")

f$download() # download to current working directory
f$download("new_name.tiff") # download to current working directory, and rename to new_name.tiff
f$download("/some/path/") # downloaded as /some/path/bogota.tiff
f$download("/some/path/new_name.tiff") # downloaded as /some/path/new_name.tiff

print(f$properties) 
# { 
#   "kind": "rawFile", 
#   "id": "4c10-d8rqhswh8.zz7AB9NJB2ctNpDGKbRD7w", 
#   "uri': '/rawFiles/4c10-d8rqhswh8.zz7AB9NJB2ctNpDGKbRD7w",
#   "name": "bogota.tiff", 
#   "md5Hash": "6pQS54rKwQphRtJbLlHz7Q==", 
#   "contentType": "image/tiff", 
#   "size": 262674
# }

Read

f = redivis::file("4c10-bk27tqmet.rkgXgUlmnJrEFFC6oWAqqA")

file_content_string = f$read(as_text=True)

Stream

f = redivis.file("rnwk-acs3famee.pVr4Gzq54L3S9pblMZTs5Q")

# Stream a file
data <- f$stream(function(x) {
  print(length(x))
})

Fields

id	The globally unique identifier for the file, as a string.
query	A reference to the query from which this file was loaded from. Will only be populated if constructed via Query.list_files
properties	A dict containing the API resource representation of the project. This will be fully populated after calling File.get(), containing the following properties: id str: The globally unique id of the file name str: The name of the file, including any extensions size int: The size of the file, in bytes contentType str: The MIME type associated with the file's extension, when available md5Hash str: The md5 checksum of the file, as a base64 string
table	A reference to the table from which this file was loaded from. Will only be populated if constructed via Table.list_files.

Methods

file$download(path[, ...])	Download the file.
file$read(as_text)	Read the file contents into memory, either as raw bytes (the default) or as a string if as_text=True.
file$stream(callback)	Read the file in a streaming manner, repeatedly calling the callback function with the latest chunk of bytes.