54 lines
1.7 KiB
Markdown
54 lines
1.7 KiB
Markdown
|
# Discovery Functions
|
||
|
|
|
||
|
|
If you are using the [discovery methods](/dataobservatory/overview/#discovery-methods) from the Data Observatory, use the following functions to retrieve [Boundary](/dataobservatory/overview/#boundary-data) and [Measures](/dataobservatory/overview/#measures-data) data.
|
||
|
|
|
||
|
|
## OBS_Search(search_term)
|
||
|
|
|
||
|
|
Use arbitrary text to search all available Measures
|
||
|
|
|
||
|
|
#### Arguments
|
||
|
|
|
||
|
|
Name | Description
|
||
|
|
--- | ---
|
||
|
|
search_term | a string to search for available Measures
|
||
|
|
boundary_id | a string identifier for a Boundary geometry (optional)
|
||
|
|
|
||
|
|
#### Returns
|
||
|
|
|
||
|
|
Key | Description
|
||
|
|
--- | ---
|
||
|
|
measure_id | the unique id of the measue for use with the ```OBS_GetMeasure``` function
|
||
|
|
name | the human readable name of the measure
|
||
|
|
description | a brief description of the measure
|
||
|
|
aggregate_type | **sum** are raw count values, **median** are statistical medians, **average** are statistical averages, **undefined** other (e.g. an index value)
|
||
|
|
sources | where the data came from (e.g. US Census Bureau)
|
||
|
|
|
||
|
|
#### Example
|
||
|
|
|
||
|
|
```SQL
|
||
|
|
SELECT * FROM OBS_Search('inequality')
|
||
|
|
```
|
||
|
|
|
||
|
|
## OBS_GetAvailableBoundaries(point_geometry)
|
||
|
|
|
||
|
|
Returns available boundary_ids at a given point geometry.
|
||
|
|
|
||
|
|
#### Arguments
|
||
|
|
|
||
|
|
Name | Description
|
||
|
|
--- | ---
|
||
|
|
point_geometry | a WGS84 point geometry (e.g. the_geom)
|
||
|
|
|
||
|
|
#### Returns
|
||
|
|
|
||
|
|
Key | Description
|
||
|
|
--- | ---
|
||
|
|
boundary_id | a boundary identifier from the [Boundary ID glossary](/dataobservatory/glossary/#boundary-ids)
|
||
|
|
description | a brief description of the boundary dataset
|
||
|
|
timespan | the timespan attached the boundary. this does not mean that the boundary is invalid outside of the timespan, but is the explicit timespan published with the geometry.
|
||
|
|
|
||
|
|
#### Example
|
||
|
|
|
||
|
|
```SQL
|
||
|
|
SELECT * FROM OBS_GetAvailableBoundaries(CDB_LatLng(40.7, -73.9))
|
||
|
|
```
|