java/core/src/java/org/apache/orc/impl/OrcAcidUtils.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
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * 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.orc.impl;

import org.apache.hadoop.fs.FSDataInputStream;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.orc.Reader;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.charset.CharacterCodingException;
import java.nio.charset.Charset;
import java.nio.charset.CharsetDecoder;

public class OrcAcidUtils {
  public static final String ACID_STATS = "hive.acid.stats";
  public static final String DELTA_SIDE_FILE_SUFFIX = "_flush_length";

  /**
   * Get the filename of the ORC ACID side file that contains the lengths
   * of the intermediate footers.
   * @param main the main ORC filename
   * @return the name of the side file
   */
  public static Path getSideFile(Path main) {
    return new Path(main + DELTA_SIDE_FILE_SUFFIX);
  }

  /**
   * Read the side file to get the last flush length.
   * @param fs the file system to use
   * @param deltaFile the path of the delta file
   * @return the maximum size of the file to use
   * @throws IOException
   */
  public static long getLastFlushLength(FileSystem fs,
                                        Path deltaFile) throws IOException {
    Path lengths = getSideFile(deltaFile);
    long result = Long.MAX_VALUE;
    if(!fs.exists(lengths)) {
      return result;
    }
    try (FSDataInputStream stream = fs.open(lengths)) {
      result = -1;
      while (stream.available() > 0) {
        result = stream.readLong();
      }
      return result;
    } catch (IOException ioe) {
      return result;
    }
  }

  private static final Charset utf8 = Charset.forName("UTF-8");
  private static final CharsetDecoder utf8Decoder = utf8.newDecoder();

  public static AcidStats parseAcidStats(Reader reader) {
    if (reader.hasMetadataValue(ACID_STATS)) {
      try {
        ByteBuffer val = reader.getMetadataValue(ACID_STATS).duplicate();
        return new AcidStats(utf8Decoder.decode(val).toString());
      } catch (CharacterCodingException e) {
        throw new IllegalArgumentException("Bad string encoding for " +
            ACID_STATS, e);
      }
    } else {
      return null;
    }
  }

}