org.elasticsearch.join.mapper.Joiner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of parent-join-client Show documentation
This module adds the support parent-child queries and aggregations
There is a newer version: 7.17.26
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.join.mapper;

import org.apache.lucene.index.Term;
import org.apache.lucene.search.BooleanClause;
import org.apache.lucene.search.BooleanQuery;
import org.apache.lucene.search.ConstantScoreQuery;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.TermQuery;
import org.elasticsearch.index.mapper.MappedFieldType;
import org.elasticsearch.index.query.SearchExecutionContext;
import org.elasticsearch.join.mapper.ParentJoinFieldMapper.JoinFieldType;
import org.elasticsearch.search.aggregations.support.AggregationContext;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.function.Consumer;
import java.util.stream.Stream;

/**
 * Utility class to help build join queries and aggregations, based on a join_field
 */
public final class Joiner {

    /**
     * Get the Joiner for this context, or {@code null} if none is configured
     */
    public static Joiner getJoiner(SearchExecutionContext context) {
        return getJoiner(context.getMatchingFieldNames("*").stream().map(context::getFieldType));
    }

    /**
     * Get the Joiner for this context, or {@code null} if none is configured
     */
    public static Joiner getJoiner(AggregationContext context) {
        return getJoiner(context.getMatchingFieldNames("*").stream().map(context::getFieldType));
    }

    /**
     * Get the Joiner for this context, or {@code null} if none is configured
     */
    static Joiner getJoiner(Stream fieldTypes) {
        Optional joinType = fieldTypes.filter(ft -> ft instanceof JoinFieldType).map(ft -> (JoinFieldType) ft).findFirst();
        return joinType.map(JoinFieldType::getJoiner).orElse(null);
    }

    private final Map> parentsToChildren = new HashMap<>();
    private final Map childrenToParents = new HashMap<>();

    private final String joinField;

    /**
     * Constructs a Joiner based on a join field and a set of relations
     */
    Joiner(String joinField, List relations) {
        this.joinField = joinField;
        for (Relations r : relations) {
            for (String child : r.children) {
                parentsToChildren.put(r.parent, r.children);
                if (childrenToParents.containsKey(child)) {
                    throw new IllegalArgumentException("[" + child + "] cannot have multiple parents");
                }
                childrenToParents.put(child, r.parent);
            }
        }
    }

    /**
     * @return the join field for the index
     */
    public String getJoinField() {
        return joinField;
    }

    /**
     * @return a filter for documents of a specific join type
     */
    public Query filter(String relationType) {
        return new TermQuery(new Term(joinField, relationType));
    }

    /**
     * @return a filter for parent documents of a specific child type
     */
    public Query parentFilter(String childType) {
        return new TermQuery(new Term(joinField, childrenToParents.get(childType)));
    }

    /**
     * @return a filter for child documents of a specific parent type
     */
    public Query childrenFilter(String parentType) {
        assert parentTypeExists(parentType);
        BooleanQuery.Builder builder = new BooleanQuery.Builder();
        for (String child : parentsToChildren.get(parentType)) {
            builder.add(filter(child), BooleanClause.Occur.SHOULD);
        }
        return new ConstantScoreQuery(builder.build());
    }

    /**
     * @return {@code true} if the child type has been defined for the join field
     */
    public boolean childTypeExists(String type) {
        return childrenToParents.containsKey(type);
    }

    /**
     * @return {@code true} if the parent type has been defined for the join field
     */
    public boolean parentTypeExists(String type) {
        return parentsToChildren.containsKey(type);
    }

    /**
     * @return {@code true} if the type has been defined as either a parent
     * or a child for the join field
     */
    public boolean knownRelation(String type) {
        return childTypeExists(type) || parentTypeExists(type);
    }

    /**
     * @return the name of the linked join field for documents of a specific child type
     */
    public String parentJoinField(String childType) {
        return joinField + "#" + childrenToParents.get(childType);
    }

    /**
     * @return the name of the linked join field for documents of a specific parent type
     */
    public String childJoinField(String parentType) {
        return joinField + "#" + parentType;
    }

    boolean canMerge(Joiner other, Consumer conflicts) {
        boolean conflicted = false;
        for (String parent : parentsToChildren.keySet()) {
            if (other.parentsToChildren.containsKey(parent) == false) {
                conflicts.accept("Cannot remove parent [" + parent + "]");
                conflicted = true;
            }
        }
        for (String child : childrenToParents.keySet()) {
            if (other.childrenToParents.containsKey(child) == false) {
                conflicts.accept("Cannot remove child [" + child + "]");
                conflicted = true;
            }
        }
        for (String newParent : other.parentsToChildren.keySet()) {
            if (childrenToParents.containsKey(newParent) && parentsToChildren.containsKey(newParent) == false) {
                conflicts.accept("Cannot create parent [" + newParent + "] from an existing child");
                conflicted = true;
            }
        }
        for (String newChild : other.childrenToParents.keySet()) {
            if (this.childrenToParents.containsKey(newChild)
                && Objects.equals(other.childrenToParents.get(newChild), this.childrenToParents.get(newChild)) == false) {
                conflicts.accept("Cannot change parent of [" + newChild + "]");
                conflicted = true;
            }
            if (this.parentsToChildren.containsKey(newChild)
                && Objects.equals(this.childrenToParents.get(newChild), other.childrenToParents.get(newChild)) == false) {
                conflicts.accept("Cannot create child [" + newChild + "] from an existing root");
                conflicted = true;
            }
        }
        return conflicted == false;
    }
}