-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
SchemaRead.java
61 lines (55 loc) · 2.22 KB
/
SchemaRead.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
/*
* Copyright (c) 2002-2018 "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.Iterator;
import org.neo4j.internal.kernel.api.schema.SchemaDescriptor;
import org.neo4j.internal.kernel.api.schema.constraints.ConstraintDescriptor;
/**
* Surface for getting schema information, such as fetching specific indexes or constraints.
*/
public interface SchemaRead
{
/**
* Acquire a reference to the index mapping the given {@code label} and {@code properties}.
*
* @param label the index label
* @param properties the index properties
* @return the IndexReference, or {@link CapableIndexReference#NO_INDEX} if such an index does not exist.
*/
CapableIndexReference index( int label, int... properties );
/**
* Finds all constraints for the given schema
* @param descriptor The descriptor of the schema
* @return All constraints for the given schema
*/
Iterator<ConstraintDescriptor> constraintsGetForSchema( SchemaDescriptor descriptor );
/**
* Checks if a constraint exists
* @param descriptor The descriptor of the constraint to check.
* @return <tt>true</tt> if the constraint exists, otherwise <tt>false</tt>
*/
boolean constraintExists( ConstraintDescriptor descriptor );
/**
* Finds all constraints for the given label
* @param labelId The id of the label
* @return All constraints for the given label
*/
Iterator<ConstraintDescriptor> constraintsGetForLabel( int labelId );
}