GuidesChangelogTypeScript API ReferencePython v2 API Reference

QueryApi

Index

Interfaces

Functions

Functions

getChangesById

  • getChangesById(builder: RequestBuilder, params: {</span>additionalFields<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>billingTag<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>endVersion<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>partition<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>sinceTime<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>startVersion<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<QueryApi.Partitions>

  • Gets the latest partition changes for a version range in a versioned layer or a time range for a volatile layer. Only the latest change for each changed partition is returned, not intermediate changes. If the response contains a partition with an empty 'dataHandle' value, the partition was deleted at the version indicated by the 'version' field of the partition object. If a partition was created and deleted between the versions specified in the 'startVersion' and 'endVersion' parameters, the partition is not included in the response. For example, if you request versions 0 to 10, and a partition was created in version 3 then deleted in version 7, it is not included in the response.

    summary
    Gets changes for the version or time range for the specific partition(s).

    Parameters

    • builder: RequestBuilder
    • params: {</span>additionalFields<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>billingTag<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>endVersion<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>partition<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>sinceTime<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>startVersion<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • Optional additionalFields?: string[]
      • Optional billingTag?: string
      • Optional endVersion?: string
      • layerId: string
      • partition: string[]
      • Optional sinceTime?: number
      • Optional startVersion?: string

    Returns Promise<QueryApi.Partitions>

getPartitionsById

  • getPartitionsById(builder: RequestBuilder, params: {</span>additionalFields<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>billingTag<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>partition<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>version<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<QueryApi.Partitions>

  • Gets metadata for specific partition ids. If the layer specified in the request does not exist, the request results in an error. If a partition specified in the request does not exist, the response does not include this partition. Maximun allowed number of partitions ids per call is 100.

    summary
    Gets metadata for the requested partitions

    Parameters

    • builder: RequestBuilder
    • params: {</span>additionalFields<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>billingTag<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>partition<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>version<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • Optional additionalFields?: string[]
      • Optional billingTag?: string
      • layerId: string
      • partition: string[]
      • Optional version?: string

    Returns Promise<QueryApi.Partitions>

quadTreeIndex

  • quadTreeIndex(builder: RequestBuilder, params: {</span>additionalFields<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>billingTag<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>depth<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>quadKey<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>version<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">}): Promise<QueryApi.Index>

  • Gets metadata for the requested index. Only available for versioned layers where the partitioning scheme is heretile.

    summary
    Gets index metadata of versioned

    Parameters

    • builder: RequestBuilder
    • params: {</span>additionalFields<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>billingTag<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>depth<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>quadKey<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>version<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">}
      • Optional additionalFields?: string[]
      • Optional billingTag?: string
      • depth: number
      • layerId: string
      • quadKey: string
      • version: number

    Returns Promise<QueryApi.Index>

quadTreeIndexVolatile

  • quadTreeIndexVolatile(builder: RequestBuilder, params: {</span>additionalFields<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>billingTag<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>depth<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>quadKey<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<QueryApi.Index>

  • Gets metadata for the requested index. Only available for volatile layers where the partitioning scheme is heretile.

    summary
    Gets index metadata for volatile layers

    Parameters

    • builder: RequestBuilder
    • params: {</span>additionalFields<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">[]</span><span class="typedoc-tsd-signature-symbol">; </span>billingTag<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>depth<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>layerId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>quadKey<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • Optional additionalFields?: string[]
      • Optional billingTag?: string
      • depth: number
      • layerId: string
      • quadKey: string

    Returns Promise<QueryApi.Index>

olp- sdk- dataservice- api

On this page