org.neo4j.kernel.api

Class ReadStatement

java.lang.Object

org.neo4j.kernel.api.ReadStatement

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

DataStatement, SchemaStatement

public class ReadStatement
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_SUCH_LABEL
static long	NO_SUCH_PROPERTY_KEY

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
Iterator<UniquenessConstraint>	constraintsGetAll() Get all constraints.
Iterator<UniquenessConstraint>	constraintsGetForLabel(long labelId) Get all constraints applicable to label.
Iterator<UniquenessConstraint>	constraintsGetForLabelAndPropertyKey(long labelId, long propertyKeyId) Get all constraints applicable to label and propertyKey.
Iterator<SafeProperty>	graphGetAllProperties()
Property	graphGetProperty(long propertyKeyId)
Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor>	indexesGetAll() Returns all indexes.
Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor>	indexesGetForLabel(long labelId) Get all indexes for a label.
org.neo4j.kernel.impl.api.index.IndexDescriptor	indexesGetForLabelAndPropertyKey(long labelId, long propertyKey) Returns the index rule for the given labelId and propertyKey.
String	indexGetFailure(org.neo4j.kernel.impl.api.index.IndexDescriptor descriptor) Returns the failure description of a failed index.
InternalIndexState	indexGetState(org.neo4j.kernel.impl.api.index.IndexDescriptor descriptor) Retrieve the state of an index.
long	labelGetForName(String labelName) Returns a label id for a label name.
String	labelGetName(long labelId) Returns the label name for the given label id.
long	labelGetOrCreateForName(String labelName) Returns a label id for a label name.
Iterator<org.neo4j.kernel.impl.core.Token>	labelsGetAllTokens() Returns the labels currently stored in the database *
Iterator<SafeProperty>	nodeGetAllProperties(long nodeId)
org.neo4j.kernel.impl.api.PrimitiveLongIterator	nodeGetLabels(long nodeId) Returns all labels set on node with id nodeId.
Property	nodeGetProperty(long nodeId, long propertyKeyId)
boolean	nodeHasLabel(long nodeId, long labelId) Checks if a node is labeled with a certain label or not.
org.neo4j.kernel.impl.api.PrimitiveLongIterator	nodesGetForLabel(long labelId)
org.neo4j.kernel.impl.api.PrimitiveLongIterator	nodesGetFromIndexLookup(org.neo4j.kernel.impl.api.index.IndexDescriptor index, Object value) Returns an iterable with the matched nodes.
long	propertyKeyGetForName(String propertyKeyName) Returns a property key id for the given property key.
String	propertyKeyGetName(long propertyKeyId) Returns the name of a property given its property key id
long	propertyKeyGetOrCreateForName(String propertyKeyName) Returns a property key id for a property key.
Iterator<SafeProperty>	relationshipGetAllProperties(long relationshipId)
Property	relationshipGetProperty(long relationshipId, long propertyKeyId)
long	relationshipTypeGetForName(String relationshipTypeName)
String	relationshipTypeGetName(long relationshipTypeId)
long	relationshipTypeGetOrCreateForName(String relationshipTypeName)
<K,V> V	schemaStateGetOrCreate(K key, Function<K,V> creator)
Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor>	uniqueIndexesGetAll() Returns all constraint indexes.
Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor>	uniqueIndexesGetForLabel(long labelId) Get all constraint indexes for a label.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_SUCH_LABEL

public static final long NO_SUCH_LABEL

See Also:

Constant Field Values

NO_SUCH_PROPERTY_KEY

public static final long NO_SUCH_PROPERTY_KEY

See Also:

Constant Field Values

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

nodesGetForLabel

public org.neo4j.kernel.impl.api.PrimitiveLongIterator nodesGetForLabel(long labelId)

Parameters:

labelId - the label id of the label that returned nodes are guaranteed to have

Returns:

ids of all nodes that have the given label

nodesGetFromIndexLookup

public org.neo4j.kernel.impl.api.PrimitiveLongIterator nodesGetFromIndexLookup(org.neo4j.kernel.impl.api.index.IndexDescriptor index,
                                                                      Object value)
                                                                        throws IndexNotFoundKernelException

Returns an iterable with the matched nodes.

Throws:

IndexNotFoundKernelException - if no such index found.

nodeHasLabel

public boolean nodeHasLabel(long nodeId,
                   long labelId)
                     throws EntityNotFoundException

Checks if a node is labeled with a certain label or not. Returns true if the node is labeled with the label, otherwise false.

Throws:

EntityNotFoundException

nodeGetLabels

public org.neo4j.kernel.impl.api.PrimitiveLongIterator nodeGetLabels(long nodeId)
                                                              throws EntityNotFoundException

Returns all labels set on node with id nodeId. If the node has no labels an empty Iterable will be returned.

Throws:

EntityNotFoundException

nodeGetProperty

