New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Script Fields Usage Source Filtering Usage »
Elastic Docs ›Elasticsearch.Net and NEST: the .NET clients [2.x] ›Search

Sort Usage

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Sort Usage

edit

Allows to add one or more sort on specific fields. Each sort can be reversed as well. The sort is defined on a per field level, with special field name for _score to sort by score.

Fluent DSL example

edit
s => s
.Sort(ss => ss
    .Ascending(p => p.StartedOn)
    .Descending(p => p.Name)
    .Descending(SortSpecialField.Score)
    .Ascending(SortSpecialField.DocumentIndexOrder)
    .Field(f => f
        .Field(p => p.LastActivity)
        .Order(SortOrder.Descending)
        .MissingLast()
        .UnmappedType(FieldType.Date)
        .Mode(SortMode.Average)
        .NestedPath(p => p.Tags)
        .NestedFilter(q => q.MatchAll())
    )
    .Field(f => f
        .Field(p => p.NumberOfCommits)
        .Order(SortOrder.Descending)
        .Missing(-1)
    )
    .GeoDistance(g => g
        .Field(p => p.Location)
        .DistanceType(GeoDistanceType.Arc)
        .Order(SortOrder.Ascending)
        .Unit(DistanceUnit.Centimeters)
        .Mode(SortMode.Min)
        .PinTo(new GeoLocation(70, -70), new GeoLocation(-12, 12))
    )
    .Script(sc => sc
        .Type("number")
        .Ascending()
        .Script(script => script
            .Inline("doc['numberOfCommits'].value * factor")
            .Params(p => p.Add("factor", 1.1))
        )
    )
)

Object Initializer syntax example

edit
new SearchRequest<Project>
{
    Sort = new List<ISort>
    {
        new SortField { Field = "startedOn", Order = SortOrder.Ascending },
        new SortField { Field = "name", Order = SortOrder.Descending },
        new SortField { Field = "_score", Order = SortOrder.Descending },
        new SortField { Field = "_doc", Order = SortOrder.Ascending },
        new SortField
        {
            Field = Field<Project>(p=>p.LastActivity),
            Order = SortOrder.Descending,
            MissingValue = "_last",
            UnmappedType = FieldType.Date,
            Mode = SortMode.Average,
            NestedPath = Field<Project>(p=>p.Tags),
            NestedFilter = new MatchAllQuery(),
        },
        new SortField
        {
            Field = Field<Project>(p=>p.NumberOfCommits),
            Order = SortOrder.Descending,
            MissingValue = -1
        },
        new GeoDistanceSort
        {
            Field = "location",
            Order = SortOrder.Ascending,
            DistanceType = GeoDistanceType.Arc,
            GeoUnit = DistanceUnit.Centimeters,
            Mode = SortMode.Min,
            Points = new [] {new GeoLocation(70, -70), new GeoLocation(-12, 12) }
        },
        new ScriptSort
        {
            Type = "number",
            Order = SortOrder.Ascending,
            Script =  new InlineScript("doc['numberOfCommits'].value * factor")
            {
                Params = new Dictionary<string, object>
                {
                    { "factor", 1.1 }
                }
            }
        }
    }
}

Example json output.

{
  "sort": [
    {
      "startedOn": {
        "order": "asc"
      }
    },
    {
      "name": {
        "order": "desc"
      }
    },
    {
      "_score": {
        "order": "desc"
      }
    },
    {
      "_doc": {
        "order": "asc"
      }
    },
    {
      "lastActivity": {
        "missing": "_last",
        "order": "desc",
        "mode": "avg",
        "nested_filter": {
          "match_all": {}
        },
        "nested_path": "tags",
        "unmapped_type": "date"
      }
    },
    {
      "numberOfCommits": {
        "missing": -1,
        "order": "desc"
      }
    },
    {
      "_geo_distance": {
        "location": [
          {
            "lat": 70.0,
            "lon": -70.0
          },
          {
            "lat": -12.0,
            "lon": 12.0
          }
        ],
        "order": "asc",
        "mode": "min",
        "distance_type": "arc",
        "unit": "cm"
      }
    },
    {
      "_script": {
        "order": "asc",
        "type": "number",
        "script": {
          "params": {
            "factor": 1.1
          },
          "inline": "doc['numberOfCommits'].value * factor"
        }
      }
    }
  ]
}
« Script Fields Usage Source Filtering Usage »
Was this helpful?
Feedback