Skip to content

Commit 645143b

Browse files
committed
Document undocumented collection.fulltext
1 parent 6d3e1e9 commit 645143b

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2232,6 +2232,26 @@ Deletes the documents with the given *keys* from the collection.
22322232
22332233
For information on the possible options see [the HTTP API for removing documents by keys](https://docs.arangodb.com/HttpSimpleQuery/index.html#remove-documents-by-their-keys).
22342234
2235+
#### collection.fulltext
2236+
2237+
`async collection.fulltext(fieldName, query, [opts]): Cursor`
2238+
2239+
Performs a fulltext query in the given *fieldName* on the collection.
2240+
2241+
**Arguments**
2242+
2243+
* **fieldName**: *String*
2244+
2245+
Name of the field to search on documents in the collection.
2246+
2247+
* **query**: *String*
2248+
2249+
Fulltext query string to search for.
2250+
2251+
* **opts**: *Object* (optional)
2252+
2253+
For information on the possible options see [the HTTP API for fulltext queries](https://docs.arangodb.com/HttpIndexes/Fulltext.html).
2254+
22352255
### Bulk importing documents
22362256
22372257
This function implements the [HTTP API for bulk imports](https://docs.arangodb.com/HttpBulkImports/index.html).

0 commit comments

Comments
 (0)