All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.h2.command.ddl.SequenceOptions Maven / Gradle / Ivy

There is a newer version: 2.3.232
Show newest version
/*
 * Copyright 2004-2021 H2 Group. Multiple-Licensed under the MPL 2.0,
 * and the EPL 1.0 (https://h2database.com/html/license.html).
 * Initial Developer: H2 Group
 */
package org.h2.command.ddl;

import org.h2.api.ErrorCode;
import org.h2.engine.SessionLocal;
import org.h2.expression.Expression;
import org.h2.expression.ValueExpression;
import org.h2.message.DbException;
import org.h2.schema.Sequence;
import org.h2.value.TypeInfo;
import org.h2.value.Value;
import org.h2.value.ValueBigint;
import org.h2.value.ValueNull;

/**
 * Sequence options.
 */
public class SequenceOptions {

    private TypeInfo dataType;

    private Expression start;

    private Expression restart;

    private Expression increment;

    private Expression maxValue;

    private Expression minValue;

    private Sequence.Cycle cycle;

    private Expression cacheSize;

    private long[] bounds;

    private final Sequence oldSequence;

    private static Long getLong(SessionLocal session, Expression expr) {
        if (expr != null) {
            Value value = expr.optimize(session).getValue(session);
            if (value != ValueNull.INSTANCE) {
                return value.getLong();
            }
        }
        return null;
    }

    /**
     * Creates new instance of sequence options.
     */
    public SequenceOptions() {
        oldSequence = null;
    }

    /**
     * Creates new instance of sequence options.
     *
     * @param oldSequence
     *            the sequence to copy options from
     * @param dataType
     *            the new data type
     */
    public SequenceOptions(Sequence oldSequence, TypeInfo dataType) {
        this.oldSequence = oldSequence;
        this.dataType = dataType;
        // Check data type correctness immediately
        getBounds();
    }

    public TypeInfo getDataType() {
        if (oldSequence != null) {
            synchronized (oldSequence) {
                copyFromOldSequence();
            }
        }
        return dataType;
    }

    private void copyFromOldSequence() {
        long bounds[] = getBounds();
        long min = Math.max(oldSequence.getMinValue(), bounds[0]);
        long max = Math.min(oldSequence.getMaxValue(), bounds[1]);
        if (max < min) {
            min = bounds[0];
            max = bounds[1];
        }
        minValue = ValueExpression.get(ValueBigint.get(min));
        maxValue = ValueExpression.get(ValueBigint.get(max));
        long v = oldSequence.getStartValue();
        if (v >= min && v <= max) {
            start = ValueExpression.get(ValueBigint.get(v));
        }
        v = oldSequence.getBaseValue();
        if (v >= min && v <= max) {
            restart = ValueExpression.get(ValueBigint.get(v));
        }
        increment = ValueExpression.get(ValueBigint.get(oldSequence.getIncrement()));
        cycle = oldSequence.getCycle();
        cacheSize = ValueExpression.get(ValueBigint.get(oldSequence.getCacheSize()));
    }

    public void setDataType(TypeInfo dataType) {
        this.dataType = dataType;
    }

    /**
     * Gets start value.
     *
     * @param session The session to calculate the value.
     * @return start value or {@code null} if value is not defined.
     */
    public Long getStartValue(SessionLocal session) {
        return check(getLong(session, start));
    }

    /**
     * Sets start value expression.
     *
     * @param start START WITH value expression.
     */
    public void setStartValue(Expression start) {
        this.start = start;
    }

    /**
     * Gets restart value.
     *
     * @param session
     *            the session to calculate the value
     * @param startValue
     *            the start value to use if restart without value is specified
     * @return restart value or {@code null} if value is not defined.
     */
    public Long getRestartValue(SessionLocal session, long startValue) {
        return check(restart == ValueExpression.DEFAULT ? (Long) startValue : getLong(session, restart));
    }

    /**
     * Sets restart value expression, or {@link ValueExpression#DEFAULT}.
     *
     * @param restart
     *            RESTART WITH value expression, or
     *            {@link ValueExpression#DEFAULT} for simple RESTART
     */
    public void setRestartValue(Expression restart) {
        this.restart = restart;
    }

    /**
     * Gets increment value.
     *
     * @param session The session to calculate the value.
     * @return increment value or {@code null} if value is not defined.
     */
    public Long getIncrement(SessionLocal session) {
        return check(getLong(session, increment));
    }

    /**
     * Sets increment value expression.
     *
     * @param increment INCREMENT BY value expression.
     */
    public void setIncrement(Expression increment) {
        this.increment = increment;
    }

