Seeker

Appearance

SEEKER QueryFilter DSL Client Documentation ​

The SEEKER QueryFilter DSL allows you to easily search for assets within SEEKER by using simple, yet powerful, search queries. This documentation will guide you through constructing search queries, including the available options and providing examples for each feature.

Basic Queries ​

A basic query is the simplest form of search, where you can directly search for asset names or specific attributes. The search is not case-sensitive and goes based on the name of the asset

Examples: ​

Search by Name:

  • Castle searches for assets with "Castle" in their name.
  • name:_neq:Castle searches for assets not equal to "castle" in name.
  • "Space Station" searches for assets named "Space Station".
  • name:_ilike:"Space Station" searches for assets named like "Space Station".
  • name:_iregex:Shi* searches for assets with names that match the regex pattern, e.g., "Ship", "Shiny", etc.

Search by Attribute:

  • attribute:width:_eq:10 finds assets where the width attribute exactly equals 10.
  • attribute:color:_iregex:"^#FF" finds assets with a color attribute starting with "#FF".
  • attribute:usage:_ilike:commercial finds assets with a usage attribute similar to "commercial".

Modifiers ​

Modifiers can be used to refine your search further, including ordering, limiting results, and searching within specific collections or tags.

Examples: ​

Limit Modifier:

  • limit:5 limits the results to 5 assets.
  • name:Castle limit:10 finds up to 10 assets named "Castle".

Order Modifier:

  • orderby:asc:name orders the results by name in ascending order.
  • orderby:desc:created_at orders the results by creation date in descending order.

Tag Modifier:

  • tag:architecture finds assets tagged with "architecture".
  • tag:"space opera" finds assets tagged with "space opera".

Collection Modifier:

  • collection:Vintage finds assets within the "Vintage" collection.
  • collection:"Sci-Fi Classics" finds assets within the "Sci-Fi Classics" collection.

Distinct Modifier:

  • distinct:name ensures the results have distinct names.
  • distinct:[name, creator] ensures the results have distinct combinations of names and creators.

Archived Modifier ​

The archived modifier allows you to include or exclude archived assets in your search.

Examples: ​

Include Archived:

  • archived:true includes archived assets in the search results.
  • name:Castle archived:true finds all assets named "Castle", including archived ones.

Exclude Archived: - By default, all queries always exclude archived assets, so you generally don't need to use these.

  • archived:false excludes archived assets from the search results.
  • tag:modern archived:false finds assets tagged "modern" that are not archived.

Combining Queries ​

Queries can be combined using spaces to search for assets that meet all the given criteria (AND logic). Use the + symbol to combine queries with OR logic.

Examples: ​

AND Queries:

  • Castle attribute:width:_gt:20 finds assets named "Castle" with width greater than 20.
  • tag:medieval tag:structure finds assets tagged both "medieval" and "structure".
  • collection:Fantasy attribute:color:_iregex:"#FF0000" finds Fantasy collection assets with a color attribute of "#FF0000".

OR Queries:

  • +Castle +Fortress finds assets with names either "Castle" or "Fortress".
  • +tag:city +tag:village finds assets tagged either "city" or "village".
  • +attribute:size:_eq:large +attribute:theme:_eq:sci-fi finds assets that are either large in size or have a "sci-fi" theme.

Combined AND/OR Queries ​

To achieve more complex searches, you can combine both AND and OR logic within the same query. This allows for highly specific searches that can target assets with multiple criteria that either must all be satisfied (AND) or where satisfying any one of the criteria is sufficient (OR). Below are examples demonstrating how to construct these combined queries. When combining AND and OR logic, remember that AND expressions are separated by spaces, while OR expressions are prefixed with a +. The system processes AND conditions first, followed by OR conditions, enabling nuanced filtering based on multiple attributes or tags.

Examples: ​

Combining Tags with AND and OR Logic:

  • +tag:outdoor +tag:indoor tag:modern finds assets tagged either "outdoor" or "indoor" and must also be tagged with "modern".
  • +attribute:material:_eq:wood +attribute:color:_eq:#FFFFFF attribute:usage:_ilike:residential finds assets that are either made of wood or colored #FFFFFF, and are used residentially.

Mixing Collection and Attribute Filters with AND/OR Logic:

  • collection:Fantasy +attribute:type:_eq:weapon +attribute:type:_eq:armor finds assets in the Fantasy collection that are either a weapon or armor.
  • collection:"Sci-Fi" attribute:status:_eq:active +attribute:availability:_eq:in_stock +attribute:availability:_eq:pre_order finds active Sci-Fi collection assets that are either in stock or available for pre-order.

Utilizing Order and Limit Modifiers with Combined Queries:

  • +tag:abstract +tag:realism tag:exhibition orderby:desc:rating limit:10 finds the top 10 rated assets tagged with either "abstract" or "realism" and must also be tagged with "exhibition", ordered by rating in descending order.
  • attribute:size:_gt:20 +attribute:color:_eq:#FF0000 orderby:asc:size finds assets greater than 20 in size or with the color #FF0000, ordered by size in ascending order.

Distinct and Archived Modifiers with Combined Queries:

  • distinct:name +collection:Archives +collection:NewReleases archived:false finds non-archived assets with unique names, either from the "Archives" or "NewReleases" collections.
  • tag:limited_edition +tag:exclusive_release distinct:[creator, series] archived:true finds archived assets tagged either "limited edition" or "exclusive release", ensuring unique combinations of creator and series.

These examples illustrate how you can combine different types of search criteria to precisely filter assets according to complex requirements. By effectively using the AND/OR logic, along with the various modifiers available in the SEEKER QueryFilter DSL, you can conduct highly targeted searches to find exactly what you need within our extensive database of assets.