Developer Studio Field Properties

The EnableFilter property determines if the column can be used in filter operations. This is just a way to allows non-Piloted Search filters on set of data. These filters are familiar to standard application and SQL programmers. They may be used to prompt users for values to specific fields. Using these filters can result in empty data sets, since the CeleriQ engine is not controlling the search path. If you have defined a search where salary is less than 10 and another where salary is more than 10, you will get an empty set, of course. This property allows you to provide custom, non-dimensional search capabilities to your application.

The EnableSearch property determines if a field is included in free-text searches. The CeleriQ engine uses many different types of filters such as dimension filters, standard filters, free-text filters, and geo-code filters. The EnableSearch property specifies that a field will be searched when a free-text query is sent to the engine. All fields are not searched when a free-text search is specified. You must set this property to true to include it in searches. Keep in mind that the more fields added as free-text filters will slow the engine down. This is true of any search engine. The more data to process the longer time it takes to get a result set.

The EnableSort property determines if a field can be used in sorting operations. The query object has a sortable field collection. This works much like an "order by" clause of a SQL statement. For added security, you must specify if a column can be used for sorting. This property is only applicable to fields derived from the primary table and other tables with one-to-many relationship with the primary table. If a field is derived from a table with a many-to-many relationship with the primary table this field cannot be set to true, sine the resulting data is really a list.

The ShowWithRecord property determines if the field is returned with the record. When querying the engine a set of records is returned, the structure of which is determined by all field marked with ShowWithRecord is true. This gives you the ability to limit fields returned for performance reasons. Especially if the fields are not used in your application, there is no reason to return them as it degrades performance.

page_revision: 0, last_edited: 1206285773|%e %b %Y, %H:%M %Z (%O ago)
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License