Class TabularDataByMQLRequest

TabularDataByMQLRequest requests tabular data using an MQL query.

from message viam.app.data.v1.TabularDataByMQLRequest

Hierarchy

Constructors

Properties

dataSource?: TabularDataSource

data_source is an optional field that can be used to specify the data source for the query. If not specified, the query will run on "standard" storage.

from field: optional viam.app.data.v1.TabularDataSource data_source = 6;

mqlBinary: Uint8Array[]

mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline. The pipeline is run on the "sensorData.readings" namespace, which holds the Viam organization's tabular data.

from field: repeated bytes mql_binary = 3;

organizationId: string

from field: string organization_id = 1;

useRecentData?: boolean

Deprecated, please use TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE instead.

from field: optional bool use_recent_data = 4;

fields: FieldList
runtime: ProtoRuntime
typeName: "viam.app.data.v1.TabularDataByMQLRequest"

Methods

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<TabularDataByMQLRequest>

  • Serialize the message to binary data.

    Parameters

    • Optionaloptions: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

MMNEPVFCICPMFPCPTTAAATR