Search & query
Last updated
Was this helpful?
version-3.5.x
Last updated
Was this helpful?
Out of the box, Quilt provides support for queries in the ElasticSearch DSL, as well as SQL queries in Athena (details forthcoming).
The objects in S3 buckets connected to Quilt are synchronized to an ElasticSearch cluster, which powers Quilt's search features. For custom queries, you can use the Queries tab in the Quilt catalog to directly query ElasticSearch cluster.
Quilt uses ElasticsSearch 6.7 ().
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:
.fcs (FlowJo)
.ipynb (Jupyter notebooks)
.parquet
.html, .txt, .tsv, .csv, .md (plus many other plain-text formats)
.xls, .xlsx
Quilt ElasticSearch queries support the following keys:
You can provide pre-canned queries for your users by providing a configuration file at s3://YOUR_BUCKET/.quilt/queries/config.yaml:
The Quilt catalog displays your saved queries in a drop-down for your users to select, edit, and execute.
index — comma-separated list of indexes to search ()
filter_path — to reducing response nesting, ()
_source — boolean that adds or removes the _source field, or a list of fields to return ()
size — limits the number of hits ()
from — starting offset for pagination ()
body — the search query body as a JSON dictionary ()
