Skip to content

Commit a9930a1

Browse files
committed
[SPARK-30363]Add Documentation for refresh resources.
1 parent a2de20c commit a9930a1

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

docs/_data/menu-sql.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,8 @@
216216
url: sql-ref-syntax-aux-resource-mgmt-list-file.html
217217
- text: LIST JAR
218218
url: sql-ref-syntax-aux-resource-mgmt-list-jar.html
219+
- text: REFRESH
220+
url: sql-ref-syntax-aux-resource-mgmt-refresh.md
219221
- text: Functions
220222
url: sql-ref-functions.html
221223
subitems:
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: global
3+
title: REFRESH
4+
displayTitle: REFRESH
5+
license: |
6+
Licensed to the Apache Software Foundation (ASF) under one or more
7+
contributor license agreements. See the NOTICE file distributed with
8+
this work for additional information regarding copyright ownership.
9+
The ASF licenses this file to You under the Apache License, Version 2.0
10+
(the "License"); you may not use this file except in compliance with
11+
the License. You may obtain a copy of the License at
12+
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
15+
Unless required by applicable law or agreed to in writing, software
16+
distributed under the License is distributed on an "AS IS" BASIS,
17+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
See the License for the specific language governing permissions and
19+
limitations under the License.
20+
---
21+
22+
### Description
23+
`REFRESH` is used to invalidate and refresh all the cached data (and the associated metadata) for
24+
all Dataset, that contains the given data source path. Path matching is by prefix, i.e. "/" would
25+
invalidate everything that is cached.
26+
27+
### Syntax
28+
{% highlight sql %}
29+
REFRESH resource_name
30+
{% endhighlight %}
31+
32+
### Parameters
33+
<dl>
34+
<dt><code><em>resource_name</em></code></dt>
35+
<dd>The path of the resource that is to be refreshed.</dd>
36+
</dl>
37+
38+
### Examples
39+
{% highlight sql %}
40+
REFRESH /tmp/test.jar;
41+
REFRESH "/tmp/test.txt";
42+
REFRESH '/tmp/test.txt';
43+
{% endhighlight %}
44+
45+
### Related Statements
46+
* [LIST JAR](sql-ref-syntax-aux-resource-mgmt-list-jar.html)
47+
* [ADD FILE](sql-ref-syntax-aux-resource-mgmt-add-file.html)
48+
* [LIST FILE](sql-ref-syntax-aux-resource-mgmt-list-file.html)
49+
* [ADD JAR](sql-ref-syntax-aux-resource-mgmt-add-jar.html)

0 commit comments

Comments
 (0)