Package org.hibernate.search.engine.common.schema.management

Interface SchemaExport

All Known Subinterfaces:
ElasticsearchIndexSchemaExport, LuceneIndexSchemaExport
@Incubating public interface SchemaExport

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T> T
    extension(SchemaExportExtension<T> extension)
    Extends the export with the given extension, resulting in an extended export exposing more information.
    void
    toFiles(Path targetDirectory)
    Writes the content of this export to a directory on the filesystem.

  • Method Details

    • toFiles

      void toFiles(Path targetDirectory)
      Writes the content of this export to a directory on the filesystem.
      Parameters:
      targetDirectory - The target directory to generate the output into.

    • extension

      default <T> T extension(SchemaExportExtension<T> extension)
      Extends the export with the given extension, resulting in an extended export exposing more information.
      Type Parameters:
      T - The type of export provided by the extension.
      Parameters:
      extension - The extension to the export interface.
      Returns:
      The extended export.
      Throws:
      SearchException - If the extension cannot be applied (wrong underlying backend, ...).