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

org.apache.cassandra.cql3.QueryOptions Maven / Gradle / Ivy

There is a newer version: 3.11.12.3
Show newest version
/*
 * 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.cql3;

import java.nio.ByteBuffer;
import java.util.*;

import com.google.common.collect.ImmutableList;

import io.netty.buffer.ByteBuf;

import org.apache.cassandra.config.ColumnDefinition;
import org.apache.cassandra.db.ConsistencyLevel;
import org.apache.cassandra.db.marshal.UTF8Type;
import org.apache.cassandra.exceptions.InvalidRequestException;
import org.apache.cassandra.service.QueryState;
import org.apache.cassandra.service.pager.PagingState;
import org.apache.cassandra.transport.CBCodec;
import org.apache.cassandra.transport.CBUtil;
import org.apache.cassandra.transport.ProtocolException;
import org.apache.cassandra.transport.ProtocolVersion;
import org.apache.cassandra.utils.Pair;

/**
 * Options for a query.
 */
public abstract class QueryOptions
{
    public static final QueryOptions DEFAULT = new DefaultQueryOptions(ConsistencyLevel.ONE,
                                                                       Collections.emptyList(),
                                                                       false,
                                                                       SpecificOptions.DEFAULT,
                                                                       ProtocolVersion.CURRENT);

    public static final CBCodec codec = new Codec();

    // A cache of bind values parsed as JSON, see getJsonColumnValue for details.
    private List> jsonValuesCache;

    public static QueryOptions fromThrift(ConsistencyLevel consistency, List values)
    {
        return new DefaultQueryOptions(consistency, values, false, SpecificOptions.DEFAULT, ProtocolVersion.V3);
    }

    public static QueryOptions forInternalCalls(ConsistencyLevel consistency, ConsistencyLevel serialConsistency, List values)
    {
        return new DefaultQueryOptions(consistency, values, false, new SpecificOptions(-1, null, serialConsistency, Long.MIN_VALUE), ProtocolVersion.V3);
    }
    
    public static QueryOptions forInternalCalls(ConsistencyLevel consistency, List values)
    {
        return new DefaultQueryOptions(consistency, values, false, SpecificOptions.DEFAULT, ProtocolVersion.V3);
    }

    public static QueryOptions forInternalCalls(List values)
    {
        return new DefaultQueryOptions(ConsistencyLevel.ONE, values, false, SpecificOptions.DEFAULT, ProtocolVersion.V3);
    }

    public static QueryOptions forProtocolVersion(ProtocolVersion protocolVersion)
    {
        return new DefaultQueryOptions(null, null, true, null, protocolVersion);
    }

    public static QueryOptions create(ConsistencyLevel consistency, List values, boolean skipMetadata, int pageSize, PagingState pagingState, ConsistencyLevel serialConsistency, ProtocolVersion version)
    {
        return new DefaultQueryOptions(consistency, values, skipMetadata, new SpecificOptions(pageSize, pagingState, serialConsistency, -1L), version);
    }

    public static QueryOptions addColumnSpecifications(QueryOptions options, List columnSpecs)
    {
        return new OptionsWithColumnSpecifications(options, columnSpecs);
    }

    public abstract ConsistencyLevel getConsistency();
    public abstract List getValues();
    public abstract boolean skipMetadata();

