query_skip Property

The number of entries to skip when querying a service.

Syntax

def get_query_skip() -> str: ...
def set_query_skip(value: str) -> None: ...

query_skip = property(get_query_skip, set_query_skip)

Default Value

""

Remarks

This property allows you to specify the number of entries to skip (from the top of the list) when calling query_service. Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than 0.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. However you can use query_order_by to specify how the entries should be sorted prior to skipping the top N items.

This property can be used in conjunction with query_order_by and query_top to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set query_order_by to "Rating desc" (to order the items by Rating from highest to lowest), set query_skip to "2" (to skip the first and second items), and finally set query_top to "2" (to only return the third and fourth items).