io.questdb.griffin.FunctionFactory Maven / Gradle / Ivy
/*******************************************************************************
* ___ _ ____ ____
* / _ \ _ _ ___ ___| |_| _ \| __ )
* | | | | | | |/ _ \/ __| __| | | | _ \
* | |_| | |_| | __/\__ \ |_| |_| | |_) |
* \__\_\\__,_|\___||___/\__|____/|____/
*
* Copyright (c) 2014-2019 Appsicle
* Copyright (c) 2019-2020 QuestDB
*
* Licensed 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.
*
******************************************************************************/
package io.questdb.griffin;
import io.questdb.cairo.CairoConfiguration;
import io.questdb.cairo.sql.Function;
import io.questdb.std.ObjList;
import io.questdb.std.Transient;
public interface FunctionFactory {
/**
* Function signature in a form of "name(type...)". Name is a literal that does not
* start with number and contains no control characters, which can be confused with
* SQL language punctuation. Control characters include but not limited to:
* ',', '(', ')', '*', '/', '%', '+', '-', '='.
*
* Argument types are represented by single character from this table:
*
* - B = byte
* - E = short
* - I = int
* - L = long
* - F = float
* - D = double
* - S = string
* - A = char
* - K = symbol
* - T = boolean
* - M = date
* - N = timestamp
* - U = binary
* - V = variable argument list
* - R = record
* - H = long256
*
*
* Lower-case letters will require arguments to be constant expressions. Upper-case letters allow both constant and
* variable expressions.
*
* @return signature, for example "substr(SII)"
*/
String getSignature();
default boolean isGroupBy() {
return false;
}
default boolean isCursor() {
return false;
}
default boolean isBoolean() {
return false;
}
Function newInstance(
@Transient ObjList args,
int position,
CairoConfiguration configuration,
SqlExecutionContext sqlExecutionContext
) throws SqlException;
}