    /**
     * Gets max value.
     *
     * @param sequence the sequence to get default max value.
     * @param session The session to calculate the value.
     * @return max value when the MAXVALUE expression is set, otherwise returns default max value.
     */
    public Long getMaxValue(Sequence sequence, SessionLocal session) {
        Long v;
        if (maxValue == ValueExpression.NULL && sequence != null) {
            v = Sequence.getDefaultMaxValue(getCurrentStart(sequence, session),
                    increment != null ? getIncrement(session) : sequence.getIncrement(), getBounds());
        } else {
            v = getLong(session, maxValue);
        }
        return check(v);
    }

    /**
     * Sets max value expression.
     *
     * @param maxValue MAXVALUE expression.
     */
    public void setMaxValue(Expression maxValue) {
        this.maxValue = maxValue;
    }

    /**
     * Gets min value.
     *
     * @param sequence the sequence to get default min value.
     * @param session The session to calculate the value.
     * @return min value when the MINVALUE expression is set, otherwise returns default min value.
     */
    public Long getMinValue(Sequence sequence, SessionLocal session) {
        Long v;
        if (minValue == ValueExpression.NULL && sequence != null) {
            v = Sequence.getDefaultMinValue(getCurrentStart(sequence, session),
                    increment != null ? getIncrement(session) : sequence.getIncrement(), getBounds());
        } else {
            v = getLong(session, minValue);
        }
        return check(v);
    }

    /**
     * Sets min value expression.
     *
     * @param minValue MINVALUE expression.
     */
    public void setMinValue(Expression minValue) {
        this.minValue = minValue;
    }

    private Long check(Long value) {
        if (value == null) {
            return null;
        } else {
            long[] bounds = getBounds();
            long v = value;
            if (v < bounds[0] || v > bounds[1]) {
                throw DbException.get(ErrorCode.NUMERIC_VALUE_OUT_OF_RANGE_1, Long.toString(v));
            }
        }
        return value;
    }

    public long[] getBounds() {
        long[] bounds = this.bounds;
        if (bounds == null) {
            this.bounds = bounds = getBounds(dataType);
        }
        return bounds;
    }

    /**
     * Get the bounds (min, max) of a data type.
     *
     * @param dataType the data type
     * @return the bounds (an array with 2 elements)
     */
    public static long[] getBounds(TypeInfo dataType) {
        long min, max;
        switch (dataType.getValueType()) {
        case Value.TINYINT:
            min = Byte.MIN_VALUE;
            max = Byte.MAX_VALUE;
            break;
        case Value.SMALLINT:
            min = Short.MIN_VALUE;
            max = Short.MAX_VALUE;
            break;
        case Value.INTEGER:
            min = Integer.MIN_VALUE;
            max = Integer.MAX_VALUE;
            break;
        case Value.BIGINT:
            min = Long.MIN_VALUE;
            max = Long.MAX_VALUE;
            break;
        case Value.REAL:
            min = -0x100_0000;
            max = 0x100_0000;
            break;
        case Value.DOUBLE:
            min = -0x20_0000_0000_0000L;
            max = 0x20_0000_0000_0000L;
            break;
        case Value.NUMERIC: {
            long p = (dataType.getPrecision() - dataType.getScale());
            if (p <= 0) {
                throw DbException.getUnsupportedException(dataType.getTraceSQL());
            } else if (p > 18) {
                min = Long.MIN_VALUE;
                max = Long.MAX_VALUE;
            } else {
                max = 10;
                for (int i = 1; i < p; i++) {
                    max *= 10;
                }
                min = - --max;
            }
            break;
        }
        case Value.DECFLOAT: {
            long p = dataType.getPrecision();
            if (p > 18) {
                min = Long.MIN_VALUE;
                max = Long.MAX_VALUE;
            } else {
                max = 10;
                for (int i = 1; i < p; i++) {
                    max *= 10;
                }
                min = -max;
            }
            break;
        }
        default:
            throw DbException.getUnsupportedException(dataType.getTraceSQL());
        }
        long bounds[] = { min, max };
        return bounds;
    }

    /**
     * Gets cycle option.
     *
     * @return cycle option value or {@code null} if is not defined.
     */
    public Sequence.Cycle getCycle() {
        return cycle;
    }

    /**
     * Sets cycle option.
     *
     * @param cycle option value.
     */
    public void setCycle(Sequence.Cycle cycle) {
        this.cycle = cycle;
    }

    /**
     * Gets cache size.
     *
     * @param session The session to calculate the value.
     * @return cache size or {@code null} if value is not defined.
     */
    public Long getCacheSize(SessionLocal session) {
        return getLong(session, cacheSize);
    }

    /**
     * Sets cache size.
     *
     * @param cacheSize cache size.
     */
    public void setCacheSize(Expression cacheSize) {
        this.cacheSize = cacheSize;
    }

    private long getCurrentStart(Sequence sequence, SessionLocal session) {
        return start != null ? getStartValue(session) : sequence.getBaseValue();
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy