org.apache.parquet.cli.commands.ShowFooterCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of parquet-cli Show documentation
The newest version!
/*
 * 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.parquet.cli.commands;

import static org.apache.parquet.hadoop.ParquetFileWriter.MAGIC;

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import org.apache.parquet.cli.BaseCommand;
import org.apache.parquet.cli.util.RawUtils;
import org.apache.parquet.format.CliUtils;
import org.apache.parquet.hadoop.ParquetFileReader;
import org.apache.parquet.hadoop.metadata.ParquetMetadata;
import org.apache.parquet.hadoop.util.HadoopInputFile;
import org.apache.parquet.io.InputFile;
import org.apache.parquet.io.SeekableInputStream;
import org.slf4j.Logger;

@Parameters(commandDescription = "Print the Parquet file footer in json format")
public class ShowFooterCommand extends BaseCommand {

  public ShowFooterCommand(Logger console) {
    super(console);
  }

  @Parameter(description = "", required = true)
  String target;

  @Parameter(
      names = {"-r", "--raw"},
      description = "Print the raw thrift object of the footer")
  boolean raw = false;

  @Override
  public int run() throws IOException {
    InputFile inputFile = HadoopInputFile.fromPath(qualifiedPath(target), getConf());

    console.info(raw ? readRawFooter(inputFile) : readFooter(inputFile));

    return 0;
  }

  private String readFooter(InputFile inputFile) throws JsonProcessingException, IOException {
    String json;
    try (ParquetFileReader reader = ParquetFileReader.open(inputFile)) {
      ParquetMetadata footer = reader.getFooter();
      ObjectMapper mapper = RawUtils.createObjectMapper();
      mapper.setVisibility(PropertyAccessor.ALL, Visibility.NONE);
      mapper.setVisibility(PropertyAccessor.FIELD, Visibility.ANY);
      json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(footer);
    }
    return json;
  }

  private String readRawFooter(InputFile file) throws IOException {
    long fileLen = file.getLength();

    int FOOTER_LENGTH_SIZE = 4;
    if (fileLen < MAGIC.length + FOOTER_LENGTH_SIZE + MAGIC.length) { // MAGIC + data + footer + footerIndex + MAGIC
      throw new RuntimeException("Not a Parquet file (length is too low: " + fileLen + ")");
    }

    try (SeekableInputStream f = file.newStream()) {
      return RawUtils.prettifyJson(CliUtils.toJson(RawUtils.readFooter(f, fileLen)));
    }
  }

  @Override
  public List getExamples() {
    return Arrays.asList(
        "# Print the parquet-mr interpreted footer of the specified Parquet file in json format",
        "sample.parquet",
        "# Print the raw thrift footer object of the specified Parquet file in json format",
        "sample.parquet --raw");
  }
}