org.apache.asterix.metadata.api

Interface IMetadataManager

All Known Implementing Classes:

MetadataManager

public interface IMetadataManager

A metadata manager provides user access to Asterix metadata (e.g., types, datasets, indexes, etc.). A metadata manager satisfies requests by contacting the metadata node which is responsible for the storage-level details. This interface describes the operations that a metadata manager must support. Every operation is meant to be performed in the context of a transaction on the metadata node against the metadata. It is the responsibility of the user to begin a transaction, lock the metadata, and commit or abort a metadata transaction using the appropriate methods declared below. Lock acquisition at finer levels is the responsibility of the metadata node, not the metadata manager or its user.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortTransaction(MetadataTransactionContext ctx) Aborts a remote transaction running on the metadata node.
void	acquireReadLatch()
void	acquireWriteLatch()
void	addAdapter(MetadataTransactionContext mdTxnCtx, DatasourceAdapter adapter)
void	addCompactionPolicy(MetadataTransactionContext ctx, CompactionPolicy policy)
void	addDataset(MetadataTransactionContext ctx, Dataset dataset) Inserts a new dataset into the metadata.
void	addDatatype(MetadataTransactionContext ctx, Datatype datatype) Inserts a datatype.
void	addDataverse(MetadataTransactionContext ctx, Dataverse dataverse) Inserts a new dataverse into the metadata.
void	addExternalFile(MetadataTransactionContext mdTxnCtx, ExternalFile externalFile)
void	addFeed(MetadataTransactionContext ctx, Feed feed)
void	addFeedPolicy(MetadataTransactionContext ctx, FeedPolicy policy)
void	addFunction(MetadataTransactionContext mdTxnCtx, Function function)
void	addIndex(MetadataTransactionContext ctx, Index index) Inserts an index into the metadata.
void	addLibrary(MetadataTransactionContext ctx, Library library) Adds a library, acquiring local locks on behalf of the given transaction id.
void	addNode(MetadataTransactionContext ctx, Node node) Inserts a node (machine).
void	addNodegroup(MetadataTransactionContext ctx, NodeGroup nodeGroup) Inserts a node group.
MetadataTransactionContext	beginTransaction() Begins a transaction on the metadata node.
void	cleanupTempDatasets() Clean up temporary datasets that have not been active for a long time.
void	commitTransaction(MetadataTransactionContext ctx) Commits a remote transaction on the metadata node.
void	dropAdapter(MetadataTransactionContext ctx, String dataverseName, String name)
void	dropDataset(MetadataTransactionContext ctx, String dataverseName, String datasetName) Deletes the dataset with given name, and all it's associated indexes.
void	dropDatasetExternalFiles(MetadataTransactionContext mdTxnCtx, Dataset dataset)
void	dropDatatype(MetadataTransactionContext ctx, String dataverseName, String datatypeName) Deletes the given datatype in given dataverse.
void	dropDataverse(MetadataTransactionContext ctx, String dataverseName) Deletes the dataverse with given name, and all it's associated datasets, indexes, and types.
void	dropExternalFile(MetadataTransactionContext mdTxnCtx, ExternalFile externalFile)
void	dropFeed(MetadataTransactionContext ctx, String dataverse, String feedName)
void	dropFunction(MetadataTransactionContext ctx, FunctionSignature functionSignature)
void	dropIndex(MetadataTransactionContext ctx, String dataverseName, String datasetName, String indexName) Deletes the index with given name, in given dataverse and dataset.
void	dropLibrary(MetadataTransactionContext ctx, String dataverseName, String libraryName) Removes a library , acquiring local locks on behalf of the given transaction id.
void	dropNodegroup(MetadataTransactionContext ctx, String nodeGroupName) Deletes a node group.
DatasourceAdapter	getAdapter(MetadataTransactionContext ctx, String dataverseName, String name)
CompactionPolicy	getCompactionPolicy(MetadataTransactionContext ctx, String dataverse, String policyName)
Dataset	getDataset(MetadataTransactionContext ctx, String dataverseName, String datasetName) Retrieves a dataset within a given dataverse.
List<ExternalFile>	getDatasetExternalFiles(MetadataTransactionContext mdTxnCtx, Dataset dataset)
List<Index>	getDatasetIndexes(MetadataTransactionContext ctx, String dataverseName, String datasetName) Retrieves all indexes of a dataset.
Datatype	getDatatype(MetadataTransactionContext ctx, String dataverseName, String datatypeName) Retrieves the datatype with given name in given dataverse.
Dataverse	getDataverse(MetadataTransactionContext ctx, String dataverseName) Retrieves a dataverse with given name.
List<Dataset>	getDataverseDatasets(MetadataTransactionContext ctx, String dataverseName) Retrieves all datasets belonging to the given dataverse.
List<Function>	getDataverseFunctions(MetadataTransactionContext ctx, String dataverseName)
List<Library>	getDataverseLibraries(MetadataTransactionContext ctx, String dataverseName) Retireve libraries installed in a given dataverse.
List<Dataverse>	getDataverses(MetadataTransactionContext ctx) Retrieves all dataverses
ExternalFile	getExternalFile(MetadataTransactionContext mdTxnCtx, String dataverseName, String datasetName, Integer fileNumber) Get en external file
Feed	getFeed(MetadataTransactionContext ctx, String dataverse, String feedName)
FeedPolicy	getFeedPolicy(MetadataTransactionContext ctx, String dataverse, String policyName)
Function	getFunction(MetadataTransactionContext ctx, FunctionSignature functionSignature)
Index	getIndex(MetadataTransactionContext ctx, String dataverseName, String datasetName, String indexName) Retrieves the index with given name, in given dataverse and dataset.
Library	getLibrary(MetadataTransactionContext ctx, String dataverseName, String libraryName)
int	getMostRecentDatasetId()
NodeGroup	getNodegroup(MetadataTransactionContext ctx, String nodeGroupName) Retrieves a node group.
void	init() Initializes the metadata manager, e.g., finds the remote metadata node.
void	initializeDatasetIdFactory(MetadataTransactionContext ctx)
void	lock(MetadataTransactionContext ctx, byte lockMode) Locks the metadata in given mode.
void	releaseReadLatch()
void	releaseWriteLatch()
void	unlock(MetadataTransactionContext ctx, byte lockMode) Releases all locks on the metadata held by the given transaction id.
void	updateDataset(MetadataTransactionContext ctx, Dataset dataset) update an existing dataset in metadata.

