org.hibernate.search.elasticsearch.schema.impl

## Interface ElasticsearchSchemaDropper

- All Known Implementing Classes:
    DefaultElasticsearchSchemaDropper

      public interface ElasticsearchSchemaDropper

  An object responsible for dropping an indexes.
  Author:
    Yoann Rodiere

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `drop(URLEncodedString indexName, ExecutionOptions executionOptions)` Drops an index, throwing an exception if dropping fails.
    `void` | `dropIfExisting(URLEncodedString indexName, ExecutionOptions executionOptions)` Drops an index, throwing an exception if dropping fails.

- - ### Method Detail

    - #### drop

          void drop(URLEncodedString indexName,
                    ExecutionOptions executionOptions)

      Drops an index, throwing an exception if dropping fails.
      Parameters:
        `indexName` - The name of the index to drop.
        `executionOptions` - The execution options, giving more context information.
      Throws:
        `SearchException` - If an error occurs.

    - #### dropIfExisting

          void dropIfExisting(URLEncodedString indexName,
                              ExecutionOptions executionOptions)

      Drops an index, throwing an exception if dropping fails.

      This method will skip operations silently if the index does not exist.

      Parameters:
        `indexName` - The name of the index to drop.
        `executionOptions` - The execution options, giving more context information.
      Throws:
        `SearchException` - If an error occurs.

Copyright © 2006-2017 Red Hat, Inc. All Rights Reserved