co.cask.cdap.data2.metadata.store

Interface MetadataStore

All Known Implementing Classes:

DefaultMetadataStore, NoOpMetadataStore

public interface MetadataStore

Defines operations on MetadataDataset for both system and user metadata. Operations supported for a specified Id.NamespacedId:

• Adding new metadata: Supported for a single scope.
• Retrieving metadata: Supported for a specified scope as well as across both scopes.
• Removing metadata: Supported for a specified scope as well as across both scopes.

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 in the specified MetadataScope.
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 in the specified MetadataScope.
void	removeProperties(MetadataScope scope, Id.NamespacedId entityId) Removes all properties for the specified Id.NamespacedId in the specified MetadataScope.
void	removeProperties(MetadataScope scope, Id.NamespacedId entityId, String... keys) Removes the specified properties of the Id.NamespacedId in the specified MetadataScope.
void	removeTags(MetadataScope scope, Id.NamespacedId entityId) Removes tags of the Id.NamespacedId in the specified MetadataScope.
void	removeTags(MetadataScope scope, Id.NamespacedId entityId, String... tagsToRemove) Removes the specified tags from the Id.NamespacedId in the specified MetadataScope.
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 properties for the specified Id.NamespacedId in the specified MetadataScope.
void	upgrade() Upgrades the MetadataStore

Method Detail

setProperties

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

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

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

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

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

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

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

Adds tags for the specified Id.NamespacedId in the specified MetadataScope.

Parameters:

scope - the MetadataScope to add the tags in

entityId - the Id.NamespacedId to add the tags to

tagsToAdd - the tags to add

getMetadata

Set<MetadataRecord> getMetadata(Id.NamespacedId entityId)

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

MetadataRecord getMetadata(MetadataScope scope,
                         Id.NamespacedId entityId)

Returns:

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

getMetadata

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

Returns:

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

getProperties

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

Returns:

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

getProperties

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

Returns:

the properties for the specified Id.NamespacedId in the specified MetadataScope

getTags

Set<String> getTags(Id.NamespacedId entityId)

Returns:

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

getTags

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

Returns:

the tags for the specified Id.NamespacedId in the specified MetadataScope

removeMetadata

void removeMetadata(Id.NamespacedId entityId)

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

Parameters:

entityId - the Id.NamespacedId to remove all metadata for

removeMetadata

void removeMetadata(MetadataScope scope,
                  Id.NamespacedId entityId)

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

Parameters:

scope - the MetadataScope

entityId - the Id.NamespacedId to remove all metadata for

removeProperties

void removeProperties(MetadataScope scope,
                    Id.NamespacedId entityId)

Removes all properties for the specified Id.NamespacedId in the specified MetadataScope.

Parameters:

scope - the MetadataScope

entityId - the Id.NamespacedId to remove all properties for

removeProperties

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

Removes the specified properties of the Id.NamespacedId in the specified MetadataScope.

Parameters:

scope - the MetadataScope

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

keys - the keys to remove

removeTags

void removeTags(MetadataScope scope,
              Id.NamespacedId entityId)

Removes tags of the Id.NamespacedId in the specified MetadataScope.

Parameters:

scope - the MetadataScope

entityId - the Id.NamespacedId to remove all tags for

removeTags

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

Removes the specified tags from the Id.NamespacedId in the specified MetadataScope.

Parameters:

scope - the MetadataScope

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

tagsToRemove - the tags to remove

searchMetadata

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

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

searchMetadata

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

Search the Metadata Dataset in the specified MetadataScope.

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

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.

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

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

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

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

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.

Parameters:

entityIds - entity ids

timeMillis - time in milliseconds

Returns:

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

getSnapshotBeforeTime

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.

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

upgrade

void upgrade()

Upgrades the MetadataStore