Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

glite::rgma::Schema Class Reference

#include <Schema.h>

List of all members.

Static Public Member Functions

void createSchema (std::string vdbName, std::string schemaService) throw ( RGMAException, RemoteException)
void destroySchema (std::string vdbName, std::string schemaService) throw ( RGMAException, RemoteException)
StringList getAllTables (std::string vdbName) throw ( RGMAException, RemoteException )
TableDefinition getTableDefinition (std::string vdbName, std::string tableName) throw ( RGMAException, RemoteException)
IndexList getTableIndexes (std::string vdbName, std::string tableName) throw ( RGMAException, RemoteException)
void setAuthorizationRules (std::string vdbName, std::string tableName, TableAuthorization tableAuthz) throw ( RGMAException, RemoteException)
TableAuthorization getAuthorizationRules (std::string vdbName, std::string tableName) throw ( RGMAException, RemoteException)
void createTable (std::string vdbName, std::string createTableStatement, TableAuthorization tableAuthz) throw ( RGMAException, RemoteException)
void dropTable (std::string vdbName, std::string tableName) throw ( RGMAException, RemoteException)
void createIndex (std::string vdbName, std::string createIndexStatement) throw ( RGMAException, RemoteException)
void dropIndex (std::string vdbName, std::string indexName) throw ( RGMAException, RemoteException)
void createView (std::string vdbName, std::string createViewStatement, TableAuthorization viewAuthz) throw ( RGMAException, RemoteException)
void dropView (std::string vdbName, std::string viewName) throw ( RGMAException, RemoteException)
std::string getProperty (std::string name, std::string parameter) throw (RemoteException, RGMAException)
std::string getProperty (std::string name) throw (RemoteException, RGMAException)
void setProperty (std::string name, std::string value, std::string parameter) throw (RemoteException, RGMAException)
void setProperty (std::string name, std::string value) throw (RemoteException, RGMAException)
std::string getVersion () throw (RemoteException)


Detailed Description

Admin API for the Schema.


Member Function Documentation

void glite::rgma::Schema::createIndex std::string  vdbName,
std::string  createIndexStatement
throw ( RGMAException, RemoteException) [static]
 

Creates an index in the Schema instance for the given VDB.

Parameters:
vdbName Name of VDB.
createIndexStatement SQL CREATE INDEX statement.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the index already exists or the CREATE INDEX statement is invalid.

void glite::rgma::Schema::createSchema std::string  vdbName,
std::string  schemaService
throw ( RGMAException, RemoteException) [static]
 

Creates a Schema instance for the given VDB. Request is forwarded to schemaService for processing.

Parameters:
vdbName The VDB that owns the Schema instance.
schemaService Schema service URL.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the Schema cannot be created.

void glite::rgma::Schema::createTable std::string  vdbName,
std::string  createTableStatement,
TableAuthorization  tableAuthz
throw ( RGMAException, RemoteException) [static]
 

Creates a table in the Schema instance for the given VDB.

Parameters:
vdbName Name of VDB.
createTableStatement SQL CREATE TABLE statement.
tableAuthz Table authorization details (for no authorization, set as null)
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the table already exists and the Schema definition given by createTableStatement does not match with the stored R-GMA Schema description.

void glite::rgma::Schema::createView std::string  vdbName,
std::string  createViewStatement,
TableAuthorization  viewAuthz
throw ( RGMAException, RemoteException) [static]
 

Creates an view in the Schema instance for the given VDB.

Parameters:
vdbName Name of VDB.
createViewStatement SQL CREATE VIEW statement.
viewAuthz View authorization details (for no authorization, set as null)
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the view already exists or the CREATE VIEW statement is invalid.

void glite::rgma::Schema::destroySchema std::string  vdbName,
std::string  schemaService
throw ( RGMAException, RemoteException) [static]
 

Removes the schema instance for the given VO. Request is forwarded to schemaService for processing.

Parameters:
vdbName The VDB that owns the Schema instance.
schemaService Schema service URL.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the Schema instance cannot be removed or does not exist.

