javadocAggregate/org/apache/calcite/sql/fun/LibraryOperator.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>LibraryOperator (Apache Calcite API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.calcite.sql.fun, annotation type: LibraryOperator">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var pathtoroot = "../../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <div class="about-language"><b>Apache Calcite</b></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Optional&nbsp;|&nbsp;</li>
 <li><a href="#annotation-interface-required-element-summary">Required</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation-interface-element-detail">Element</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.sql.fun</a></div>
 <h1 title="Annotation Type LibraryOperator" class="title">Annotation Type LibraryOperator</h1>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
 <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#FIELD" title="class or interface in java.lang.annotation" class="external-link">FIELD</a>)
 </span><span class="modifiers">public @interface </span><span class="element-name type-name-label">LibraryOperator</span></div>
 <div class="block">An annotation that is read by <a href="SqlLibraryOperatorTableFactory.html" title="class in org.apache.calcite.sql.fun"><code>SqlLibraryOperatorTableFactory</code></a> to
  add functions and operators to a library.

  <p>Typically, such collections are associated with a particular dialect or
  database. For example, <a href="SqlLibrary.html#ORACLE"><code>SqlLibrary.ORACLE</code></a> is a collection of functions
  that are in the Oracle database but not the SQL standard.

  <p>In <a href="SqlLibraryOperatorTableFactory.html" title="class in org.apache.calcite.sql.fun"><code>SqlLibraryOperatorTableFactory</code></a> this annotation is applied to
  function definitions to include them in a particular library. It allows
  an operator to belong to more than one library.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
 <li>
 <section class="member-summary" id="annotation-interface-required-element-summary">
 <h2>Required Element Summary</h2>
 <div class="caption"><span>Required Elements</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Required Element</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code><a href="SqlLibrary.html" title="enum in org.apache.calcite.sql.fun">SqlLibrary</a>[]</code></div>
 <div class="col-second even-row-color"><code><a href="#libraries()" class="member-name-link">libraries</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">The set of libraries that this function or operator belongs to.</div>
 </div>
 </div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details" id="annotation-interface-element-detail">
 <ul class="details-list">
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <li>
 <section class="member-details">
 <h2>Element Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="libraries()">
 <h3>libraries</h3>
 <div class="member-signature"><span class="return-type"><a href="SqlLibrary.html" title="enum in org.apache.calcite.sql.fun">SqlLibrary</a>[]</span>&nbsp;<span class="element-name">libraries</span></div>
 <div class="block">The set of libraries that this function or operator belongs to.
  Must not be null or empty.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<html lang="en">
	<head>
	<!-- Generated by javadoc (17) -->
	<title>LibraryOperator (Apache Calcite API)</title>
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="description" content="declaration: package: org.apache.calcite.sql.fun, annotation type: LibraryOperator">
	<meta name="generator" content="javadoc/ClassWriterImpl">
	<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
	<script type="text/javascript" src="../../../../../script.js"></script>
	<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
	<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
	</head>
	<body class="class-declaration-page">
	<script type="text/javascript">var pathtoroot = "../../../../../";
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<div class="flex-box">
	<header role="banner" class="flex-header">
	<nav role="navigation">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="top-nav" id="navbar-top">
	<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
	<div class="about-language"><b>Apache Calcite</b></div>
	<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
	<li><a href="../../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="nav-bar-cell1-rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../../index-all.html">Index</a></li>
	<li><a href="../../../../../help-doc.html#class">Help</a></li>
	</ul>
	</div>
	<div class="sub-nav">
	<div>
	<ul class="sub-nav-list">
	<li>Summary: </li>
	<li>Field \| </li>
	<li>Optional \| </li>
	<li><a href="#annotation-interface-required-element-summary">Required</a></li>
	</ul>
	<ul class="sub-nav-list">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#annotation-interface-element-detail">Element</a></li>
	</ul>
	</div>
	<div class="nav-list-search"><label for="search-input">SEARCH:</label>
	<input type="text" id="search-input" value="search" disabled="disabled">
	<input type="reset" id="reset-button" value="reset" disabled="disabled">
	</div>
	</div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	<span class="skip-nav" id="skip-navbar-top"></span></nav>
	</header>
	<div class="flex-content">
	<main role="main">
	<!-- ======== START OF CLASS DATA ======== -->
	<div class="header">
	<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.sql.fun</a></div>
	<h1 title="Annotation Type LibraryOperator" class="title">Annotation Type LibraryOperator</h1>
	</div>
	<section class="class-description" id="class-description">
	<hr>
	<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
	<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#FIELD" title="class or interface in java.lang.annotation" class="external-link">FIELD</a>)
	</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">LibraryOperator</span></div>
	<div class="block">An annotation that is read by <a href="SqlLibraryOperatorTableFactory.html" title="class in org.apache.calcite.sql.fun"><code>SqlLibraryOperatorTableFactory</code></a> to
	add functions and operators to a library.

	<p>Typically, such collections are associated with a particular dialect or
	database. For example, <a href="SqlLibrary.html#ORACLE"><code>SqlLibrary.ORACLE</code></a> is a collection of functions
	that are in the Oracle database but not the SQL standard.

	<p>In <a href="SqlLibraryOperatorTableFactory.html" title="class in org.apache.calcite.sql.fun"><code>SqlLibraryOperatorTableFactory</code></a> this annotation is applied to
	function definitions to include them in a particular library. It allows
	an operator to belong to more than one library.</div>
	</section>
	<section class="summary">
	<ul class="summary-list">
	<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
	<li>
	<section class="member-summary" id="annotation-interface-required-element-summary">
	<h2>Required Element Summary</h2>
	<div class="caption"><span>Required Elements</span></div>
	<div class="summary-table three-column-summary">
	<div class="table-header col-first">Modifier and Type</div>
	<div class="table-header col-second">Required Element</div>
	<div class="table-header col-last">Description</div>
	<div class="col-first even-row-color"><code><a href="SqlLibrary.html" title="enum in org.apache.calcite.sql.fun">SqlLibrary</a>[]</code></div>
	<div class="col-second even-row-color"><code><a href="#libraries()" class="member-name-link">libraries</a></code></div>
	<div class="col-last even-row-color">
	<div class="block">The set of libraries that this function or operator belongs to.</div>
	</div>
	</div>
	</section>
	</li>
	</ul>
	</section>
	<section class="details" id="annotation-interface-element-detail">
	<ul class="details-list">
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<li>
	<section class="member-details">
	<h2>Element Details</h2>
	<ul class="member-list">
	<li>
	<section class="detail" id="libraries()">
	<h3>libraries</h3>
	<div class="member-signature"><span class="return-type"><a href="SqlLibrary.html" title="enum in org.apache.calcite.sql.fun">SqlLibrary</a>[]</span> <span class="element-name">libraries</span></div>
	<div class="block">The set of libraries that this function or operator belongs to.
	Must not be null or empty.</div>
	</section>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</section>
	<!-- ========= END OF CLASS DATA ========= -->
	</main>
	<footer role="contentinfo">
	<hr>
	<p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>