accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From joshelser <...@git.apache.org>
Subject [GitHub] accumulo pull request: ACCUMULO-4165 Added a user facing API for R...
Date Fri, 27 May 2016 22:54:02 GMT
Github user joshelser commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/103#discussion_r64975799
  
    --- Diff: core/src/main/java/org/apache/accumulo/core/client/rfile/RFile.java ---
    @@ -0,0 +1,271 @@
    +/*
    + * 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.accumulo.core.client.rfile;
    +
    +import java.io.IOException;
    +import java.io.OutputStream;
    +import java.util.Map;
    +import java.util.Map.Entry;
    +
    +import org.apache.accumulo.core.client.Scanner;
    +import org.apache.accumulo.core.client.admin.TableOperations;
    +import org.apache.accumulo.core.client.sample.SamplerConfiguration;
    +import org.apache.accumulo.core.data.Key;
    +import org.apache.accumulo.core.security.Authorizations;
    +import org.apache.hadoop.fs.FileSystem;
    +import org.apache.hadoop.io.Text;
    +
    +/**
    + * RFile is Accumulo's internal storage format for Key Value pairs. This class is a Factory
that enables creating a {@link Scanner} for reading and a
    + * {@link RFileWriter} for writing Rfiles.
    + *
    + * <p>
    + * The {@link Scanner} created by this class makes it easy to experiment with real data
from a live system on a developers workstation. Also the {@link Scanner}
    + * can be used to write tools to analyze Accumulo's raw data.
    + *
    + * @since 1.8.0
    + */
    +public class RFile {
    +
    +  public static interface InputArguments {
    +    /**
    +     * Specify RFiles to read from. When multiple are specified the {@link Scanner} constructed
will present a merged view.
    +     *
    +     * @param inputs
    +     *          one or more RFiles to read.
    +     * @return this
    +     */
    +    ScannerOptions from(RFileSource... inputs);
    +
    +    /**
    +     * Specify RFiles to read from. When multiple are specified the {@link Scanner} constructed
will present a merged view.
    +     *
    +     * @param files
    +     *          one or more RFiles to read.
    +     * @return this
    +     */
    +    ScannerFSOptions from(String... files);
    +  }
    +
    +  public static interface ScannerFSOptions extends ScannerOptions {
    +    /**
    +     * Optionally provide a FileSystem to open RFiles. If not specified, the FileSystem
will be constructed using configuration on the classpath.
    +     *
    +     * @param fs
    +     *          use this FileSystem to open files.
    +     * @return this
    +     */
    +    ScannerOptions withFileSystem(FileSystem fs);
    +  }
    +
    +  public static interface ScannerOptions {
    +
    +    /**
    +     * By default the {@link Scanner} created will setup the default Accumulo system
iterators. The iterators do things like the following :
    +     *
    +     * <ul>
    +     * <li>Suppress deleted data</li>
    +     * <li>Filter based on @link {@link Authorizations}</li>
    +     * <li>Filter columns specified by functions like {@link Scanner#fetchColumn(Text,
Text)} and {@link Scanner#fetchColumnFamily(Text)}</li>
    +     * </ul>
    +     *
    +     * <p>
    +     * Calling this method will turn off these system iterators and allow reading the
raw data in an RFile. When reading the raw data, delete data and delete
    +     * markers may be seen. Delete markers are {@link Key}s with the delete flag set.
    +     *
    +     * <p>
    +     * Disabling system iterators will cause {@link #withAuthorizations(Authorizations)},
{@link Scanner#fetchColumn(Text, Text)}, and
    +     * {@link Scanner#fetchColumnFamily(Text)} to throw runtime exceptions.
    +     *
    +     * @return this
    +     */
    +    public ScannerOptions withoutSystemIterators();
    +
    +    /**
    +     * The authorizations passed here will be used to filter Keys, from the {@link Scanner},
based on the content of the column visibility field.
    +     *
    +     * @param auths
    +     *          scan with these authorizations
    +     * @return this
    +     */
    +    public ScannerOptions withAuthorizations(Authorizations auths);
    +
    +    /**
    +     * Enabling this option will cache RFiles data in memory. This option is useful when
doing lots of random accesses.
    +     *
    +     * @param cacheSize
    +     *          the size of the data cache in bytes.
    +     * @return this
    +     */
    +    public ScannerOptions withDataCache(long cacheSize);
    +
    +    /**
    +     * Enabling this option will cache RFiles indexes in memory. Index data within a
RFile is used to find data when seeking to a {@link Key}. This option is
    +     * useful when doing lots of random accesses.
    +     *
    +     * @param cacheSize
    +     *          the size of the index cache in bytes.
    +     * @return this
    +     */
    +    public ScannerOptions withIndexCache(long cacheSize);
    +
    +    /**
    +     * This option allows limiting the {@link Scanner} from reading data less than or
equal to the specified row from the RFiles. If not specified then there is
    +     * no lower bound.
    +     *
    +     * @param row
    +     *          exclusive lower bound
    +     * @return this
    +     */
    +    public ScannerOptions withLowerBound(byte[] row);
    +
    +    /**
    +     * @see #withLowerBound(byte[])
    +     * @param row
    +     *          encoded as UTF-8
    +     */
    +    public ScannerOptions withLowerBound(String row);
    +
    +    /**
    +     * @see #withLowerBound(byte[])
    +     */
    +    public ScannerOptions withLowerBound(Text row);
    +
    +    /**
    +     * This option allows limiting the {@link Scanner} from reading data greater than
the specified row from the RFiles. If not specified then there is no upper
    +     * bound.
    +     *
    +     * @param row
    +     *          inclusive upper bound bound
    +     * @return this
    +     */
    +    public ScannerOptions withUpperBound(byte[] row);
    +
    +    /**
    +     * @see #withUpperBound(byte[])
    +     * @param row
    +     *          encoded as UTF-8
    +     */
    +    public ScannerOptions withUpperBound(String row);
    +
    +    /**
    +     * @see #withUpperBound(byte[])
    +     */
    +    public ScannerOptions withUpperBound(Text row);
    +
    +    /**
    +     * Construct the {@link Scanner} with iterators specified in a tables properties.
Properties for a table can be obtained by calling
    +     * {@link TableOperations#getProperties(String)}
    +     *
    +     * @param props
    +     *          iterable over Accumulo table key value properties.
    +     * @return this
    +     */
    +    public ScannerOptions withTableProperties(Iterable<Entry<String,String>>
props);
    +
    +    /**
    +     * @see #withTableProperties(Iterable)
    +     * @param props
    +     *          a map instead of an Iterable
    +     * @return this
    +     */
    +    public ScannerOptions withTableProperties(Map<String,String> props);
    +
    +    /**
    +     * @return a Scanner over RFile using the specified options.
    +     */
    +    public Scanner build();
    +  }
    +
    +  /**
    +   * Entry point for building a new {@link Scanner} over one or more RFiles.
    +   */
    +  public static InputArguments newScanner() {
    +    return new RFileScannerBuilder();
    +  }
    +
    +  public static interface OutputArguments {
    --- End diff --
    
    Same here, should have javadoc on the interface


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message