alluxio.client.lineage

Class AbstractLineageClient

java.lang.Object

alluxio.client.lineage.AbstractLineageClient

Direct Known Subclasses:

AlluxioLineage

@PublicApi
 @ThreadSafe
public abstract class AbstractLineageClient
extends Object

Alluxio Lineage client. This class provides implementation of interacting with Alluxio Lineage master.

Field Summary

Fields

Modifier and Type	Field and Description
protected LineageContext	mContext

Constructor Summary

Constructors

Constructor and Description
AbstractLineageClient(LineageContext context) Constructs a new instance with a LineageContext.

Method Summary

Modifier and Type	Method and Description
long	createLineage(List<AlluxioURI> inputFiles, List<AlluxioURI> outputFiles, Job job, CreateLineageOptions options) Creates a lineage.
boolean	deleteLineage(long lineageId, DeleteLineageOptions options) Deletes a lineage identified by a given id.
List<LineageInfo>	getLineageInfoList(GetLineageInfoListOptions options) Lists all the lineages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mContext

protected LineageContext mContext

Constructor Detail

AbstractLineageClient

public AbstractLineageClient(LineageContext context)

Constructs a new instance with a LineageContext.

Parameters:

context - lineage context

Method Detail

createLineage

public long createLineage(List<AlluxioURI> inputFiles,
                          List<AlluxioURI> outputFiles,
                          Job job,
                          CreateLineageOptions options)
                   throws FileDoesNotExistException,
                          AlluxioException,
                          IOException

Creates a lineage. It requires all the input files either exist in Alluxio storage, or have been added as output files in other lineages. It also requires the output files do not exist in Alluxio, and it will create an empty file for each of the output files.

Parameters:

inputFiles - the files that the job depends on

outputFiles - the files that the job outputs

job - the job that takes the listed input file and computes the output file

options - the method options

Returns:

the lineage id

Throws:

FileDoesNotExistException - an input file does not exist in Alluxio storage, nor is added as an output file of an existing lineage

AlluxioException

IOException

deleteLineage

public boolean deleteLineage(long lineageId,
                             DeleteLineageOptions options)
                      throws IOException,
                             LineageDoesNotExistException,
                             LineageDeletionException,
                             AlluxioException

Deletes a lineage identified by a given id. If the delete is cascade, it will delete all the downstream lineages that depend on the given one recursively. Otherwise it throw a lineage deletion exception, when there are other lineages whose input files are the output files of the specified lineage.

Parameters:

lineageId - the id of the lineage

options - method options

Returns:

true if the lineage deletion is successful, false otherwise

Throws:

LineageDoesNotExistException - if the lineage does not exist

LineageDeletionException - if the deletion is cascade but the lineage has children

IOException

AlluxioException

getLineageInfoList

public List<LineageInfo> getLineageInfoList(GetLineageInfoListOptions options)
                                     throws IOException

Lists all the lineages.

Parameters:

options - method options

Returns:

the information about lineages

Throws:

IOException