SqlLibrary (Apache Calcite API)

java.lang.Object
- java.lang.Enum<SqlLibrary>
- - org.apache.calcite.sql.fun.SqlLibrary

All Implemented Interfaces:

Serializable, Comparable<SqlLibrary>
```
public enum SqlLibrary
extends Enum<SqlLibrary>
```
A library is a collection of SQL functions and operators.
Typically, such collections are associated with a particular dialect or database. For example, ORACLE is a collection of functions that are in the Oracle database but not the SQL standard.
In SqlLibraryOperatorTableFactory 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.

See Also:

LibraryOperator

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BIG_QUERY` A collection of operators that are in Google BigQuery but not in standard SQL.
`HIVE` A collection of operators that are in Apache Hive but not in standard SQL.
`MYSQL` A collection of operators that are in MySQL but not in standard SQL.
`ORACLE` A collection of operators that are in Oracle but not in standard SQL.
`POSTGRESQL` A collection of operators that are in PostgreSQL but not in standard SQL.
`SPARK` A collection of operators that are in Apache Spark but not in standard SQL.
`SPATIAL` Geospatial operators.
`STANDARD` The standard operators.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`abbrev` Abbreviation for the library used in SQL reference.
`String`	`fun` Name of this library when it appears in the connect string; see `CalciteConnectionProperty.FUN`.
`static Map<String,SqlLibrary>`	`MAP`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static @Nullable SqlLibrary`	`of(String name)` Looks up a value.
`static List<SqlLibrary>`	`parse(String libraryNameList)` Parses a comma-separated string such as "standard,oracle".
`static SqlLibrary`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SqlLibrary[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - STANDARD
```
public static final SqlLibrary STANDARD
```
    The standard operators.
  - SPATIAL
```
public static final SqlLibrary SPATIAL
```
    Geospatial operators.
  - BIG_QUERY
```
public static final SqlLibrary BIG_QUERY
```
    A collection of operators that are in Google BigQuery but not in standard SQL.
  - HIVE
```
public static final SqlLibrary HIVE
```
    A collection of operators that are in Apache Hive but not in standard SQL.
  - MYSQL
```
public static final SqlLibrary MYSQL
```
    A collection of operators that are in MySQL but not in standard SQL.
  - ORACLE
```
public static final SqlLibrary ORACLE
```
    A collection of operators that are in Oracle but not in standard SQL.
  - POSTGRESQL
```
public static final SqlLibrary POSTGRESQL
```
    A collection of operators that are in PostgreSQL but not in standard SQL.
  - SPARK
```
public static final SqlLibrary SPARK
```
    A collection of operators that are in Apache Spark but not in standard SQL.
- Field Detail
  - abbrev
```
public final String abbrev
```
    Abbreviation for the library used in SQL reference.
  - fun
```
public final String fun
```
    Name of this library when it appears in the connect string; see CalciteConnectionProperty.FUN.
  - MAP
```
public static final Map<String,SqlLibrary> MAP
```
- Method Detail
  - values
```
public static SqlLibrary[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SqlLibrary c : SqlLibrary.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SqlLibrary valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - of
```
public static @Nullable SqlLibrary of(String name)
```
    Looks up a value. Returns null if not found. You can use upper- or lower-case name.
  - parse
```
public static List<SqlLibrary> parse(String libraryNameList)
```
    Parses a comma-separated string such as "standard,oracle".

Enum SqlLibrary

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STANDARD

SPATIAL

BIG_QUERY

HIVE

MYSQL

ORACLE

POSTGRESQL

SPARK

Field Detail

abbrev

fun

MAP

Method Detail

values

valueOf

of

parse