com.clickzetta.platform.client.api.BulkLoadWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of clickzetta-java Show documentation

The java SDK for clickzetta's Lakehouse

There is a newer version: 2.0.0

package com.clickzetta.platform.client.api;

import com.clickzetta.platform.client.Table;
import com.clickzetta.platform.common.Schema;

import java.io.Closeable;
import java.io.IOException;
import java.util.Optional;

public interface BulkLoadWriter extends Closeable {

  // Getters

  /**
   * Return the stream id of the current BulkLoadStream.
   */
  String getStreamId();

  /**
   * Operation of the current BulkLoadStream.
   * 
   * Supported values: APPEND, UPSERT, OVERWRITE.
   */
  BulkLoadOperation getOperation();

  /**
   * Get table schema. Virtual or hidden columns are excluded.
   */
  @Deprecated
  Schema getSchema();

  /**
   * Get table meta data.
   */
  Table getTable();

  /**
   * Get partition specs when the BulkLoadStream is created.
   */
  Optional getPartitionSpecs();

  /**
   * Return the uniqueId associated with this writer.
   */
  long getPartitionId();

  // Write

  /**
   * Create a row with full table schema.
   */
  Row createRow();

  /**
   * Write a row to the BulkLoadStream.
   */
  void write(Row... rows) throws IOException;

}