0ba532b16a
Next steps after DC2DC and Cluster doc improvements: - We refactor replication sections and make more intuitive separation between Master/Slave and the new Active Failover in 3.3 - We create corresponding sections for Master/Slave and Active Failover in the Administration and Deployment chapters, as well as in the Scalability chapter, where these "modes" are introduced - We touch and improve the "Architecture" chapter as well, where some architecture info have to be placed - We reorg the TOC having in more "logical" order: -- Deployment -- Administration -- Security -- Monitoring -- Troubleshooting - We adds parts in the TOC - We add toc per pages, using page-toc plugin - We also put close together "Scalability" and "Architecture" chapters, preliminary steps of further improvements / aggregation - We improve swagger Internal Ref: - https://github.com/arangodb/planning/issues/1692 - https://github.com/arangodb/planning/issues/1655 - https://github.com/arangodb/planning/issues/1858 - https://github.com/arangodb/planning/issues/973 (partial fix) - https://github.com/arangodb/planning/issues/1498 (partial fix) |
||
|---|---|---|
| .. | ||
| README.md | ||
README.md
HTTP Interface for Simple Queries
Simple Queries
This is an introduction to ArangoDB's HTTP interface for simple queries.
Simple queries can be used if the query condition is straight forward simple, i.e., a document reference, all documents, a query-by-example, or a simple geo query. In a simple query you can specify exactly one collection and one condition. The result can then be sorted and can be split into pages.
Working with Simples Queries using HTTP
To limit the amount of results to be transferred in one batch, simple queries support a batchSize parameter that can optionally be used to tell the server to limit the number of results to be transferred in one batch to a certain value. If the query has more results than were transferred in one go, more results are waiting on the server so they can be fetched subsequently. If no value for the batchSize parameter is specified, the server will use a reasonable default value.
If the server has more documents than should be returned in a single batch, the server will set the hasMore attribute in the result. It will also return the id of the server-side cursor in the id attribute in the result. This id can be used with the cursor API to fetch any outstanding results from the server and dispose the server-side cursor afterwards.
@startDocuBlock put_api_simple_all
@startDocuBlock put_api_simple_by_example
@startDocuBlock put_api_simple_first_example
@startDocuBlock RestLookupByKeys
@startDocuBlock put_api_simple_any
@startDocuBlock RestRemoveByKeys
@startDocuBlock put_api_simple_remove_by_example
@startDocuBlock put_api_simple_replace_by_example
@startDocuBlock put_api_simple_update_by_example
@startDocuBlock put_api_simple_range
@startDocuBlock put_api_simple_near
@startDocuBlock put_api_simple_within
@startDocuBlock put_api_simple_within_rectangle
@startDocuBlock put_api_simple_fulltext