co.cask.cdap.data2.metadata.store

Class DefaultMetadataStore

java.lang.Object

co.cask.cdap.data2.metadata.store.DefaultMetadataStore

All Implemented Interfaces:

MetadataStore

public class DefaultMetadataStore
extends Object
implements MetadataStore

Implementation of MetadataStore used in distributed mode.

Field Summary

Fields

Modifier and Type	Field and Description
static Id.DatasetInstance	BUSINESS_METADATA_INSTANCE_ID

Method Summary

Methods

Modifier and Type	Method and Description
void	addTags(MetadataScope scope, Id.NamespacedId entityId, String... tagsToAdd) Adds tags for the specified Id.NamespacedId.
Set<MetadataRecord>	getMetadata(Id.NamespacedId entityId)
MetadataRecord	getMetadata(MetadataScope scope, Id.NamespacedId entityId)
Set<MetadataRecord>	getMetadata(MetadataScope scope, Set<Id.NamespacedId> entityIds)
Map<String,String>	getProperties(Id.NamespacedId entityId)
Map<String,String>	getProperties(MetadataScope scope, Id.NamespacedId entityId)
Set<MetadataRecord>	getSnapshotBeforeTime(MetadataScope scope, Set<Id.NamespacedId> entityIds, long timeMillis) Returns the snapshot of the metadata for entities on or before the given time in the specified MetadataScope.
Set<MetadataRecord>	getSnapshotBeforeTime(Set<Id.NamespacedId> entityIds, long timeMillis) Returns the snapshot of the metadata for entities on or before the given time in both MetadataScope.USER and MetadataScope.SYSTEM.
Set<String>	getTags(Id.NamespacedId entityId)
Set<String>	getTags(MetadataScope scope, Id.NamespacedId entityId)
void	removeMetadata(Id.NamespacedId entityId) Removes all metadata (including properties and tags) for the specified Id.NamespacedId in both MetadataScope.USER and MetadataScope.SYSTEM.
void	removeMetadata(MetadataScope scope, Id.NamespacedId entityId) Removes all metadata (including properties and tags) for the specified Id.NamespacedId.
void	removeProperties(MetadataScope scope, Id.NamespacedId entityId) Removes all properties for the specified Id.NamespacedId.
void	removeProperties(MetadataScope scope, Id.NamespacedId entityId, String... keys) Removes the specified properties of the Id.NamespacedId.
void	removeTags(MetadataScope scope, Id.NamespacedId entityId) Removes all the tags from the Id.NamespacedId
void	removeTags(MetadataScope scope, Id.NamespacedId entityId, String... tagsToRemove) Removes the specified tags from the Id.NamespacedId
Set<MetadataSearchResultRecord>	searchMetadata(MetadataScope scope, String namespaceId, String searchQuery) Search the Metadata Dataset in the specified MetadataScope.
Set<MetadataSearchResultRecord>	searchMetadata(String namespaceId, String searchQuery) Search the Metadata Dataset in both MetadataScope.USER and MetadataScope.SYSTEM.
Set<MetadataSearchResultRecord>	searchMetadataOnType(MetadataScope scope, String namespaceId, String searchQuery, MetadataSearchTargetType type) Search the Metadata Dataset for the specified target type in the specified MetadataScope.
Set<MetadataSearchResultRecord>	searchMetadataOnType(String namespaceId, String searchQuery, MetadataSearchTargetType type) Search the Metadata Dataset for the specified target type in both MetadataScope.USER and MetadataScope.SYSTEM.
void	setProperties(MetadataScope scope, Id.NamespacedId entityId, Map<String,String> properties) Adds/updates properties for the specified Id.NamespacedId in the specified MetadataScope.
void	setProperties(MetadataScope scope, Id.NamespacedId entityId, Map<String,String> properties, Indexer indexer) Adds/updates metadata for the specified Id.NamespacedId.
static void	setupDatasets(DatasetFramework framework) Adds datasets and types to the given DatasetFramework.
void	upgrade() Upgrades the MetadataStore

Methods inherited from class java.lang.Object

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

Field Detail

BUSINESS_METADATA_INSTANCE_ID

public static final Id.DatasetInstance BUSINESS_METADATA_INSTANCE_ID

Method Detail

setProperties

