-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ExplicitIndexWrite.java
152 lines (138 loc) · 6.09 KB
/
ExplicitIndexWrite.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
/*
* 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.internal.kernel.api;
import java.util.Map;
import org.neo4j.internal.kernel.api.exceptions.KernelException;
import org.neo4j.internal.kernel.api.exceptions.explicitindex.ExplicitIndexNotFoundKernelException;
/**
* Operations for creating and modifying explicit indexes.
*/
public interface ExplicitIndexWrite
{
/**
* Adds node to explicit index.
*
* @param indexName The name of the index
* @param node The id of the node to add
* @param key The key to associate with the node
* @param value The value to associate with the node an key
* @throws ExplicitIndexNotFoundKernelException If there is no explicit index with the given name
*/
void nodeAddToExplicitIndex( String indexName, long node, String key, Object value )
throws KernelException;
/**
* Removes a node from an explicit index
*
* @param indexName The name of the index
* @param node The id of the node to remove
* @param key The key to associate with the node
* @param value The value to associate with the node and key
* @throws ExplicitIndexNotFoundKernelException If there is no explicit index with the given name
*/
void nodeRemoveFromExplicitIndex( String indexName, long node, String key, Object value )
throws ExplicitIndexNotFoundKernelException;
/**
* Removes a node from an explicit index
*
* @param indexName The name of the index
* @param node The id of the node to remove
* @param key The key to associate with the node
* @throws ExplicitIndexNotFoundKernelException If there is no explicit index with the given name
*/
void nodeRemoveFromExplicitIndex( String indexName, long node, String key ) throws
ExplicitIndexNotFoundKernelException;
/**
* Removes a given node from an explicit index
*
* @param indexName The name of the index from which the node is to be removed.
* @param node The node id of the node to remove
* @throws ExplicitIndexNotFoundKernelException If there is no explicit index with the given name
*/
void nodeRemoveFromExplicitIndex( String indexName, long node ) throws ExplicitIndexNotFoundKernelException;
/**
* Adds relationship to explicit index.
*
* @param indexName The name of the index
* @param relationship The id of the relationship to add
* @param key The key to associate with the relationship
* @param value The value to associate with the relationship and key
* @throws ExplicitIndexNotFoundKernelException If there is no explicit index with the given name
*/
void relationshipAddToExplicitIndex( String indexName, long relationship, String key, Object value )
throws KernelException;
/**
* Removes relationship from explicit index.
*
* @param indexName The name of the index
* @param relationship The id of the relationship to remove
* @param key The key to associate with the relationship
* @param value The value to associate with the relationship and key
* @throws ExplicitIndexNotFoundKernelException If there is no explicit index with the given name
*/
void relationshipRemoveFromExplicitIndex( String indexName, long relationship, String key, Object value )
throws KernelException;
/**
* Removes relationship to explicit index.
*
* @param indexName The name of the index
* @param relationship The id of the relationship to remove
* @param key The key to associate with the relationship
* @throws ExplicitIndexNotFoundKernelException If there is no explicit index with the given name
*/
void relationshipRemoveFromExplicitIndex( String indexName, long relationship, String key )
throws KernelException;
/**
* Removes relationship to explicit index.
*
* @param indexName The name of the index
* @param relationship The id of the relationship to remove
* @throws ExplicitIndexNotFoundKernelException If there is no explicit index with the given name
*/
void relationshipRemoveFromExplicitIndex( String indexName, long relationship )
throws KernelException;
/**
* Creates an explicit index in a separate transaction if not yet available.
*
* @param indexName The name of the index to create.
* @param customConfig The configuration of the explicit index.
*/
void nodeExplicitIndexCreateLazily( String indexName, Map<String,String> customConfig );
/**
* Creates an explicit index.
*
* @param indexName The name of the index to create.
* @param customConfig The configuration of the explicit index.
*/
void nodeExplicitIndexCreate( String indexName, Map<String,String> customConfig );
/**
* Creates an explicit index in a separate transaction if not yet available.
*
* @param indexName The name of the index to create.
* @param customConfig The configuration of the explicit index.
*/
void relationshipExplicitIndexCreateLazily( String indexName, Map<String,String> customConfig );
/**
* Creates an explicit index.
*
* @param indexName The name of the index to create.
* @param customConfig The configuration of the explicit index.
*/
void relationshipExplicitIndexCreate( String indexName, Map<String,String> customConfig );
}