com.questdb.griffin.FunctionFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of questdb-core Show documentation

QuestDB is High Performance Time Series Database

The newest version!

/*******************************************************************************
 *    ___                  _   ____  ____
 *   / _ \ _   _  ___  ___| |_|  _ \| __ )
 *  | | | | | | |/ _ \/ __| __| | | |  _ \
 *  | |_| | |_| |  __/\__ \ |_| |_| | |_) |
 *   \__\_\\__,_|\___||___/\__|____/|____/
 *
 * Copyright (C) 2014-2019 Appsicle
 *
 * This program is free software: you can redistribute it and/or  modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 *
 ******************************************************************************/

package com.questdb.griffin;

import com.questdb.cairo.CairoConfiguration;
import com.questdb.cairo.sql.Function;
import com.questdb.std.ObjList;

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
     * C = cursor
     * 
     *
     * @return signature, for example "substr(SII)"
     */
    String getSignature();

    default boolean isGroupBy() {
        return false;
    }

    Function newInstance(ObjList args, int position, CairoConfiguration configuration) throws SqlException;
}