PostCursorBody Class |
Represents a request body for creating an AQL query cursor.
Inheritance HierarchyNamespace: ArangoDBNetStandard.CursorApi.Models
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe PostCursorBody type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PostCursorBody | Initializes a new instance of the PostCursorBody class |
Properties| Name | Description | |
|---|---|---|
 | BatchSize |
Maximum number of result documents to be transferred from the server
to the client in one roundtrip. If this attribute is not set,
a server-controlled default value will be used.
A value of 0 is disallowed.
|
| BindVars |
The bind parameters of the AQL query.
|
| Cache |
Flag to determine whether the AQL query results cache shall be used.
If set to false, then any query cache lookup will be skipped for the query.
If set to true, it will lead to the query cache being checked for the query
if the query cache mode is either 'on' or 'demand'.
|
| Count |
Whether the number of documents in the result set should be returned
in Count.
Calculating the “count” attribute might have a performance impact for some queries
so this option is turned off by default, and “count” is only returned when requested.
|
| MemoryLimit |
The maximum number of memory (measured in bytes) that the query is allowed to use.
If set, then the query will fail with error “resource limit exceeded”
in case it allocates too much memory.
A value of 0 indicates that there is no memory limit.
|
| Options |
Extra options for the AQL query.
|
| Query |
Contains the AQL query to be executed.
|
| Ttl |
The time-to-live for the cursor (in seconds).
The cursor will be removed on the server automatically after the specified amount of time.
This is useful to ensure garbage collection of cursors that are not fully fetched by clients.
If not set, a server-defined value will be used (default: 30 seconds).
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also