| |
| <!DOCTYPE html> |
| <!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]--> |
| <!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]--> |
| <!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>CREATE FUNCTION - Spark 3.0.0-preview Documentation</title> |
| |
| |
| |
| |
| <link rel="stylesheet" href="css/bootstrap.min.css"> |
| <style> |
| body { |
| padding-top: 60px; |
| padding-bottom: 40px; |
| } |
| </style> |
| <meta name="viewport" content="width=device-width"> |
| <link rel="stylesheet" href="css/bootstrap-responsive.min.css"> |
| <link rel="stylesheet" href="css/main.css"> |
| |
| <script src="js/vendor/modernizr-2.6.1-respond-1.1.0.min.js"></script> |
| |
| <link rel="stylesheet" href="css/pygments-default.css"> |
| |
| |
| <!-- Google analytics script --> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-32518208-2']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| </script> |
| |
| |
| </head> |
| <body> |
| <!--[if lt IE 7]> |
| <p class="chromeframe">You are using an outdated browser. <a href="https://browsehappy.com/">Upgrade your browser today</a> or <a href="http://www.google.com/chromeframe/?redirect=true">install Google Chrome Frame</a> to better experience this site.</p> |
| <![endif]--> |
| |
| <!-- This code is taken from http://twitter.github.com/bootstrap/examples/hero.html --> |
| |
| <div class="navbar navbar-fixed-top" id="topbar"> |
| <div class="navbar-inner"> |
| <div class="container"> |
| <div class="brand"><a href="index.html"> |
| <img src="img/spark-logo-hd.png" style="height:50px;"/></a><span class="version">3.0.0-preview</span> |
| </div> |
| <ul class="nav"> |
| <!--TODO(andyk): Add class="active" attribute to li some how.--> |
| <li><a href="index.html">Overview</a></li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Programming Guides<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="quick-start.html">Quick Start</a></li> |
| <li><a href="rdd-programming-guide.html">RDDs, Accumulators, Broadcasts Vars</a></li> |
| <li><a href="sql-programming-guide.html">SQL, DataFrames, and Datasets</a></li> |
| <li><a href="structured-streaming-programming-guide.html">Structured Streaming</a></li> |
| <li><a href="streaming-programming-guide.html">Spark Streaming (DStreams)</a></li> |
| <li><a href="ml-guide.html">MLlib (Machine Learning)</a></li> |
| <li><a href="graphx-programming-guide.html">GraphX (Graph Processing)</a></li> |
| <li><a href="sparkr.html">SparkR (R on Spark)</a></li> |
| </ul> |
| </li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="api/scala/index.html#org.apache.spark.package">Scala</a></li> |
| <li><a href="api/java/index.html">Java</a></li> |
| <li><a href="api/python/index.html">Python</a></li> |
| <li><a href="api/R/index.html">R</a></li> |
| <li><a href="api/sql/index.html">SQL, Built-in Functions</a></li> |
| </ul> |
| </li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Deploying<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="cluster-overview.html">Overview</a></li> |
| <li><a href="submitting-applications.html">Submitting Applications</a></li> |
| <li class="divider"></li> |
| <li><a href="spark-standalone.html">Spark Standalone</a></li> |
| <li><a href="running-on-mesos.html">Mesos</a></li> |
| <li><a href="running-on-yarn.html">YARN</a></li> |
| <li><a href="running-on-kubernetes.html">Kubernetes</a></li> |
| </ul> |
| </li> |
| |
| <li class="dropdown"> |
| <a href="api.html" class="dropdown-toggle" data-toggle="dropdown">More<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="configuration.html">Configuration</a></li> |
| <li><a href="monitoring.html">Monitoring</a></li> |
| <li><a href="tuning.html">Tuning Guide</a></li> |
| <li><a href="job-scheduling.html">Job Scheduling</a></li> |
| <li><a href="security.html">Security</a></li> |
| <li><a href="hardware-provisioning.html">Hardware Provisioning</a></li> |
| <li><a href="migration-guide.html">Migration Guide</a></li> |
| <li class="divider"></li> |
| <li><a href="building-spark.html">Building Spark</a></li> |
| <li><a href="https://spark.apache.org/contributing.html">Contributing to Spark</a></li> |
| <li><a href="https://spark.apache.org/third-party-projects.html">Third Party Projects</a></li> |
| </ul> |
| </li> |
| </ul> |
| <!--<p class="navbar-text pull-right"><span class="version-text">v3.0.0-preview</span></p>--> |
| </div> |
| </div> |
| </div> |
| |
| <div class="container-wrapper"> |
| |
| |
| |
| <div class="left-menu-wrapper"> |
| <div class="left-menu"> |
| <h3><a href="sql-programming-guide.html">Spark SQL Guide</a></h3> |
| |
| <ul> |
| |
| <li> |
| <a href="sql-getting-started.html"> |
| |
| Getting Started |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-data-sources.html"> |
| |
| Data Sources |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-performance-tuning.html"> |
| |
| Performance Tuning |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-distributed-sql-engine.html"> |
| |
| Distributed SQL Engine |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-pyspark-pandas-with-arrow.html"> |
| |
| PySpark Usage Guide for Pandas with Apache Arrow |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-migration-old.html"> |
| |
| Migration Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref.html"> |
| |
| SQL Reference |
| |
| </a> |
| </li> |
| |
| |
| |
| <ul> |
| |
| <li> |
| <a href="sql-ref-datatypes.html"> |
| |
| Data Types |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-null-semantics.html"> |
| |
| Null Semantics |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-nan-semantics.html"> |
| |
| NaN Semantics |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax.html"> |
| |
| SQL Syntax |
| |
| </a> |
| </li> |
| |
| |
| |
| <ul> |
| |
| <li> |
| <a href="sql-ref-syntax-ddl.html"> |
| |
| Data Definition Statements |
| |
| </a> |
| </li> |
| |
| |
| |
| <ul> |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-alter-database.html"> |
| |
| ALTER DATABASE |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-alter-table.html"> |
| |
| ALTER TABLE |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-alter-view.html"> |
| |
| ALTER VIEW |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-create-database.html"> |
| |
| CREATE DATABASE |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-create-function.html"> |
| |
| <b>CREATE FUNCTION</b> |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-create-table.html"> |
| |
| CREATE TABLE |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-create-view.html"> |
| |
| CREATE VIEW |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-drop-database.html"> |
| |
| DROP DATABASE |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-drop-function.html"> |
| |
| DROP FUNCTION |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-drop-table.html"> |
| |
| DROP TABLE |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-drop-view.html"> |
| |
| DROP VIEW |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-truncate-table.html"> |
| |
| TRUNCATE TABLE |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-ddl-repair-table.html"> |
| |
| REPAIR TABLE |
| |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-dml.html"> |
| |
| Data Manipulation Statements |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-qry.html"> |
| |
| Data Retrieval(Queries) |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-syntax-aux.html"> |
| |
| Auxilarry Statements |
| |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| |
| |
| |
| <li> |
| <a href="sql-ref-functions.html"> |
| |
| Functions |
| |
| </a> |
| </li> |
| |
| |
| |
| <li> |
| <a href="sql-ref-arithmetic-ops.html"> |
| |
| Arthmetic operations |
| |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| |
| |
| |
| </ul> |
| |
| </div> |
| </div> |
| |
| <input id="nav-trigger" class="nav-trigger" checked type="checkbox"> |
| <label for="nav-trigger"></label> |
| <div class="content-with-sidebar" id="content"> |
| |
| <h1 class="title">CREATE FUNCTION</h1> |
| |
| |
| <h3 id="description">Description</h3> |
| <p>The <code>CREATE FUNCTION</code> statement is used to create a temporary or permanent function |
| in Spark. Temporary functions are scoped at a session level where as permanent |
| functions are created in the persistent catalog and are made available to |
| all sessions. The resources specified in the <code>USING</code> clause are made available |
| to all executors when they are executed for the first time. In addition to the |
| SQL interface, spark allows users to create custom user defined scalar and |
| aggregate functions using Scala, Python and Java APIs. Please refer to |
| <a href="sql-getting-started.html#scalar-functions">scalar_functions</a> and |
| <a href="sql-getting-started#aggregations">aggregate functions</a> for more information.</p> |
| |
| <h3 id="syntax">Syntax</h3> |
| |
| <figure class="highlight"><pre><code class="language-sql" data-lang="sql"><span></span><span class="k">CREATE</span> <span class="p">[</span> <span class="k">OR</span> <span class="k">REPLACE</span> <span class="p">]</span> <span class="p">[</span> <span class="k">TEMPORARY</span> <span class="p">]</span> <span class="k">FUNCTION</span> <span class="p">[</span> <span class="k">IF</span> <span class="k">NOT</span> <span class="k">EXISTS</span> <span class="p">]</span> |
| <span class="n">function_name</span> <span class="k">AS</span> <span class="n">class_name</span> <span class="p">[</span> <span class="n">resource_locations</span> <span class="p">]</span></code></pre></figure> |
| |
| <h3 id="parameters">Parameters</h3> |
| <dl> |
| <dt><code><em>OR REPLACE</em></code></dt> |
| <dd> |
| If specified, the resources for the function are reloaded. This is mainly useful |
| to pick up any changes made to the implementation of the function. This |
| parameter is mutually exclusive to <code>IF NOT EXISTS</code> and can not |
| be specified together. |
| </dd> |
| <dt><code><em>TEMPORARY</em></code></dt> |
| <dd> |
| Indicates the scope of function being created. When <code>TEMPORARY</code> is specified, the |
| created function is valid and visible in the current session. No persistent |
| entry is made in the catalog for these kind of functions. |
| </dd> |
| <dt><code><em>IF NOT EXISTS</em></code></dt> |
| <dd> |
| If specified, creates the function only when it does not exist. The creation |
| of function succeeds (no error is thrown) if the specified function already |
| exists in the system. This parameter is mutually exclusive to <code> OR REPLACE</code> |
| and can not be specified together. |
| </dd> |
| <dt><code><em>function_name</em></code></dt> |
| <dd> |
| Specifies a name of funnction to be created. The function name may be |
| optionally qualified with a database name. <br /><br /> |
| <b>Syntax:</b> |
| <code> |
| [database_name.]function_name |
| </code> |
| </dd> |
| <dt><code><em>class_name</em></code></dt> |
| <dd> |
| Specifies the name of the class that provides the implementation for function to be created. |
| The implementing class should extend one of the base classes as follows: |
| <ul> |
| <li>Should extend <code>UDF</code> or <code>UDAF</code> in <code>org.apache.hadoop.hive.ql.exec</code> package.</li> |
| <li>Should extend <code>AbstractGenericUDAFResolver</code>, <code>GenericUDF</code>, or |
| <code>GenericUDTF</code> in <code>org.apache.hadoop.hive.ql.udf.generic</code> package.</li> |
| <li>Should extend <code>UserDefinedAggregateFunction</code> in <code>org.apache.spark.sql.expressions</code> package.</li> |
| </ul> |
| </dd> |
| <dt><code><em>resource_locations</em></code></dt> |
| <dd> |
| Specifies the list of resources that contain the implementation of the function |
| along with its dependencies. <br /><br /> |
| <b>Syntax:</b> |
| <code> |
| USING { { (JAR | FILE ) resource_uri} , ...} |
| </code> |
| </dd> |
| </dl> |
| |
| <h3 id="examples">Examples</h3> |
| |
| <figure class="highlight"><pre><code class="language-sql" data-lang="sql"><span></span><span class="c1">-- 1. Create a simple UDF `SimpleUdf` that increments the supplied integral value by 10.</span> |
| <span class="c1">-- import org.apache.hadoop.hive.ql.exec.UDF;</span> |
| <span class="c1">-- public class SimpleUdf extends UDF {</span> |
| <span class="c1">-- public int evaluate(int value) {</span> |
| <span class="c1">-- return value + 10;</span> |
| <span class="c1">-- }</span> |
| <span class="c1">-- }</span> |
| <span class="c1">-- 2. Compile and place it in a JAR file called `SimpleUdf.jar` in /tmp.</span> |
| |
| <span class="c1">-- Create a table called `test` and insert two rows.</span> |
| <span class="k">CREATE</span> <span class="k">TABLE</span> <span class="n">test</span><span class="p">(</span><span class="n">c1</span> <span class="nb">INT</span><span class="p">);</span> |
| <span class="k">INSERT</span> <span class="k">INTO</span> <span class="n">test</span> <span class="k">VALUES</span> <span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="p">(</span><span class="mi">2</span><span class="p">);</span> |
| |
| <span class="c1">-- Create a permanent function called `simple_udf`. </span> |
| <span class="k">CREATE</span> <span class="k">FUNCTION</span> <span class="n">simple_udf</span> <span class="k">AS</span> <span class="s1">'SimpleUdf'</span> |
| <span class="k">USING</span> <span class="n">JAR</span> <span class="s1">'/tmp/SimpleUdf.jar'</span><span class="p">;</span> |
| |
| <span class="c1">-- Verify that the function is in the registry.</span> |
| <span class="k">SHOW</span> <span class="k">USER</span> <span class="n">FUNCTIONS</span><span class="p">;</span> |
| <span class="o">+</span><span class="c1">------------------+</span> |
| <span class="o">|</span> <span class="k">function</span><span class="o">|</span> |
| <span class="o">+</span><span class="c1">------------------+</span> |
| <span class="o">|</span><span class="k">default</span><span class="p">.</span><span class="n">simple_udf</span><span class="o">|</span> |
| <span class="o">+</span><span class="c1">------------------+</span> |
| |
| <span class="c1">-- Invoke the function. Every selected value should be incremented by 10.</span> |
| <span class="k">SELECT</span> <span class="n">simple_udf</span><span class="p">(</span><span class="n">c1</span><span class="p">)</span> <span class="k">AS</span> <span class="n">function_return_value</span> <span class="k">FROM</span> <span class="n">t1</span><span class="p">;</span> |
| <span class="o">+</span><span class="c1">---------------------+ </span> |
| <span class="o">|</span><span class="n">function_return_value</span><span class="o">|</span> |
| <span class="o">+</span><span class="c1">---------------------+</span> |
| <span class="o">|</span> <span class="mi">11</span><span class="o">|</span> |
| <span class="o">|</span> <span class="mi">12</span><span class="o">|</span> |
| <span class="o">+</span><span class="c1">---------------------+</span> |
| |
| <span class="c1">-- Created a temporary function.</span> |
| <span class="k">CREATE</span> <span class="k">TEMPORARY</span> <span class="k">FUNCTION</span> <span class="n">simple_temp_udf</span> <span class="k">AS</span> <span class="s1">'SimpleUdf'</span> |
| <span class="k">USING</span> <span class="n">JAR</span> <span class="s1">'/tmp/SimpleUdf.jar'</span><span class="p">;</span> |
| |
| <span class="c1">-- Verify that the newly created temporary function is in the registry.</span> |
| <span class="c1">-- Please note that the temporary function does not have a qualified</span> |
| <span class="c1">-- database associated with it.</span> |
| <span class="k">SHOW</span> <span class="k">USER</span> <span class="n">FUNCTIONS</span><span class="p">;</span> |
| <span class="o">+</span><span class="c1">------------------+</span> |
| <span class="o">|</span> <span class="k">function</span><span class="o">|</span> |
| <span class="o">+</span><span class="c1">------------------+</span> |
| <span class="o">|</span><span class="k">default</span><span class="p">.</span><span class="n">simple_udf</span><span class="o">|</span> |
| <span class="o">|</span> <span class="n">simple_temp_udf</span><span class="o">|</span> |
| <span class="o">+</span><span class="c1">------------------+</span> |
| |
| <span class="c1">-- 1. Modify `SimpleUdf`'s implementation to add supplied integral value by 20.</span> |
| <span class="c1">-- import org.apache.hadoop.hive.ql.exec.UDF;</span> |
| |
| <span class="c1">-- public class SimpleUdfR extends UDF {</span> |
| <span class="c1">-- public int evaluate(int value) {</span> |
| <span class="c1">-- return value + 20;</span> |
| <span class="c1">-- }</span> |
| <span class="c1">-- }</span> |
| <span class="c1">-- 2. Compile and place it in a jar file called `SimpleUdfR.jar` in /tmp.</span> |
| |
| <span class="c1">-- Replace the implementation of `simple_udf`</span> |
| <span class="k">CREATE</span> <span class="k">OR</span> <span class="k">REPLACE</span> <span class="k">FUNCTION</span> <span class="n">simple_udf</span> <span class="k">AS</span> <span class="s1">'SimpleUdfR'</span> |
| <span class="k">USING</span> <span class="n">JAR</span> <span class="s1">'/tmp/SimpleUdfR.jar'</span><span class="p">;</span> |
| |
| <span class="c1">-- Invoke the function. Every selected value should be incremented by 20.</span> |
| <span class="k">SELECT</span> <span class="n">simple_udf</span><span class="p">(</span><span class="n">c1</span><span class="p">)</span> <span class="k">AS</span> <span class="n">function_return_value</span> <span class="k">FROM</span> <span class="n">t1</span><span class="p">;</span> |
| <span class="o">+</span><span class="c1">---------------------+ </span> |
| <span class="o">|</span><span class="n">function_return_value</span><span class="o">|</span> |
| <span class="o">+</span><span class="c1">---------------------+</span> |
| <span class="o">|</span> <span class="mi">21</span><span class="o">|</span> |
| <span class="o">|</span> <span class="mi">22</span><span class="o">|</span> |
| <span class="o">+</span><span class="c1">---------------------+</span></code></pre></figure> |
| |
| <h3 id="related-statements">Related statements</h3> |
| <ul> |
| <li><a href="sql-ref-syntax-aux-show-functions.html">SHOW FUNCTIONS</a></li> |
| <li><a href="sql-ref-syntax-aux-describe-function.html">DESCRIBE FUNCTION</a></li> |
| <li><a href="sql-ref-syntax-ddl-drop-function.html">DROP FUNCTION</a></li> |
| </ul> |
| |
| |
| </div> |
| |
| <!-- /container --> |
| </div> |
| |
| <script src="js/vendor/jquery-3.4.1.min.js"></script> |
| <script src="js/vendor/bootstrap.min.js"></script> |
| <script src="js/vendor/anchor.min.js"></script> |
| <script src="js/main.js"></script> |
| |
| <!-- MathJax Section --> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| TeX: { equationNumbers: { autoNumber: "AMS" } } |
| }); |
| </script> |
| <script> |
| // Note that we load MathJax this way to work with local file (file://), HTTP and HTTPS. |
| // We could use "//cdn.mathjax...", but that won't support "file://". |
| (function(d, script) { |
| script = d.createElement('script'); |
| script.type = 'text/javascript'; |
| script.async = true; |
| script.onload = function(){ |
| MathJax.Hub.Config({ |
| tex2jax: { |
| inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], |
| displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], |
| processEscapes: true, |
| skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'] |
| } |
| }); |
| }; |
| script.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + |
| 'cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js' + |
| '?config=TeX-AMS-MML_HTMLorMML'; |
| d.getElementsByTagName('head')[0].appendChild(script); |
| }(document)); |
| </script> |
| </body> |
| </html> |
