io.questdb.cairo.sql.Record Maven / Gradle / Ivy
/*******************************************************************************
* ___ _ ____ ____
* / _ \ _ _ ___ ___| |_| _ \| __ )
* | | | | | | |/ _ \/ __| __| | | | _ \
* | |_| | |_| | __/\__ \ |_| |_| | |_) |
* \__\_\\__,_|\___||___/\__|____/|____/
*
* Copyright (c) 2014-2019 Appsicle
* Copyright (c) 2019-2022 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.cairo.sql;
import io.questdb.std.BinarySequence;
import io.questdb.std.Long256;
import io.questdb.std.str.CharSink;
/**
* Access the value of columns of a table record by column index.
*
* Type checking is not performed beforehand, meaning the type of the
* element being retrieved by the following methods should be known by
* performing a prior lookup using {@link io.questdb.cairo.sql.RecordMetadata}
*/
public interface Record {
CharSequenceFunction GET_STR = Record::getStr;
CharSequenceFunction GET_SYM = Record::getSym;
/**
* Gets the value of a binary column by index
*
* @param col numeric index of the column
* @return the binary content
*/
default BinarySequence getBin(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the length of the binary value of a column by index
*
* @param col numeric index of the column
* @return length of the binary content
*/
default long getBinLen(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a boolean column by index
*
* @param col numeric index of the column
* @return boolean
*/
default boolean getBool(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a byte column by index
*
* @param col numeric index of the column
* @return byte as 8-bit signed integer
*/
default byte getByte(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a char column by index
*
* @param col numeric index of the column
* @return 16-bit char value
*/
default char getChar(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a date column by index
*
* @param col numeric index of the column
* @return date value of the column as 64-bit signed long integer
*/
default long getDate(int col) {
return getLong(col);
}
/**
* Gets the value of a double column by index
*
* @param col numeric index of the column
* @return 64-bit double floating point
*/
default double getDouble(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a float column by index
*
* @param col numeric index of the column
* @return 32-bit floating point value
*/
default float getFloat(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a byte GeoHash column by index
*
* @param col numeric index of the column
* @return geohash
*/
default byte getGeoByte(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of an int GeoHash column by index
*
* @param col numeric index of the column
* @return geohash
*/
default int getGeoInt(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a long GeoHash column by index
*
* @param col numeric index of the column
* @return geohash
*/
default long getGeoLong(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a short GeoHash column by index
*
* @param col numeric index of the column
* @return geohash
*/
default short getGeoShort(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of an integer column by index
*
* @param col numeric index of the column
* @return 32-bit integer
*/
default int getInt(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a long column by index
*
* @param col numeric index of the column
* @return 64-bit signed integer
*/
default long getLong(int col) {
throw new UnsupportedOperationException();
}
default long getLong128Hi(int col) {
throw new UnsupportedOperationException();
}
default long getLong128Lo(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a long256 column by index
*
* @param col numeric index of the column
* @param sink a character sink
*/
default void getLong256(int col, CharSink sink) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a long256 column by index
* getLong256A used for A/B comparison with getLong256B to compare references
*
* @param col numeric index of the column
* @return unsigned 256-bit integer
*/
default Long256 getLong256A(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a long256 column by index
* getLong256B used for A/B comparison with getLong256A to compare references
*
* @param col numeric index of the column
* @return unsigned 256-bit integer
*/
default Long256 getLong256B(int col) {
throw new UnsupportedOperationException();
}
/**
* Get record by column index
*
* @param col numeric index of the column
* @return record
*/
default Record getRecord(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the numeric ID of this row. This can be not real table row id
*
* @return numeric ID of the current row
*/
default long getRowId() {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a short column by index
*
* @param col numeric index of the column
* @return 16-bit signed integer
*/
default short getShort(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a string column by index
*
* @param col numeric index of the column
* @return string, null if string is empty
*/
default CharSequence getStr(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a string column by index
*
* @param col numeric index of the column
* @param sink a character sink
*/
default void getStr(int col, CharSink sink) {
sink.put(getStr(col));
}
/**
* Gets the value of a string column by index
* getStrB used for A/B comparison with getStr to compare references
*
* @param col numeric index of the column
* @return string, null if string is empty
*/
default CharSequence getStrB(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the length of the string value of a column by index
*
* @param col numeric index of the column
* @return length of the string value
*/
default int getStrLen(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a symbol column by index
*
* @param col numeric index of the column
* @return symbol value as string
*/
default CharSequence getSym(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the string-based value of a symbol column by index
* getSymB used for A/B comparison with getSym to compare references
*
* @param col numeric index of the column
* @return symbol value as string
*/
default CharSequence getSymB(int col) {
throw new UnsupportedOperationException();
}
/**
* Gets the value of a timestamp column by index
*
* @param col numeric index of the column
* @return 64-bit signed integer
*/
default long getTimestamp(int col) {
return getLong(col);
}
/**
* Gets the numeric ID of this row. This must be real table row id
*
* @return numeric ID of the current row
*/
default long getUpdateRowId() {
throw new UnsupportedOperationException();
}
@FunctionalInterface
interface CharSequenceFunction {
/**
* @param record to retrieve CharSequence from
* @param col numeric index of the column
* @return record as a char sequence
*/
CharSequence get(Record record, int col);
}
}