public void setProperties(MetadataScope scope,
                 Id.NamespacedId entityId,
                 Map<String,String> properties)

Description copied from interface: MetadataStore

Adds/updates properties for the specified Id.NamespacedId in the specified MetadataScope.

Specified by:

setProperties in interface MetadataStore

Parameters:

scope - the MetadataScope to add/update the properties in

entityId - the Id.NamespacedId to add the properties to

properties - the properties to add/update

setProperties

public void setProperties(MetadataScope scope,
                 Id.NamespacedId entityId,
                 Map<String,String> properties,
                 @Nullable
                 Indexer indexer)

Adds/updates metadata for the specified Id.NamespacedId.

Specified by:

setProperties in interface MetadataStore

Parameters:

scope - the MetadataScope to add/update the properties in

entityId - the Id.NamespacedId to add the properties to

properties - the properties to add/update

indexer - Indexer to use for creating indexes

addTags

public void addTags(MetadataScope scope,
           Id.NamespacedId entityId,
           String... tagsToAdd)

Adds tags for the specified Id.NamespacedId.

Specified by:

addTags in interface MetadataStore

Parameters:

scope - the MetadataScope to add the tags in

entityId - the Id.NamespacedId to add the tags to

tagsToAdd - the tags to add

getMetadata

public Set<MetadataRecord> getMetadata(Id.NamespacedId entityId)

Specified by:

getMetadata in interface MetadataStore

Returns:

a set of MetadataRecord representing all the metadata (including properties and tags) for the specified Id.NamespacedId in both MetadataScope.USER and MetadataScope.SYSTEM.

getMetadata

public MetadataRecord getMetadata(MetadataScope scope,
                         Id.NamespacedId entityId)

Specified by:

getMetadata in interface MetadataStore

Returns:

a MetadataRecord representing all the metadata (including properties and tags) for the specified Id.NamespacedId in the specified MetadataScope.

getMetadata

public Set<MetadataRecord> getMetadata(MetadataScope scope,
                              Set<Id.NamespacedId> entityIds)

Specified by:

getMetadata in interface MetadataStore

Returns:

a set of MetadataRecords representing all the metadata (including properties and tags) for the specified set of Id.NamespacedIds.

getProperties

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

Specified by:

getProperties in interface MetadataStore

Returns:

the properties for the specified Id.NamespacedId in both MetadataScope.USER and MetadataScope.SYSTEM

getProperties

public Map<String,String> getProperties(MetadataScope scope,
                               Id.NamespacedId entityId)

Specified by:

getProperties in interface MetadataStore

Returns:

the metadata for the specified Id.NamespacedId

getTags

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

Specified by:

getTags in interface MetadataStore

Returns:

the tags for the specified Id.NamespacedId in both MetadataScope.USER and MetadataScope.SYSTEM

getTags

public Set<String> getTags(MetadataScope scope,
                  Id.NamespacedId entityId)

Specified by:

getTags in interface MetadataStore

Returns:

the tags for the specified Id.NamespacedId

removeMetadata

public void removeMetadata(Id.NamespacedId entityId)

Description copied from interface: MetadataStore

Removes all metadata (including properties and tags) for the specified Id.NamespacedId in both MetadataScope.USER and MetadataScope.SYSTEM.

Specified by:

removeMetadata in interface MetadataStore

Parameters:

entityId - the Id.NamespacedId to remove all metadata for

removeMetadata

public void removeMetadata(MetadataScope scope,
                  Id.NamespacedId entityId)

Removes all metadata (including properties and tags) for the specified Id.NamespacedId.

Specified by:

removeMetadata in interface MetadataStore

Parameters:

scope - the MetadataScope

entityId - the Id.NamespacedId to remove all metadata for

removeProperties

public void removeProperties(MetadataScope scope,
                    Id.NamespacedId entityId)

Removes all properties for the specified Id.NamespacedId.

Specified by:

removeProperties in interface MetadataStore

Parameters:

scope - the MetadataScope

entityId - the Id.NamespacedId to remove all properties for

removeProperties

public void removeProperties(MetadataScope scope,
                    Id.NamespacedId entityId,
                    String... keys)

Removes the specified properties of the Id.NamespacedId.

Specified by:

removeProperties in interface MetadataStore