Method Detail

init

void init()
          throws RemoteException,
                 MetadataException

Initializes the metadata manager, e.g., finds the remote metadata node.

Throws:

RemoteException - If an error occurred while contacting the proxy for finding the metadata node.

MetadataException

beginTransaction

MetadataTransactionContext beginTransaction()
                                            throws ACIDException,
                                                   RemoteException

Begins a transaction on the metadata node.

Returns:

A globally unique transaction id.

Throws:

ACIDException

RemoteException

commitTransaction

void commitTransaction(MetadataTransactionContext ctx)
                       throws ACIDException,
                              RemoteException

Commits a remote transaction on the metadata node.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

Throws:

ACIDException

RemoteException

abortTransaction

void abortTransaction(MetadataTransactionContext ctx)
                      throws ACIDException,
                             RemoteException

Aborts a remote transaction running on the metadata node.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

Throws:

ACIDException

RemoteException

lock

void lock(MetadataTransactionContext ctx,
        byte lockMode)
          throws ACIDException,
                 RemoteException

Locks the metadata in given mode. The lock acquisition is delegated to the metadata node. This method blocks until the lock can be acquired.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

lockMode - Desired lockode.

Throws:

ACIDException

RemoteException

unlock

void unlock(MetadataTransactionContext ctx,
          byte lockMode)
            throws ACIDException,
                   RemoteException

Releases all locks on the metadata held by the given transaction id.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

Throws:

ACIDException

RemoteException

addDataverse

void addDataverse(MetadataTransactionContext ctx,
                Dataverse dataverse)
                  throws MetadataException

Inserts a new dataverse into the metadata.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverse - Dataverse instance to be inserted.

Throws:

MetadataException - For example, if the dataverse already exists.

getDataverses

List<Dataverse> getDataverses(MetadataTransactionContext ctx)
                              throws MetadataException

Retrieves all dataverses

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

Returns:

A list of dataverse instances.

Throws:

MetadataException

getDataverse

Dataverse getDataverse(MetadataTransactionContext ctx,
                     String dataverseName)
                       throws MetadataException

