Entry search

Created by Richard Saunders, last modified by Simon Horan on 02 Apr 2020

A query tree structure, along with order and paging specifiers, allows a search to be performed against indexed documents held in ElasticSearch. The query API allows any required sub-query structure to be defined and a comprehensive selection of Operators enable individual field level evaluation.

Queries

This example demonstrates a simple search with default ordering and paging options:

Synchronous

@using Zengenti.Contensis.Delivery
@using Zengenti.Data
@using Zengenti.Search

@{
    var client = ContensisClient.Create();

    var query = new Query(
        Op.Contains("title", "Batman"),
        Op.GreaterThan("runtime", 200)
    );

    // Execute the search returning entries
    PagedList<Entry> entriesResult = client.Entries.Search(query);

    // Execute the search returning typed models
    PagedList<Movie> moviesResult = client.Entries.Search<Movie>(query);
}

Asynchronous

@using Zengenti.Contensis.Delivery
@using Zengenti.Data
@using Zengenti.Search

@{
    var client = ContensisClient.Create();

    // Execute the search asynchronously  returning entries
    PagedList<Entry> entriesResult = await client.Entries.SearchAsync(query);

    // Execute the search returning typed models
    PagedList<Movie> moviesResult = await client.Entries.SearchAsync<Movie>(query);
}

Sub-queries

A sub-query is a query within another query that is used as a condition to further restrict the results. Effectively they are defined by an explicit nesting of logical operators.

This example demonstrates a simple search with a sub-query:

Synchronous

var query = new Query(
    Op.Contains("title", "Batman"),
    Op.Or(
        Op.GreaterThan("releaseDate", 1960),
        Op.Contains("tagline", "gotham")
    )
);

Location searches

Search for locations within a radius of a specified location.

Supported distance units

Unit	Search value
Mile	`mi` or `miles`
Yard	`yd` or `yards`
Feet	`ft` or `feet`
Inch	`in` or `inch`
Kilometer	`km` or `kilometers`
Meter	`m` or `meters`
Centimeter	`cm` or `centimeters`
Millimeter	`mm` or `millimeters`
Nautical mile	`NM`, `nmi` or `nauticalmiles`

Example

Find all entries which have a location within 10.5 miles of Ludlow Castle's location.
Append the search value at the end of the distance specified, so for example "10.5mi" or "10.5miles".

var query = new Query(
    Op.DistanceWithin("location", 52.36700505, -2.72304296, "10.5mi"))
);

Ordering

Results can be ordered by one or more fields in an ascending or descending direction. Order clauses are prioritised in the order that they are added. By default, if no order clauses are specified then the entry results are ordered by the EntryTitle in an ascending direction.

Order by 'releaseDate'.

query.OrderBy.Add("releaseDate")

Order by 'releaseDate' in a descending direction using the '-' token.

query.OrderBy.Add("-releaseDate")

Multiple order clauses.

query.OrderBy.Add("title", "-releaseDate")

Paging

Paging allows the number of results to be restricted to a defined count so that the results are easier to handle and ensures a response is returned quickly. The page index can also be specified to allow which set of results is to be returned. The page size is limited to a maximum of 10,000 however this is not recommended.

// Create a query
var query = new Query(
    Op.EqualTo("sys.contentTypeId", "film"));

// Set the number of entries to be returned per page
query.PageSize = 50;

// Get the 2nd result set
query.PageIndex = 1;

Specifying fields

System fields

System fields such as id, contentTypeId, projectId, versionNo etc. are under the sys object and can be accessed using a dot notation, e.g. sys.id, sys.contentTypeId, sys.projectId, sys.version.versionNo.

The entryTitle and entryDescription fields are dynamic values, determined by the EntryTitleField and entryDescriptionField values in the content type.

Data fields

Fields defined in the content type for the entry can be accessed by their API id.

All fields

All fields can be searched by specifying an asterisk (*) in the field id. Note there are some limitations, and the FreeText operator is not supported for all fields.

Example

var query = new Query(
    Op.EqualTo("*", "Interstellar"));

Array fields

Searching on array fields require square brackets [] to be specified in the field id before any field ids within the object. Note that this syntax is not required for single object fields. All operators support searching across array fields.

Example array field search

This example searches for a quote source of "Bruce Willis" within a quote array field called movieQuote.

var query = new Query(
    Op.EqualTo("movieQuote[].source", "Bruce Willis"));

Limiting fields

If you have large entries and only require a subset of fields it is worth limiting the fields returned in the results. This will reduce the size of the payload from the API which in turn will improve performance. You can include fields by specifiying the field API ID or you can exclude fields by prefixing the field API ID with a -. Field limiting also applies to linked entries when specifying a linkDepth.

Example field limiting

var query = new Query(
    Op.EqualTo("title", "Interstellar"));
    query.Fields = new[] {"title", "movieQuote"};
)

Complete example

The example below combines the ordering and paging concepts:

@using Zengenti.Contensis.Delivery
@using Zengenti.Data
@using Zengenti.Search

@{
    var client = ContensisClient.Create();

    var query = new Query(
        Op.Contains("title", "Batman"),
        Op.GreaterThan("runtime", 200)
    );

    query.OrderBy.Add("-releaseDate")
    query.PageIndex = 1;
    query.PageSize = 50;
    query.Fields = new[] {"title"};

    // Execute the search
    var results = client.Entries.Search(query);
}