length

Type: integer

Engine default: null (no offset)

Parameter syntax

'length' => number_of_records

length: number_of_records

length: number_of_records

'length': number_of_records

length = number_of_records

length: Int = number_of_records

.Length(number_of_records)

.setLength(number_of_records)

opt.Length(number_of_records)

length = Some(number_of_records)

Can be used in these methods:
search, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, generate_secured_api_key, add_api_key, update_api_key search, browse, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Set the number of hits to retrieve (used only with offset).

In most cases, page and hitsPerPage is the recommended method for pagination. This setting is part of an alternative paging approach.

Usage notes

1000 is the maximum.
If offset is omitted, length is ignored.
If offset is specified but length omitted, the number of records returned is equal to hitsPerPage. Using offset requires that you specify length as well; otherwise, it defaults to page-based pagination.

Impact on the response:

Page-based pagination (page and hitsPerPage):

Copy
{
  ...
  "page": 1,
  "nbPages": 20,
  "hitsPerPage": 10,
  ...
}

With offset / length:

Copy
 {
   ...
   "offset": 5,
   "length": 10,
   ...
 }

Examples

Get n results

Copy

1
2
3
$results = $index->search('query', [
  'length' => 4
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.length, to: 4)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}