Retrieves a dataverse with given name.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Name of the dataverse to retrieve.

Returns:

A dataverse instance.

Throws:

MetadataException - For example, if the dataverse does not exist.

getDataverseDatasets

List<Dataset> getDataverseDatasets(MetadataTransactionContext ctx,
                                 String dataverseName)
                                   throws MetadataException

Retrieves all datasets belonging to the given dataverse.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Name of the dataverse of which to find all datasets.

Returns:

A list of dataset instances.

Throws:

MetadataException - For example, if the dataverse does not exist.

dropDataverse

void dropDataverse(MetadataTransactionContext ctx,
                 String dataverseName)
                   throws MetadataException

Deletes the dataverse with given name, and all it's associated datasets, indexes, and types.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

Throws:

MetadataException - For example, if the dataverse does not exist.

addDataset

void addDataset(MetadataTransactionContext ctx,
              Dataset dataset)
                throws MetadataException

Inserts a new dataset into the metadata.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataset - Dataset instance to be inserted.

Throws:

MetadataException - For example, if the dataset already exists.

getDataset

Dataset getDataset(MetadataTransactionContext ctx,
                 String dataverseName,
                 String datasetName)
                   throws MetadataException

Retrieves a dataset within a given dataverse.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Dataverse name to look for the dataset.

datasetName - Name of dataset to be retrieved.

Returns:

A dataset instance.

Throws:

MetadataException - For example, if the dataset does not exist.

getDatasetIndexes

List<Index> getDatasetIndexes(MetadataTransactionContext ctx,
                            String dataverseName,
                            String datasetName)
                              throws MetadataException

Retrieves all indexes of a dataset.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Name of dataverse which holds the given dataset.

datasetName - Name of dataset for which to retrieve all indexes.

Returns:

A list of Index instances.

Throws:

MetadataException - For example, if the dataset and/or dataverse does not exist.

dropDataset

void dropDataset(MetadataTransactionContext ctx,
               String dataverseName,
               String datasetName)
                 throws MetadataException

Deletes the dataset with given name, and all it's associated indexes.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Name of dataverse which holds the given dataset.

datasetName - Name of dataset to delete.

Throws:

MetadataException - For example, if the dataset and/or dataverse does not exist.

addIndex

void addIndex(MetadataTransactionContext ctx,
            Index index)
              throws MetadataException

Inserts an index into the metadata. The index itself knows its name, and which dataset it belongs to.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

index - Index instance to be inserted.

Throws:

MetadataException - For example, if the index already exists.

getIndex

Index getIndex(MetadataTransactionContext ctx,
             String dataverseName,
             String datasetName,
             String indexName)
               throws MetadataException

Retrieves the index with given name, in given dataverse and dataset.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Name of the datavers holding the given dataset.

datasetName - Name of the dataset holding the index.

Returns:

An Index instance.

Throws:

MetadataException - For example, if the index does not exist.

dropIndex

void dropIndex(MetadataTransactionContext ctx,
             String dataverseName,
             String datasetName,
             String indexName)
               throws MetadataException

Deletes the index with given name, in given dataverse and dataset.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Name of the datavers holding the given dataset.

datasetName - Name of the dataset holding the index.

Throws:

MetadataException - For example, if the index does not exist.

addDatatype

void addDatatype(MetadataTransactionContext ctx,
               Datatype datatype)
                 throws MetadataException

Inserts a datatype.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

datatype - Datatype instance to be inserted.

Throws:

MetadataException - For example, if the datatype already exists.

getDatatype

Datatype getDatatype(MetadataTransactionContext ctx,
                   String dataverseName,
                   String datatypeName)
                     throws MetadataException

Retrieves the datatype with given name in given dataverse.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Name of dataverse holding the datatype.

datatypeName - Name of datatype to be retrieved.

Returns:

A datatype instance.

Throws:

MetadataException - For example, if the datatype does not exist.

dropDatatype

void dropDatatype(MetadataTransactionContext ctx,
                String dataverseName,
                String datatypeName)
                  throws MetadataException

Deletes the given datatype in given dataverse.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - Name of dataverse holding the datatype.

datatypeName - Name of datatype to be deleted.

Throws:

MetadataException - For example, if there are still datasets using the type to be deleted.

