forked from apache/pinot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support st_contains using H3 index (apache#8498)
The idea is to convert input geometry into a list of h3 cells by using polyfill. But h3 polyfill only fills with the hexagons whose centers are contained by the geometry. so creating a method coverGeometryInH3 to return the set of H3 cells at the specified resolution which completely cover the input shape.
- Loading branch information
Showing
5 changed files
with
501 additions
and
30 deletions.
There are no files selected for viewing
152 changes: 152 additions & 0 deletions
152
...e/src/main/java/org/apache/pinot/core/operator/filter/H3InclusionIndexFilterOperator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pinot.core.operator.filter; | ||
|
|
||
| import it.unimi.dsi.fastutil.longs.LongIterator; | ||
| import it.unimi.dsi.fastutil.longs.LongSet; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import org.apache.commons.lang3.tuple.Pair; | ||
| import org.apache.pinot.common.request.context.ExpressionContext; | ||
| import org.apache.pinot.common.request.context.predicate.EqPredicate; | ||
| import org.apache.pinot.common.request.context.predicate.Predicate; | ||
| import org.apache.pinot.core.common.Operator; | ||
| import org.apache.pinot.core.operator.blocks.FilterBlock; | ||
| import org.apache.pinot.core.operator.dociditerators.ScanBasedDocIdIterator; | ||
| import org.apache.pinot.core.operator.docidsets.BitmapDocIdSet; | ||
| import org.apache.pinot.segment.local.utils.GeometrySerializer; | ||
| import org.apache.pinot.segment.local.utils.H3Utils; | ||
| import org.apache.pinot.segment.spi.IndexSegment; | ||
| import org.apache.pinot.segment.spi.index.reader.H3IndexReader; | ||
| import org.apache.pinot.spi.utils.BooleanUtils; | ||
| import org.apache.pinot.spi.utils.BytesUtils; | ||
| import org.locationtech.jts.geom.Geometry; | ||
| import org.roaringbitmap.buffer.BufferFastAggregation; | ||
| import org.roaringbitmap.buffer.ImmutableRoaringBitmap; | ||
| import org.roaringbitmap.buffer.MutableRoaringBitmap; | ||
|
|
||
|
|
||
| /** | ||
| * A filter operator that uses H3 index for geospatial data inclusion | ||
| */ | ||
| public class H3InclusionIndexFilterOperator extends BaseFilterOperator { | ||
|
|
||
| private static final String EXPLAIN_NAME = "INCLUSION_FILTER_H3_INDEX"; | ||
|
|
||
| private final IndexSegment _segment; | ||
| private final Predicate _predicate; | ||
| private final int _numDocs; | ||
| private final H3IndexReader _h3IndexReader; | ||
| private final Geometry _geometry; | ||
| private final boolean _isPositiveCheck; | ||
|
|
||
| public H3InclusionIndexFilterOperator(IndexSegment segment, Predicate predicate, int numDocs) { | ||
| _segment = segment; | ||
| _predicate = predicate; | ||
| _numDocs = numDocs; | ||
|
|
||
| List<ExpressionContext> arguments = predicate.getLhs().getFunction().getArguments(); | ||
| EqPredicate eqPredicate = (EqPredicate) predicate; | ||
| _isPositiveCheck = BooleanUtils.toBoolean(eqPredicate.getValue()); | ||
|
|
||
| if (arguments.get(0).getType() == ExpressionContext.Type.IDENTIFIER) { | ||
| _h3IndexReader = segment.getDataSource(arguments.get(0).getIdentifier()).getH3Index(); | ||
| _geometry = GeometrySerializer.deserialize(BytesUtils.toBytes(arguments.get(1).getLiteral())); | ||
| } else { | ||
| _h3IndexReader = segment.getDataSource(arguments.get(1).getIdentifier()).getH3Index(); | ||
| _geometry = GeometrySerializer.deserialize(BytesUtils.toBytes(arguments.get(0).getLiteral())); | ||
| } | ||
| // must be some h3 index | ||
| assert _h3IndexReader != null : "the column must have H3 index setup."; | ||
| } | ||
|
|
||
| @Override | ||
| protected FilterBlock getNextBlock() { | ||
| // get the set of H3 cells at the specified resolution which completely cover the input shape and potential cover. | ||
| Pair<LongSet, LongSet> fullCoverAndPotentialCoverCells = | ||
| H3Utils.coverGeometryInH3(_geometry, _h3IndexReader.getH3IndexResolution().getLowestResolution()); | ||
| LongSet fullyCoverH3Cells = fullCoverAndPotentialCoverCells.getLeft(); | ||
| LongSet potentialCoverH3Cells = fullCoverAndPotentialCoverCells.getRight(); | ||
|
|
||
| // have list of h3 cell ids for polygon provided | ||
| // return filtered num_docs | ||
| ImmutableRoaringBitmap[] potentialMatchDocIds = new ImmutableRoaringBitmap[potentialCoverH3Cells.size()]; | ||
| int i = 0; | ||
| LongIterator potentialCoverH3CellsIterator = potentialCoverH3Cells.iterator(); | ||
| while (potentialCoverH3CellsIterator.hasNext()) { | ||
| potentialMatchDocIds[i++] = _h3IndexReader.getDocIds(potentialCoverH3CellsIterator.nextLong()); | ||
| } | ||
| MutableRoaringBitmap potentialMatchMutableRoaringBitmap = BufferFastAggregation.or(potentialMatchDocIds); | ||
| if (_isPositiveCheck) { | ||
| ImmutableRoaringBitmap[] fullMatchDocIds = new ImmutableRoaringBitmap[fullyCoverH3Cells.size()]; | ||
| i = 0; | ||
| LongIterator fullyCoverH3CellsIterator = fullyCoverH3Cells.iterator(); | ||
| while (fullyCoverH3CellsIterator.hasNext()) { | ||
| fullMatchDocIds[i++] = _h3IndexReader.getDocIds(fullyCoverH3CellsIterator.nextLong()); | ||
| } | ||
| MutableRoaringBitmap fullMatchMutableRoaringBitmap = BufferFastAggregation.or(fullMatchDocIds); | ||
| return getFilterBlock(fullMatchMutableRoaringBitmap, potentialMatchMutableRoaringBitmap); | ||
| } else { | ||
| i = 0; | ||
| // remove full match from potential match to get potential not match cells. | ||
| potentialCoverH3Cells.removeAll(fullyCoverH3Cells); | ||
| ImmutableRoaringBitmap[] potentialNotMatchMutableRoaringBitmap = | ||
| new ImmutableRoaringBitmap[potentialCoverH3Cells.size()]; | ||
| LongIterator potentialNotMatchH3CellsIterator = potentialCoverH3Cells.iterator(); | ||
| while (potentialNotMatchH3CellsIterator.hasNext()) { | ||
| potentialNotMatchMutableRoaringBitmap[i++] = | ||
| _h3IndexReader.getDocIds(potentialNotMatchH3CellsIterator.nextLong()); | ||
| } | ||
| MutableRoaringBitmap potentialNotMatch = BufferFastAggregation.or(potentialNotMatchMutableRoaringBitmap); | ||
| // flip potential match bit map to get exactly not match bitmap. | ||
| potentialMatchMutableRoaringBitmap.flip(0L, _numDocs); | ||
| return getFilterBlock(potentialMatchMutableRoaringBitmap, potentialNotMatch); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns the filter block based on the given the partial match doc ids. | ||
| */ | ||
| private FilterBlock getFilterBlock(MutableRoaringBitmap fullMatchDocIds, MutableRoaringBitmap partialMatchDocIds) { | ||
| ExpressionFilterOperator expressionFilterOperator = new ExpressionFilterOperator(_segment, _predicate, _numDocs); | ||
| ScanBasedDocIdIterator docIdIterator = | ||
| (ScanBasedDocIdIterator) expressionFilterOperator.getNextBlock().getBlockDocIdSet().iterator(); | ||
| MutableRoaringBitmap result = docIdIterator.applyAnd(partialMatchDocIds); | ||
| result.or(fullMatchDocIds); | ||
| return new FilterBlock(new BitmapDocIdSet(result, _numDocs) { | ||
| @Override | ||
| public long getNumEntriesScannedInFilter() { | ||
| return docIdIterator.getNumEntriesScanned(); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| public List<Operator> getChildOperators() { | ||
| return Collections.emptyList(); | ||
| } | ||
|
|
||
| @Override | ||
| public String toExplainString() { | ||
| StringBuilder stringBuilder = new StringBuilder(EXPLAIN_NAME).append("(inclusionIndex:h3_index"); | ||
| stringBuilder.append(",operator:").append(_predicate.getType()); | ||
| stringBuilder.append(",predicate:").append(_predicate.toString()); | ||
| return stringBuilder.append(')').toString(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.