co.cask.cdap.data2.dataset2.lib.cube

Class CubeDatasetDefinition

java.lang.Object

co.cask.cdap.api.dataset.lib.AbstractDatasetDefinition<CubeDataset,co.cask.cdap.api.dataset.DatasetAdmin>

co.cask.cdap.data2.dataset2.lib.cube.CubeDatasetDefinition

All Implemented Interfaces:

co.cask.cdap.api.dataset.DatasetDefinition<CubeDataset,co.cask.cdap.api.dataset.DatasetAdmin>

public class CubeDatasetDefinition
extends co.cask.cdap.api.dataset.lib.AbstractDatasetDefinition<CubeDataset,co.cask.cdap.api.dataset.DatasetAdmin>

Dataset definition of CubeDataset, the dataset that implements Cube to store and query CubeFacts.

Cube dataset can be configured with aggregation resolutions and aggregations. E.g.

     dataset.cube.resolutions=1,60
     dataset.cube.aggregation.userPages.dimensions=user,page
     dataset.cube.aggregation.userPages.requiredDimensions=page
     dataset.cube.aggregation.userActions.dimensions=user,action
     dataset.cube.aggregation.userActions.requiredDimensions=action
    

• configures Cube to aggregate data for 1 second and 60 seconds resolutions
• configures "userPages" aggregation (name doesn't have any restricted format, can be any alphabetical) that aggregates measurements for user and page; allows querying e.g. number of visits of specific user of specific page
• configures "userActions" aggregation (name doesn't have any restricted format, can be any alphabetical) that aggregates measurements for user and action; allows querying e.g. number of specific actions of specific user

Aggregation is defined with list of dimensions to aggregate by and a list of required dimensions (dataset.cube.aggregation.[agg_name].dimensions and dataset.cube.aggregation.[agg_name].requiredDimensions properties respectively). The CubeFact measurement is aggregated within an aggregation if it contains all required dimensions which non-null value.

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	DEFAULT_RESOLUTIONS
static String	PROPERTY_AGGREGATION_PREFIX
static String	PROPERTY_DIMENSIONS
static String	PROPERTY_REQUIRED_DIMENSIONS

Fields inherited from interface co.cask.cdap.api.dataset.DatasetDefinition

NO_ARGUMENTS

Constructor Summary

Constructors

Constructor and Description
CubeDatasetDefinition(String name, co.cask.cdap.api.dataset.DatasetDefinition<? extends co.cask.cdap.api.dataset.table.Table,?> tableDef, co.cask.cdap.api.dataset.DatasetDefinition<MetricsTable,? extends co.cask.cdap.api.dataset.DatasetAdmin> metricsTableDef) Creates instance of CubeDatasetDefinition.

Method Summary

Methods

Modifier and Type	Method and Description
co.cask.cdap.api.dataset.DatasetSpecification	configure(String instanceName, co.cask.cdap.api.dataset.DatasetProperties properties)
co.cask.cdap.api.dataset.DatasetAdmin	getAdmin(co.cask.cdap.api.dataset.DatasetContext datasetContext, co.cask.cdap.api.dataset.DatasetSpecification spec, ClassLoader classLoader)
CubeDataset	getDataset(co.cask.cdap.api.dataset.DatasetContext datasetContext, co.cask.cdap.api.dataset.DatasetSpecification spec, Map<String,String> arguments, ClassLoader classLoader)

Methods inherited from class co.cask.cdap.api.dataset.lib.AbstractDatasetDefinition

getName

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_AGGREGATION_PREFIX

public static final String PROPERTY_AGGREGATION_PREFIX

See Also:

Constant Field Values

PROPERTY_DIMENSIONS

public static final String PROPERTY_DIMENSIONS

See Also:

Constant Field Values

PROPERTY_REQUIRED_DIMENSIONS

public static final String PROPERTY_REQUIRED_DIMENSIONS

See Also:

Constant Field Values

DEFAULT_RESOLUTIONS

public static final int[] DEFAULT_RESOLUTIONS

Constructor Detail

CubeDatasetDefinition

public CubeDatasetDefinition(String name,
                     co.cask.cdap.api.dataset.DatasetDefinition<? extends co.cask.cdap.api.dataset.table.Table,?> tableDef,
                     co.cask.cdap.api.dataset.DatasetDefinition<MetricsTable,? extends co.cask.cdap.api.dataset.DatasetAdmin> metricsTableDef)

Creates instance of CubeDatasetDefinition.

Parameters:

name - this dataset type name

tableDef - Table dataset definition, used to create tables to store cube data

metricsTableDef - MetricsTable dataset definition, used to create tables to store encoding mappings (see "entity" table). Has to be non-transactional: Cube dataset uses in-memory non-transactional cache in front of it, so all writes must be durable independent on transaction completion.

Method Detail

configure

public co.cask.cdap.api.dataset.DatasetSpecification configure(String instanceName,
                                                      co.cask.cdap.api.dataset.DatasetProperties properties)

getAdmin

public co.cask.cdap.api.dataset.DatasetAdmin getAdmin(co.cask.cdap.api.dataset.DatasetContext datasetContext,
                                             co.cask.cdap.api.dataset.DatasetSpecification spec,
                                             ClassLoader classLoader)
                                               throws IOException

Throws:

IOException

getDataset

public CubeDataset getDataset(co.cask.cdap.api.dataset.DatasetContext datasetContext,
                     co.cask.cdap.api.dataset.DatasetSpecification spec,
                     Map<String,String> arguments,
                     ClassLoader classLoader)
                       throws IOException

Throws:

IOException