Package com.sas.metadata.remote

Interface DatabaseSchema

All Superinterfaces:
CMetadata, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, RelationalSchema, Remote, Root
public interface DatabaseSchema extends RelationalSchema
A relational schema that contains tables that are not in SAS data sets. In order to use a SAS application server to access the tables in a database schema, the tables must also be registered with a SAS library.

Attributes of DatabaseSchema are:

Associations of DatabaseSchema are:

Usage

To create an instance of this DatabaseSchema, use the factory create methods.
Example: create a DatabaseSchema with name "DatabaseSchema_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 DatabaseSchema myObject = (DatabaseSchema) factory.createComplexMetadataObject(objectStore, "DatabaseSchema_Object", MetadataObjects.DATABASESCHEMA, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_SCHEMANAME_NAME

      static final String ATTRIBUTE_SCHEMANAME_NAME
      Constant used for the name of the SchemaName attribute.

      SchemaName: The name the DBMS uses to refer to this schema.

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface DeployedDataPackage
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface RelationalSchema
      Specified by:
      initializeRequiredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      Specified by:
      initializePredObjects in interface DeployedDataPackage
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface RelationalSchema
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getSchemaName

      String getSchemaName() throws RemoteException
      Gets the String value of SchemaName
      Returns:
      The SchemaName
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getSchemaNameState

      int getSchemaNameState() throws RemoteException
      Gets the Metadata State of SchemaName
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getSchemaNameMaxLength

      int getSchemaNameMaxLength() throws RemoteException
      Gets the maximum length of SchemaName
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • setSchemaName

      void setSchemaName(String inSchemaName) throws RemoteException
      Sets the SchemaName value and sets the state to MetadataState.LOCAL.
      Parameters:
      inSchemaName - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setSchemaName

      void setSchemaName(String inSchemaName, int state) throws RemoteException
      Sets the SchemaName Metadata State.
      Parameters:
      inSchemaName - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSchemaNameState

      void setSchemaNameState(int state) throws RemoteException
      Sets the Metadata State of SchemaName.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.