Skip to content

Commit b97a9a7

Browse files
committed
V8 pinned readme
1 parent 8bfe260 commit b97a9a7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,14 @@ $searchQuery->sumSortBy('field', 'asc');
130130
$searchQuery->medianSortBy('field', 'asc');
131131
```
132132

133+
### Pinned query
134+
135+
Promotes selected documents to rank higher than those matching a given query. This feature is typically used to guide searchers to curated documents that are promoted over and above any "organic" matches for a search. The promoted or "pinned" documents are identified using the document IDs stored in the _id field.
136+
137+
```php
138+
$searchQuery->pinned(['doc-3', 'doc-1', 'doc-2']);
139+
```
140+
133141
### Pagination
134142

135143
#### Offset Pagination

0 commit comments

Comments
 (0)