| --- |
| layout: global |
| title: ADD JAR |
| displayTitle: ADD JAR |
| license: | |
| 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 |
| |
| `ADD JAR` adds a JAR file to the list of resources. The added JAR file can be listed using [LIST JAR](sql-ref-syntax-aux-resource-mgmt-list-jar.html). |
| |
| ### Syntax |
| |
| ```sql |
| ADD { JAR | JARS } file_name [ ... ] |
| ``` |
| |
| ### Parameters |
| |
| * **file_name** |
| |
| The name of the JAR file to be added. It could be either on a local file system or a distributed file system or an Ivy URI. |
| Apache Ivy is a popular dependency manager focusing on flexibility and simplicity. Now we support two parameter in URI query string: |
| |
| * transitive: whether to download dependent jars related to your ivy URL. The parameter name is case-sensitive, and the parameter value is case-insensitive. If multiple transitive parameters are specified, the last one wins. |
| * exclude: exclusion list during downloading Ivy URI jar and dependent jars. |
| |
| User can write Ivy URI such as: |
| |
| ivy://group:module:version |
| ivy://group:module:version?transitive=[true|false] |
| ivy://group:module:version?transitive=[true|false]&exclude=group:module,group:module |
| |
| ### Examples |
| |
| ```sql |
| ADD JAR /tmp/test.jar; |
| ADD JAR "/path/to/some.jar"; |
| ADD JAR '/some/other.jar'; |
| ADD JAR "/path with space/abc.jar"; |
| ADD JARS "/path with space/def.jar" '/path with space/ghi.jar'; |
| ADD JAR "ivy://group:module:version"; |
| ADD JAR "ivy://group:module:version?transitive=false" |
| ADD JAR "ivy://group:module:version?transitive=true" |
| ADD JAR "ivy://group:module:version?exclude=group:module&transitive=true" |
| ``` |
| |
| ### Related Statements |
| |
| * [LIST JAR](sql-ref-syntax-aux-resource-mgmt-list-jar.html) |
| * [ADD FILE](sql-ref-syntax-aux-resource-mgmt-add-file.html) |
| * [LIST FILE](sql-ref-syntax-aux-resource-mgmt-list-file.html) |
| * [ADD ARCHIVE](sql-ref-syntax-aux-resource-mgmt-add-archive.html) |
| * [LIST ARCHIVE](sql-ref-syntax-aux-resource-mgmt-list-archive.html) |