org.apache.phoenix.parse.ColumnDef Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.phoenix.parse;
import java.sql.SQLException;
import org.apache.hadoop.hbase.io.ImmutableBytesWritable;
import org.apache.phoenix.compile.ExpressionCompiler;
import org.apache.phoenix.compile.StatementContext;
import org.apache.phoenix.exception.SQLExceptionCode;
import org.apache.phoenix.exception.SQLExceptionInfo;
import org.apache.phoenix.expression.Determinism;
import org.apache.phoenix.expression.Expression;
import org.apache.phoenix.expression.LiteralExpression;
import org.apache.phoenix.schema.ConstraintViolationException;
import org.apache.phoenix.schema.DelegateSQLException;
import org.apache.phoenix.schema.SortOrder;
import org.apache.phoenix.schema.types.PDataType;
import org.apache.phoenix.schema.types.PDecimal;
import org.apache.phoenix.schema.types.PVarbinary;
import org.apache.phoenix.util.ExpressionUtil;
import org.apache.phoenix.util.SchemaUtil;
import com.google.common.base.Preconditions;
/**
*
* Represents a column definition during DDL
*
*
* @since 0.1
*/
public class ColumnDef {
private final ColumnName columnDefName;
private final PDataType dataType;
private final Boolean isNull;
private final Integer maxLength;
private final Integer scale;
private boolean isPK;
private final SortOrder sortOrder;
private final boolean isArray;
private final Integer arrSize;
private final String expressionStr;
private final boolean isRowTimestamp;
public ColumnDef(ColumnDef def, String expressionStr) {
this.columnDefName = def.columnDefName;
this.dataType = def.dataType;
this.isNull = def.isNull;
this.maxLength = def.maxLength;
this.scale = def.scale;
this.isPK = def.isPK;
this.sortOrder = def.sortOrder;
this.isArray = def.isArray;
this.arrSize = def.arrSize;
this.isRowTimestamp = def.isRowTimestamp;
this.expressionStr = expressionStr;
}
ColumnDef(ColumnName columnDefName, String sqlTypeName, boolean isArray, Integer arrSize, Boolean isNull, Integer maxLength,
Integer scale, boolean isPK, SortOrder sortOrder, String expressionStr, boolean isRowTimestamp) {
try {
Preconditions.checkNotNull(sortOrder);
PDataType baseType;
PDataType dataType;
this.columnDefName = columnDefName;
// TODO : Add correctness check for arrSize. Should this be ignored as in postgres
// Also add what is the limit that we would support. Are we going to support a
// fixed size or like postgres allow infinite. May be the data types max limit can
// be used for the array size (May be too big)
if (isArray) {
this.isArray = true;
dataType = sqlTypeName == null ? null : PDataType.fromTypeId(PDataType.sqlArrayType(SchemaUtil.normalizeIdentifier(sqlTypeName)));
baseType = sqlTypeName == null ? null : PDataType.fromSqlTypeName(SchemaUtil.normalizeIdentifier(sqlTypeName));
this.arrSize = arrSize; // Can only be non negative based on parsing
if (baseType == PVarbinary.INSTANCE) {
throw new SQLExceptionInfo.Builder(SQLExceptionCode.VARBINARY_ARRAY_NOT_SUPPORTED)
.setColumnName(columnDefName.getColumnName()).build().buildException();
}
} else {
baseType = dataType = sqlTypeName == null ? null : PDataType.fromSqlTypeName(SchemaUtil.normalizeIdentifier(sqlTypeName));
if (this.isArray = dataType != null && dataType.isArrayType()) {
baseType = PDataType.arrayBaseType(dataType);
}
this.arrSize = null;
}
this.isNull = isNull;
if (baseType == PDecimal.INSTANCE) {
// for deciaml, 1 <= maxLength <= PDataType.MAX_PRECISION;
if (maxLength == null) {
scale = null;
} else {
if (maxLength < 1 || maxLength > PDataType.MAX_PRECISION) {
throw new SQLExceptionInfo.Builder(SQLExceptionCode.DECIMAL_PRECISION_OUT_OF_RANGE)
.setColumnName(columnDefName.getColumnName()).build().buildException();
}
// When a precision is specified and a scale is not specified, it is set to 0.
//
// This is the standard as specified in
// http://docs.oracle.com/cd/B28359_01/server.111/b28318/datatype.htm#CNCPT1832
// and
// http://docs.oracle.com/javadb/10.6.2.1/ref/rrefsqlj15260.html.
// Otherwise, if scale is bigger than maxLength, just set it to the maxLength;
//
// When neither a precision nor a scale is specified, the precision and scale is
// ignored. All decimal are stored with as much decimal points as possible.
scale = scale == null ? PDataType.DEFAULT_SCALE : scale > maxLength ? maxLength : scale;
}
} else {
if (maxLength != null && maxLength < 1) {
throw new SQLExceptionInfo.Builder(SQLExceptionCode.NONPOSITIVE_MAX_LENGTH)
.setColumnName(columnDefName.getColumnName()).build().buildException();
}
scale = null;
if (baseType == null) {
maxLength = null;
} else if (baseType.isFixedWidth()) {
if (baseType.getByteSize() == null) {
if (maxLength == null) {
throw new SQLExceptionInfo.Builder(SQLExceptionCode.MISSING_MAX_LENGTH)
.setColumnName(columnDefName.getColumnName()).build().buildException();
}
} else {
maxLength = null;
}
}
}
this.maxLength = maxLength;
this.scale = scale;
this.isPK = isPK;
this.sortOrder = sortOrder;
this.dataType = dataType;
this.expressionStr = expressionStr;
this.isRowTimestamp = isRowTimestamp;
} catch (SQLException e) {
throw new ParseException(e);
}
}
ColumnDef(ColumnName columnDefName, String sqlTypeName, Boolean isNull, Integer maxLength,
Integer scale, boolean isPK, SortOrder sortOrder, String expressionStr, boolean isRowTimestamp) {
this(columnDefName, sqlTypeName, false, 0, isNull, maxLength, scale, isPK, sortOrder, expressionStr, isRowTimestamp);
}
public ColumnName getColumnDefName() {
return columnDefName;
}
public PDataType getDataType() {
return dataType;
}
public boolean isNull() {
// null or Boolean.TRUE means NULL
// Boolean.FALSE means NOT NULL
return !Boolean.FALSE.equals(isNull);
}
public boolean isNullSet() {
return isNull != null;
}
public Integer getMaxLength() {
return maxLength;
}
public Integer getScale() {
return scale;
}
public boolean isPK() {
return isPK;
}
public SortOrder getSortOrder() {
return sortOrder;
}
public boolean isArray() {
return isArray;
}
public Integer getArraySize() {
return arrSize;
}
public String getExpression() {
return expressionStr;
}
public boolean isRowTimestamp() {
return isRowTimestamp;
}
public void setIsPK(boolean isPK) {
this.isPK = isPK;
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(columnDefName.getColumnNode().toString());
buf.append(' ');
buf.append(dataType.getSqlTypeName());
if (maxLength != null) {
buf.append('(');
buf.append(maxLength);
if (scale != null) {
buf.append(',');
buf.append(scale); // has both max length and scale. For ex- decimal(10,2)
}
buf.append(')');
}
if (isArray) {
buf.append(' ');
buf.append(PDataType.ARRAY_TYPE_SUFFIX);
buf.append(' ');
}
return buf.toString();
}
public boolean validateDefault(StatementContext context, PrimaryKeyConstraint pkConstraint) throws SQLException {
String defaultStr = this.getExpression();
if (defaultStr == null) {
return true;
}
ExpressionCompiler compiler = new ExpressionCompiler(context);
ParseNode defaultParseNode =
new SQLParser(this.getExpression()).parseExpression();
Expression defaultExpression = defaultParseNode.accept(compiler);
if (!defaultParseNode.isStateless()
|| defaultExpression.getDeterminism() != Determinism.ALWAYS) {
throw new SQLExceptionInfo.Builder(SQLExceptionCode.CANNOT_CREATE_DEFAULT)
.setColumnName(this.getColumnDefName().getColumnName()).build()
.buildException();
}
if (this.isRowTimestamp() || ( pkConstraint != null && pkConstraint.isColumnRowTimestamp(this.getColumnDefName()))) {
throw new SQLExceptionInfo.Builder(
SQLExceptionCode.CANNOT_CREATE_DEFAULT_ROWTIMESTAMP)
.setColumnName(this.getColumnDefName().getColumnName())
.build().buildException();
}
ImmutableBytesWritable ptr = new ImmutableBytesWritable();
// Evaluate the expression to confirm it's validity
LiteralExpression defaultValue = ExpressionUtil.getConstantExpression(defaultExpression, ptr);
// A DEFAULT that evaluates to null should be ignored as it adds nothing
if (defaultValue.getValue() == null) {
return false;
}
PDataType sourceType = defaultExpression.getDataType();
PDataType targetType = this.getDataType();
// Ensure that coercion works (will throw if not)
context.getTempPtr().set(ptr.get(), ptr.getOffset(), ptr.getLength());
try {
targetType.coerceBytes(context.getTempPtr(), defaultValue.getValue(), sourceType,
defaultValue.getMaxLength(), defaultValue.getScale(),
defaultValue.getSortOrder(),
this.getMaxLength(), this.getScale(),
this.getSortOrder());
} catch (ConstraintViolationException e) {
if (e.getCause() instanceof SQLException) {
SQLException sqlE = (SQLException) e.getCause();
throw new DelegateSQLException(sqlE, ". DEFAULT " + SQLExceptionInfo.COLUMN_NAME + "=" + this.getColumnDefName().getColumnName());
}
throw e;
}
if (!targetType.isSizeCompatible(ptr, defaultValue.getValue(), sourceType,
sortOrder, defaultValue.getMaxLength(),
defaultValue.getScale(), this.getMaxLength(), this.getScale())) {
throw new SQLExceptionInfo.Builder(
SQLExceptionCode.DATA_EXCEEDS_MAX_CAPACITY).setColumnName(this.getColumnDefName().getColumnName())
.setMessage("DEFAULT " + this.getExpression()).build()
.buildException();
}
return true;
}
}© 2015 - 2024 Weber Informatics LLC | Privacy Policy