mirror of https://gitee.com/bigwinds/arangodb
206 lines
5.5 KiB
Markdown
206 lines
5.5 KiB
Markdown
<!-- don't edit here, its from https://@github.com/arangodb/arangodbjs.git / docs/Drivers/ -->
|
|
# Simple queries
|
|
|
|
These functions implement the
|
|
[HTTP API for simple queries](../../../..//HTTP/SimpleQuery/index.html).
|
|
|
|
## collection.all
|
|
|
|
`async collection.all([opts]): Cursor`
|
|
|
|
Performs a query to fetch all documents in the collection. Returns a
|
|
[new _Cursor_ instance](../Cursor.md) for the query results.
|
|
|
|
**Arguments**
|
|
|
|
* **opts**: `Object` (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for returning all documents](../../../..//HTTP/SimpleQuery/index.html#return-all-documents).
|
|
|
|
## collection.any
|
|
|
|
`async collection.any(): Object`
|
|
|
|
Fetches a document from the collection at random.
|
|
|
|
## collection.first
|
|
|
|
`async collection.first([opts]): Array<Object>`
|
|
|
|
Performs a query to fetch the first documents in the collection. Returns an
|
|
array of the matching documents.
|
|
|
|
**Note**: This method is not available when using the driver with ArangoDB 3.0
|
|
and higher as the corresponding API method has been removed.
|
|
|
|
**Arguments**
|
|
|
|
* **opts**: `Object` (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for returning the first document of a collection](https://docs.arangodb.com/2.8/HttpSimpleQuery/#first-document-of-a-collection).
|
|
|
|
If _opts_ is a number it is treated as _opts.count_.
|
|
|
|
## collection.last
|
|
|
|
`async collection.last([opts]): Array<Object>`
|
|
|
|
Performs a query to fetch the last documents in the collection. Returns an array
|
|
of the matching documents.
|
|
|
|
**Note**: This method is not available when using the driver with ArangoDB 3.0
|
|
and higher as the corresponding API method has been removed.
|
|
|
|
**Arguments**
|
|
|
|
* **opts**: `Object` (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for returning the last document of a collection](https://docs.arangodb.com/2.8/HttpSimpleQuery/#last-document-of-a-collection).
|
|
|
|
If _opts_ is a number it is treated as _opts.count_.
|
|
|
|
## collection.byExample
|
|
|
|
`async collection.byExample(example, [opts]): Cursor`
|
|
|
|
Performs a query to fetch all documents in the collection matching the given
|
|
_example_. Returns a [new _Cursor_ instance](../Cursor.md) for the query results.
|
|
|
|
**Arguments**
|
|
|
|
* **example**: _Object_
|
|
|
|
An object representing an example for documents to be matched against.
|
|
|
|
* **opts**: _Object_ (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for fetching documents by example](../../../..//HTTP/SimpleQuery/index.html#find-documents-matching-an-example).
|
|
|
|
## collection.firstExample
|
|
|
|
`async collection.firstExample(example): Object`
|
|
|
|
Fetches the first document in the collection matching the given _example_.
|
|
|
|
**Arguments**
|
|
|
|
* **example**: _Object_
|
|
|
|
An object representing an example for documents to be matched against.
|
|
|
|
## collection.removeByExample
|
|
|
|
`async collection.removeByExample(example, [opts]): Object`
|
|
|
|
Removes all documents in the collection matching the given _example_.
|
|
|
|
**Arguments**
|
|
|
|
* **example**: _Object_
|
|
|
|
An object representing an example for documents to be matched against.
|
|
|
|
* **opts**: _Object_ (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for removing documents by example](../../../..//HTTP/SimpleQuery/index.html#remove-documents-by-example).
|
|
|
|
## collection.replaceByExample
|
|
|
|
`async collection.replaceByExample(example, newValue, [opts]): Object`
|
|
|
|
Replaces all documents in the collection matching the given _example_ with the
|
|
given _newValue_.
|
|
|
|
**Arguments**
|
|
|
|
* **example**: _Object_
|
|
|
|
An object representing an example for documents to be matched against.
|
|
|
|
* **newValue**: _Object_
|
|
|
|
The new value to replace matching documents with.
|
|
|
|
* **opts**: _Object_ (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for replacing documents by example](../../../..//HTTP/SimpleQuery/index.html#replace-documents-by-example).
|
|
|
|
## collection.updateByExample
|
|
|
|
`async collection.updateByExample(example, newValue, [opts]): Object`
|
|
|
|
Updates (patches) all documents in the collection matching the given _example_
|
|
with the given _newValue_.
|
|
|
|
**Arguments**
|
|
|
|
* **example**: _Object_
|
|
|
|
An object representing an example for documents to be matched against.
|
|
|
|
* **newValue**: _Object_
|
|
|
|
The new value to update matching documents with.
|
|
|
|
* **opts**: _Object_ (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for updating documents by example](../../../..//HTTP/SimpleQuery/index.html#update-documents-by-example).
|
|
|
|
## collection.lookupByKeys
|
|
|
|
`async collection.lookupByKeys(keys): Array<Object>`
|
|
|
|
Fetches the documents with the given _keys_ from the collection. Returns an
|
|
array of the matching documents.
|
|
|
|
**Arguments**
|
|
|
|
* **keys**: _Array_
|
|
|
|
An array of document keys to look up.
|
|
|
|
## collection.removeByKeys
|
|
|
|
`async collection.removeByKeys(keys, [opts]): Object`
|
|
|
|
Deletes the documents with the given _keys_ from the collection.
|
|
|
|
**Arguments**
|
|
|
|
* **keys**: _Array_
|
|
|
|
An array of document keys to delete.
|
|
|
|
* **opts**: _Object_ (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for removing documents by keys](../../../..//HTTP/SimpleQuery/index.html#remove-documents-by-their-keys).
|
|
|
|
## collection.fulltext
|
|
|
|
`async collection.fulltext(fieldName, query, [opts]): Cursor`
|
|
|
|
Performs a fulltext query in the given _fieldName_ on the collection.
|
|
|
|
**Arguments**
|
|
|
|
* **fieldName**: _String_
|
|
|
|
Name of the field to search on documents in the collection.
|
|
|
|
* **query**: _String_
|
|
|
|
Fulltext query string to search for.
|
|
|
|
* **opts**: _Object_ (optional)
|
|
|
|
For information on the possible options see
|
|
[the HTTP API for fulltext queries](../../../..//HTTP/Indexes/Fulltext.html).
|