Search Queries

Swarm Storage integrates with Elasticsearch to let client applications list and search the metadata on the objects being stored in the Swarm cluster. You access these operations by applying query arguments that are specific to search.

See Elasticsearch for Swarm for details on implementing and managing Elasticsearch.

Scope of Searching in Swarm

Swarm Search supports domain-level searching; to search on your entire cluster, iterate across the domains. Swarm looks up objects by the underlying contextid so that you can query by context (domain/bucket) name as usual but always get correct query results even if a domain or bucket has been renamed. After this lookup, Swarm generates the final content query, which supports a wide range of functionality:

Filter by name or value. You can filter by an object's name or by any of its metadata (field) using equality checks, greater/less than comparisons, and wildcard matches.
Filter by buckets. You can filter the search to certain buckets (context) using greater/less than comparison (for buckets in numbered ranges) or wildcard matches (for buckets that match a prefix pattern). To restrict search to a single bucket, you only need to include the bucket in the URL path.
Filter by object type. You can add the stype argument to filter by one of these Swarm types: domain, bucket, named, alias, immutable, unnamed (both alias and immutable), or all.
Operate on metadata fields. You can perform AND and OR operations on the values of metadata fields to find the matching objects.
Sort by value. Your sort specification can combine multiple metadata fields, including the context.
Paginate large result sets with sort markers. You can apply markers when the context is sorted (ascending or descending) and in conjunction with markers for other metadata fields, when the sort specification includes multiple fields.
Calculate disk usage. The du aggregation filters the results to calculate disk usage, inclusive or exclusive of object replicas in the cluster.
Locate versions. If you are using versioning, you can use the versions argument to surface all of the historical versions of a single object or of all objects in the context.