public Property nodeGetProperty(long nodeId,
                       long propertyKeyId)
                         throws EntityNotFoundException

Throws:

EntityNotFoundException

relationshipGetProperty

public Property relationshipGetProperty(long relationshipId,
                               long propertyKeyId)
                                 throws EntityNotFoundException

Throws:

EntityNotFoundException

graphGetProperty

public Property graphGetProperty(long propertyKeyId)

nodeGetAllProperties

public Iterator<SafeProperty> nodeGetAllProperties(long nodeId)
                                            throws EntityNotFoundException

Throws:

EntityNotFoundException

relationshipGetAllProperties

public Iterator<SafeProperty> relationshipGetAllProperties(long relationshipId)
                                                    throws EntityNotFoundException

Throws:

EntityNotFoundException

graphGetAllProperties

public Iterator<SafeProperty> graphGetAllProperties()

indexesGetForLabelAndPropertyKey

public org.neo4j.kernel.impl.api.index.IndexDescriptor indexesGetForLabelAndPropertyKey(long labelId,
                                                                               long propertyKey)
                                                                                 throws SchemaRuleNotFoundException

Returns the index rule for the given labelId and propertyKey.

Throws:

SchemaRuleNotFoundException

indexesGetForLabel

public Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor> indexesGetForLabel(long labelId)

Get all indexes for a label.

indexesGetAll

public Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor> indexesGetAll()

Returns all indexes.

uniqueIndexesGetForLabel

public Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor> uniqueIndexesGetForLabel(long labelId)

Get all constraint indexes for a label.

uniqueIndexesGetAll

public Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor> uniqueIndexesGetAll()

Returns all constraint indexes.

indexGetState

public InternalIndexState indexGetState(org.neo4j.kernel.impl.api.index.IndexDescriptor descriptor)
                                 throws IndexNotFoundKernelException

Retrieve the state of an index.

Throws:

IndexNotFoundKernelException

indexGetFailure

public String indexGetFailure(org.neo4j.kernel.impl.api.index.IndexDescriptor descriptor)
                       throws IndexNotFoundKernelException

Returns the failure description of a failed index.

Throws:

IndexNotFoundKernelException

constraintsGetForLabelAndPropertyKey

public Iterator<UniquenessConstraint> constraintsGetForLabelAndPropertyKey(long labelId,
                                                                  long propertyKeyId)

Get all constraints applicable to label and propertyKey. There are only UniquenessConstraint for the time being.

constraintsGetForLabel

public Iterator<UniquenessConstraint> constraintsGetForLabel(long labelId)

Get all constraints applicable to label. There are only UniquenessConstraint for the time being.

constraintsGetAll

public Iterator<UniquenessConstraint> constraintsGetAll()

Get all constraints. There are only UniquenessConstraint for the time being.

labelGetForName

public long labelGetForName(String labelName)

Returns a label id for a label name. If the label doesn't exist, NO_SUCH_LABEL will be returned.

labelGetName

public String labelGetName(long labelId)
                    throws LabelNotFoundKernelException

Returns the label name for the given label id.

Throws:

LabelNotFoundKernelException

propertyKeyGetForName

public long propertyKeyGetForName(String propertyKeyName)

Returns a property key id for the given property key. If the property key doesn't exist, NO_SUCH_PROPERTY_KEY will be returned.

propertyKeyGetName

public String propertyKeyGetName(long propertyKeyId)
                          throws PropertyKeyIdNotFoundKernelException

Returns the name of a property given its property key id

Throws:

PropertyKeyIdNotFoundKernelException

labelsGetAllTokens

public Iterator<org.neo4j.kernel.impl.core.Token> labelsGetAllTokens()

Returns the labels currently stored in the database *

relationshipTypeGetForName

public long relationshipTypeGetForName(String relationshipTypeName)

relationshipTypeGetName

public String relationshipTypeGetName(long relationshipTypeId)
                               throws RelationshipTypeIdNotFoundKernelException

Throws:

RelationshipTypeIdNotFoundKernelException

labelGetOrCreateForName

public long labelGetOrCreateForName(String labelName)
                             throws IllegalTokenNameException,
                                    TooManyLabelsException

Returns a label id for a label name. If the label doesn't exist prior to this call it gets created.

Throws:

IllegalTokenNameException

TooManyLabelsException

propertyKeyGetOrCreateForName

public long propertyKeyGetOrCreateForName(String propertyKeyName)
                                   throws IllegalTokenNameException

Returns a property key id for a property key. If the key doesn't exist prior to this call it gets created.

Throws:

IllegalTokenNameException

relationshipTypeGetOrCreateForName

public long relationshipTypeGetOrCreateForName(String relationshipTypeName)
                                        throws IllegalTokenNameException

Throws:

IllegalTokenNameException

schemaStateGetOrCreate

public <K,V> V schemaStateGetOrCreate(K key,
                             Function<K,V> creator)