    /**
     * Returns the term corresponding to column {@code columnName} in the JSON value of bind index {@code bindIndex}.
     *
     * This is functionally equivalent to:
     *   {@code Json.parseJson(UTF8Type.instance.getSerializer().deserialize(getValues().get(bindIndex)), expectedReceivers).get(columnName)}
     * but this cache the result of parsing the JSON so that while this might be called for multiple columns on the same {@code bindIndex}
     * value, the underlying JSON value is only parsed/processed once.
     *
     * Note: this is a bit more involved in CQL specifics than this class generally is but we as we need to cache this per-query and in an object
     * that is available when we bind values, this is the easier place to have this.
     *
     * @param bindIndex the index of the bind value that should be interpreted as a JSON value.
     * @param columnName the name of the column we want the value of.
     * @param expectedReceivers the columns expected in the JSON value at index {@code bindIndex}. This is only used when parsing the
     * json initially and no check is done afterwards. So in practice, any call of this method on the same QueryOptions object and with the same
     * {@code bindIndx} values should use the same value for this parameter, but this isn't validated in any way.
     *
     * @return the value correspong to column {@code columnName} in the (JSON) bind value at index {@code bindIndex}. This may return null if the
     * JSON value has no value for this column.
     */
    public Term getJsonColumnValue(int bindIndex, ColumnIdentifier columnName, Collection expectedReceivers) throws InvalidRequestException
    {
        if (jsonValuesCache == null)
            jsonValuesCache = new ArrayList<>(Collections.>nCopies(getValues().size(), null));

        Map jsonValue = jsonValuesCache.get(bindIndex);
        if (jsonValue == null)
        {
            ByteBuffer value = getValues().get(bindIndex);
            if (value == null)
                throw new InvalidRequestException("Got null for INSERT JSON values");

            jsonValue = Json.parseJson(UTF8Type.instance.getSerializer().deserialize(value), expectedReceivers);
            jsonValuesCache.set(bindIndex, jsonValue);
        }

        return jsonValue.get(columnName);
    }

