Search & query
Quilt provides support for queries in the Elasticsearch DSL, as well as SQL queries in Athena.
The objects in Amazon S3 buckets connected to Quilt are synchronized to an Elasticsearch cluster, which provides Quilt's search features.
Quilt maintains a near-realtime index of the objects in your S3 bucket in Elasticsearch. Each bucket corresponds to one or more Elasticsearch indexes. As objects are mutated in S3, Quilt uses an event-driven system (via SNS and SQS) to update Elasticsearch.
There are two types of indexing in Quilt:
- shallow indexing includes object metadata (such as the file name and size)
- deep indexing includes object contents. Quilt supports deep indexing for the following file extensions:
- .csv, .html, .json, .md, .rmd, .rst, .tab, .txt, .tsv (plain-text formats)
- .fcs (FlowJo)
- .ipynb (Jupyter notebooks)
- .xls, .xlsx
By default, Quilt indexes a limited number of bytes per document for specified file formats (100KB). Both the max number of bytes per document and which file formats to deep index can be customized per Bucket in the Catalog Admin settings.
Example of Admin Bucket indexing options
The navigation bar on every page in the catalog provides a convenient shortcut for searching objects and packages in an Amazon S3 bucket.
The following are all valid search parameters:
comment: Package comment.
content: Object content.
ext: Object extension.
handle: Package name.
hash: Package hash.
key: Object key.
key_text: Analyzed object key.
last_modified: Last modified date.
last_modified:[2022-02-04 TO 2022-02-20]
metadata: Package metadata.
size: Object size in bytes.
version_id: Object version id.
pointer_file: Package revision tag in S3; either "latest" or a top hash.
package_stats.total_files: Package total files.
package_stats.total_bytes: Package total bytes.
Logical operators and grouping
a AND b
a OR b
_exists_: Matches any non-null value for the given field.
(): Group terms.
(a AND b) NOT c
Wildcard and regular expressions
*: Zero or more characters, avoid leading
?: Exactly one character.
//: Regular expression (slows performance).
Quilt Elasticsearch queries support the following keys:
_source— boolean that adds or removes the
_sourcefield, or a list of fields to return (learn more)
You can provide pre-canned queries for your users by providing a configuration file at
name: My first query
description: Optional description
name: Second query
The Quilt catalog displays your saved queries in a drop-down for your users to select, edit, and execute.
You can park reusable Athena Queries in the Quilt catalog so that your users can run them. You must first set up you an Athena workgroup and Saved queries per AWS's Athena documentation.
"Run query" executes the selected query and waits for the result.