GuidesChangelogTypeScript API ReferencePython v2 API Reference

IndexApi

Index

Interfaces

Functions

Functions

insertIndexes

  • insertIndexes(builder: RequestBuilder, params: {</span>indexes<span class="typedoc-tsd-signature-symbol">: </span><a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-indexapi" class="typedoc-tsd-signature-type" data-tsd-kind="Namespace">IndexApi</a><span class="typedoc-tsd-signature-symbol">.</span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-indexapi-index" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">Index</a><span class="typedoc-tsd-signature-symbol">[]</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">}): Promise<Response>

  • Adds index data for a given data blob to an index layer. For more information, see Publish to an Index Layer.

    summary
    Inserts index data to an index layer

    Parameters

    • builder: RequestBuilder
    • params: {</span>indexes<span class="typedoc-tsd-signature-symbol">: </span><a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-indexapi" class="typedoc-tsd-signature-type" data-tsd-kind="Namespace">IndexApi</a><span class="typedoc-tsd-signature-symbol">.</span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-indexapi-index" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">Index</a><span class="typedoc-tsd-signature-symbol">[]</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">}

    Returns Promise<Response>

performQuery

  • performQuery(builder: RequestBuilder, params: {</span>huge<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">boolean</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>query<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<DataResponse>

  • Queries the index layer for the partitions that match the query. Returns each partition that matches the query, including each partition's data handle, which you use with the blob API to retrieve data for each partition.

    summary
    Gets the partitions that match the query

    Parameters

    • builder: RequestBuilder
    • params: {</span>huge<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">boolean</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>query<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • Optional huge?: boolean
      • layerID: string
      • query: string

    Returns Promise<DataResponse>

performUpdate

  • performUpdate(builder: RequestBuilder, params: {</span>layerID<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>request<span class="typedoc-tsd-signature-symbol">: </span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-indexapi-updateindexrequest" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">UpdateIndexRequest</a><span class="typedoc-tsd-signature-symbol">}): Promise<Response>

  • Modifies partitions in an index layer.

    summary
    Updates index layer partitions

    Parameters

    • builder: RequestBuilder
    • params: {</span>layerID<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>request<span class="typedoc-tsd-signature-symbol">: </span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-indexapi-updateindexrequest" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">UpdateIndexRequest</a><span class="typedoc-tsd-signature-symbol">}

    Returns Promise<Response>

olp- sdk- dataservice- api

On this page