class in UnityEditor.Search
/
Inherits from:Search.QueryEngine_1
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseA QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators. Default query engine of type object.
See QueryEngine<T>.
QueryEngine | Construct a new QueryEngine. |
globalStringComparison | Global string comparison options for word matching and filter handling (if not overridden). |
searchDataCallback | The callback used to get the data to match to the search words. |
searchDataOverridesStringComparison | Indicates if word/phrase matching uses searchDataStringComparison or not. |
searchDataStringComparison | String comparison options for word/phrase matching. |
searchWordMatcher | The function used to match the search data against the search words. |
skipIncompleteFilters | Boolean. Indicates if incomplete filters should be skipped. If true, filters are skipped. If false and validateFilters is true, incomplete filters will generate errors when parsed. |
skipUnknownFilters | Boolean. Indicates if unknown filters should be skipped. If true, unknown filters are skipped. If false and validateFilters is true, unknown filters will generate errors if no default filter handler is provided. |
validateFilters | Get or set if the engine must validate filters when parsing the query. Defaults to true. |
AddFilter | Adds a new custom filter. |
AddFiltersFromAttribute | Adds all custom filters that are identified with the method attribute TFilterAttribute. |
AddNestedQueryAggregator | Adds a new nested query aggregator. An aggregator is an operation that can be applied on a nested query to aggregate the results of the nested query according to certain criteria. |
AddOperator | Adds a custom filter operator. |
AddOperatorHandler | Adds a custom filter operator handler. |
AddTypeParser | Adds a type parser that parses a string and returns a custom type. Used by custom operator handlers (see AddOperatorHandler). |
ClearFilters | Removes all filters that were added on the QueryEngine. |
GetAllFilters | Get all filters added on this QueryEngine. |
GetOperator | Get a custom operator added on the QueryEngine. |
ParseQuery | Parses a query string into a ParsedQuery operation. This ParsedQuery operation can then be used to filter any data set of type TData. |
RemoveFilter | Removes a custom filter. |
RemoveOperator | Removes a custom operator that was added on the QueryEngine. |
SetDefaultFilter | Sets the default filter handler for filters that were not registered. |
SetDefaultParamFilter | Sets the default filter handler for function filters that were not registered. |
SetFilterNestedQueryTransformer | Sets a filter's nested query transformer function. This function takes the result of a nested query and extracts the necessary data to compare with the filter. |
SetGlobalStringComparisonOptions | Sets global string comparison options. Used for word matching and filter handling (unless overridden by filter). |
SetNestedQueryHandler | Sets the function that will handle nested queries. Only one handler can be set. |
SetSearchDataCallback | Sets the callback used to fetch the data that is matched against the search words. |
SetSearchWordMatcher | Set the search word matching function to be used instead of the default one. Set to null to use the default. |
TryGetFilter | Get a filter by its token. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.