void glite::rgma::Schema::dropIndex std::string  vdbName,
std::string  indexName
throw ( RGMAException, RemoteException) [static]
 

Drops an index from the Schema instance for the given VDB.

Parameters:
vdbName Name of VDB.
indexName Index to drop.
Exceptions:
RemoteException If the service can not be contacted.
RGMAException If the index does not exist.

void glite::rgma::Schema::dropTable std::string  vdbName,
std::string  tableName
throw ( RGMAException, RemoteException) [static]
 

Drops a table from the Schema instance for the given VDB.

Parameters:
vdbName Name of VDB.
tableName Table to drop.
Exceptions:
RemoteException If the service can not be contacted.
RGMAException If the table does not exist.

void glite::rgma::Schema::dropView std::string  vdbName,
std::string  viewName
throw ( RGMAException, RemoteException) [static]
 

Drops an view from the Schema instance for the given VDB.

Parameters:
vdbName Name of VDB.
viewName View to drop.
Exceptions:
RemoteException If the service can not be contacted.
RGMAException If the view does not exist.

StringList glite::rgma::Schema::getAllTables std::string  vdbName  )  throw ( RGMAException, RemoteException ) [static]
 

Gets a list of all tables in the schema for the given VDB.

Parameters:
vdbName Name of VDB.
Returns:
A StringList of table names.
Exceptions:
RemoteException If the service could not be contacted.

TableAuthorization glite::rgma::Schema::getAuthorizationRules std::string  vdbName,
std::string  tableName
throw ( RGMAException, RemoteException) [static]
 

Gets the authorization rules for the given table.

Parameters:
vdbName Name of VDB.
tableName Table name.
Returns:
Table authorization details.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the table does not exist.

std::string glite::rgma::Schema::getProperty std::string  name  )  throw (RemoteException, RGMAException) [static]
 

Gets the value of the specified service property.

Parameters:
name Name of property.
Returns:
Current value of property.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the name/parameter combination is invalid.

std::string glite::rgma::Schema::getProperty std::string  name,
std::string  parameter
throw (RemoteException, RGMAException) [static]
 

Gets the value of the specified service property.

Parameters:
name Name of property.
parameter Parameter to property
Returns:
Current value of property.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the name/parameter combination is invalid.

TableDefinition glite::rgma::Schema::getTableDefinition std::string  vdbName,
std::string  tableName
throw ( RGMAException, RemoteException) [static]
 

Gets the definition for table tableName in the given VDB.

Parameters:
vdbName Name of VDB.
tableName Name of table.
Returns:
Table definition.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the table could not be found

IndexList glite::rgma::Schema::getTableIndexes std::string  vdbName,
std::string  tableName
throw ( RGMAException, RemoteException) [static]
 

Gets the list of indexes defined on the given table in the given VDB.

Parameters:
vdbName Name of VDB.
tableName Name of table.
Returns:
List of Index objects.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the table could not be found

void glite::rgma::Schema::setAuthorizationRules std::string  vdbName,
std::string  tableName,
TableAuthorization  tableAuthz
throw ( RGMAException, RemoteException) [static]
 

Sets the authorization rules for the given table.

Parameters:
vdbName Name of VDB.
tableName Table name.
tableAuthz Table authorization details (for no authorization, set as null).
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the table does not exist or the rules are invalid.

void glite::rgma::Schema::setProperty std::string  name,
std::string  value
throw (RemoteException, RGMAException) [static]
 

Changes the value of the specified service property.

Parameters:
name Name of property.
value New value of property.
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the name/parameter combination is invalid.

void glite::rgma::Schema::setProperty std::string  name,
std::string  value,
std::string  parameter
throw (RemoteException, RGMAException) [static]
 

Changes the value of the specified service property.

Parameters:
name Name of property.
value New value of property.
parameter Parameter to property
Exceptions:
RemoteException If the service could not be contacted.
RGMAException If the name/parameter combination is invalid.


The documentation for this class was generated from the following files:
Generated on Thu May 11 19:23:44 2006 for glite-rgma-api-cpp by doxygen 1.3.5