Query Parameters (Spider)

[Table of Contents](https://github.com/dell-oss/Doradus/wiki/Spider Databases: Table-of-Contents) | Previous | Next
Spider Object Queries: Query Parameters Overview

---

An object query allows the following parameters:

• Query (required): A DQL query expression that selects objects in the perspective table.

• Page size (optional): Limits the number of objects returned. If absent, the page size defaults to search_default_page_size in the doradus.yaml file. The page size can be set to 0 to disable paging, causing all results to be returned in a single page.

• Fields (optional): A comma-separated list of fields to return for each object. Several formats and options are allowed for this parameter as described later in the section Fields Parameter By default, all scalar fields for selected objects are returned.

• Order (optional): Orders the objects returned by a scalar field belonging to the perspective table. Without this parameter, objects are returned in an internally-defined order. When an order field is specified, by default objects are sorted in ascending of the field’s value. Optionally, the field name can be followed by ASC to explicitly request ascending order or DESC to request descending order.

• Skip (optional): Causes the specified number of objects to be skipped. Without this parameter, the first page of objects is returned.

How query parameters are passed depends on the REST command. Spider supports object queries submitted in two different ways:

• URI command: All query parameters are passed in the URI of the command.

• Entity command: All query parameters are passed in an input entity (XML or JSON document) submitted with the command.

REST commands and how query parameters are passed are described in the section Spider REST Commands. The examples in this section use the URI command format.