site/docs/3.0.2/sql-ref-functions.html - spark-website - Git at Google


 <!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>Functions - Spark 3.0.2 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.2</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/org/apache/spark/index.html">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.2</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-ansi-compliance.html">

                 ANSI Compliance

         </a>
     </li>


     <li>
         <a href="sql-ref-datatypes.html">

                 Data Types

         </a>
     </li>


     <li>
         <a href="sql-ref-datetime-pattern.html">

                 Datetime Pattern

         </a>
     </li>


     <li>
         <a href="sql-ref-functions.html">

                 <b>Functions</b>

         </a>
     </li>


 <ul>

     <li>
         <a href="sql-ref-functions-builtin.html">

                 Built-in Functions

         </a>
     </li>


     <li>
         <a href="sql-ref-functions-udf-scalar.html">

                 Scalar UDFs (User-Defined Functions)

         </a>
     </li>


     <li>
         <a href="sql-ref-functions-udf-aggregate.html">

                 UDAFs (User-Defined Aggregate Functions)

         </a>
     </li>


     <li>
         <a href="sql-ref-functions-udf-hive.html">

                 Integration with Hive UDFs/UDAFs/UDTFs

         </a>
     </li>


 </ul>


     <li>
         <a href="sql-ref-identifier.html">

                 Identifiers

         </a>
     </li>


     <li>
         <a href="sql-ref-literals.html">

                 Literals

         </a>
     </li>


     <li>
         <a href="sql-ref-null-semantics.html">

                 Null Semantics

         </a>
     </li>


     <li>
         <a href="sql-ref-syntax.html">

                 SQL Syntax

         </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">Functions</h1>


                     <p>Spark SQL provides two function features to meet a wide range of user needs: built-in functions and user-defined functions (UDFs).
 Built-in functions are commonly used routines that Spark SQL predefines and a complete list of the functions can be found in the <a href="api/sql/">Built-in Functions</a> API document. UDFs allow users to define their own functions when the system’s built-in functions are not enough to perform the desired task.</p>

 <h3 id="built-in-functions">Built-in Functions</h3>

 <p>Spark SQL has some categories of frequently-used built-in functions for aggregation, arrays/maps, date/timestamp, and JSON data.
 This subsection presents the usages and descriptions of these functions.</p>

 <h4 id="scalar-functions">Scalar Functions</h4>
 <ul>
   <li><a href="sql-ref-functions-builtin.html#array-functions">Array Functions</a></li>
   <li><a href="sql-ref-functions-builtin.html#map-functions">Map Functions</a></li>
   <li><a href="sql-ref-functions-builtin.html#date-and-timestamp-functions">Date and Timestamp Functions</a></li>
   <li><a href="sql-ref-functions-builtin.html#json-functions">JSON Functions</a></li>
 </ul>

 <h4 id="aggregate-like-functions">Aggregate-like Functions</h4>
 <ul>
   <li><a href="sql-ref-functions-builtin.html#aggregate-functions">Aggregate Functions</a></li>
   <li><a href="sql-ref-functions-builtin.html#window-functions">Window Functions</a></li>
 </ul>

 <h3 id="udfs-user-defined-functions">UDFs (User-Defined Functions)</h3>

 <p>User-Defined Functions (UDFs) are a feature of Spark SQL that allows users to define their own functions when the system&#8217;s built-in functions are not enough to perform the desired task. To use UDFs in Spark SQL, users must first define the function, then register the function with Spark, and finally call the registered function. The User-Defined Functions can act on a single row or act on multiple rows at once. Spark SQL also supports integration of existing Hive implementations of UDFs, UDAFs and UDTFs.</p>

 <ul>
   <li><a href="sql-ref-functions-udf-scalar.html">Scalar User-Defined Functions (UDFs)</a></li>
   <li><a href="sql-ref-functions-udf-aggregate.html">User-Defined Aggregate Functions (UDAFs)</a></li>
   <li><a href="sql-ref-functions-udf-hive.html">Integration with Hive UDFs/UDAFs/UDTFs</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>

	<!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>Functions - Spark 3.0.2 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.2</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/org/apache/spark/index.html">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.2</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-ansi-compliance.html">

	ANSI Compliance

	</a>
	</li>



	<li>
	<a href="sql-ref-datatypes.html">

	Data Types

	</a>
	</li>



	<li>
	<a href="sql-ref-datetime-pattern.html">

	Datetime Pattern

	</a>
	</li>



	<li>
	<a href="sql-ref-functions.html">

	<b>Functions</b>

	</a>
	</li>



	<ul>

	<li>
	<a href="sql-ref-functions-builtin.html">

	Built-in Functions

	</a>
	</li>



	<li>
	<a href="sql-ref-functions-udf-scalar.html">

	Scalar UDFs (User-Defined Functions)

	</a>
	</li>



	<li>
	<a href="sql-ref-functions-udf-aggregate.html">

	UDAFs (User-Defined Aggregate Functions)

	</a>
	</li>



	<li>
	<a href="sql-ref-functions-udf-hive.html">

	Integration with Hive UDFs/UDAFs/UDTFs

	</a>
	</li>



	</ul>



	<li>
	<a href="sql-ref-identifier.html">

	Identifiers

	</a>
	</li>



	<li>
	<a href="sql-ref-literals.html">

	Literals

	</a>
	</li>



	<li>
	<a href="sql-ref-null-semantics.html">

	Null Semantics

	</a>
	</li>



	<li>
	<a href="sql-ref-syntax.html">

	SQL Syntax

	</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">Functions</h1>


	<p>Spark SQL provides two function features to meet a wide range of user needs: built-in functions and user-defined functions (UDFs).
	Built-in functions are commonly used routines that Spark SQL predefines and a complete list of the functions can be found in the <a href="api/sql/">Built-in Functions</a> API document. UDFs allow users to define their own functions when the system’s built-in functions are not enough to perform the desired task.</p>

	<h3 id="built-in-functions">Built-in Functions</h3>

	<p>Spark SQL has some categories of frequently-used built-in functions for aggregation, arrays/maps, date/timestamp, and JSON data.
	This subsection presents the usages and descriptions of these functions.</p>

	<h4 id="scalar-functions">Scalar Functions</h4>
	<ul>
	<li><a href="sql-ref-functions-builtin.html#array-functions">Array Functions</a></li>
	<li><a href="sql-ref-functions-builtin.html#map-functions">Map Functions</a></li>
	<li><a href="sql-ref-functions-builtin.html#date-and-timestamp-functions">Date and Timestamp Functions</a></li>
	<li><a href="sql-ref-functions-builtin.html#json-functions">JSON Functions</a></li>
	</ul>

	<h4 id="aggregate-like-functions">Aggregate-like Functions</h4>
	<ul>
	<li><a href="sql-ref-functions-builtin.html#aggregate-functions">Aggregate Functions</a></li>
	<li><a href="sql-ref-functions-builtin.html#window-functions">Window Functions</a></li>
	</ul>

	<h3 id="udfs-user-defined-functions">UDFs (User-Defined Functions)</h3>

	<p>User-Defined Functions (UDFs) are a feature of Spark SQL that allows users to define their own functions when the system’s built-in functions are not enough to perform the desired task. To use UDFs in Spark SQL, users must first define the function, then register the function with Spark, and finally call the registered function. The User-Defined Functions can act on a single row or act on multiple rows at once. Spark SQL also supports integration of existing Hive implementations of UDFs, UDAFs and UDTFs.</p>

	<ul>
	<li><a href="sql-ref-functions-udf-scalar.html">Scalar User-Defined Functions (UDFs)</a></li>
	<li><a href="sql-ref-functions-udf-aggregate.html">User-Defined Aggregate Functions (UDAFs)</a></li>
	<li><a href="sql-ref-functions-udf-hive.html">Integration with Hive UDFs/UDAFs/UDTFs</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>