Package com.flowable.indexing.api

Interface LowLevelIndexingService

All Known Implementing Classes:
IndexingServiceImpl
public interface LowLevelIndexingService
Exposes low-level indexing operations. Use the higher-level IndexingService when possible. Only use this when you absolutely know what you're doing.

  • Method Summary

    Modifier and Type Method Description
    default void addToBulkIndexRequest​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, com.fasterxml.jackson.databind.node.ObjectNode data)  
    void addToBulkIndexRequest​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, com.fasterxml.jackson.databind.node.ObjectNode data, java.lang.String idFieldName)  
    void deleteByQuery​(java.lang.String aliasName, com.fasterxml.jackson.databind.node.ObjectNode query)
    Delete indexed objects based on a query.
    void deleteIndexedObject​(java.lang.String aliasName, java.lang.String id)
    Delete the indexed object using the provided id.
    default void indexObject​(java.lang.Object object)
    Indexes the given object.
    void indexObject​(java.lang.Object object, java.lang.String idFieldName)
    Similar to indexObject(Object), but by providing an alternative field name that contains the id, instead of depending on the IndexingJsonConstants.PROPERTY_ID in the json.
    void updateByQuery​(java.lang.String mappingType, com.fasterxml.jackson.databind.node.ObjectNode data)
    Perform Update by Query for the given Mapping type.

  • Method Details

    • indexObject

      default void indexObject​(java.lang.Object object)
      Indexes the given object. If the object is a JsonNode, no serialization will happen. Register a custom ObjectSerializationService to have custom object serialization. Followings the following pattern for choosing how to index: - If the object has an external version, index it - If the object has a script, do an update with a script - Otherwise, do an upsert update with the provided data

    • indexObject

      void indexObject​(java.lang.Object object, java.lang.String idFieldName)
      Similar to indexObject(Object), but by providing an alternative field name that contains the id, instead of depending on the IndexingJsonConstants.PROPERTY_ID in the json.

    • deleteIndexedObject

      void deleteIndexedObject​(java.lang.String aliasName, java.lang.String id)
      Delete the indexed object using the provided id.

    • deleteByQuery

      void deleteByQuery​(java.lang.String aliasName, com.fasterxml.jackson.databind.node.ObjectNode query)
      Delete indexed objects based on a query.

    • updateByQuery

      void updateByQuery​(java.lang.String mappingType, com.fasterxml.jackson.databind.node.ObjectNode data)
      Perform Update by Query for the given Mapping type.
      Parameters:
      mappingType - the type of the mapping for which the update should be done
      data - the update by query request data

    • addToBulkIndexRequest

      default void addToBulkIndexRequest​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, com.fasterxml.jackson.databind.node.ObjectNode data)

    • addToBulkIndexRequest

      void addToBulkIndexRequest​(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, com.fasterxml.jackson.databind.node.ObjectNode data, java.lang.String idFieldName)