Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

v3/sessions/:session_handle/materialized-tables/:identifier/refresh

Verb: POST

Response code: 200 OK

Trigger a refresh operation of the materialized table.

Request

body

{

  "isPeriodic": true, # required

  "scheduleTime": "", #optional

  "dynamicOptions": { #optional

           "key": "value"

   },

   "staticPartitions": { #optional

           "key": "value"

    },

  "executionConfig":  {  #optional

            "key":  "value"

    }

}

Response

body

{

  jobID  "operationHandle" : "",

  clusterInfo: {

        "key": "value"

   }

}


fetch result using the operation handle using fetch results Rest API

/v1/sessions/:session_handle/operations/:operation_handle/result/:token

Verb: GET

Response code: 200 OK

Request body

{}

Response

body


{

    "resultType": "PAYLOAD",

    "isQueryResult": false,

    "resultKind": "SUCCESS_WITH_CONTENT",

    "results": {

        "columns": [

            {

                "name": "job id",

                "logicalType": {

                    "type": "VARCHAR",

                    "nullable": true,

                    "length": 2147483647

                },

                "comment": null

            },

            {

                "name": "cluster info",

                "logicalType": {

                    "type": "MAP",

                    "nullable": true,

                    "keyType": {

                        "type": "VARCHAR",

                        "nullable": true,

                        "length": 2147483647

                    },

                    "valueType": {

                        "type": "VARCHAR",

                        "nullable": true,

                        "length": 2147483647

                    }

                },

                "comment": null

            }

        ],

        "rowFormat": "JSON",

        "data": [

            {

                "kind": "INSERT",

                "fields": [

                    "af29ca75fafe38d14b10dbaf5c973a83",

                    {

                        "execution.target": "remote"

                    }

                ]

            }

        ]

    },

    "nextResultUri": "/v3/sessions/209bb9e5-f156-47cd-83ce-c93abf75ce64/operations/5ee7240b-1d2e-4f0c-a452-782f933e8e52/result/1?rowFormat=JSON"

}



The materialized table identifier must be a fully qualified path: 'catalogName.databaseName.objectName', it is responsibility for locating the materialized table in catalog.

...