-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Implement Mutable FST Index #8861
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
80 changes: 80 additions & 0 deletions
80
...ava/org/apache/pinot/segment/local/realtime/impl/invertedindex/NativeMutableFSTIndex.java
This file contains hidden or 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,80 @@ | ||
| /** | ||
| * 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.segment.local.realtime.impl.invertedindex; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.concurrent.locks.ReentrantReadWriteLock; | ||
| import org.apache.pinot.segment.local.utils.nativefst.mutablefst.MutableFST; | ||
| import org.apache.pinot.segment.local.utils.nativefst.mutablefst.MutableFSTImpl; | ||
| import org.apache.pinot.segment.local.utils.nativefst.utils.RealTimeRegexpMatcher; | ||
| import org.apache.pinot.segment.spi.index.mutable.MutableTextIndex; | ||
| import org.roaringbitmap.RoaringBitmapWriter; | ||
| import org.roaringbitmap.buffer.ImmutableRoaringBitmap; | ||
| import org.roaringbitmap.buffer.MutableRoaringBitmap; | ||
|
|
||
|
|
||
| public class NativeMutableFSTIndex implements MutableTextIndex { | ||
| private final String _column; | ||
| private final MutableFST _fst; | ||
| private final ReentrantReadWriteLock.ReadLock _readLock; | ||
| private final ReentrantReadWriteLock.WriteLock _writeLock; | ||
| private int _dictId; | ||
|
|
||
| public NativeMutableFSTIndex(String column) { | ||
| _column = column; | ||
| _fst = new MutableFSTImpl(); | ||
|
|
||
| ReentrantReadWriteLock readWriteLock = new ReentrantReadWriteLock(); | ||
| _readLock = readWriteLock.readLock(); | ||
| _writeLock = readWriteLock.writeLock(); | ||
| } | ||
|
|
||
| @Override | ||
| public void add(String document) { | ||
| _writeLock.lock(); | ||
| try { | ||
| _fst.addPath(document, _dictId); | ||
| _dictId++; | ||
| } finally { | ||
| _writeLock.unlock(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public ImmutableRoaringBitmap getDictIds(String searchQuery) { | ||
| RoaringBitmapWriter<MutableRoaringBitmap> writer = RoaringBitmapWriter.bufferWriter().get(); | ||
| _readLock.lock(); | ||
| try { | ||
| RealTimeRegexpMatcher.regexMatch(searchQuery, _fst, writer::add); | ||
| return writer.get(); | ||
| } finally { | ||
| _readLock.unlock(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public MutableRoaringBitmap getDocIds(String searchQuery) { | ||
| throw new UnsupportedOperationException("getDocIds is not supported for NativeMutableFSTIndex"); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() | ||
| throws IOException { | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
88 changes: 88 additions & 0 deletions
88
...org/apache/pinot/segment/local/realtime/impl/invertedindex/NativeMutableFSTIndexTest.java
This file contains hidden or 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,88 @@ | ||
| /** | ||
| * 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.segment.local.realtime.impl.invertedindex; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import javax.annotation.Nullable; | ||
| import org.roaringbitmap.buffer.ImmutableRoaringBitmap; | ||
| import org.testng.annotations.AfterClass; | ||
| import org.testng.annotations.BeforeClass; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import static org.testng.Assert.assertEquals; | ||
| import static org.testng.Assert.assertTrue; | ||
|
|
||
|
|
||
| public class NativeMutableFSTIndexTest { | ||
| private static final String TEXT_COLUMN_NAME = "testColumnName"; | ||
| private NativeMutableFSTIndex _nativeMutableFSTIndex; | ||
|
|
||
| @BeforeClass | ||
| public void setUp() | ||
| throws Exception { | ||
| _nativeMutableFSTIndex = new NativeMutableFSTIndex(TEXT_COLUMN_NAME); | ||
| List<String> documents = getTextData(); | ||
|
|
||
| for (String doc : documents) { | ||
| _nativeMutableFSTIndex.add(doc); | ||
| } | ||
| } | ||
|
|
||
| @AfterClass | ||
| public void tearDown() | ||
| throws IOException { | ||
| _nativeMutableFSTIndex.close(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testQueries() { | ||
| String nativeQuery = "P.*"; | ||
| List<Integer> resultList = Arrays.asList(0, 9); | ||
| testSelectionResults(nativeQuery, 2, resultList); | ||
|
|
||
| nativeQuery = "a.*"; | ||
| resultList = Arrays.asList(5, 6); | ||
| testSelectionResults(nativeQuery, 2, resultList); | ||
|
|
||
| nativeQuery = ".*ed"; | ||
| resultList = Arrays.asList(6); | ||
| testSelectionResults(nativeQuery, 1, resultList); | ||
|
|
||
| nativeQuery = ".*m.*"; | ||
| resultList = Arrays.asList(6, 7, 8); | ||
| testSelectionResults(nativeQuery, 3, resultList); | ||
| } | ||
|
|
||
| private List<String> getTextData() { | ||
| return Arrays.asList("Prince", "Andrew", "kept", "looking", "with", "an", "amused", "smile", "from", "Pierre"); | ||
| } | ||
|
|
||
| private void testSelectionResults(String nativeQuery, int resultCount, @Nullable List<Integer> results) { | ||
| ImmutableRoaringBitmap resultMap = _nativeMutableFSTIndex.getDictIds(nativeQuery); | ||
| assertEquals(resultMap.getCardinality(), resultCount); | ||
|
|
||
| if (results != null) { | ||
| for (int result : results) { | ||
| assertTrue(resultMap.contains(result)); | ||
| } | ||
| } | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add more tests like
.*m.*