org.apache.asterix.metadata.entities

Class InternalDatasetDetails

java.lang.Object

org.apache.asterix.metadata.entities.InternalDatasetDetails

All Implemented Interfaces:

Serializable, IDatasetDetails

public class InternalDatasetDetails
extends Object
implements IDatasetDetails

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalDatasetDetails.FileStructure
static class	InternalDatasetDetails.PartitioningStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autogenerated
protected InternalDatasetDetails.FileStructure	fileStructure
static String	FILTER_FIELD_NAME
protected List<String>	filterField
protected long	lastAccessTime
protected List<List<String>>	partitioningKeys
protected InternalDatasetDetails.PartitioningStrategy	partitioningStrategy
protected List<List<String>>	primaryKeys
protected List<IAType>	primaryKeyTypes
protected boolean	temp

Constructor Summary

Constructors

Constructor and Description
InternalDatasetDetails(InternalDatasetDetails.FileStructure fileStructure, InternalDatasetDetails.PartitioningStrategy partitioningStrategy, List<List<String>> partitioningKey, List<List<String>> primaryKey, List<IAType> primaryKeyType, boolean autogenerated, List<String> filterField, boolean temp)

Method Summary

Methods

Modifier and Type	Method and Description
DatasetConfig.DatasetType	getDatasetType()
InternalDatasetDetails.FileStructure	getFileStructure()
List<String>	getFilterField()
long	getLastAccessTime()
List<List<String>>	getPartitioningKey()
InternalDatasetDetails.PartitioningStrategy	getPartitioningStrategy()
List<List<String>>	getPrimaryKey()
List<IAType>	getPrimaryKeyType()
boolean	isAutogenerated()
boolean	isTemp()
void	writeDatasetDetailsRecordType(DataOutput out)
protected void	writePropertyTypeRecord(String name, String value, DataOutput out, ARecordType recordType)

Methods inherited from class java.lang.Object

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

Field Detail

fileStructure

protected final InternalDatasetDetails.FileStructure fileStructure

partitioningStrategy

protected final InternalDatasetDetails.PartitioningStrategy partitioningStrategy

partitioningKeys

protected final List<List<String>> partitioningKeys

primaryKeys

protected final List<List<String>> primaryKeys

primaryKeyTypes

protected final List<IAType> primaryKeyTypes

autogenerated

protected final boolean autogenerated

temp

protected final boolean temp

lastAccessTime

protected long lastAccessTime

filterField

protected final List<String> filterField

FILTER_FIELD_NAME

public static final String FILTER_FIELD_NAME

See Also:

Constant Field Values

Constructor Detail

InternalDatasetDetails

public InternalDatasetDetails(InternalDatasetDetails.FileStructure fileStructure,
                      InternalDatasetDetails.PartitioningStrategy partitioningStrategy,
                      List<List<String>> partitioningKey,
                      List<List<String>> primaryKey,
                      List<IAType> primaryKeyType,
                      boolean autogenerated,
                      List<String> filterField,
                      boolean temp)

Method Detail

getPartitioningKey

public List<List<String>> getPartitioningKey()

isAutogenerated

public boolean isAutogenerated()

getPrimaryKey

public List<List<String>> getPrimaryKey()

getPrimaryKeyType

public List<IAType> getPrimaryKeyType()

getFileStructure

public InternalDatasetDetails.FileStructure getFileStructure()

getPartitioningStrategy

public InternalDatasetDetails.PartitioningStrategy getPartitioningStrategy()

getFilterField

public List<String> getFilterField()

getDatasetType

public DatasetConfig.DatasetType getDatasetType()

Specified by:

getDatasetType in interface IDatasetDetails

getLastAccessTime

public long getLastAccessTime()

Specified by:

getLastAccessTime in interface IDatasetDetails

isTemp

public boolean isTemp()

Specified by:

isTemp in interface IDatasetDetails

Returns:

if the dataset is a temporary dataset. Here is a summary of temporary datasets: 1. Different from a persistent dataset, reads and writes over a temporary dataset do not require any lock. Writes over a temporary dataset do not generate any write-ahead update and commit log but generate flush log and job commit log. 2. A temporary dataset can only be an internal dataset, stored in partitioned LSM-Btrees. 3. All secondary indexes for persistent datasets are supported for temporary datasets. 4. A temporary dataset will be automatically garbage collected if it is not active in the past 30 days. A temporary dataset could be used for the following scenarios: 1. A data scientist wants to run some one-time data analysis queries over a dataset that s/he pre-processed and the dataset is only used by her/himself in an one-query-at-a-time manner. 2. Articulate AQL with external systems such as Pregelix/IMRU/Spark. A user can first run an AQL query to populate a temporary dataset, then kick off an external runtime to read this dataset, dump the results of the external runtime to yet-another-temporary dataset, and finally run yet-another AQL over the second temporary dataset.

writeDatasetDetailsRecordType

public void writeDatasetDetailsRecordType(DataOutput out)
                                   throws org.apache.hyracks.api.exceptions.HyracksDataException

Specified by:

writeDatasetDetailsRecordType in interface IDatasetDetails

Throws:

org.apache.hyracks.api.exceptions.HyracksDataException

writePropertyTypeRecord

protected void writePropertyTypeRecord(String name,
                           String value,
                           DataOutput out,
                           ARecordType recordType)
                                throws org.apache.hyracks.api.exceptions.HyracksDataException

Throws:

org.apache.hyracks.api.exceptions.HyracksDataException