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

com.datastax.driver.core.TableOptionsMetadata Maven / Gradle / Ivy

There is a newer version: 3.6.0-1
Show newest version
/*
 *      Copyright (C) 2012-2015 DataStax Inc.
 *
 *   Licensed 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 com.datastax.driver.core;

import com.datastax.driver.$internal.com.google.common.base.Objects;
import com.datastax.driver.$internal.com.google.common.collect.ImmutableMap;

import java.nio.ByteBuffer;
import java.util.Map;

public class TableOptionsMetadata {

    private static final String COMMENT = "comment";
    private static final String READ_REPAIR = "read_repair_chance";
    private static final String DCLOCAL_READ_REPAIR = "dclocal_read_repair_chance";
    private static final String LOCAL_READ_REPAIR = "local_read_repair_chance";
    private static final String REPLICATE_ON_WRITE = "replicate_on_write";
    private static final String GC_GRACE = "gc_grace_seconds";
    private static final String BF_FP_CHANCE = "bloom_filter_fp_chance";
    private static final String CACHING = "caching";
    private static final String COMPACTION = "compaction";
    private static final String COMPACTION_CLASS = "compaction_strategy_class";
    private static final String COMPACTION_OPTIONS = "compaction_strategy_options";
    private static final String POPULATE_CACHE_ON_FLUSH = "populate_io_cache_on_flush";
    private static final String COMPRESSION = "compression";
    private static final String COMPRESSION_PARAMS = "compression_parameters";
    private static final String MEMTABLE_FLUSH_PERIOD_MS = "memtable_flush_period_in_ms";
    private static final String DEFAULT_TTL = "default_time_to_live";
    private static final String SPECULATIVE_RETRY = "speculative_retry";
    private static final String INDEX_INTERVAL = "index_interval";
    private static final String MIN_INDEX_INTERVAL = "min_index_interval";
    private static final String MAX_INDEX_INTERVAL = "max_index_interval";
    private static final String CRC_CHECK_CHANCE = "crc_check_chance";
    private static final String EXTENSIONS = "extensions";

    private static final boolean DEFAULT_REPLICATE_ON_WRITE = true;
    private static final double DEFAULT_BF_FP_CHANCE = 0.01;
    private static final boolean DEFAULT_POPULATE_CACHE_ON_FLUSH = false;
    private static final int DEFAULT_MEMTABLE_FLUSH_PERIOD = 0;
    private static final int DEFAULT_DEFAULT_TTL = 0;
    private static final String DEFAULT_SPECULATIVE_RETRY = "NONE";
    private static final int DEFAULT_INDEX_INTERVAL = 128;
    private static final int DEFAULT_MIN_INDEX_INTERVAL = 128;
    private static final int DEFAULT_MAX_INDEX_INTERVAL = 2048;
    private static final double DEFAULT_CRC_CHECK_CHANCE = 1.0;

    private final boolean isCompactStorage;

    private final String comment;
    private final double readRepair;
    private final double localReadRepair;
    private final boolean replicateOnWrite;
    private final int gcGrace;
    private final double bfFpChance;
    private final Map caching;
    private final boolean populateCacheOnFlush;
    private final int memtableFlushPeriodMs;
    private final int defaultTTL;
    private final String speculativeRetry;
    private final Integer indexInterval;
    private final Integer minIndexInterval;
    private final Integer maxIndexInterval;
    private final Map compaction;
    private final Map compression;
    private final Double crcCheckChance;
    private final Map extensions;

    TableOptionsMetadata(Row row, boolean isCompactStorage, VersionNumber version) {

        boolean is120 = version.getMajor() < 2;
        boolean is200 = version.getMajor() == 2 && version.getMinor() == 0;
        boolean is210 = version.getMajor() == 2 && version.getMinor() >= 1;
        boolean is300OrHigher = version.getMajor() > 2;
        boolean is210OrHigher = is210 || is300OrHigher;

        this.isCompactStorage = isCompactStorage;
        this.comment = isNullOrAbsent(row, COMMENT) ? "" : row.getString(COMMENT);
        this.readRepair = row.getDouble(READ_REPAIR);

        if (is300OrHigher)
            this.localReadRepair = row.getDouble(DCLOCAL_READ_REPAIR);
        else
            this.localReadRepair = row.getDouble(LOCAL_READ_REPAIR);

        this.replicateOnWrite = is210OrHigher || isNullOrAbsent(row, REPLICATE_ON_WRITE) ? DEFAULT_REPLICATE_ON_WRITE : row.getBool(REPLICATE_ON_WRITE);
        this.gcGrace = row.getInt(GC_GRACE);
        this.bfFpChance = isNullOrAbsent(row, BF_FP_CHANCE) ? DEFAULT_BF_FP_CHANCE : row.getDouble(BF_FP_CHANCE);

        this.populateCacheOnFlush = isNullOrAbsent(row, POPULATE_CACHE_ON_FLUSH) ? DEFAULT_POPULATE_CACHE_ON_FLUSH : row.getBool(POPULATE_CACHE_ON_FLUSH);
        this.memtableFlushPeriodMs = is120 || isNullOrAbsent(row, MEMTABLE_FLUSH_PERIOD_MS) ? DEFAULT_MEMTABLE_FLUSH_PERIOD : row.getInt(MEMTABLE_FLUSH_PERIOD_MS);
        this.defaultTTL = is120 || isNullOrAbsent(row, DEFAULT_TTL) ? DEFAULT_DEFAULT_TTL : row.getInt(DEFAULT_TTL);
        this.speculativeRetry = is120 || isNullOrAbsent(row, SPECULATIVE_RETRY) ? DEFAULT_SPECULATIVE_RETRY : row.getString(SPECULATIVE_RETRY);

        if (is200)
            this.indexInterval = isNullOrAbsent(row, INDEX_INTERVAL) ? DEFAULT_INDEX_INTERVAL : row.getInt(INDEX_INTERVAL);
        else
            this.indexInterval = null;

        if (is210OrHigher) {
            this.minIndexInterval = isNullOrAbsent(row, MIN_INDEX_INTERVAL)
                    ? DEFAULT_MIN_INDEX_INTERVAL
                    : row.getInt(MIN_INDEX_INTERVAL);
            this.maxIndexInterval = isNullOrAbsent(row, MAX_INDEX_INTERVAL)
                    ? DEFAULT_MAX_INDEX_INTERVAL
                    : row.getInt(MAX_INDEX_INTERVAL);
        } else {
            this.minIndexInterval = null;
            this.maxIndexInterval = null;
        }

        if (is300OrHigher) {
            this.caching = ImmutableMap.copyOf(row.getMap(CACHING, String.class, String.class));
        } else if (is210) {
            this.caching = ImmutableMap.copyOf(SimpleJSONParser.parseStringMap(row.getString(CACHING)));
        } else {
            this.caching = ImmutableMap.of("keys", row.getString(CACHING));
        }

        if (is300OrHigher)
            this.compaction = ImmutableMap.copyOf(row.getMap(COMPACTION, String.class, String.class));
        else {
            this.compaction = ImmutableMap.builder()
                    .put("class", row.getString(COMPACTION_CLASS))
                    .putAll(SimpleJSONParser.parseStringMap(row.getString(COMPACTION_OPTIONS)))
                    .build();
        }

        if (is300OrHigher)
            this.compression = ImmutableMap.copyOf(row.getMap(COMPRESSION, String.class, String.class));
        else
            this.compression = ImmutableMap.copyOf(SimpleJSONParser.parseStringMap(row.getString(COMPRESSION_PARAMS)));

        if (is300OrHigher)
            this.crcCheckChance = isNullOrAbsent(row, CRC_CHECK_CHANCE)
                    ? DEFAULT_CRC_CHECK_CHANCE
                    : row.getDouble(CRC_CHECK_CHANCE);
        else
            this.crcCheckChance = null;

        if (is300OrHigher)
            this.extensions = ImmutableMap.copyOf(row.getMap(EXTENSIONS, String.class, ByteBuffer.class));
        else
            this.extensions = ImmutableMap.of();
    }

    private static boolean isNullOrAbsent(Row row, String name) {
        return row.getColumnDefinitions().getIndexOf(name) < 0
                || row.isNull(name);
    }

    /**
     * Returns whether the table uses the {@code COMPACT STORAGE} option.
     *
     * @return whether the table uses the {@code COMPACT STORAGE} option.
     */
    public boolean isCompactStorage() {
        return isCompactStorage;
    }

    /**
     * Returns the commentary set for this table.
     *
     * @return the commentary set for this table, or {@code null} if noe has been set.
     */
    public String getComment() {
        return comment;
    }

    /**
     * Returns the chance with which a read repair is triggered for this table.
     *
     * @return the read repair chance set for table (in [0.0, 1.0]).
     */
    public double getReadRepairChance() {
        return readRepair;
    }

    /**
     * Returns the cluster local read repair chance set for this table.
     *
     * @return the local read repair chance set for table (in [0.0, 1.0]).
     */
    public double getLocalReadRepairChance() {
        return localReadRepair;
    }

    /**
     * Returns whether replicateOnWrite is set for this table.
     * 

* This is only meaningful for tables holding counters. * * @return whether replicateOnWrite is set for this table. */ public boolean getReplicateOnWrite() { return replicateOnWrite; } /** * Returns the tombstone garbage collection grace time in seconds for this table. * * @return the tombstone garbage collection grace time in seconds for this table. */ public int getGcGraceInSeconds() { return gcGrace; } /** * Returns the false positive chance for the Bloom filter of this table. * * @return the Bloom filter false positive chance for this table (in [0.0, 1.0]). */ public double getBloomFilterFalsePositiveChance() { return bfFpChance; } /** * Returns the caching options for this table. * * @return an immutable map containing the caching options for this table. */ public Map getCaching() { return caching; } /** * Whether the populate I/O cache on flush is set on this table. * * @return whether the populate I/O cache on flush is set on this table. */ public boolean getPopulateIOCacheOnFlush() { return populateCacheOnFlush; } /* * Returns the memtable flush period (in milliseconds) option for this table. *

* Note: this option is not available in Cassandra 1.2 and will return 0 (no periodic * flush) when connected to 1.2 nodes. * * @return the memtable flush period option for this table or 0 if no * periodic flush is configured. */ public int getMemtableFlushPeriodInMs() { return memtableFlushPeriodMs; } /** * Returns the default TTL for this table. *

* Note: this option is not available in Cassandra 1.2 and will return 0 (no default * TTL) when connected to 1.2 nodes. * * @return the default TTL for this table or 0 if no default TTL is * configured. */ public int getDefaultTimeToLive() { return defaultTTL; } /** * Returns the speculative retry option for this table. *

* Note: this option is not available in Cassandra 1.2 and will return "NONE" (no * speculative retry) when connected to 1.2 nodes. * * @return the speculative retry option this table. */ public String getSpeculativeRetry() { return speculativeRetry; } /** * Returns the index interval option for this table. *

* Note: this option is not available in Cassandra 1.2 (more precisely, it is not * configurable per-table) and will return 128 (the default index interval) when * connected to 1.2 nodes. It is deprecated in Cassandra 2.1 and above, and will * therefore return {@code null} for 2.1 nodes. * * @return the index interval option for this table. */ public Integer getIndexInterval() { return indexInterval; } /** * Returns the minimum index interval option for this table. *

* Note: this option is available in Cassandra 2.1 and above, and will return * {@code null} for earlier versions. * * @return the minimum index interval option for this table. */ public Integer getMinIndexInterval() { return minIndexInterval; } /** * Returns the maximum index interval option for this table. *

* Note: this option is available in Cassandra 2.1 and above, and will return * {@code null} for earlier versions. * * @return the maximum index interval option for this table. */ public Integer getMaxIndexInterval() { return maxIndexInterval; } /** * When compression is enabled, this option defines the probability * with which checksums for compressed blocks are checked during reads. * The default value for this options is 1.0 (always check). *

* Note that this option is available in Cassandra 3.0.0 and above, when it * became a "top-level" table option, whereas previously it was a suboption * of the {@link #getCompression() compression} option. *

* For Cassandra versions prior to 3.0.0, this method always returns {@code null}. * * @return the probability with which checksums for compressed blocks are checked during reads */ public Double getCrcCheckChance() { return crcCheckChance; } /** * Returns the compaction options for this table. * * @return an immutable map containing the compaction options for this table. */ public Map getCompaction() { return compaction; } /** * Returns the compression options for this table. * * @return an immutable map containing the compression options for this table. */ public Map getCompression() { return compression; } /** * Returns the extension options for this table. *

* For Cassandra versions prior to 3.0.0, this method always returns an empty map. * * @return an immutable map containing the extension options for this table. */ public Map getExtensions() { return extensions; } @Override public boolean equals(Object other) { if (other == this) return true; if (!(other instanceof TableOptionsMetadata)) return false; TableOptionsMetadata that = (TableOptionsMetadata) other; return this.isCompactStorage == that.isCompactStorage && Objects.equal(this.comment, that.comment) && this.readRepair == that.readRepair && this.localReadRepair == that.localReadRepair && this.replicateOnWrite == that.replicateOnWrite && this.gcGrace == that.gcGrace && this.bfFpChance == that.bfFpChance && Objects.equal(this.caching, that.caching) && this.populateCacheOnFlush == that.populateCacheOnFlush && this.memtableFlushPeriodMs == that.memtableFlushPeriodMs && this.defaultTTL == that.defaultTTL && Objects.equal(this.speculativeRetry, that.speculativeRetry) && Objects.equal(this.indexInterval, that.indexInterval) && Objects.equal(this.minIndexInterval, that.minIndexInterval) && Objects.equal(this.maxIndexInterval, that.maxIndexInterval) && Objects.equal(this.compaction, that.compaction) && Objects.equal(this.compression, that.compression) && Objects.equal(this.crcCheckChance, that.crcCheckChance) && Objects.equal(this.extensions, that.extensions); } @Override public int hashCode() { return Objects.hashCode(isCompactStorage, comment, readRepair, localReadRepair, replicateOnWrite, gcGrace, bfFpChance, caching, populateCacheOnFlush, memtableFlushPeriodMs, defaultTTL, speculativeRetry, indexInterval, minIndexInterval, maxIndexInterval, compaction, compression, crcCheckChance, extensions); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy