asterixdb/asterix-common/src/main/java/org/apache/asterix/common/config/DatasetConfig.java

/*
 * 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.asterix.common.config;

import java.util.HashMap;
import java.util.Map;

public class DatasetConfig {

    /*
     * We have two kinds of datasets. INTERNAL: A dataset with data persisted
     * in ASTERIX storage. The dataset is populated either using a load
     * statement or using insert statement. EXTERNAL: A dataset with data
     * residing outside ASTERIX. As such ASTERIX does not maintain any indexes
     * on the data. The data for the dataset is fetched as and when required
     * from an external data source using an adapter.
     */
    public enum DatasetType {
        INTERNAL,
        EXTERNAL,
        VIEW
    }

    public enum IndexType {
        BTREE,
        RTREE,
        SINGLE_PARTITION_WORD_INVIX,
        SINGLE_PARTITION_NGRAM_INVIX,
        LENGTH_PARTITIONED_WORD_INVIX,
        LENGTH_PARTITIONED_NGRAM_INVIX,
        ARRAY,
        SAMPLE
    }

    public enum TransactionState {
        /**
         * The committed state <- nothing is required->
         */
        COMMIT,
        /**
         * The state after starting the refresh transaction
         * <- will either abort moving to committed state or move to ready to commit->
         */
        BEGIN,
        /**
         * The transaction is ready to commit <- can only move forward to committed state->
         */
        READY_TO_COMMIT
    }

    public enum ExternalFilePendingOp {
        /**
         * the stored file is part of a committed transaction nothing is required
         */
        NO_OP,
        /**
         * the stored file is part of an ongoing transaction (will be added if transaction succeed)
         */
        ADD_OP,
        /**
         * the stored file is part of an ongoing transaction (will be dropped if transaction succeed)
         */
        DROP_OP,
        /**
         * the stored file is part of an ongoing transaction (will be updated if transaction succeed)
         */
        APPEND_OP
    }

    public enum DatasetFormat {
        /**
         * Row format using ADM
         */
        ROW("row"),
        /**
         * Column format using AMAX
         */
        COLUMN("column");

        private final String format;
        private static final Map<String, DatasetFormat> FORMATS = createFormats();

        DatasetFormat(String format) {
            this.format = format;
        }

        private static Map<String, DatasetFormat> createFormats() {
            Map<String, DatasetFormat> formats = new HashMap<>();
            for (DatasetFormat format : DatasetFormat.values()) {
                formats.put(format.format, format);
            }
            return formats;
        }

        public static DatasetFormat getFormat(String format) {
            return FORMATS.get(format.trim().toLowerCase());
        }
    }
}