Start Query Planning

lakeformation_start_query_planning

R Documentation

Submits a request to process a query statement¶

Description¶

Submits a request to process a query statement.

This operation generates work units that can be retrieved with the get_work_units operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.

Usage¶

lakeformation_start_query_planning(QueryPlanningContext, QueryString)

Arguments¶

QueryPlanningContext: [required] A structure containing information about the query plan.
QueryString: [required] A PartiQL query statement used as an input to the planner service.

Value¶

A list with the following syntax:

list(
  QueryId = "string"
)

Request syntax¶

svc$start_query_planning(
  QueryPlanningContext = list(
    CatalogId = "string",
    DatabaseName = "string",
    QueryAsOfTime = as.POSIXct(
      "2015-01-01"
    ),
    QueryParameters = list(
      "string"
    ),
    TransactionId = "string"
  ),
  QueryString = "string"
)