flink-libraries/flink-table/src/main/java/org/apache/flink/table/temptable/TableService.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
 *
 *     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.flink.table.temptable;

import java.util.List;

/**
 * The interface of TableService API.
 */
public interface TableService {

	/**
	 * Return a list of all the partition ids of the given table.
	 *
	 * @param tableName the name of the table.
	 * @return partition id in a list.
	 * @throws Exception
	 */
	List<Integer> getPartitions(String tableName) throws Exception;

	/**
	 * Append some bytes to one partition of a table.
	 * @param tableName the name of the table.
	 * @param partitionId partition id of the table.
	 * @param content bytes to append
	 * @return The number of bytes that have been successfully written.
	 * @throws Exception
	 */
	int write(String tableName, int partitionId, byte[] content) throws Exception;

	/**
	 * Given a table, read from the specified partition, starting from the given offset and read up to the given number of bytes.
	 * @param tableName the name of the table.
	 * @param partitionId partition id of the table.
	 * @param offset the start index for read.
	 * @param readCount the length for read.
	 * @return the bytes of successful read, may be shorter than readCount, never return null.
	 * @throws Exception
	 */
	byte[] read(String tableName, int partitionId, int offset, int readCount) throws Exception;

	/**
	 * initialize a table with specified partition, this request will delete the data if the given table name and partition id.
	 * @param tableName the name of the table.
	 * @param partitionId partition id of the table.
	 * @throws Exception
	 */
	void initializePartition(String tableName, int partitionId) throws Exception;

}