Skip to content

Prepare Query

timestreamquery_prepare_query R Documentation

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running

Description

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true.

Usage

timestreamquery_prepare_query(QueryString, ValidateOnly)

Arguments

QueryString

[required] The Timestream query string that you want to use as a prepared statement. Parameter names can be specified in the query string @ character followed by an identifier.

ValidateOnly

By setting this value to true, Timestream will only validate that the query string is a valid Timestream query, and not store the prepared query for later use.

Value

A list with the following syntax: 

list(
  QueryString = "string",
  Columns = list(
    list(
      Name = "string",
      Type = list(
        ScalarType = "VARCHAR"|"BOOLEAN"|"BIGINT"|"DOUBLE"|"TIMESTAMP"|"DATE"|"TIME"|"INTERVAL_DAY_TO_SECOND"|"INTERVAL_YEAR_TO_MONTH"|"UNKNOWN"|"INTEGER",
        ArrayColumnInfo = list(
          Name = "string",
          Type = list()
        ),
        TimeSeriesMeasureValueColumnInfo = list(
          Name = "string",
          Type = list()
        ),
        RowColumnInfo = list(
          list(
            Name = "string",
            Type = list()
          )
        )
      ),
      DatabaseName = "string",
      TableName = "string",
      Aliased = TRUE|FALSE
    )
  ),
  Parameters = list(
    list(
      Name = "string",
      Type = list(
        ScalarType = "VARCHAR"|"BOOLEAN"|"BIGINT"|"DOUBLE"|"TIMESTAMP"|"DATE"|"TIME"|"INTERVAL_DAY_TO_SECOND"|"INTERVAL_YEAR_TO_MONTH"|"UNKNOWN"|"INTEGER",
        ArrayColumnInfo = list(
          Name = "string",
          Type = list()
        ),
        TimeSeriesMeasureValueColumnInfo = list(
          Name = "string",
          Type = list()
        ),
        RowColumnInfo = list(
          list(
            Name = "string",
            Type = list()
          )
        )
      )
    )
  )
)

Request syntax

svc$prepare_query(
  QueryString = "string",
  ValidateOnly = TRUE|FALSE
)