-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
FulltextProvider.java
359 lines (332 loc) · 13.4 KB
/
FulltextProvider.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.api.impl.fulltext;
import java.io.File;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.function.Consumer;
import java.util.function.Function;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.kernel.AvailabilityGuard;
import org.neo4j.kernel.api.exceptions.InvalidArgumentsException;
import org.neo4j.kernel.api.index.InternalIndexState;
import org.neo4j.kernel.impl.transaction.log.TransactionIdStore;
import org.neo4j.logging.Log;
import org.neo4j.scheduler.JobScheduler;
/**
* Provider class that manages and provides fulltext indices. This is the main entry point for the fulltext addon.
*/
public class FulltextProvider implements AutoCloseable
{
public static final String LUCENE_FULLTEXT_ADDON_PREFIX = "__lucene__fulltext__addon__";
public static final String FIELD_ENTITY_ID = LUCENE_FULLTEXT_ADDON_PREFIX + "internal__id__";
private final GraphDatabaseService db;
private final Log log;
private final TransactionIdStore transactionIdStore;
private final FulltextTransactionEventUpdater fulltextTransactionEventUpdater;
private final Set<String> nodeProperties;
private final Set<String> relationshipProperties;
private final Map<String,WritableFulltext> writableNodeIndices;
private final Map<String,WritableFulltext> writableRelationshipIndices;
private final FulltextUpdateApplier applier;
private final FulltextFactory factory;
private final ReadWriteLock configurationLock;
/**
* Creates a provider of fulltext indices for the given database. This is the entry point for all fulltext index
* operations.
*
* @param db Database that this provider should work with.
* @param log For logging errors.
* @param availabilityGuard Used for waiting with populating the index until the database is available.
* @param scheduler For background work.
* @param transactionIdStore Used for checking if the store has had transactions applied to it, while the fulltext
* @param fileSystem The filesystem to use.
* @param storeDir Store directory of the database.
* @param analyzerClassName The Lucene analyzer to use for the {@link LuceneFulltext} created by this factory.
*/
public FulltextProvider( GraphDatabaseService db, Log log, AvailabilityGuard availabilityGuard,
JobScheduler scheduler, TransactionIdStore transactionIdStore,
FileSystemAbstraction fileSystem, File storeDir,
String analyzerClassName ) throws IOException
{
this.db = db;
this.log = log;
this.transactionIdStore = transactionIdStore;
applier = new FulltextUpdateApplier( log, availabilityGuard, scheduler );
applier.start();
factory = new FulltextFactory( fileSystem, storeDir, analyzerClassName );
fulltextTransactionEventUpdater = new FulltextTransactionEventUpdater( this, applier );
nodeProperties = ConcurrentHashMap.newKeySet();
relationshipProperties = ConcurrentHashMap.newKeySet();
writableNodeIndices = new ConcurrentHashMap<>();
writableRelationshipIndices = new ConcurrentHashMap<>();
configurationLock = new ReentrantReadWriteLock( true );
}
public void registerTransactionEventHandler() throws IOException
{
db.registerTransactionEventHandler( fulltextTransactionEventUpdater );
}
private boolean matchesConfiguration( WritableFulltext index ) throws IOException
{
long txId = transactionIdStore.getLastCommittedTransactionId();
FulltextIndexConfiguration currentConfig =
new FulltextIndexConfiguration( index.getAnalyzerName(), index.getProperties(), txId );
FulltextIndexConfiguration storedConfig;
try ( ReadOnlyFulltext indexReader = index.getIndexReader() )
{
storedConfig = indexReader.getConfigurationDocument();
}
return storedConfig == null && index.getProperties().isEmpty() ||
storedConfig != null && storedConfig.equals( currentConfig );
}
/**
* Wait for the asynchronous background population, if one is on-going, to complete.
* <p>
* Such population, where the entire store is scanned for data to write to the index, will be started if the index
* needs to recover after an unclean shut-down, or a configuration change.
*
* @throws RuntimeException If it was not possible to wait for the population to finish, for some reason.
*/
public void awaitPopulation()
{
try
{
applier.writeBarrier().awaitCompletion();
}
catch ( ExecutionException e )
{
throw new AssertionError( "The writeBarrier operation should never throw an exception", e );
}
catch ( IOException e )
{
throw new UncheckedIOException( e );
}
}
public void openIndex( String identifier, FulltextIndexType type ) throws IOException
{
LuceneFulltext index = factory.openFulltextIndex( identifier, type );
register( index );
}
public void createIndex( String identifier, FulltextIndexType type, List<String> properties )
throws IOException
{
LuceneFulltext index = factory.createFulltextIndex( identifier, type, properties );
register( index );
}
private void register( LuceneFulltext fulltextIndex ) throws IOException
{
configurationLock.writeLock().lock();
try
{
WritableFulltext writableFulltext = new WritableFulltext( fulltextIndex );
writableFulltext.open();
if ( fulltextIndex.getType() == FulltextIndexType.NODES )
{
if ( !matchesConfiguration( writableFulltext ) )
{
writableFulltext.drop();
writableFulltext.open();
if ( !writableFulltext.getProperties().isEmpty() )
{
applier.populateNodes( writableFulltext, db );
}
}
writableNodeIndices.put( fulltextIndex.getIdentifier(), writableFulltext );
nodeProperties.addAll( fulltextIndex.getProperties() );
}
else
{
if ( !matchesConfiguration( writableFulltext ) )
{
writableFulltext.drop();
writableFulltext.open();
if ( !writableFulltext.getProperties().isEmpty() )
{
applier.populateRelationships( writableFulltext, db );
}
}
writableRelationshipIndices.put( fulltextIndex.getIdentifier(), writableFulltext );
relationshipProperties.addAll( fulltextIndex.getProperties() );
}
}
finally
{
configurationLock.writeLock().unlock();
}
}
String[] getNodeProperties()
{
return nodeProperties.toArray( new String[0] );
}
String[] getRelationshipProperties()
{
return relationshipProperties.toArray( new String[0] );
}
Collection<WritableFulltext> writableNodeIndices()
{
return Collections.unmodifiableCollection( writableNodeIndices.values() );
}
Collection<WritableFulltext> writableRelationshipIndices()
{
return Collections.unmodifiableCollection( writableRelationshipIndices.values() );
}
/**
* Returns a reader for the specified index.
*
* @param identifier Identifier for the index.
* @param type Type of the index.
* @return A {@link ReadOnlyFulltext} for the index, or null if no such index is found.
* @throws IOException
*/
public ReadOnlyFulltext getReader( String identifier, FulltextIndexType type ) throws IOException
{
WritableFulltext writableFulltext = getIndexMap( type ).get( identifier );
if ( writableFulltext == null )
{
throw new IllegalArgumentException( "No such " + type + " index '" + identifier + "'." );
}
return writableFulltext.getIndexReader();
}
private Map<String,WritableFulltext> getIndexMap( FulltextIndexType type )
{
switch ( type )
{
case NODES:
return writableNodeIndices;
case RELATIONSHIPS:
return writableRelationshipIndices;
default:
throw new IllegalArgumentException( "No such fulltext index type: " + type );
}
}
public Set<String> getProperties( String identifier, FulltextIndexType type )
{
return applyToMatchingIndex( identifier, type, WritableFulltext::getProperties );
}
private <E> E applyToMatchingIndex(
String identifier, FulltextIndexType type, Function<WritableFulltext,E> function )
{
if ( type == FulltextIndexType.NODES )
{
return function.apply( writableNodeIndices.get( identifier ) );
}
else
{
return function.apply( writableRelationshipIndices.get( identifier ) );
}
}
public InternalIndexState getState( String identifier, FulltextIndexType type )
{
return applyToMatchingIndex( identifier, type, WritableFulltext::getState );
}
void drop( String identifier, FulltextIndexType type ) throws IOException
{
configurationLock.writeLock().lock();
try
{
// Wait for the queue of updates to drain, before deleting an index.
awaitPopulation();
if ( type == FulltextIndexType.NODES )
{
writableNodeIndices.remove( identifier ).drop();
}
else
{
writableRelationshipIndices.remove( identifier ).drop();
}
rebuildProperties();
}
finally
{
configurationLock.writeLock().unlock();
}
}
private void rebuildProperties()
{
nodeProperties.clear();
relationshipProperties.clear();
writableNodeIndices.forEach( ( s, index ) -> nodeProperties.addAll( index.getProperties() ) );
writableRelationshipIndices.forEach( ( s, index ) -> relationshipProperties.addAll( index.getProperties() ) );
}
Lock readLockIndexConfiguration()
{
Lock lock = configurationLock.readLock();
lock.lock();
return lock;
}
public void changeIndexedProperties( String identifier, FulltextIndexType type, List<String> propertyKeys )
throws IOException, InvalidArgumentsException
{
configurationLock.writeLock().lock();
try
{
if ( propertyKeys.stream().anyMatch( s -> s.startsWith( FulltextProvider.LUCENE_FULLTEXT_ADDON_PREFIX ) ) )
{
throw new InvalidArgumentsException(
"It is not possible to index property keys starting with " +
FulltextProvider.LUCENE_FULLTEXT_ADDON_PREFIX );
}
Set<String> currentProperties = getProperties( identifier, type );
if ( !currentProperties.containsAll( propertyKeys ) || !propertyKeys.containsAll( currentProperties ) )
{
drop( identifier, type );
createIndex( identifier, type, propertyKeys );
}
}
finally
{
configurationLock.writeLock().unlock();
}
}
/**
* Closes the provider and all associated resources.
*/
@Override
public void close()
{
db.unregisterTransactionEventHandler( fulltextTransactionEventUpdater );
applier.stop();
Consumer<WritableFulltext> fulltextCloser = luceneFulltextIndex ->
{
try
{
luceneFulltextIndex.saveConfiguration( transactionIdStore.getLastCommittedTransactionId() );
luceneFulltextIndex.close();
}
catch ( IOException e )
{
log.error( "Unable to close fulltext index.", e );
}
};
writableNodeIndices.values().forEach( fulltextCloser );
writableRelationshipIndices.values().forEach( fulltextCloser );
}
}