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/RWCQIGkWOsSpECjhwJp7KIBErh1HPTBMbT0cqSlwyVpcla2Iey/F0NSu5LXdZL2rdGLJHI4nDlz5sItR7EOfHHBjwWKABj4ZcElhMorh8oavuDnXq3X4JkwzJojCY0wknlYeQg1W9m4IaoKNHiBIJlMmiafzCdzXqvAwEhnlUGGSVP4F6rOa+gFrdH3TDinFQSGlpWrVuuSka5SOAdGlr1sYyUE9sxYZGVVC7OGUMbF5xNecOvoImXNW8kX3NmAy3zlMivgBXfCiwYQPOG05UY0wBfpq+CKEHICSfABbDUwEmJ2xbCGnS9kcNZNFni4aZUHyRfoWyh4qGpoBF9sOd47uiegV2bNu+4yCUPAX628J4nD+05HgGbxBCwLDiq1UlUPKi94ZQ2CQVIW8awiGNPrQBq3Y2Ps1TVUOHL1ojxLV55uwHslIZSXu/soRDWwypqVWrdeXGlgNh4M2TBlpNoo2QrNfGsILtG7gCJ8JkOdp1ChgkDW5N3ltUIEv2zE3WDjxQ6xgptW60foXANrxJ1q2oaJxrYG6cqkioIjpKQvHAg3YcewEq3GsNsoxxaUvcOSKROlglMVOCsLZj2bz37YMaE/XdVQfV4qg+A3QpfkKNyJxmnCej4LvCt6X4mz5KU1cLqKRMwxiV52xUM67CcMnSXT2wARc6Ss/LJzdOxLbqXcI8sP+VpwMG1D4ZAqUNAlLzjJ8oKnHCX6pYSkGKHC6HUm0nvytrvc8z/c6G8M8oc/37GAAqEBg+S7/Bbnw41+0ne1YsLcT3jXjYzvs4Di1wd0e+gK/3Dy7uTNOfuR/XZ2+p6huFNL9MoF9tfvJ2cnDJVbZnr+wuazyYw/5MIOzseyIbGn6x4WmLgQnDUhZdKL2XxcSXIrGJIwlW2QLLRVBSHQxff/pXwMRl3wBkIQa6AYHmb5bmNUCx/N6CTM0s6VMuucwaHVuEu8XBAPYvY+HTzLqDwIWW/DE6BEUvXhI0aQ/pez2RjZ17vepqxh1JPAxNzIxOybxHeK7V4SSAshIlSLDQwzAeGWMetxfvnPDCYFK9umYvN9AzpAkXD76TF+vqVWZIRmAfwGPAPvrWe2qlpPTL+tlQbmvKUiQFYPQ9L3hO5HA3cOKoxtIQP2tUh1Cf0GsLa7mTPOmFjzBZ9u5tNcAsJ0S9NjN93n/nQAPEUojaStp4ZSI7rFdKptJXRtAy5+nr2ajRB6R9tMwga0dbEzJk0T9iaPaMBuFdasPDoijeWE0+gZoGq9wvt4n3Bq+Rno9yXtUZDPhtH0ZNzxRq1p1MvMYS9LLXI3+9KYvbIx+jlUvjWo4gA+jn/s0ZINIlpVQPFc9MP7ayeqGo5exK6qJBikLu8Pd7qCE8JJ8XzyavKClihgjTB7ynLXZ8d97T6waTvkxv/5KZXzEuEOp04LZQisSMxtZvcF38wJnN1Ds+CL/Ijap/hAAioDxGM6ud1eiQAfve46Wr5pwUf6FXwjvKJ+EInZz5qLldABnojEs7Ncd56zr3uoPepfXhSGpqGN0C394wWPyZH4EYfYGoQkel1s89abZMjROSkYjo5KJ8316QSNDg6flL3cqyt/nH445wW/yk/FnGVe3BK+4jaZmd9hMVNpbcu1MOs2Vbmkkz5/AwXjsQI=
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"],"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/RWCQIGkWOsSpECjhwJp7KIBErh1HPTBMbT0cqSlwyVpcla2Iey/F0NSu5LXdZL2rdGLJHI4nDlz5sItR7EOfHHBjwWKABj4ZcElhMorh8oavuDnXq3X4JkwzJojCY0wknlYeQg1W9m4IaoKNHiBIJlMmiafzCdzXqvAwEhnlUGGSVP4F6rOa+gFrdH3TDinFQSGlpWrVuuSka5SOAdGlr1sYyUE9sxYZGVVC7OGUMbF5xNecOvoImXNW8kX3NmAy3zlMivgBXfCiwYQPOG05UY0wBfpq+CKEHICSfABbDUwEmJ2xbCGnS9kcNZNFni4aZUHyRfoWyh4qGpoBF9sOd47uiegV2bNu+4yCUPAX628J4nD+05HgGbxBCwLDiq1UlUPKi94ZQ2CQVIW8awiGNPrQBq3Y2Ps1TVUOHL1ojxLV55uwHslIZSXu/soRDWwypqVWrdeXGlgNh4M2TBlpNoo2QrNfGsILtG7gCJ8JkOdp1ChgkDW5N3ltUIEv2zE3WDjxQ6xgptW60foXANrxJ1q2oaJxrYG6cqkioIjpKQvHAg3YcewEq3GsNsoxxaUvcOSKROlglMVOCsLZj2bz37YMaE/XdVQfV4qg+A3QpfkKNyJxmnCej4LvCt6X4mz5KU1cLqKRMwxiV52xUM67CcMnSXT2wARc6Ss/LJzdOxLbqXcI8sP+VpwMG1D4ZAqUNAlLzjJ8oKnHCX6pYSkGKHC6HUm0nvytrvc8z/c6G8M8oc/37GAAqEBg+S7/Bbnw41+0ne1YsLcT3jXjYzvs4Di1wd0e+gK/3Dy7uTNOfuR/XZ2+p6huFNL9MoF9tfvJ2cnDJVbZnr+wuazyYw/5MIOzseyIbGn6x4WmLgQnDUhZdKL2XxcSXIrGJIwlW2QLLRVBSHQxff/pXwMRl3wBkIQa6AYHmb5bmNUCx/N6CTM0s6VMuucwaHVuEu8XBAPYvY+HTzLqDwIWW/DE6BEUvXhI0aQ/pez2RjZ17vepqxh1JPAxNzIxOybxHeK7V4SSAshIlSLDQwzAeGWMetxfvnPDCYFK9umYvN9AzpAkXD76TF+vqVWZIRmAfwGPAPvrWe2qlpPTL+tlQbmvKUiQFYPQ9L3hO5HA3cOKoxtIQP2tUh1Cf0GsLa7mTPOmFjzBZ9u5tNcAsJ0S9NjN93n/nQAPEUojaStp4ZSI7rFdKptJXRtAy5+nr2ajRB6R9tMwga0dbEzJk0T9iaPaMBuFdasPDoijeWE0+gZoGq9wvt4n3Bq+Rno9yXtUZDPhtH0ZNzxRq1p1MvMYS9LLXI3+9KYvbIx+jlUvjWo4gA+jn/s0ZINIlpVQPFc9MP7ayeqGo5exK6qJBikLu8Pd7qCE8JJ8XzyavKClihgjTB7ynLXZ8d97T6waTvkxv/5KZXzEuEOp04LZQisSMxtZvcF38wJnN1Ds+CL/Ijap/hAAioDxGM6ud1eiQAfve46Wr5pwUf6FXwjvKJ+EInZz5qLldABnojEs7Ncd56zr3uoPepfXhSGpqGN0C394wWPyZH4EYfYGoQkel1s89abZMjROSkYjo5KJ8316QSNDg6flL3cqyt/nH445wW/yk/FnGVe3BK+4jaZmd9hMVNpbcu1MOs2Vbmkkz5/AwXjsQI=
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"],"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