org.apache.cassandra.db.marshal.UserType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-all Show documentation
Show all versions of cassandra-all Show documentation
The Apache Cassandra Project develops a highly scalable second-generation distributed database, bringing together Dynamo's fully distributed design and Bigtable's ColumnFamily-based data model.
/*
* 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.cassandra.db.marshal;
import java.nio.ByteBuffer;
import java.util.*;
import java.util.stream.Collectors;
import com.google.common.base.Objects;
import com.google.common.collect.Lists;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.cassandra.cql3.*;
import org.apache.cassandra.db.rows.Cell;
import org.apache.cassandra.db.rows.CellPath;
import org.apache.cassandra.schema.Difference;
import org.apache.cassandra.serializers.MarshalException;
import org.apache.cassandra.serializers.TypeSerializer;
import org.apache.cassandra.serializers.UserTypeSerializer;
import org.apache.cassandra.transport.ProtocolVersion;
import org.apache.cassandra.utils.ByteBufferUtil;
import org.apache.cassandra.utils.Pair;
import static com.google.common.collect.Iterables.any;
import static com.google.common.collect.Iterables.transform;
import static org.apache.cassandra.cql3.ColumnIdentifier.maybeQuote;
/**
* A user defined type.
*
* A user type is really just a tuple type on steroids.
*/
public class UserType extends TupleType implements SchemaElement
{
private static final Logger logger = LoggerFactory.getLogger(UserType.class);
private static final ConflictBehavior CONFLICT_BEHAVIOR = ConflictBehavior.get();
public final String keyspace;
public final ByteBuffer name;
private final List fieldNames;
private final List stringFieldNames;
private final boolean isMultiCell;
private final UserTypeSerializer serializer;
public UserType(String keyspace, ByteBuffer name, List fieldNames, List> fieldTypes, boolean isMultiCell)
{
super(fieldTypes, false);
assert fieldNames.size() == fieldTypes.size();
this.keyspace = keyspace;
this.name = name;
this.fieldNames = fieldNames;
this.stringFieldNames = new ArrayList<>(fieldNames.size());
this.isMultiCell = isMultiCell;
LinkedHashMap> fieldSerializers = new LinkedHashMap<>(fieldTypes.size());
for (int i = 0, m = fieldNames.size(); i < m; i++)
{
String stringFieldName = fieldNames.get(i).toString();
stringFieldNames.add(stringFieldName);
TypeSerializer existing = fieldSerializers.put(stringFieldName, fieldTypes.get(i).getSerializer());
if (existing != null)
CONFLICT_BEHAVIOR.onConflict(keyspace, getNameAsString(), stringFieldName);
}
this.serializer = new UserTypeSerializer(fieldSerializers);
}
public static UserType getInstance(TypeParser parser)
{
Pair, List>> params = parser.getUserTypeParameters();
String keyspace = params.left.left;
ByteBuffer name = params.left.right;
List columnNames = new ArrayList<>(params.right.size());
List> columnTypes = new ArrayList<>(params.right.size());
for (Pair p : params.right)
{
columnNames.add(new FieldIdentifier(p.left));
columnTypes.add(p.right);
}
return new UserType(keyspace, name, columnNames, columnTypes, true);
}
@Override
public boolean isUDT()
{
return true;
}
public boolean isTuple()
{
return false;
}
@Override
public boolean isMultiCell()
{
return isMultiCell;
}
@Override
public boolean isFreezable()
{
return true;
}
public AbstractType fieldType(int i)
{
return type(i);
}
public List> fieldTypes()
{
return types;
}
public FieldIdentifier fieldName(int i)
{
return fieldNames.get(i);
}
public String fieldNameAsString(int i)
{
return stringFieldNames.get(i);
}
public List fieldNames()
{
return fieldNames;
}
public String getNameAsString()
{
return UTF8Type.instance.compose(name);
}
public int fieldPosition(FieldIdentifier fieldName)
{
return fieldNames.indexOf(fieldName);
}
public CellPath cellPathForField(FieldIdentifier fieldName)
{
// we use the field position instead of the field name to allow for field renaming in ALTER TYPE statements
return CellPath.create(ByteBufferUtil.bytes((short)fieldPosition(fieldName)));
}
public ShortType nameComparator()
{
return ShortType.instance;
}
public ByteBuffer serializeForNativeProtocol(Iterator> cells, ProtocolVersion protocolVersion)
{
assert isMultiCell;
ByteBuffer[] components = new ByteBuffer[size()];
short fieldPosition = 0;
while (cells.hasNext())
{
Cell cell = cells.next();
// handle null fields that aren't at the end
short fieldPositionOfCell = ByteBufferUtil.toShort(cell.path().get(0));
while (fieldPosition < fieldPositionOfCell)
components[fieldPosition++] = null;
components[fieldPosition++] = cell.buffer();
}
// append trailing nulls for missing cells
while (fieldPosition < size())
components[fieldPosition++] = null;
return TupleType.buildValue(components);
}
public void validateCell(Cell cell) throws MarshalException
{
if (isMultiCell)
{
ByteBuffer path = cell.path().get(0);
nameComparator().validate(path);
Short fieldPosition = nameComparator().getSerializer().deserialize(path);
fieldType(fieldPosition).validate(cell.value(), cell.accessor());
}
else
{
validate(cell.value(), cell.accessor());
}
}
@Override
public Term fromJSONObject(Object parsed) throws MarshalException
{
if (parsed instanceof String)
parsed = Json.decodeJson((String) parsed);
if (!(parsed instanceof Map))
throw new MarshalException(String.format(
"Expected a map, but got a %s: %s", parsed.getClass().getSimpleName(), parsed));
Map map = (Map) parsed;
Json.handleCaseSensitivity(map);
List terms = new ArrayList<>(types.size());
Set keys = map.keySet();
assert keys.isEmpty() || keys.iterator().next() instanceof String;
int foundValues = 0;
for (int i = 0; i < types.size(); i++)
{
Object value = map.get(stringFieldNames.get(i));
if (value == null)
{
terms.add(Constants.NULL_VALUE);
}
else
{
terms.add(types.get(i).fromJSONObject(value));
foundValues += 1;
}
}
// check for extra, unrecognized fields
if (foundValues != map.size())
{
for (Object fieldName : keys)
{
if (!stringFieldNames.contains(fieldName))
throw new MarshalException(String.format(
"Unknown field '%s' in value of user defined type %s", fieldName, getNameAsString()));
}
}
return new UserTypes.DelayedValue(this, terms);
}
@Override
public String toJSONString(ByteBuffer buffer, ProtocolVersion protocolVersion)
{
ByteBuffer[] buffers = split(buffer);
StringBuilder sb = new StringBuilder("{");
for (int i = 0; i < types.size(); i++)
{
if (i > 0)
sb.append(", ");
String name = stringFieldNames.get(i);
if (!name.equals(name.toLowerCase(Locale.US)))
name = "\"" + name + "\"";
sb.append('"');
sb.append(Json.quoteAsJsonString(name));
sb.append("\": ");
ByteBuffer valueBuffer = (i >= buffers.length) ? null : buffers[i];
if (valueBuffer == null)
sb.append("null");
else
sb.append(types.get(i).toJSONString(valueBuffer, protocolVersion));
}
return sb.append("}").toString();
}
@Override
public UserType freeze()
{
if (isMultiCell)
return new UserType(keyspace, name, fieldNames, fieldTypes(), false);
else
return this;
}
@Override
public AbstractType freezeNestedMulticellTypes()
{
if (!isMultiCell())
return this;
// the behavior here doesn't exactly match the method name: we want to freeze everything inside of UDTs
List> newTypes = fieldTypes().stream()
.map(subtype -> (subtype.isFreezable() && subtype.isMultiCell() ? subtype.freeze() : subtype))
.collect(Collectors.toList());
return new UserType(keyspace, name, fieldNames, newTypes, isMultiCell);
}
@Override
public int hashCode()
{
return Objects.hashCode(keyspace, name, fieldNames, types, isMultiCell);
}
@Override
public boolean isValueCompatibleWith(AbstractType previous)
{
if (this == previous)
return true;
if (!(previous instanceof UserType))
return false;
UserType other = (UserType) previous;
if (isMultiCell != other.isMultiCell())
return false;
if (!keyspace.equals(other.keyspace))
return false;
Iterator> thisTypeIter = types.iterator();
Iterator> previousTypeIter = other.types.iterator();
while (thisTypeIter.hasNext() && previousTypeIter.hasNext())
{
if (!thisTypeIter.next().isCompatibleWith(previousTypeIter.next()))
return false;
}
// it's okay for the new type to have additional fields, but not for the old type to have additional fields
return !previousTypeIter.hasNext();
}
@Override
public boolean equals(Object o)
{
if(!(o instanceof UserType))
return false;
UserType that = (UserType)o;
return equalsWithoutTypes(that) && types.equals(that.types);
}
private boolean equalsWithoutTypes(UserType other)
{
return name.equals(other.name)
&& fieldNames.equals(other.fieldNames)
&& keyspace.equals(other.keyspace)
&& isMultiCell == other.isMultiCell;
}
public Optional compare(UserType other)
{
if (!equalsWithoutTypes(other))
return Optional.of(Difference.SHALLOW);
boolean differsDeeply = false;
for (int i = 0; i < fieldTypes().size(); i++)
{
AbstractType thisType = fieldType(i);
AbstractType thatType = other.fieldType(i);
if (!thisType.equals(thatType))
{
if (thisType.asCQL3Type().toString().equals(thatType.asCQL3Type().toString()))
differsDeeply = true;
else
return Optional.of(Difference.SHALLOW);
}
}
return differsDeeply ? Optional.of(Difference.DEEP) : Optional.empty();
}
@Override
public CQL3Type asCQL3Type()
{
return CQL3Type.UserDefined.create(this);
}
@Override
public boolean referencesUserType(V name, ValueAccessor accessor)
{
return this.name.equals(name) || any(fieldTypes(), t -> t.referencesUserType(name, accessor));
}
@Override
public UserType withUpdatedUserType(UserType udt)
{
if (!referencesUserType(udt.name))
return this;
// preserve frozen/non-frozen status of the updated UDT
if (name.equals(udt.name))
{
return isMultiCell == udt.isMultiCell
? udt
: new UserType(keyspace, name, udt.fieldNames(), udt.fieldTypes(), isMultiCell);
}
return new UserType(keyspace,
name,
fieldNames,
Lists.newArrayList(transform(fieldTypes(), t -> t.withUpdatedUserType(udt))),
isMultiCell());
}
@Override
public boolean referencesDuration()
{
return fieldTypes().stream().anyMatch(f -> f.referencesDuration());
}
@Override
public String toString()
{
return this.toString(false);
}
@Override
public String toString(boolean ignoreFreezing)
{
boolean includeFrozenType = !ignoreFreezing && !isMultiCell();
StringBuilder sb = new StringBuilder();
if (includeFrozenType)
sb.append(FrozenType.class.getName()).append("(");
sb.append(getClass().getName());
sb.append(TypeParser.stringifyUserTypeParameters(keyspace, name, fieldNames, types, ignoreFreezing || !isMultiCell));
if (includeFrozenType)
sb.append(")");
return sb.toString();
}
public String getCqlTypeName()
{
return String.format("%s.%s", maybeQuote(keyspace), maybeQuote(getNameAsString()));
}
@Override
public TypeSerializer getSerializer()
{
return serializer;
}
@Override
public SchemaElementType elementType()
{
return SchemaElementType.TYPE;
}
@Override
public String elementKeyspace()
{
return keyspace;
}
@Override
public String elementName()
{
return getNameAsString();
}
@Override
public String toCqlString(boolean withInternals, boolean ifNotExists)
{
CqlBuilder builder = new CqlBuilder();
builder.append("CREATE TYPE ");
if (ifNotExists)
{
builder.append("IF NOT EXISTS ");
}
builder.appendQuotingIfNeeded(keyspace)
.append('.')
.appendQuotingIfNeeded(getNameAsString())
.append(" (")
.newLine()
.increaseIndent();
for (int i = 0; i < size(); i++)
{
if (i > 0)
builder.append(",")
.newLine();
builder.append(fieldNameAsString(i))
.append(' ')
.append(fieldType(i));
}
builder.newLine()
.decreaseIndent()
.append(");");
return builder.toString();
}
private enum ConflictBehavior
{
LOG {
void onConflict(String keyspace, String name, String fieldName)
{
logger.error("Duplicate names found in UDT {}.{} for column {}",
maybeQuote(keyspace), maybeQuote(name), maybeQuote(fieldName));
}
},
REJECT {
@Override
void onConflict(String keyspace, String name, String fieldName)
{
throw new AssertionError(String.format("Duplicate names found in UDT %s.%s for column %s; " +
"to resolve set -D" + UDT_CONFLICT_BEHAVIOR + "=LOG on startup and remove the type",
maybeQuote(keyspace), maybeQuote(name), maybeQuote(fieldName)));
}
};
private static final String UDT_CONFLICT_BEHAVIOR = "cassandra.type.udt.conflict_behavior";
abstract void onConflict(String keyspace, String name, String fieldName);
static ConflictBehavior get()
{
String value = System.getProperty(UDT_CONFLICT_BEHAVIOR, REJECT.name());
return ConflictBehavior.valueOf(value);
}
}
}