addNodegroup

void addNodegroup(MetadataTransactionContext ctx,
                NodeGroup nodeGroup)
                  throws MetadataException

Inserts a node group.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

nodeGroup - Node group instance to insert.

Throws:

MetadataException - For example, if the node group already exists.

getNodegroup

NodeGroup getNodegroup(MetadataTransactionContext ctx,
                     String nodeGroupName)
                       throws MetadataException

Retrieves a node group.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

nodeGroupName - Name of node group to be retrieved.

Throws:

MetadataException - For example, if the node group does not exist.

dropNodegroup

void dropNodegroup(MetadataTransactionContext ctx,
                 String nodeGroupName)
                   throws MetadataException

Deletes a node group.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

nodeGroupName - Name of node group to be deleted.

Throws:

MetadataException - For example, there are still datasets partitioned on the node group to be deleted.

addNode

void addNode(MetadataTransactionContext ctx,
           Node node)
             throws MetadataException

Inserts a node (machine).

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

node - Node instance to be inserted.

Throws:

MetadataException - For example, if the node already exists.

addFunction

void addFunction(MetadataTransactionContext mdTxnCtx,
               Function function)
                 throws MetadataException

Parameters:

mdTxnCtx - MetadataTransactionContext of an active metadata transaction.

function - An instance of type Function that represents the function being added

Throws:

MetadataException

getFunction

Function getFunction(MetadataTransactionContext ctx,
                   FunctionSignature functionSignature)
                     throws MetadataException

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

functionSignature - the functions signature (unique to the function)

Returns:

Throws:

MetadataException

dropFunction

void dropFunction(MetadataTransactionContext ctx,
                FunctionSignature functionSignature)
                  throws MetadataException

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

functionSignature - the functions signature (unique to the function)

Throws:

MetadataException

addAdapter

void addAdapter(MetadataTransactionContext mdTxnCtx,
              DatasourceAdapter adapter)
                throws MetadataException

Parameters:

mdTxnCtx - MetadataTransactionContext of an active metadata transaction.

function - An instance of type Adapter that represents the adapter being added

Throws:

MetadataException

getAdapter

DatasourceAdapter getAdapter(MetadataTransactionContext ctx,
                           String dataverseName,
                           String name)
                             throws MetadataException

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - the dataverse associated with the adapter being searched

Name - name of the adapter

Returns:

Throws:

MetadataException

dropAdapter

void dropAdapter(MetadataTransactionContext ctx,
               String dataverseName,
               String name)
                 throws MetadataException

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - the dataverse associated with the adapter being dropped

name - name of the adapter

Throws:

MetadataException

addCompactionPolicy

void addCompactionPolicy(MetadataTransactionContext ctx,
                       CompactionPolicy policy)
                         throws MetadataException

Parameters:

ctx -

policy -

Throws:

MetadataException

getCompactionPolicy

CompactionPolicy getCompactionPolicy(MetadataTransactionContext ctx,
                                   String dataverse,
                                   String policyName)
                                     throws MetadataException

Parameters:

ctx -

dataverse -

policyName -

Returns:

Throws:

MetadataException

getDataverseFunctions

List<Function> getDataverseFunctions(MetadataTransactionContext ctx,
                                   String dataverseName)
                                     throws MetadataException

Parameters:

ctx -

dataverseName -

Returns:

Throws:

MetadataException

addFeed

void addFeed(MetadataTransactionContext ctx,
           Feed feed)
             throws MetadataException

Parameters:

ctx -

feed -

Throws:

MetadataException

getFeed

Feed getFeed(MetadataTransactionContext ctx,
           String dataverse,
           String feedName)
             throws MetadataException

Parameters:

ctx -

dataverse -

feedName -

Returns:

Throws:

MetadataException

dropFeed

void dropFeed(MetadataTransactionContext ctx,
            String dataverse,
            String feedName)
              throws MetadataException

Parameters:

ctx -

dataverse -

feedName -

Throws:

MetadataException

addFeedPolicy

void addFeedPolicy(MetadataTransactionContext ctx,
                 FeedPolicy policy)
                   throws MetadataException

Parameters:

ctx -

policy -

Throws:

MetadataException

getFeedPolicy

