Working with a Bucket
Last updated
Was this helpful?
Last updated
Was this helpful?
Quilt allows you to create, read, and write packages both on your local filesystem and on S3 buckets configured to work with Quilt3. For convenience, we provide a simple API for working with S3 buckets that serves as an alternative to .
To connect to an S3 Bucket
:
This requires that the bucket is configured to work with Quilt 3. Unless this bucket is public, you will also first need to log into the catalog that controls this bucket:
To see the contents of a Bucket
, use keys
:
To download a file or folder from a bucket use fetch
:
To read a file or folder out of a bucket directly into memory use deserialize
:
To read the metadata on an object, use get_meta
:
You can write data to a bucket.
Note that set
operations on a Package
are put
operations on a Bucket
.
You can search for individual objects using search
.
Note that this feature is currently only supported for buckets backed by a Quilt catalog instance. Before performing a search you must first configure a connection to that instance using quilt3.config
.
Quilt supports unstructured search:
As well as structured search on metadata (note that this feature is experimental):