Package org.teiid.adminapi

Interface VDB

  • All Superinterfaces:
    AdminObject, DomainAware, Serializable
    All Known Implementing Classes:
    VDBMetaData
    public interface VDB
extends AdminObject, DomainAware
    Represents a Virtual Database in the Teiid System.
    A VDB has a name and a version.

    The identifier pattern for a VDB is name.version, where the name of the VDB and its version represent its unique identifier in the Teiid system. There are no spaces allowed in a given VDB name, and VDB name must start with a letter. A version number is automatically assigned to a VDB when it is deployed into a system. A VDB is uniquely identified by name.version". For example: "Accounts.1", "UnifiedSales.4", etc.

    Since:
    4.3

    • Method Detail

      • getModels

        List<Model> getModels()
        Returns:
        Collection of Teiid Models

      • getStatus

        VDB.Status getStatus()
        Returns:
        the status

      • getConnectionType

        VDB.ConnectionType getConnectionType()
        Returns:
        the connection status

      • getVersion

        String getVersion()
        Returns:
        the VDB version.

      • getDescription

        String getDescription()
        Get the description of the VDB
        Returns:

      • getValidityErrors

        List<String> getValidityErrors()
        Shows any validity errors present in the VDB
        Returns:

      • isValid

        boolean isValid()
        Shows if VDB is a valid entity
        Returns:

      • getDataPolicies

        List<DataPolicy> getDataPolicies()
        Get the data roles defined on this VDB
        Returns:

      • getOverrideTranslators

        List<Translator> getOverrideTranslators()
        Get the list of translators defined in the VDB
        Returns:

      • getVDBImports

        List<? extends VDBImport> getVDBImports()
        Get the list of vdb imports
        Returns:

      • getEntries

        List<? extends Entry> getEntries()
        Get the list of other resources included in the VDB
        Returns:

      • isVisible

        boolean isVisible​(String modelName)
        Whether the model is visible
        Parameters:
        modelName -
        Returns:

      • getName

        String getName()
        Description copied from interface: AdminObject
        Get the name for this AdminObject, usually the last component of the identifier.
        Specified by:
        getName in interface AdminObject
        Returns:
        the name of the vdb. If this vdb is using semantic versioning, that version will be included in the name.