spark-instrumented-optimizer/docs/sql-ref-syntax-aux-resource-mgmt-list-archive.md
Kousuke Saruta 2fd85174e9 [SPARK-34603][SQL] Support ADD ARCHIVE and LIST ARCHIVES command
### What changes were proposed in this pull request?

This PR adds `ADD ARCHIVE` and `LIST ARCHIVES` commands to SQL and updates relevant documents.
SPARK-33530 added `addArchive` and `listArchives` to `SparkContext` but it's not supported yet to add/list archives with SQL.

### Why are the changes needed?

To complement features.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Added new test and confirmed the generated HTML from the updated documents.

Closes #31721 from sarutak/sql-archive.

Authored-by: Kousuke Saruta <sarutak@oss.nttdata.com>
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
2021-03-09 21:28:35 +09:00

1.6 KiB

layout title displayTitle license
global LIST ARCHIVE LIST ARCHIVE Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Description

LIST ARCHIVE lists the archives added by ADD ARCHIVE.

Syntax

LIST { ARCHIVE | ARCHIVES } file_name [ ... ]

Examples

ADD ARCHIVE /tmp/test.zip;
ADD ARCHIVE /tmp/test_2.tar.gz;
LIST ARCHIVE;
-- output for LIST ARCHIVE
file:/tmp/test.zip
file:/tmp/test_2.tar.gz

LIST ARCHIVE /tmp/test.zip /some/random.tgz /another/random.tar;
-- output
file:/tmp/test.zip