tech.ydb.table.result.ResultSetReader Maven / Gradle / Ivy

Go to download
package tech.ydb.table.result;

import tech.ydb.table.values.Type;

/**
 * @author Sergey Polovko
 */
public interface ResultSetReader {

    /**
     * Returns {@code true} if the result was truncated, {@code false} otherwise.
     */
    boolean isTruncated();

    /**
     * Returns number of columns.
     */
    int getColumnCount();

    /**
     * Returns number of rows.
     */
    int getRowCount();

    /**
     * Explicitly switch to a specific row.
     */
    void setRowIndex(int index);

    /**
     * Set iterator to the next table row.
     *
     * On success tryNextRow will reset all column parsers to the values in next row.
     * Column parsers are invalid before the first TryNextRow call.
     */
    boolean next();

    /**
     * Returns column name by index.
     */
    String getColumnName(int index);

    /**
     * Returns column index by name or {@code -1} if column with given name is not present.
     */
    int getColumnIndex(String name);

    /**
     * Returns value reader for column by index.
     */
    ValueReader getColumn(int index);

    /**
     * Returns value reader for column by name.
     */
    ValueReader getColumn(String name);

    /**
     * Returns column type by index (always create a new type instance)
     */
    Type getColumnType(int index);
}