org.apache.druid.client.cache.CacheConfig Maven / Gradle / Ivy

Go to download
/*
 * 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.druid.client.cache;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.collect.ImmutableList;
import org.apache.druid.query.Query;

import javax.validation.constraints.Min;
import java.util.List;

public class CacheConfig
{
  public static final String POPULATE_CACHE = "populateCache";
  // The defaults defined here for cache related parameters are different from the QueryContext defaults due to legacy reasons.
  // They should be made the same at some point in the future.
  @JsonProperty
  private boolean useCache = false;

  @JsonProperty
  private boolean populateCache = false;

  @JsonProperty
  private boolean useResultLevelCache = false;

  @JsonProperty
  private boolean populateResultLevelCache = false;

  @JsonProperty
  @Min(0)
  private int numBackgroundThreads = 0;

  @JsonProperty
  @Min(0)
  private int cacheBulkMergeLimit = Integer.MAX_VALUE;

  @JsonProperty
  private int maxEntrySize = 1_000_000;

  @JsonProperty
  private List unCacheable = ImmutableList.of();

  @JsonProperty
  private int resultLevelCacheLimit = Integer.MAX_VALUE;

  public boolean isPopulateCache()
  {
    return populateCache;
  }

  public boolean isUseCache()
  {
    return useCache;
  }

  public boolean isPopulateResultLevelCache()
  {
    return populateResultLevelCache;
  }

  public boolean isUseResultLevelCache()
  {
    return useResultLevelCache;
  }

  public int getNumBackgroundThreads()
  {
    return numBackgroundThreads;
  }

  public int getCacheBulkMergeLimit()
  {
    return cacheBulkMergeLimit;
  }

  public int getMaxEntrySize()
  {
    return maxEntrySize;
  }

  public int getResultLevelCacheLimit()
  {
    return resultLevelCacheLimit;
  }

  public boolean isQueryCacheable(Query query)
  {
    return isQueryCacheable(query.getType());
  }

  public boolean isQueryCacheable(String queryType)
  {
    // O(n) impl, but I don't think we'll ever have a million query types here
    return !unCacheable.contains(queryType);
  }
}