-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
IndexProxy.java
121 lines (101 loc) · 4.6 KB
/
IndexProxy.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
/*
* 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 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.impl.api.index;
import java.io.File;
import java.io.IOException;
import java.util.concurrent.Future;
import org.neo4j.graphdb.ResourceIterator;
import org.neo4j.kernel.api.exceptions.index.IndexActivationFailedKernelException;
import org.neo4j.kernel.api.exceptions.index.IndexEntryConflictException;
import org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException;
import org.neo4j.kernel.api.exceptions.index.IndexPopulationFailedKernelException;
import org.neo4j.kernel.api.exceptions.schema.UniquePropertyValueValidationException;
import org.neo4j.kernel.api.index.IndexAccessor;
import org.neo4j.kernel.api.index.IndexPopulator;
import org.neo4j.kernel.api.index.IndexUpdater;
import org.neo4j.kernel.api.index.InternalIndexState;
import org.neo4j.kernel.api.index.PropertyAccessor;
import org.neo4j.kernel.api.index.SchemaIndexProvider;
import org.neo4j.kernel.api.schema.LabelSchemaDescriptor;
import org.neo4j.kernel.api.schema.LabelSchemaSupplier;
import org.neo4j.kernel.api.schema.index.IndexDescriptor;
import org.neo4j.storageengine.api.schema.IndexReader;
import org.neo4j.storageengine.api.schema.PopulationProgress;
/**
* Controls access to {@link IndexPopulator}, {@link IndexAccessor} during different stages
* of the lifecycle of an index. It's designed to be decorated with multiple stacked instances.
*
* The contract of {@link IndexProxy} is
*
* <ul>
* <li>The index may not be created twice</li>
* <li>The context may not be closed twice</li>
* <li>Close or drop both close the context</li>
* <li>The index may not be dropped before it has been created</li>
* <li>newUpdater and force may only be called after the index has been created and before it is closed</li>
* <li>It is an error to not close an updater before doing any other call on an index</li>
* <li>It is an error to close or drop the index while there are still ongoing calls to update and force</li>
* </ul>
*
* @see ContractCheckingIndexProxy
*/
public interface IndexProxy extends LabelSchemaSupplier
{
void start() throws IOException;
IndexUpdater newUpdater( IndexUpdateMode mode );
/**
* Initiates dropping this index context. The returned {@link Future} can be used to await
* its completion.
* Must close the context as well.
*/
Future<Void> drop() throws IOException;
/**
* Initiates a closing of this index context. The returned {@link Future} can be used to await
* its completion.
*/
Future<Void> close() throws IOException;
IndexDescriptor getDescriptor();
@Override
LabelSchemaDescriptor schema();
SchemaIndexProvider.Descriptor getProviderDescriptor();
InternalIndexState getState();
/**
* @return failure message. Expect a call to it if {@link #getState()} returns {@link InternalIndexState#FAILED}.
*/
IndexPopulationFailure getPopulationFailure() throws IllegalStateException;
PopulationProgress getIndexPopulationProgress();
void force() throws IOException;
void refresh() throws IOException;
/**
* @throws IndexNotFoundKernelException if the index isn't online yet.
*/
IndexReader newReader() throws IndexNotFoundKernelException;
/**
* @return {@code true} if the call waited, {@code false} if the condition was already reached.
*/
boolean awaitStoreScanCompleted() throws IndexPopulationFailedKernelException, InterruptedException;
void activate() throws IndexActivationFailedKernelException;
void validate() throws IndexPopulationFailedKernelException, UniquePropertyValueValidationException;
ResourceIterator<File> snapshotFiles() throws IOException;
default void verifyDeferredConstraints( PropertyAccessor accessor ) throws IndexEntryConflictException, IOException
{
throw new IllegalStateException( this.toString() );
}
}