Parameters:

scope - the MetadataScope

entityId - the Id.NamespacedId to remove the specified keys for

keys - the keys to remove

removeTags

public void removeTags(MetadataScope scope,
              Id.NamespacedId entityId)

Removes all the tags from the Id.NamespacedId

Specified by:

removeTags in interface MetadataStore

Parameters:

scope - the MetadataScope

entityId - the Id.NamespacedId to remove all tags for

removeTags

public void removeTags(MetadataScope scope,
              Id.NamespacedId entityId,
              String... tagsToRemove)

Removes the specified tags from the Id.NamespacedId

Specified by:

removeTags in interface MetadataStore

Parameters:

scope - the MetadataScope

entityId - the Id.NamespacedId to remove the specified tags for

tagsToRemove - the tags to remove

searchMetadata

public Set<MetadataSearchResultRecord> searchMetadata(String namespaceId,
                                             String searchQuery)

Description copied from interface: MetadataStore

Search the Metadata Dataset in both MetadataScope.USER and MetadataScope.SYSTEM.

Specified by:

searchMetadata in interface MetadataStore

searchMetadata

public Set<MetadataSearchResultRecord> searchMetadata(MetadataScope scope,
                                             String namespaceId,
                                             String searchQuery)

Description copied from interface: MetadataStore

Search the Metadata Dataset in the specified MetadataScope.

Specified by:

searchMetadata in interface MetadataStore

Parameters:

scope - the MetadataScope to restrict the search to

namespaceId - the namespace to search in

searchQuery - the search query, which could be of two forms: [key]:[value] or just [value]

searchMetadataOnType

public Set<MetadataSearchResultRecord> searchMetadataOnType(String namespaceId,
                                                   String searchQuery,
                                                   MetadataSearchTargetType type)

Description copied from interface: MetadataStore

Search the Metadata Dataset for the specified target type in both MetadataScope.USER and MetadataScope.SYSTEM.

Specified by:

searchMetadataOnType in interface MetadataStore

Parameters:

namespaceId - the namespace to search in

searchQuery - the search query, which could be of two forms: [key]:[value] or just [value]

type - the MetadataSearchTargetType to restrict the search to

searchMetadataOnType

public Set<MetadataSearchResultRecord> searchMetadataOnType(MetadataScope scope,
                                                   String namespaceId,
                                                   String searchQuery,
                                                   MetadataSearchTargetType type)

Description copied from interface: MetadataStore

Search the Metadata Dataset for the specified target type in the specified MetadataScope.

Specified by:

searchMetadataOnType in interface MetadataStore

Parameters:

scope - the MetadataScope to restrict the search to

namespaceId - the namespace to search in

searchQuery - the search query, which could be of two forms: [key]:[value] or just [value]

type - the MetadataSearchTargetType to restrict the search to

getSnapshotBeforeTime

public Set<MetadataRecord> getSnapshotBeforeTime(Set<Id.NamespacedId> entityIds,
                                        long timeMillis)

Description copied from interface: MetadataStore

Returns the snapshot of the metadata for entities on or before the given time in both MetadataScope.USER and MetadataScope.SYSTEM.

Specified by:

getSnapshotBeforeTime in interface MetadataStore

Parameters:

entityIds - entity ids

timeMillis - time in milliseconds

Returns:

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

getSnapshotBeforeTime

public Set<MetadataRecord> getSnapshotBeforeTime(MetadataScope scope,
                                        Set<Id.NamespacedId> entityIds,
                                        long timeMillis)

Description copied from interface: MetadataStore

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

Specified by:

getSnapshotBeforeTime in interface MetadataStore

Parameters:

scope - the MetadataScope to get the snapshot in

entityIds - entity ids

timeMillis - time in milliseconds

Returns:

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

setupDatasets

public static void setupDatasets(DatasetFramework framework)
                          throws IOException,
                                 DatasetManagementException

Adds datasets and types to the given DatasetFramework. Used by the upgrade tool to upgrade Metadata Datasets.

Parameters:

framework - Dataset framework to add types and datasets to

Throws:

IOException

DatasetManagementException

upgrade

public void upgrade()

Description copied from interface: MetadataStore

Upgrades the MetadataStore

Specified by:

upgrade in interface MetadataStore