FeedPolicy getFeedPolicy(MetadataTransactionContext ctx,
                       String dataverse,
                       String policyName)
                         throws MetadataException

Parameters:

ctx -

dataverse -

policyName -

Returns:

Throws:

MetadataException

initializeDatasetIdFactory

void initializeDatasetIdFactory(MetadataTransactionContext ctx)
                                throws MetadataException

Throws:

MetadataException

getMostRecentDatasetId

int getMostRecentDatasetId()
                           throws MetadataException

Throws:

MetadataException

acquireWriteLatch

void acquireWriteLatch()

releaseWriteLatch

void releaseWriteLatch()

acquireReadLatch

void acquireReadLatch()

releaseReadLatch

void releaseReadLatch()

dropLibrary

void dropLibrary(MetadataTransactionContext ctx,
               String dataverseName,
               String libraryName)
                 throws MetadataException

Removes a library , acquiring local locks on behalf of the given transaction id.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - dataverse asociated with the adapter that is to be deleted.

libraryName - Name of library to be deleted. MetadataException for example, if the library does not exists.

Throws:

RemoteException

MetadataException

addLibrary

void addLibrary(MetadataTransactionContext ctx,
              Library library)
                throws MetadataException

Adds a library, acquiring local locks on behalf of the given transaction id.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

library - Library to be added

Throws:

MetadataException - for example, if the library is already added.

RemoteException

getLibrary

Library getLibrary(MetadataTransactionContext ctx,
                 String dataverseName,
                 String libraryName)
                   throws MetadataException,
                          RemoteException

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - dataverse asociated with the library that is to be retrieved.

libraryName - name of the library that is to be retrieved

Returns:

Library

Throws:

MetadataException

RemoteException

getDataverseLibraries

List<Library> getDataverseLibraries(MetadataTransactionContext ctx,
                                  String dataverseName)
                                    throws MetadataException

Retireve libraries installed in a given dataverse.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataverseName - dataverse asociated with the library that is to be retrieved.

Returns:

Library

Throws:

MetadataException

RemoteException

addExternalFile

void addExternalFile(MetadataTransactionContext mdTxnCtx,
                   ExternalFile externalFile)
                     throws MetadataException

Parameters:

mdTxnCtx - MetadataTransactionContext of an active metadata transaction.

externalFile - An instance of type ExternalFile that represents the external file being added

Throws:

MetadataException

getDatasetExternalFiles

List<ExternalFile> getDatasetExternalFiles(MetadataTransactionContext mdTxnCtx,
                                         Dataset dataset)
                                           throws MetadataException

Parameters:

mdTxnCtx - MetadataTransactionContext of an active metadata transaction.

dataset - An instance of type Dataset that represents the "external" dataset

Returns:

A list of external files belonging to the dataset

Throws:

MetadataException

dropExternalFile

void dropExternalFile(MetadataTransactionContext mdTxnCtx,
                    ExternalFile externalFile)
                      throws MetadataException

Parameters:

mdTxnCtx - MetadataTransactionContext of an active metadata transaction.

externalFile - An instance of type ExternalFile that represents the external file being dropped

Throws:

MetadataException

dropDatasetExternalFiles

void dropDatasetExternalFiles(MetadataTransactionContext mdTxnCtx,
                            Dataset dataset)
                              throws MetadataException

Parameters:

mdTxnCtx - MetadataTransactionContext of an active metadata transaction.

dataset - An instance of type dataset that owns the external files being dropped

Throws:

MetadataException

getExternalFile

ExternalFile getExternalFile(MetadataTransactionContext mdTxnCtx,
                           String dataverseName,
                           String datasetName,
                           Integer fileNumber)
                             throws MetadataException

Get en external file

Parameters:

mdTxnCtx -

dataverseName -

datasetName -

fileNumber -

Returns:

Throws:

MetadataException

updateDataset

void updateDataset(MetadataTransactionContext ctx,
                 Dataset dataset)
                   throws MetadataException

update an existing dataset in metadata.

Parameters:

ctx - MetadataTransactionContext of an active metadata transaction.

dataset - Existing Dataset.

Throws:

MetadataException - For example, if the dataset already exists.

cleanupTempDatasets

void cleanupTempDatasets()
                         throws MetadataException

Clean up temporary datasets that have not been active for a long time.

Throws:

MetadataException