fe/src/main/java/org/apache/impala/analysis/AlterTableSortByStmt.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.impala.analysis;

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

import org.apache.impala.catalog.FeHBaseTable;
import org.apache.impala.catalog.FeKuduTable;
import org.apache.impala.catalog.FeTable;
import org.apache.impala.common.AnalysisException;
import org.apache.impala.thrift.TAlterTableParams;
import org.apache.impala.thrift.TAlterTableSetTblPropertiesParams;
import org.apache.impala.thrift.TAlterTableType;
import org.apache.impala.thrift.TTablePropertyType;
import org.apache.impala.thrift.TSortingOrder;
import com.google.common.base.Joiner;
import com.google.common.base.Preconditions;

/**
* Represents an ALTER TABLE SORT BY [LEXICAL|ZORDER] (c1, c2, ...) statement.
*
*/
public class AlterTableSortByStmt extends AlterTableStmt {
  // Table property key for sort.columns
  public static final String TBL_PROP_SORT_COLUMNS = "sort.columns";
  public static final String TBL_PROP_SORT_ORDER = "sort.order";

  private final List<String> columns_;
  private final TSortingOrder sortingOrder_;

  public AlterTableSortByStmt(TableName tableName, List<String> columns,
      TSortingOrder sortingOrder) {
    super(tableName);
    Preconditions.checkNotNull(columns);
    columns_ = columns;
    sortingOrder_ = sortingOrder;
  }

  @Override
  public TAlterTableParams toThrift() {
    TAlterTableParams params = super.toThrift();
    params.setAlter_type(TAlterTableType.SET_TBL_PROPERTIES);
    TAlterTableSetTblPropertiesParams tblPropertyParams =
        new TAlterTableSetTblPropertiesParams();
    tblPropertyParams.setTarget(TTablePropertyType.TBL_PROPERTY);
    Map<String, String> properties = new HashMap<>();
    properties.put(TBL_PROP_SORT_COLUMNS, Joiner.on(",").join(columns_));
    properties.put(TBL_PROP_SORT_ORDER, sortingOrder_.toString());
    tblPropertyParams.setProperties(properties);
    params.setSet_tbl_properties_params(tblPropertyParams);
    return params;
  }

  @Override
  public void analyze(Analyzer analyzer) throws AnalysisException {
    super.analyze(analyzer);
    // Disallow setting sort columns on HBase and Kudu tables.
    FeTable targetTable = getTargetTable();
    if (targetTable instanceof FeHBaseTable) {
      throw new AnalysisException(String.format("ALTER TABLE SORT BY not supported "
          + "on HBase tables."));
    }
    if (targetTable instanceof FeKuduTable) {
      throw new AnalysisException(String.format("ALTER TABLE SORT BY not supported "
          + "on Kudu tables."));
    }

    TableDef.analyzeSortColumns(columns_, targetTable, sortingOrder_);
  }
}