    /**
     * Tells whether or not this QueryOptions contains the column specifications for the bound variables.
     * 

The column specifications will be present only for prepared statements.

* @return true this QueryOptions contains the column specifications for the bound * variables, false otherwise. */ public boolean hasColumnSpecifications() { return false; } /** * Returns the column specifications for the bound variables (optional operation). * *

The column specifications will be present only for prepared statements.

* *

Invoke the {@link hasColumnSpecifications} method before invoking this method in order to ensure that this * QueryOptions contains the column specifications.

* * @return the option names * @throws UnsupportedOperationException If this QueryOptions does not contains the column * specifications. */ public ImmutableList getColumnSpecifications() { throw new UnsupportedOperationException(); } /** The pageSize for this query. Will be {@code <= 0} if not relevant for the query. */ public int getPageSize() { return getSpecificOptions().pageSize; } /** The paging state for this query, or null if not relevant. */ public PagingState getPagingState() { return getSpecificOptions().state; } /** Serial consistency for conditional updates. */ public ConsistencyLevel getSerialConsistency() { return getSpecificOptions().serialConsistency; } public long getTimestamp(QueryState state) { long tstamp = getSpecificOptions().timestamp; return tstamp != Long.MIN_VALUE ? tstamp : state.getTimestamp(); } /** * The protocol version for the query. Will be 3 if the object don't come from * a native protocol request (i.e. it's been allocated locally or by CQL-over-thrift). */ public abstract ProtocolVersion getProtocolVersion(); // Mainly for the sake of BatchQueryOptions abstract SpecificOptions getSpecificOptions(); public QueryOptions prepare(List specs) { return this; } static class DefaultQueryOptions extends QueryOptions { private final ConsistencyLevel consistency; private final List values; private final boolean skipMetadata; private final SpecificOptions options; private final transient ProtocolVersion protocolVersion; DefaultQueryOptions(ConsistencyLevel consistency, List values, boolean skipMetadata, SpecificOptions options, ProtocolVersion protocolVersion) { this.consistency = consistency; this.values = values; this.skipMetadata = skipMetadata; this.options = options; this.protocolVersion = protocolVersion; } public ConsistencyLevel getConsistency() { return consistency; } public List getValues() { return values; } public boolean skipMetadata() { return skipMetadata; } public ProtocolVersion getProtocolVersion() { return protocolVersion; } SpecificOptions getSpecificOptions() { return options; } } static class QueryOptionsWrapper extends QueryOptions { protected final QueryOptions wrapped; QueryOptionsWrapper(QueryOptions wrapped) { this.wrapped = wrapped; } public List getValues() { return this.wrapped.getValues(); } public ConsistencyLevel getConsistency() { return wrapped.getConsistency(); } public boolean skipMetadata() { return wrapped.skipMetadata(); } public ProtocolVersion getProtocolVersion() { return wrapped.getProtocolVersion(); } SpecificOptions getSpecificOptions() { return wrapped.getSpecificOptions(); } @Override public QueryOptions prepare(List specs) { wrapped.prepare(specs); return this; } } /** * QueryOptions decorator that provides access to the column specifications. */ static class OptionsWithColumnSpecifications extends QueryOptionsWrapper { private final ImmutableList columnSpecs; OptionsWithColumnSpecifications(QueryOptions wrapped, List columnSpecs) { super(wrapped); this.columnSpecs = ImmutableList.copyOf(columnSpecs); } @Override public boolean hasColumnSpecifications() { return true; } @Override public ImmutableList getColumnSpecifications() { return columnSpecs; } } static class OptionsWithNames extends QueryOptionsWrapper { private final List names; private List orderedValues; OptionsWithNames(DefaultQueryOptions wrapped, List names) { super(wrapped); this.names = names; } @Override public QueryOptions prepare(List specs) { super.prepare(specs); orderedValues = new ArrayList(specs.size()); for (int i = 0; i < specs.size(); i++) { String name = specs.get(i).name.toString(); for (int j = 0; j < names.size(); j++) { if (name.equals(names.get(j))) { orderedValues.add(wrapped.getValues().get(j)); break; } } } return this; } @Override public List getValues() { assert orderedValues != null; // We should have called prepare first! return orderedValues; } } // Options that are likely to not be present in most queries static class SpecificOptions { private static final SpecificOptions DEFAULT = new SpecificOptions(-1, null, null, Long.MIN_VALUE); private final int pageSize; private final PagingState state; private final ConsistencyLevel serialConsistency; private final long timestamp; private SpecificOptions(int pageSize, PagingState state, ConsistencyLevel serialConsistency, long timestamp) { this.pageSize = pageSize; this.state = state; this.serialConsistency = serialConsistency == null ? ConsistencyLevel.SERIAL : serialConsistency; this.timestamp = timestamp; } } private static class Codec implements CBCodec { private enum Flag { // The order of that enum matters!! VALUES, SKIP_METADATA, PAGE_SIZE, PAGING_STATE, SERIAL_CONSISTENCY, TIMESTAMP, NAMES_FOR_VALUES; private static final Flag[] ALL_VALUES = values(); public static EnumSet deserialize(int flags) { EnumSet set = EnumSet.noneOf(Flag.class); for (int n = 0; n < ALL_VALUES.length; n++) { if ((flags & (1 << n)) != 0) set.add(ALL_VALUES[n]); } return set; } public static int serialize(EnumSet flags) { int i = 0; for (Flag flag : flags) i |= 1 << flag.ordinal(); return i; } } public QueryOptions decode(ByteBuf body, ProtocolVersion version) { ConsistencyLevel consistency = CBUtil.readConsistencyLevel(body); EnumSet flags = Flag.deserialize(version.isGreaterOrEqualTo(ProtocolVersion.V5) ? (int)body.readUnsignedInt() : (int)body.readUnsignedByte()); List values = Collections.emptyList(); List names = null; if (flags.contains(Flag.VALUES)) { if (flags.contains(Flag.NAMES_FOR_VALUES)) { Pair, List> namesAndValues = CBUtil.readNameAndValueList(body, version); names = namesAndValues.left; values = namesAndValues.right; } else { values = CBUtil.readValueList(body, version); } } boolean skipMetadata = flags.contains(Flag.SKIP_METADATA); flags.remove(Flag.VALUES); flags.remove(Flag.SKIP_METADATA); SpecificOptions options = SpecificOptions.DEFAULT; if (!flags.isEmpty()) { int pageSize = flags.contains(Flag.PAGE_SIZE) ? body.readInt() : -1; PagingState pagingState = flags.contains(Flag.PAGING_STATE) ? PagingState.deserialize(CBUtil.readValue(body), version) : null; ConsistencyLevel serialConsistency = flags.contains(Flag.SERIAL_CONSISTENCY) ? CBUtil.readConsistencyLevel(body) : ConsistencyLevel.SERIAL; long timestamp = Long.MIN_VALUE; if (flags.contains(Flag.TIMESTAMP)) { long ts = body.readLong(); if (ts == Long.MIN_VALUE) throw new ProtocolException(String.format("Out of bound timestamp, must be in [%d, %d] (got %d)", Long.MIN_VALUE + 1, Long.MAX_VALUE, ts)); timestamp = ts; } options = new SpecificOptions(pageSize, pagingState, serialConsistency, timestamp); } DefaultQueryOptions opts = new DefaultQueryOptions(consistency, values, skipMetadata, options, version); return names == null ? opts : new OptionsWithNames(opts, names); } public void encode(QueryOptions options, ByteBuf dest, ProtocolVersion version) { CBUtil.writeConsistencyLevel(options.getConsistency(), dest); EnumSet flags = gatherFlags(options); if (version.isGreaterOrEqualTo(ProtocolVersion.V5)) dest.writeInt(Flag.serialize(flags)); else dest.writeByte((byte)Flag.serialize(flags)); if (flags.contains(Flag.VALUES)) CBUtil.writeValueList(options.getValues(), dest); if (flags.contains(Flag.PAGE_SIZE)) dest.writeInt(options.getPageSize()); if (flags.contains(Flag.PAGING_STATE)) CBUtil.writeValue(options.getPagingState().serialize(version), dest); if (flags.contains(Flag.SERIAL_CONSISTENCY)) CBUtil.writeConsistencyLevel(options.getSerialConsistency(), dest); if (flags.contains(Flag.TIMESTAMP)) dest.writeLong(options.getSpecificOptions().timestamp); // Note that we don't really have to bother with NAMES_FOR_VALUES server side, // and in fact we never really encode QueryOptions, only decode them, so we // don't bother. } public int encodedSize(QueryOptions options, ProtocolVersion version) { int size = 0; size += CBUtil.sizeOfConsistencyLevel(options.getConsistency()); EnumSet flags = gatherFlags(options); size += (version.isGreaterOrEqualTo(ProtocolVersion.V5) ? 4 : 1); if (flags.contains(Flag.VALUES)) size += CBUtil.sizeOfValueList(options.getValues()); if (flags.contains(Flag.PAGE_SIZE)) size += 4; if (flags.contains(Flag.PAGING_STATE)) size += CBUtil.sizeOfValue(options.getPagingState().serializedSize(version)); if (flags.contains(Flag.SERIAL_CONSISTENCY)) size += CBUtil.sizeOfConsistencyLevel(options.getSerialConsistency()); if (flags.contains(Flag.TIMESTAMP)) size += 8; return size; } private EnumSet gatherFlags(QueryOptions options) { EnumSet flags = EnumSet.noneOf(Flag.class); if (options.getValues().size() > 0) flags.add(Flag.VALUES); if (options.skipMetadata()) flags.add(Flag.SKIP_METADATA); if (options.getPageSize() >= 0) flags.add(Flag.PAGE_SIZE); if (options.getPagingState() != null) flags.add(Flag.PAGING_STATE); if (options.getSerialConsistency() != ConsistencyLevel.SERIAL) flags.add(Flag.SERIAL_CONSISTENCY); if (options.getSpecificOptions().timestamp != Long.MIN_VALUE) flags.add(Flag.TIMESTAMP); return flags; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy