co.cask.cdap.data2.metadata.dataset

Class MetadataDataset

java.lang.Object

co.cask.cdap.api.dataset.lib.AbstractDataset

co.cask.cdap.data2.metadata.dataset.MetadataDataset

All Implemented Interfaces:

co.cask.cdap.api.dataset.Dataset, co.cask.cdap.api.dataset.metrics.MeteredDataset, co.cask.tephra.TransactionAware, Closeable, AutoCloseable

public class MetadataDataset
extends co.cask.cdap.api.dataset.lib.AbstractDataset

Dataset that manages Metadata using an IndexedTable.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CASE_INSENSITIVE_VALUE_COLUMN
static String	INDEX_COLUMN
static String	KEYVALUE_COLUMN
static String	KEYVALUE_SEPARATOR
static String	TAGS_KEY

Constructor Summary

Constructors

Constructor and Description
MetadataDataset(co.cask.cdap.api.dataset.lib.IndexedTable indexedTable)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTags(Id.NamespacedId targetId, String... tagsToAdd) Adds a new tag for the specified Id.NamespacedId.
Map<String,String>	getProperties(Id.NamespacedId targetId) Retrieves all the properties for the specified Id.NamespacedId.
MetadataEntry	getProperty(Id.NamespacedId targetId, String key) Retrieve the MetadataEntry corresponding to the specified key for the Id.NamespacedId.
Set<Metadata>	getSnapshotBeforeTime(Set<Id.NamespacedId> targetIds, long timeMillis) Returns the snapshot of the metadata for entities on or before the given time.
Set<String>	getTags(Id.NamespacedId targetId) Retrieves all the tags for the specified Id.NamespacedId.
void	removeProperties(Id.NamespacedId targetId) Removes all properties from the specified entity.
void	removeProperties(Id.NamespacedId targetId, String... keys) Removes the specified keys from the metadata properties of an entity.
void	removeTags(Id.NamespacedId targetId) Removes all tags from the specified entity.
void	removeTags(Id.NamespacedId targetId, String... tagsToRemove) Removes the specified tags from the specified entity.
List<MetadataEntry>	search(String namespaceId, String searchQuery, MetadataSearchTargetType type) Searches entities that match the specified search query in the specified namespace and Id.Namespace#SYSTEM for the specified MetadataSearchTargetType.
void	setProperty(Id.NamespacedId targetId, String key, String value) Sets a metadata property for the specified Id.NamespacedId.
void	setProperty(Id.NamespacedId targetId, String key, String value, Indexer indexer) Sets a metadata property for the specified Id.NamespacedId.
void	upgrade() Upgrades the metadata from 3.2 to 3.3 for new storage format

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

close, commitTx, getName, getTransactionAwareName, getTxChanges, postTxCommit, rollbackTx, setMetricsCollector, startTx, toString, updateTx

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_COLUMN

public static final String INDEX_COLUMN

See Also:

Constant Field Values

CASE_INSENSITIVE_VALUE_COLUMN

public static final String CASE_INSENSITIVE_VALUE_COLUMN

See Also:

Constant Field Values

KEYVALUE_COLUMN

public static final String KEYVALUE_COLUMN

See Also:

Constant Field Values

TAGS_KEY

public static final String TAGS_KEY

See Also:

Constant Field Values

KEYVALUE_SEPARATOR

public static final String KEYVALUE_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

MetadataDataset

public MetadataDataset(co.cask.cdap.api.dataset.lib.IndexedTable indexedTable)

Method Detail

setProperty

public void setProperty(Id.NamespacedId targetId,
               String key,
               String value)

Sets a metadata property for the specified Id.NamespacedId.

Parameters:

targetId - The target Id: Id.Application / Id.Program / Id.DatasetInstance/Id.Stream

key - The metadata key to be added

value - The metadata value to be added

setProperty

public void setProperty(Id.NamespacedId targetId,
               String key,
               String value,
               @Nullable
               Indexer indexer)

Sets a metadata property for the specified Id.NamespacedId.

Parameters:

targetId - The target Id: Id.Application / Id.Program / Id.DatasetInstance/Id.Stream

key - The metadata key to be added

value - The metadata value to be added

indexer - the indexer to use to create indexes for this key-value property

addTags

public void addTags(Id.NamespacedId targetId,
           String... tagsToAdd)

Adds a new tag for the specified Id.NamespacedId.

Parameters:

targetId - the target Id: app-id(ns+app) / program-id(ns+app+pgtype+pgm) / dataset-id(ns+dataset)/stream-id(ns+stream).

tagsToAdd - the tags to add

getProperty

@Nullable
public MetadataEntry getProperty(Id.NamespacedId targetId,
                                 String key)

Retrieve the MetadataEntry corresponding to the specified key for the Id.NamespacedId.

Parameters:

targetId - the Id.NamespacedId for which the MetadataEntry is to be retrieved

key - the property key for which the MetadataEntry is to be retrieved

Returns:

the MetadataEntry corresponding to the specified key for the Id.NamespacedId

getProperties

public Map<String,String> getProperties(Id.NamespacedId targetId)

Retrieves all the properties for the specified Id.NamespacedId.

Parameters:

targetId - the Id.NamespacedId for which properties are to be retrieved

Returns:

the properties of the specified Id.NamespacedId

getTags

public Set<String> getTags(Id.NamespacedId targetId)

Retrieves all the tags for the specified Id.NamespacedId.

Parameters:

targetId - the Id.NamespacedId for which tags are to be retrieved

Returns:

the tags of the specified Id.NamespacedId

removeProperties

public void removeProperties(Id.NamespacedId targetId,
                    String... keys)

Removes the specified keys from the metadata properties of an entity.

Parameters:

targetId - the Id.NamespacedId from which to remove the specified keys

keys - the keys to remove

removeTags

public void removeTags(Id.NamespacedId targetId,
              String... tagsToRemove)

Removes the specified tags from the specified entity.

Parameters:

targetId - the Id.NamespacedId from which to remove the specified tags

tagsToRemove - the tags to remove

removeProperties

public void removeProperties(Id.NamespacedId targetId)

Removes all properties from the specified entity.

Parameters:

targetId - the Id.NamespacedId for which to remove the properties

removeTags

public void removeTags(Id.NamespacedId targetId)

Removes all tags from the specified entity.

Parameters:

targetId - the Id.NamespacedId for which to remove the tags

getSnapshotBeforeTime

public Set<Metadata> getSnapshotBeforeTime(Set<Id.NamespacedId> targetIds,
                                  long timeMillis)

Returns the snapshot of the metadata for entities on or before the given time.

Parameters:

targetIds - entity ids

timeMillis - time in milliseconds

Returns:

the snapshot of the metadata for entities on or before the given time

search

public List<MetadataEntry> search(String namespaceId,
                         String searchQuery,
                         MetadataSearchTargetType type)

Searches entities that match the specified search query in the specified namespace and Id.Namespace#SYSTEM for the specified MetadataSearchTargetType.

Parameters:

namespaceId - the namespace to search in

searchQuery - the search query, which could be of two forms: [key]:[value] or just [value] and can have '*' at the end for a prefix search

type - the MetadataSearchTargetType to restrict the search to.

upgrade

public void upgrade()

Upgrades the metadata from 3.2 to 3.3 for new storage format