Skip to main content

stac

Creates, updates, deletes, gets or lists a stac resource.

Overview

Namestac
TypeResource
Idazure.planetary_computer_dataplane.stac

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringUnique identifier for the mosaic. Required.
namestringShort descriptive name for the mosaic. Required.
cqlarrayA list of valid CQL2-JSON expressions used to filter the collection to moasic. Required.
descriptionstringDetailed description of the mosaic.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_mosaicselectcollection_id, mosaic_id, endpointGet Collection Mosaic. Get a mosaic definition from a given collection.
get_render_optionselectcollection_id, render_option_id, endpointGet Collection Render Option. Get a render option for a given collection.
get_itemselectcollection_id, item_id, endpointsign, durationFetch a single STAC Item.
get_collection_configurationselectcollection_id, endpointGet Config. Get the complete user configuration for a given collection.
get_collectionsselectendpointsign, durationGet Collections. List all collections in the GeoCatalog instance.
replace_mosaicexeccollection_id, mosaic_id, endpoint, id, name, cqlUpdate Collection Mosaic. Update a mosaic definition from a given collection.
delete_mosaicexeccollection_id, mosaic_id, endpointDelete Collection Mosaic. Delete a mosaic definition from a given collection.
get_mosaicsexeccollection_id, endpointGet Collection Mosaics. Get the mosaic definitions for a given collection.
add_mosaicexeccollection_id, endpoint, id, name, cqlAdd Collection Mosaic. Add a mosaic definition to a given collection.
get_collectionexeccollection_id, endpointsign, durationGet Collection. Get a collection in the GeoCatalog instance.
replace_collectionexeccollection_id, endpoint, id, description, links, license, extentReplace Collection. Replace an existing collection in the GeoCatalog instance.
delete_collectionexeccollection_id, endpointDelete Collection. Delete a collection in the GeoCatalog instance.
create_collectionexecendpoint, id, description, links, license, extentCreate Collection. Create a new collection in the GeoCatalog instance.
get_partition_typeexeccollection_id, endpointGet Partitiontype. Get the partitiontype for a GeoCatalog Collection.
replace_partition_typeexeccollection_id, endpointCreate Partitiontype. Updates partition type for a GeoCatalog Collection. This will determine the partitioning scheme for items within the database, and can only be set before any items are loaded. Ideal partitioning schemes result in partitions of roughly 100k items each. The default partitioning scheme is "none" which does not partition items.
replace_render_optionexeccollection_id, render_option_id, endpoint, id, nameUpdate Collection Render Option. Update a render option for a given collection.
delete_render_optionexeccollection_id, render_option_id, endpointDelete Collection Render Option. Delete a render option for a given collection.
get_render_optionsexeccollection_id, endpointGet Collection Render Options. Get all render options for a given collection.
create_render_optionexeccollection_id, endpoint, id, nameAdd Collection Render Option. Add a render option for a given collection.
get_collection_thumbnailexeccollection_id, endpointGet Collection Thumbnail. Get thumbnail for given collection.
get_tile_settingsexeccollection_id, endpointGet Collection Tile Settings. Get the tile settings for a given collection.
replace_tile_settingsexeccollection_id, endpoint, minZoom, maxItemsPerTileUpdate Collection Tile Settings. Update the tile settings for a given collection.
get_conformance_classesexecendpointConformance Classes. Returns the STAC conformance classes.
get_landing_pageexecendpointLanding Page. Return the STAC landing page.
replace_itemexeccollection_id, item_id, endpoint, type, geometry, id, bbox, properties, assetsReplace a STAC item in a collection.
delete_itemexeccollection_id, item_id, endpointDelete a STAC item from a collection.
update_itemexeccollection_id, item_id, endpoint, type, geometry, id, bbox, properties, assetsUpdate a STAC item in a collection.
get_item_collectionexeccollection_id, endpointlimit, bbox, datetime, sign, duration, tokenFetch features of the feature collection with id collectionId. Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.
create_itemexeccollection_id, endpoint, typeCreate a new STAC item or a set of items in a collection.
get_queryablesexecendpointQueryables. List all queryables in the GeoCatalog instance.
get_collection_queryablesexeccollection_id, endpointCollection Queryables. List all queryables in a given collection.
create_queryablesexeccollection_id, endpoint, name, definitionSet Collection Queryables. Set queryables for a collection given a list of queryable definitions.
create_collection_assetexeccollection_id, endpoint, data, fileCreate Collection Asset. Create a new asset in the Collection metadata and write the associated file to managed storage.
replace_collection_assetexeccollection_id, asset_id, endpoint, data, fileUpdate Collection Asset. Update an existing asset in a given collection.
delete_collection_assetexeccollection_id, asset_id, endpointDelete Collection Asset. Delete an asset from a given collection.
replace_queryableexeccollection_id, queryable_name, endpoint, name, definitionUpdate Collection Queryables. Updates a queryable given a queryable definition and corresponding collection id.
delete_queryableexeccollection_id, queryable_name, endpointDelete Queryables. Delete queryables by name for specified collection.
searchexecendpointsign, durationSearch. STAC search operation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
asset_idstringSTAC Asset ID. Required.
collection_idstringUnique identifier for the STAC collection. Required.
endpointstringThe service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
item_idstringSTAC Item id. Required.
mosaic_idstringUnique identifier for the mosaic configuration. Required.
queryable_namestringName of the queryable property to operate on. Required.
render_option_idstringUnique identifier for the render option. Required.
bboxarrayOnly features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Minimum value, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Maximum value, coordinate axis 3 (optional) The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84 _). For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. Default value is None.
datetimestringEither a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: * A date-time: "2018-02-12T23:20:50Z" * A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" * Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z" Only features that have a temporal property that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. Default value is None.
durationintegerURL signature duration in minutes. Default value is None.
limitintegerThe optional limit parameter recommends the number of items that should be present in the response document. If the limit parameter value is greater than advertised limit maximum, the server must return the maximum possible number of items, rather than responding with an error. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items must not be counted. Minimum = 1. Maximum = 10000. Default = 10. Default value is None.
signstringWhether to sign asset URLs in the response. Known values are: "true" and "false". Default value is None.
tokenstringPagination token for fetching the next set of results. Default value is None.

SELECT examples

Get Collection Mosaic. Get a mosaic definition from a given collection.

SELECT
id,
name,
cql,
description
FROM azure.planetary_computer_dataplane.stac
WHERE collection_id = '{{ collection_id }}' -- required
AND mosaic_id = '{{ mosaic_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

Lifecycle Methods

Update Collection Mosaic. Update a mosaic definition from a given collection.

EXEC azure.planetary_computer_dataplane.stac.replace_mosaic 
@collection_id='{{ collection_id }}' --required,
@mosaic_id='{{ mosaic_id }}' --required,
@endpoint='{{ endpoint }}' --required
@@json=
'{
"id": "{{ id }}",
"name": "{{ name }}",
"description": "{{ description }}",
"cql": "{{ cql }}"
}'
;