API Documentation Github NPM

Class

OsduV2QueryService

OsduV2QueryService(osdu_client, data_partition)

Class that provides named access to OSDU V2 Query endpoints

Constructor

# new OsduV2QueryService(osdu_client, data_partition)

Parameters:
Name Type Description
osdu_client BaseOsduClient

An implementation of the OSDU client class to broker communication with the OSDU API
data_partition string

The data partition against which requests will be made

View Source service/query/v2.js, line 11

Methods

# async query(query_params) → {Object}

Get OSDU records that match the given query constraints

Parameters:
Name Type Description
query_params Object

Query parameters built using the OsduQueryBuilder

View Source service/query/v2.js, line 26

The API Response

Object

# async queryAll(query_params) → {Object}

Get all OSDU records that match the given query constraints

  • Will page internally and aggregate results until no more pages are found
  • Note that this may make multiple network requests if multiple pages are found
Parameters:
Name Type Description
query_params Object

Query parameters built using the OsduQueryBuilder

View Source service/query/v2.js, line 55

The API Response

Object

# async queryWithPaging(query_params) → {Object}

Get OSDU records that match the given query constraints

  • Allow specification of a cursor for paged queries
Parameters:
Name Type Description
query_params Object

Query parameters built using the OsduQueryBuilder

View Source service/query/v2.js, line 38

The API Response

Object