1---
2id: post-dataset-refresh
3title: "Refresh Dataset"
4description: "Trigger an on-demand refresh for an accelerated dataset."
5sidebar_label: "Refresh Dataset"
6hide_title: true
7hide_table_of_contents: true
8api: eJzlV9tuGzcQ/RWCQIGkWOsSpECrhwJp4qIBErhxHPTBEbT0cqRlwiVpcla2Iey/F0NSu5LXdZL2rdGLJHI4nDlz5sIdR7EJfHHJXwkUATDwZcElhMorh8oavuAXXm024JkwzJoTCY0wknlYewg1W9u4IaoKNHiBIJlMmiYfzUdzUavAwEhnlUGGSVP4F6ouaugFrdF3TDinFQSGlpXrVuuSka5SOAdGlr1sYyUE9sRYZGVVC7OBUMbFpxNecOvoImXNa8kX3NmAq3zlKivgBXfCiwYQPOG040Y0wBfpq+CKEHICSfAebDUwEmJ2zbCGvS9kcNZNFni4bpUHyRfoWyh4qGpoBF/sON45uiegV2bDu26ZhCHgb1bekcTxfWcjQLN4ApYFB5Vaq6oHlRe8sgbBICmLeFYRjOmnQBp3Y2Ps1SeocOTqZXmerjzbgvdKQiiX+/soRDWwypq12rReXGlgNh4M2TBlpNoq2QrNfGsILtG7gCJ8JkOdp1ChgkDW5N3VJ4UIftWI28HGyz1iBTet1g/QuQbWiFvVtA0TjW0N0pVJFQVHSElfOBBuwl7BWrQaw36jHFtQ9g5LpkyUCk5V4KwsmPVsPvthz4T+dFVD9XmlDILfCl2So3ArGqcJ6/ks8K7ofSXOkpfWwNk6EjHHJHrZFffpcJgwdJZMbwNEzJGy8svO0bEvuZVyjyw/5mvBwbQNhUOqQEGXvOAkywuecpTolxKSfomqpmPLgqPC6H+m1Fvyu1seIBGu9TeG+/27NyygQGjAIKEgvwWGcK0fRUGtmTB3E951I+P7fKBI9qHdHbvC35++OX15wX5kv5+fvWUobtUKvXKB/fXH6fkpQ+VWmai/svlsMuP3WbEH9qG8SDzquvulJi4EZ01IOfVsNh/XlNwUhnRMBRwkC21VQQh08d1/KSSDUZe8gRDEBiiGx/m+3xhVxQdzOwmztHOlzCbncmg17lMwl8ajmL1NB88zKvdC1tvwCCiRVH34iBGk//lsNkb2xb7LKWsYdScwMUsyMft28Z1ie5AE0kKICNViC8N0QLhlzHqcn/8zg0nB2rap7HzfgA5QJNx+eoifr6kpGaFZAL8Fz8B765mtqtYT029qpYE5b6kIkNXDuPQ9ofvBwK2DCmNbyIB9LVJdQr8BrO1++ozTJtZ8wafb+TSXgDDd0RzZTQ+5Px0ATxFKw2nrqaHUiG4xnWpbCV3bgIufZ7/MRgi9oW0mYQvautgZk6YJe5mHNWA3CmtWnpyQxnLCaQgNULVe4V28Tzi1+gz0e0l7FOTzYUg9HXe8UWsa9TJz3MtSi9xPwTRwr22Mfg6Vbw2qOIqP4x97tGSDiFYVUDwX/Rj/womqhpNnsasqCQapy/vjna7ghHBSPJ/M55PZSWsCUvWhTQpdI8yB2tz/2au+ih9Ztxuy5P/8vMoZinCLU6eFMgRWpOgu8/ySb+cEzv7xWfBFflgdkn2gAxUEYjSd3O2uRIAPXncdLV+34CMRC74VXsXYEEX7+XOxFjrAI5F4cp4r0FP2dY+3B/3Li8LQXLQVuqV/vOAxTRI/4jhbg5BEtMtd3nqZDDm5IAXD0VERpVk/naAhwuGjssuDCvPn2fsLXvCr/HzM+ebFDeErbpKZ+W0Wc5bWdlwLs2lTvUs66fM3sES38Q==
9sidebar_class_name: "post api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24 as={"h1"}
25 className={"openapi__heading"}
26 children={"Refresh Dataset"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"post"}
32 path={"/v1/datasets/{name}/acceleration/refresh"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40Trigger an on-demand refresh for an accelerated dataset.
41
42This endpoint triggers an on-demand refresh for an accelerated dataset.
43The refresh only applies to `full` and `append` refresh modes (not `changes` mode).
44
45<Heading
46 id={"request"}
47 as={"h2"}
48 className={"openapi-tabs__heading"}
49 children={"Request"}
50>
51</Heading>
52
53<ParamsDetails
54 parameters={[{"name":"name","in":"path","description":"The name of the dataset to refresh.","required":true,"schema":{"type":"string"}}]}
55>
56
57</ParamsDetails>
58
59<RequestSchema
60 title={"Body"}
61 body={{"description":"On-demand refresh request for a specific dataset.","content":{"application/json":{"schema":{"type":"object","description":"[`RefreshOverrides`] specifies the configurable options for a individual run of a refresh task.","properties":{"refresh_jitter_max":{"type":["string","null"],"description":"The maximum amount of jitter to add to the refresh. Defaults to the `refresh_jitter_max` specified in the spicepod, or 10% of the `refresh_check_interval`.","example":"10s"},"refresh_mode":{"oneOf":[{"type":"null"},{"description":"The refresh mode to use for this refresh. Defaults to the `refresh_mode` specified in the spicepod, or `full`.","type":"string","enum":["disabled","full","append","changes","caching"],"title":"RefreshMode"}]},"refresh_sql":{"type":["string","null"],"description":"The SQL statement used for this refresh. Defaults to the `refresh_sql` specified in the spicepod, if any."}},"title":"RefreshOverrides"},"example":{"refresh_sql":"SELECT * FROM taxi_trips WHERE tip_amount > 10.0","refresh_mode":"full","refresh_jitter_max":"10s"}}},"required":true}}
62>
63
64</RequestSchema>
65
66<StatusCodes
67 id={undefined}
68 label={undefined}
69 responses={{"201":{"description":"Dataset refresh triggered successfully","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset refresh triggered for taxi_trips."}}}},"400":{"description":"Acceleration not enabled for the dataset","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset taxi_trips does not have acceleration enabled"}}}},"404":{"description":"Dataset not found","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset taxi_trips not found"}}}},"500":{"description":"Internal server error occurred while processing refresh","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Unexpected internal error occurred while processing refresh"}}}}}}
70>
71
72</StatusCodes>
73
74
75
1---
2id: post-dataset-refresh
3title: "Refresh Dataset"
4description: "Trigger an on-demand refresh for an accelerated dataset."
5sidebar_label: "Refresh Dataset"
6hide_title: true
7hide_table_of_contents: true
8api: eJzlV9tuGzcQ/RWCQIGkWOsSpECrhwJp4qIBErhxHPTBEbT0cqRlwiVpcla2Iey/F0NSu5LXdZL2rdGLJHI4nDlz5sIdR7EJfHHJXwkUATDwZcElhMorh8oavuAXXm024JkwzJoTCY0wknlYewg1W9u4IaoKNHiBIJlMmiYfzUdzUavAwEhnlUGGSVP4F6ouaugFrdF3TDinFQSGlpXrVuuSka5SOAdGlr1sYyUE9sRYZGVVC7OBUMbFpxNecOvoImXNa8kX3NmAq3zlKivgBXfCiwYQPOG040Y0wBfpq+CKEHICSfAebDUwEmJ2zbCGvS9kcNZNFni4bpUHyRfoWyh4qGpoBF/sON45uiegV2bDu26ZhCHgb1bekcTxfWcjQLN4ApYFB5Vaq6oHlRe8sgbBICmLeFYRjOmnQBp3Y2Ps1SeocOTqZXmerjzbgvdKQiiX+/soRDWwypq12rReXGlgNh4M2TBlpNoq2QrNfGsILtG7gCJ8JkOdp1ChgkDW5N3VJ4UIftWI28HGyz1iBTet1g/QuQbWiFvVtA0TjW0N0pVJFQVHSElfOBBuwl7BWrQaw36jHFtQ9g5LpkyUCk5V4KwsmPVsPvthz4T+dFVD9XmlDILfCl2So3ArGqcJ6/ks8K7ofSXOkpfWwNk6EjHHJHrZFffpcJgwdJZMbwNEzJGy8svO0bEvuZVyjyw/5mvBwbQNhUOqQEGXvOAkywuecpTolxKSfomqpmPLgqPC6H+m1Fvyu1seIBGu9TeG+/27NyygQGjAIKEgvwWGcK0fRUGtmTB3E951I+P7fKBI9qHdHbvC35++OX15wX5kv5+fvWUobtUKvXKB/fXH6fkpQ+VWmai/svlsMuP3WbEH9qG8SDzquvulJi4EZ01IOfVsNh/XlNwUhnRMBRwkC21VQQh08d1/KSSDUZe8gRDEBiiGx/m+3xhVxQdzOwmztHOlzCbncmg17lMwl8ajmL1NB88zKvdC1tvwCCiRVH34iBGk//lsNkb2xb7LKWsYdScwMUsyMft28Z1ie5AE0kKICNViC8N0QLhlzHqcn/8zg0nB2rap7HzfgA5QJNx+eoifr6kpGaFZAL8Fz8B765mtqtYT029qpYE5b6kIkNXDuPQ9ofvBwK2DCmNbyIB9LVJdQr8BrO1++ozTJtZ8wafb+TSXgDDd0RzZTQ+5Px0ATxFKw2nrqaHUiG4xnWpbCV3bgIufZ7/MRgi9oW0mYQvautgZk6YJe5mHNWA3CmtWnpyQxnLCaQgNULVe4V28Tzi1+gz0e0l7FOTzYUg9HXe8UWsa9TJz3MtSi9xPwTRwr22Mfg6Vbw2qOIqP4x97tGSDiFYVUDwX/Rj/womqhpNnsasqCQapy/vjna7ghHBSPJ/M55PZSWsCUvWhTQpdI8yB2tz/2au+ih9Ztxuy5P/8vMoZinCLU6eFMgRWpOgu8/ySb+cEzv7xWfBFflgdkn2gAxUEYjSd3O2uRIAPXncdLV+34CMRC74VXsXYEEX7+XOxFjrAI5F4cp4r0FP2dY+3B/3Li8LQXLQVuqV/vOAxTRI/4jhbg5BEtMtd3nqZDDm5IAXD0VERpVk/naAhwuGjssuDCvPn2fsLXvCr/HzM+ebFDeErbpKZ+W0Wc5bWdlwLs2lTvUs66fM3sES38Q==
9sidebar_class_name: "post api-method"
10info_path: docs/api/HTTP/runtime
11custom_edit_url: null
12proxy: http://localhost:8090
13---
14
15import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
16import ParamsDetails from "@theme/ParamsDetails";
17import RequestSchema from "@theme/RequestSchema";
18import StatusCodes from "@theme/StatusCodes";
19import OperationTabs from "@theme/OperationTabs";
20import TabItem from "@theme/TabItem";
21import Heading from "@theme/Heading";
22
23<Heading
24 as={"h1"}
25 className={"openapi__heading"}
26 children={"Refresh Dataset"}
27>
28</Heading>
29
30<MethodEndpoint
31 method={"post"}
32 path={"/v1/datasets/{name}/acceleration/refresh"}
33 context={"endpoint"}
34>
35
36</MethodEndpoint>
37
38
39
40Trigger an on-demand refresh for an accelerated dataset.
41
42This endpoint triggers an on-demand refresh for an accelerated dataset.
43The refresh only applies to `full` and `append` refresh modes (not `changes` mode).
44
45<Heading
46 id={"request"}
47 as={"h2"}
48 className={"openapi-tabs__heading"}
49 children={"Request"}
50>
51</Heading>
52
53<ParamsDetails
54 parameters={[{"name":"name","in":"path","description":"The name of the dataset to refresh.","required":true,"schema":{"type":"string"}}]}
55>
56
57</ParamsDetails>
58
59<RequestSchema
60 title={"Body"}
61 body={{"description":"On-demand refresh request for a specific dataset.","content":{"application/json":{"schema":{"type":"object","description":"[`RefreshOverrides`] specifies the configurable options for a individual run of a refresh task.","properties":{"refresh_jitter_max":{"type":["string","null"],"description":"The maximum amount of jitter to add to the refresh. Defaults to the `refresh_jitter_max` specified in the spicepod, or 10% of the `refresh_check_interval`.","example":"10s"},"refresh_mode":{"oneOf":[{"type":"null"},{"description":"The refresh mode to use for this refresh. Defaults to the `refresh_mode` specified in the spicepod, or `full`.","type":"string","enum":["disabled","full","append","changes","caching"],"title":"RefreshMode"}]},"refresh_sql":{"type":["string","null"],"description":"The SQL statement used for this refresh. Defaults to the `refresh_sql` specified in the spicepod, if any."}},"title":"RefreshOverrides"},"example":{"refresh_sql":"SELECT * FROM taxi_trips WHERE tip_amount > 10.0","refresh_mode":"full","refresh_jitter_max":"10s"}}},"required":true}}
62>
63
64</RequestSchema>
65
66<StatusCodes
67 id={undefined}
68 label={undefined}
69 responses={{"201":{"description":"Dataset refresh triggered successfully","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset refresh triggered for taxi_trips."}}}},"400":{"description":"Acceleration not enabled for the dataset","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset taxi_trips does not have acceleration enabled"}}}},"404":{"description":"Dataset not found","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Dataset taxi_trips not found"}}}},"500":{"description":"Internal server error occurred while processing refresh","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message describing the result of the request"}},"title":"MessageResponse"},"example":{"message":"Unexpected internal error occurred while processing refresh"}}}}}}
70>
71
72</StatusCodes>
73
74
75