datasets.md

CurrentModule=JuliaHub
DocTestSetup = :(using JuliaHub)

using JuliaHub

[Datasets](@id datasets)

These APIs allow you to create, read, update, and delete datasets owned by [the currently authenticated user](@ref authentication).

• You can use datasets, dataset, and download_dataset to access datasets or their metadata.
• upload_dataset, update_dataset, and delete_dataset can be used to create, update, or delete datasets.

See also: help.julialang.org on datasets, DataSets.jl.

Dataset types

JuliaHub currently has two distinct types of datasets:

1. Blob: a single file; or, more abstractly, a collection of bytes
2. BlobTree: a directory or a file; more abstractly a tree-like collection of Blobs, indexed by file system paths

These types mirror the concepts in DataSets.jl

JuliaHub.jl APIs do not rely that much on the dataset type for anything, except when downloading or uploading. In that case, a local file always corresponds to a Blob, and a local directory corresponds to a BlobTree. For example, when trying to upload a file as a new version of a BlobTree-type dataset will fail, because the dataset type can not change.

The upload_dataset function uses information filesystem to determine whether the created dataset is a Blob or a BlobTree, and similarly download_dataset will always download a Blob into a file, and a BlobTree as a directory.

Dataset versions

A JuliaHub dataset can have zero or more versions. A newly created dataset usually has at least one version, but it may have zero versions if, for example, the upload did not finish. The versions are indexed with a linear list of integers starting from 1.

Reference

JuliaHub.Dataset
JuliaHub.DatasetVersion
JuliaHub.datasets
JuliaHub.DatasetReference
JuliaHub.dataset
JuliaHub.download_dataset
JuliaHub.upload_dataset
JuliaHub.update_dataset
JuliaHub.delete_dataset

Index

Pages = ["datasets.md"]