Namespace: Consultingwerk.SmartIndex.ElasticSearch
Class 
SmartIndexQueryBuilder Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartIndex.ElasticSearch.SmartIndexQueryBuilder

Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartIndex.ISmartIndexQueryBuilder


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder AddAggregationByField (character, character) Adds an terms Aggregation by the given field name
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder AddSubAggregationByField (character, character, character, character, integer) Adds a terms SubAggregation two levels below the given aggregation
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder AddSubAggregationByField (character, character, character, integer) Adds an terms SubAggregation by the given field name
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetFields (character) Sets the fields of the Payload based on the given list of field names
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetFields (handle) Sets the fields of the Payload based on the fields of the given buffer handle
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetFrom (integer) Sets the offset of the first document the query returns
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetPageSize (integer) Set the Page Size
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetQuery (TableQuery) Sets the query from a TableQuery
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetQueryString (character) Sets the Query Strings
Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetSize (integer) Sets the maximum number of documents the query returns

Top Constructor Summary
Options Name Purpose
SmartIndexQueryBuilder (character) Constructor for the SmartIndexQueryBuilder class

Top Property Summary
Options Name Purpose
Consultingwerk.SmartIndex.SmartIndexQuery Query


Method Detail
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder AddAggregationByField (character, character)
Purpose: Adds an terms Aggregation by the given field name
Notes:

Parameters:
pcAggregationName CHARACTER
The name of the aggregation
pcFieldName CHARACTER
The name of the field
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder AddSubAggregationByField (character, character, character, character, integer)
Purpose: Adds a terms SubAggregation two levels below the given aggregation
Notes: The parent sub aggregation has to have been added before - the
aggregation it nests into is addressed by its path

Parameters:
pcAggregationName CHARACTER
The name of the aggregation
pcSubAggregationName CHARACTER
The name of the sub-aggregation to nest into
pcSubSubAggregationName CHARACTER
The name of the sub-aggregation to add
pcFieldName CHARACTER
The name of the field
piSize INTEGER
The size of the bucket
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder AddSubAggregationByField (character, character, character, integer)
Purpose: Adds an terms SubAggregation by the given field name
Notes:

Parameters:
pcAggregationName CHARACTER
The name of the aggregation
pcSubAggregationName CHARACTER
The name of the sub-aggregation
pcFieldName CHARACTER
The name of the field
piSize INTEGER
The size of the bucket
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetFields (character)
Purpose: Sets the fields of the Payload based on the given list of
field names
Notes: Replaces the fields that were set before

Parameters:
pcFieldNames CHARACTER
The comma delimited list of field names
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetFields (handle)
Purpose: Sets the fields of the Payload based on the fields of
the given buffer handle
Notes:

Parameters:
phBuffer HANDLE
The handle of the buffer
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetFrom (integer)
Purpose: Sets the offset of the first document the query returns
Notes: Together with SetSize this gives simple paging

Parameters:
piFrom INTEGER
The offset of the first document to return
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetPageSize (integer)
Purpose: Set the Page Size
Notes: Synonym of SetSize

Parameters:
piPageSize INTEGER
The page size to set
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetQuery (TableQuery)
Purpose: Sets the query from a TableQuery
Notes: The predicates are translated into the Elasticsearch Query DSL
and placed in the request body, see QueryEntryTranslator for the
operator mapping. A TableQuery without predicates is ignored -
it would translate into a query matching nothing, where the
caller means "no restriction"

Parameters:
poTableQuery Consultingwerk.OERA.QueryBuilder.TableQuery
The TableQuery holding the predicates of the query
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetQueryString (character)
Purpose: Sets the Query Strings
Notes:

Parameters:
pcQueryString CHARACTER
The value for the Query String
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance
Top

Consultingwerk.SmartIndex.ISmartIndexQueryBuilder SetSize (integer)
Purpose: Sets the maximum number of documents the query returns
Notes: Defaults to 10, the default of Elasticsearch itself

Parameters:
piSize INTEGER
The maximum number of documents to return
Returns Consultingwerk.SmartIndex.ISmartIndexQueryBuilder
The SmartIndexQueryBuilder instance


Constructor Detail
Top

SmartIndexQueryBuilder (character)
Purpose: Constructor for the SmartIndexQueryBuilder class
Notes: Use ISmartIndexQueryBuilderFactory:UsingIndex rather than
creating an instance directly

Parameters:
pcIndexName CHARACTER
The name of the search index


Property Detail
Top

Consultingwerk.SmartIndex.SmartIndexQuery Query

Returns Consultingwerk.SmartIndex.SmartIndexQuery


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:17:20