Skip to contents

Query SB for items using generic query parameters

Source: R/query_sb.R
query_sb.Rd

Generic SB query function to construct advanced queries.

The following is a list of query parameters you can use in the query_list parameter.

  • q (character): Query string

  • q (character): Lucene query string

  • fields (character): Character vector of fields to return

  • folderId (character): Alphanumeric string representing folder ID

  • parentId (character): Alphanumeric string representing folder ID. This can be used to return all children items within the folder, but not within sub-folders.

  • sort (character) One of "firstContact", "dateCreated", "lastUpdated", or "title". By default sorted by search score

  • order (character) One of "asc" or "desc"

  • ids Vector of item ids.

  • ancestors (character): Alphanumeric string representing folder ID. This can be used to return all children items within the folder, even within sub-folders. Used as a filter

  • tags Filter by tags, e.g, "distribution". Used as a filter

  • browseCategory One of .... Used as a filter

  • browseType One of .... Used as a filter

  • dateRange A json string with keys dateType and choice. Where dateType is one of Acquisition, Award, Collected, dateCreated, Received, Reported, Transmitted, Due, End, Info, lastUpdated, Publication, Release, or Start. And where choice is one of day, week, month, year, or range (if range selected, also supply start and end keys with dates of the form YYYY-MM-DD). Used as a filter

  • projectStatus One of Active, Approved, Completed, In Progress, Proposed. Used as a filter

  • spatialQuery A WKT string. Used as a filter

  • extentQuery Use existing extents (footprints) to search against item bounding boxes and representational points. This is a alphanumeric string.

Usage

query_sb(query_list, ..., limit = 20)

Arguments

query_list

List of item query selectors. See Details.

...

Additional parameters are passed on to GET

limit

Maximum number of returned items. Will do paging to retrieve results when limit is over 1000. Use with caution, queries 10k results are slow.

Value

A list of sbitem objects

See also

query_items

Examples

if (FALSE) {
query_sb(list(q = "water"))

# Search by project status
query_sb(list(projectStatus = "Active"))

# Search a folder ID
query_sb(list(q = "water", folderId = '504216b9e4b04b508bfd337d'))

# Filter by ancestor
query_sb(list(ancestors = "4f831626e4b0e84f6086809b"))

# Filter by tags
query_sb(list(tags = "distribution"))

# Filter by browse category
query_sb(list(browseCategory = "Image"))

# Filter by browse type
query_sb(list(browseType = "Map Service"))

# Filter by WKT geometry string
wkt1 <- "POLYGON((-104.4 41.0,-95.1 41.0,-95.1 37.5,-104.4 37.5,-104.4 41.0))"
wkt2 <- "POLYGON((-104.4 38.3,-95.2 38.3,-95.2 33.7,-104.4 34.0,-104.4 38.3))"
query_sb(list(spatialQuery = wkt1))
query_sb(list(spatialQuery = wkt1, spatialQuery = wkt2))

# Date range
query_sb(list(dateRange = '{"dateType":"Collected","choice":"year"}'))
query_sb(list(dateRange = '{"dateType":"lastUpdated","choice":"month"}'))
query_sb(list(dateRange = 
    '{"dateType":"Release","choice":"range","start":"2014-09-01","end":"2015-09-01"}'))
}