Class DataClient

Hierarchy

DataClient

Index

Constructors

Properties

Methods

binaryDataByFilter binaryDataByIds createFilter tabularDataByFilter tabularDataByMQL tabularDataBySQL

Constructors

constructor

new DataClient(serviceHost: string, grpcOptions: RpcOptions): DataClient
Parameters
- serviceHost: string
- grpcOptions: RpcOptions
Returns DataClient

Properties

`Private` service

service: DataServiceClient

Methods

binaryDataByFilter

binaryDataByFilter(filter?: Filter): Promise<dataApi.BinaryData.AsObject[]>
Parameters
- Optional filter: Filter
Returns Promise<dataApi.BinaryData.AsObject[]>

binaryDataByIds

binaryDataByIds(ids: dataApi.BinaryID.AsObject[]): Promise<dataApi.BinaryData.AsObject[]>
Parameters
- ids: dataApi.BinaryID.AsObject[]
Returns Promise<dataApi.BinaryData.AsObject[]>

createFilter

createFilter(options: FilterOptions): Filter
Parameters
- options: FilterOptions
Returns Filter

tabularDataByFilter

tabularDataByFilter(filter?: Filter): Promise<TabularData[]>
Filter and download tabular data. The returned metadata might be empty if the metadata index of the data is out of the bounds of the returned metadata list.
Parameters
- Optional filter: Filter
  
  Optional pb.Filter specifying tabular data to retrieve. No filter implies all tabular data.
Returns Promise<TabularData[]>

tabularDataByMQL

tabularDataByMQL(organizationId: string, query: string): Promise<{
[key: string]: JavaScriptValue;
}[]>
Obtain unified tabular data and metadata, queried with MQL.

Returns
An array of data objects
Parameters
- organizationId: string
  
  The ID of the organization that owns the data
- query: string
  
  The MQL query to run
Returns Promise<{
[key: string]: JavaScriptValue;
}[]>

tabularDataBySQL

tabularDataBySQL(organizationId: string, query: string): Promise<{
[key: string]: JavaScriptValue;
}[]>
Obtain unified tabular data and metadata, queried with SQL.

Returns
An array of data objects
Parameters
- organizationId: string
  
  The ID of the organization that owns the data
- query: string
  
  The SQL query to run
Returns Promise<{
[key: string]: JavaScriptValue;
}[]>

Generated using TypeDoc