Package io.vanslog.spring.data.meilisearch.core

Interface MeilisearchIndexOperations

public interface MeilisearchIndexOperations
Operations for APIs scoped to a single Meilisearch index.
Author:
Junghoon Ban
See Also:
  • Index

  • Method Details

    • create

      MeilisearchIndex create()
      Create the bound index without declaring a primary key.
      Returns:
      the created index

    • create

      MeilisearchIndex create(MeilisearchIndexCreateRequest request)
      Create the bound index using the given request.
      Parameters:
      request - index creation options
      Returns:
      the created index

    • get

      MeilisearchIndex get()
      Return the bound index metadata.
      Returns:
      index metadata

    • list

      MeilisearchIndexList list()
      Return a page of indexes using Meilisearch defaults.
      Returns:
      indexes page

    • list

      MeilisearchIndexList list(MeilisearchIndexQuery query)
      Return a page of indexes using the given query.
      Parameters:
      query - index listing options
      Returns:
      indexes page

    • update

      MeilisearchIndex update(MeilisearchIndexUpdateRequest request)
      Update the bound index using the given request.
      Parameters:
      request - index update options
      Returns:
      the updated index

    • delete

      boolean delete()
      Delete the bound index.
      Returns:
      true if the delete task succeeded

    • stats

      MeilisearchIndexStats stats()
      Return statistics for the bound index.
      Returns:
      index statistics

    • getSettings

      MeilisearchIndexSettings getSettings()
      Return runtime settings for the bound index.
      Returns:
      index settings

    • updateSettings

      MeilisearchIndexSettings updateSettings(MeilisearchIndexSettings settings)
      Update runtime settings for the bound index.
      Parameters:
      settings - index settings to update
      Returns:
      index settings after the update task succeeds

    • resetSettings

      MeilisearchIndexSettings resetSettings()
      Reset all runtime settings for the bound index to Meilisearch defaults.
      Returns:
      index settings after the reset task succeeds