com.uber.hoodie.common.table.SyncableFileSystemView Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hoodie-common Show documentation

The newest version!

/*
 *  Copyright (c) 2019 Uber Technologies, Inc. ([email protected])
 *
 *  Licensed 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 com.uber.hoodie.common.table;

/*
 * A consolidated file-system view interface exposing both realtime and read-optimized views along with
 * update operations.
 */
public interface SyncableFileSystemView extends TableFileSystemView, TableFileSystemView.ReadOptimizedView,
    TableFileSystemView.RealtimeView {



  /**
   * Allow View to release resources and close
   */
  void close();

  /**
   * Reset View so that they can be refreshed
   */
  void reset();

  /**
   * Read the latest timeline and refresh the file-system view to match the current state of the file-system.
   * The refresh can either be done incrementally (from reading file-slices in metadata files) or from scratch by
   * reseting view storage
   */
  void sync();
}