Package | Description |
---|---|
io.cdap.cdap.api |
Interfaces for program and resource specifications, program lifecycle, runtime context and processors.
|
io.cdap.cdap.api.dataset |
Defines APIs for accessing and managing data within CDAP.
|
io.cdap.cdap.api.dataset.lib |
Collection of
Dataset implementations available out-of-the-box in CDAP. |
io.cdap.cdap.api.dataset.table |
Provides access to the system-level table
Dataset s available within CDAP. |
io.cdap.cdap.api.workflow |
For constructing workflows.
|
io.cdap.cdap.internal.api |
This package contains internal classes for supporting the CDAP API.
|
io.cdap.cdap.internal.dataset |
This package contains internal classes for supporting the CDAP API.
|
Modifier and Type | Method and Description |
---|---|
void |
DatasetConfigurer.createDataset(String datasetName,
Class<? extends Dataset> datasetClass,
DatasetProperties props)
Deploys a Dataset type using the datasetClass parameter (see
DatasetConfigurer.addDatasetType(Class) ), then
adds a Dataset instance, if absent in the CDAP namespace, or if the Dataset instance already exists,
updates the existing instance with the new properties. |
void |
DatasetConfigurer.createDataset(String datasetName,
String typeName,
DatasetProperties properties)
Adds a Dataset instance, created automatically if absent in the CDAP namespace.
|
Modifier and Type | Field and Description |
---|---|
static DatasetProperties |
DatasetProperties.EMPTY
Empty properties.
|
Modifier and Type | Method and Description |
---|---|
DatasetProperties |
DatasetProperties.Builder.build()
Create a DatasetProperties from this builder, using the private DatasetProperties
constructor.
|
DatasetProperties |
DatasetManager.getDatasetProperties(String name)
Get the properties with which a dataset was created or updated.
|
static DatasetProperties |
DatasetProperties.of(Map<String,String> props)
Helper method to create a DatasetProperties from a map of key/values.
|
Modifier and Type | Method and Description |
---|---|
DatasetSpecification |
DatasetDefinition.configure(String instanceName,
DatasetProperties properties)
Configures new instance of the dataset.
|
void |
DatasetManager.createDataset(String name,
String type,
DatasetProperties properties)
Create a new dataset instance.
|
static String |
ExploreProperties.getExploreDatabaseName(DatasetProperties props) |
static String |
ExploreProperties.getExploreTableName(DatasetProperties props) |
DatasetSpecification |
Reconfigurable.reconfigure(String instanceName,
DatasetProperties newProperties,
DatasetSpecification currentSpec)
Validates the new properties, including a compatibility check with the existing spec, and returns a
new dataset specification for the dataset instance.
|
DatasetSpecification |
DatasetSpecification.setOriginalProperties(DatasetProperties originalProps) |
void |
DatasetManager.updateDataset(String name,
DatasetProperties properties)
Update an existing dataset with new properties.
|
Modifier and Type | Method and Description |
---|---|
DatasetProperties |
ObjectMappedTableProperties.Builder.build()
Create a DatasetProperties from this builder.
|
static DatasetProperties |
ObjectStores.objectStoreProperties(Type type,
DatasetProperties props)
Creates properties for
ObjectStore dataset instance. |
static DatasetProperties |
TimeseriesTables.timeseriesTableProperties(int timeIntervalToStorePerRow,
DatasetProperties props)
Creates properties for
TimeseriesTable data set instance. |
Modifier and Type | Method and Description |
---|---|
DatasetSpecification |
IndexedTableDefinition.configure(String instanceName,
DatasetProperties properties) |
DatasetSpecification |
CompositeDatasetDefinition.configure(String instanceName,
DatasetProperties properties) |
static void |
ObjectStores.createIndexedObjectStore(ApplicationConfigurer configurer,
String datasetName,
Type type,
DatasetProperties props)
Adds
IndexedObjectStore dataset to be created at application deploy if not exists. |
static void |
ObjectStores.createObjectStore(ApplicationConfigurer configurer,
String datasetName,
Type type,
DatasetProperties props)
Adds an
ObjectStore dataset to be created at application deploy if it does not exist. |
static DatasetProperties |
ObjectStores.objectStoreProperties(Type type,
DatasetProperties props)
Creates properties for
ObjectStore dataset instance. |
static DatasetSpecification |
AbstractDatasetDefinition.reconfigure(DatasetDefinition def,
String name,
DatasetProperties newProps,
DatasetSpecification currentSpec)
Reconfigure a dataset instance.
|
DatasetSpecification |
TimeseriesTableDefinition.reconfigure(String instanceName,
DatasetProperties newProperties,
DatasetSpecification currentSpec) |
DatasetSpecification |
CounterTimeseriesTableDefinition.reconfigure(String instanceName,
DatasetProperties newProperties,
DatasetSpecification currentSpec) |
DatasetSpecification |
IndexedTableDefinition.reconfigure(String instanceName,
DatasetProperties newProperties,
DatasetSpecification currentSpec) |
DatasetSpecification |
CompositeDatasetDefinition.reconfigure(String instanceName,
DatasetProperties newProperties,
DatasetSpecification currentSpec) |
static DatasetProperties |
TimeseriesTables.timeseriesTableProperties(int timeIntervalToStorePerRow,
DatasetProperties props)
Creates properties for
TimeseriesTable data set instance. |
Modifier and Type | Method and Description |
---|---|
static DatasetProperties |
Tables.tableProperties(ConflictDetection level,
int ttl,
DatasetProperties props)
|
Modifier and Type | Method and Description |
---|---|
static void |
Tables.createTable(ApplicationConfigurer configurer,
String datasetName,
ConflictDetection level,
int ttl,
DatasetProperties props)
Adds
Table data set to be created at application deploy if not exists. |
static String |
TableProperties.getColumnFamily(DatasetProperties props) |
static byte[] |
TableProperties.getColumnFamilyBytes(DatasetProperties props) |
static ConflictDetection |
TableProperties.getConflictDetection(DatasetProperties props,
ConflictDetection defaultLevel) |
static boolean |
TableProperties.getReadlessIncrementSupport(DatasetProperties props) |
static String |
TableProperties.getRowFieldName(DatasetProperties props) |
static Schema |
TableProperties.getSchema(DatasetProperties props) |
static Long |
TableProperties.getTTL(DatasetProperties props) |
static DatasetProperties |
Tables.tableProperties(ConflictDetection level,
int ttl,
DatasetProperties props)
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractWorkflow.createLocalDataset(String datasetName,
Class<? extends Dataset> datasetClass,
DatasetProperties props)
Adds a local dataset instance to the
Workflow . |
void |
WorkflowConfigurer.createLocalDataset(String datasetName,
Class<? extends Dataset> datasetClass,
DatasetProperties props)
Adds a local dataset instance to the
Workflow . |
protected void |
AbstractWorkflow.createLocalDataset(String datasetName,
String typeName,
DatasetProperties properties)
Adds a local dataset instance to the
Workflow . |
void |
WorkflowConfigurer.createLocalDataset(String datasetName,
String typeName,
DatasetProperties properties)
Adds a local dataset instance to the
Workflow . |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractProgramDatasetConfigurable.createDataset(String datasetName,
Class<? extends Dataset> datasetClass,
DatasetProperties properties)
Calls
DatasetConfigurer.createDataset(String, String, DatasetProperties) , passing the dataset class
and properties. |
void |
DefaultDatasetConfigurer.createDataset(String datasetInstanceName,
Class<? extends Dataset> datasetClass,
DatasetProperties properties) |
protected void |
AbstractProgramDatasetConfigurable.createDataset(String datasetName,
String typeName,
DatasetProperties properties)
Calls
DatasetConfigurer.createDataset(String, String, DatasetProperties) , passing the type name and
properties. |
void |
DefaultDatasetConfigurer.createDataset(String datasetInstanceName,
String typeName,
DatasetProperties properties) |
Modifier and Type | Method and Description |
---|---|
DatasetProperties |
DatasetCreationSpec.getProperties() |
Constructor and Description |
---|
DatasetCreationSpec(String instanceName,
String typeName,
DatasetProperties props) |
Copyright © 2022 Cask Data, Inc. Licensed under the Apache License, Version 2.0.