Interface SchemaApi

  • All Superinterfaces:
    SchemaUtil
    All Known Implementing Classes:
    MockSchemaApi

    public interface SchemaApi
    extends SchemaUtil
    API for working with available schemas.
    • Method Detail

      • getSchema

        Schema getSchema​(java.lang.String schemaName)
        Fetch a schema according to schemaName.

        If schemaName is null, the default schema will be returned, if available.

        Returns null if schema does not exist.

        Specified by:
        getSchema in interface SchemaUtil
        Parameters:
        schemaName - the schema name
        Returns:
        the schema
      • addSchema

        default Schema addSchema​(Schema schema)
                          throws AttivioException
        Add/update schema

        WARNING: System restart will be required for all components to take notice of the new/modified schema.

        Throws:
        AttivioException
      • removeSchema

        default void removeSchema​(java.lang.String schemaName)
                           throws AttivioException
        Remove a schema from the system.

        WARNING: System restart will be required for all components to take notice of the removed schema.

        Throws:
        AttivioException