Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2002-2016 "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 .
*/
package org.neo4j.kernel.api;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import org.neo4j.collection.RawIterator;
import org.neo4j.collection.primitive.PrimitiveIntIterator;
import org.neo4j.collection.primitive.PrimitiveLongIterator;
import org.neo4j.cursor.Cursor;
import org.neo4j.graphdb.Direction;
import org.neo4j.kernel.api.constraints.NodePropertyConstraint;
import org.neo4j.kernel.api.constraints.PropertyConstraint;
import org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint;
import org.neo4j.kernel.api.exceptions.EntityNotFoundException;
import org.neo4j.kernel.api.exceptions.LabelNotFoundKernelException;
import org.neo4j.kernel.api.exceptions.ProcedureException;
import org.neo4j.kernel.api.exceptions.PropertyKeyIdNotFoundKernelException;
import org.neo4j.kernel.api.exceptions.RelationshipTypeIdNotFoundKernelException;
import org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException;
import org.neo4j.kernel.api.exceptions.legacyindex.LegacyIndexNotFoundKernelException;
import org.neo4j.kernel.api.exceptions.schema.DuplicateIndexSchemaRuleException;
import org.neo4j.kernel.api.exceptions.schema.IndexBrokenKernelException;
import org.neo4j.kernel.api.exceptions.schema.SchemaRuleNotFoundException;
import org.neo4j.kernel.api.index.IndexDescriptor;
import org.neo4j.kernel.api.index.InternalIndexState;
import org.neo4j.kernel.api.proc.CallableProcedure;
import org.neo4j.kernel.api.proc.ProcedureSignature;
import org.neo4j.kernel.impl.api.RelationshipVisitor;
import org.neo4j.kernel.impl.api.store.RelationshipIterator;
import org.neo4j.register.Register.DoubleLongRegister;
import org.neo4j.storageengine.api.NodeItem;
import org.neo4j.storageengine.api.RelationshipItem;
import org.neo4j.storageengine.api.Token;
import org.neo4j.storageengine.api.lock.ResourceType;
import org.neo4j.storageengine.api.schema.PopulationProgress;
/**
* Defines all types of read operations that can be done from the {@link KernelAPI}.
*/
public interface ReadOperations
{
int ANY_LABEL = -1;
int ANY_RELATIONSHIP_TYPE = -1;
int NO_SUCH_LABEL = -1;
int NO_SUCH_PROPERTY_KEY = -1;
//===========================================
//== TOKEN OPERATIONS =======================
//===========================================
/** Returns a label id for a label name. If the label doesn't exist, {@link #NO_SUCH_LABEL} will be returned. */
int labelGetForName( String labelName );
/** Returns the label name for the given label id. */
String labelGetName( int labelId ) throws LabelNotFoundKernelException;
/** Returns the labels currently stored in the database * */
Iterator labelsGetAllTokens(); // TODO: Token is a store level concern, should not make it this far up the stack
/**
* Returns a property key id for the given property key. If the property key doesn't exist,
* {@link StatementConstants#NO_SUCH_PROPERTY_KEY} will be returned.
*/
int propertyKeyGetForName( String propertyKeyName );
/** Returns the name of a property given its property key id */
String propertyKeyGetName( int propertyKeyId ) throws PropertyKeyIdNotFoundKernelException;
/** Returns the property keys currently stored in the database */
Iterator propertyKeyGetAllTokens();
int relationshipTypeGetForName( String relationshipTypeName );
String relationshipTypeGetName( int relationshipTypeId ) throws RelationshipTypeIdNotFoundKernelException;
/** Returns the relationship types currently stored in the database */
Iterator relationshipTypesGetAllTokens();
int labelCount();
int propertyKeyCount();
int relationshipTypeCount();
//===========================================
//== DATA OPERATIONS ========================
//===========================================
/**
* @param labelId the label id of the label that returned nodes are guaranteed to have
* @return ids of all nodes that have the given label
*/
PrimitiveLongIterator nodesGetForLabel( int labelId );
/**
* Returns an iterator with the matched nodes.
*
* @throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException if no such index found.
*/
PrimitiveLongIterator nodesGetFromIndexSeek( IndexDescriptor index, Object value )
throws IndexNotFoundKernelException;
/**
* Returns an iterator with the matched nodes.
*
* @throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException if no such index found.
*/
PrimitiveLongIterator nodesGetFromIndexRangeSeekByPrefix( IndexDescriptor index, String prefix )
throws IndexNotFoundKernelException;
/**
* Returns an iterator with the matched nodes.
*
* @throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException if no such index found.
*/
PrimitiveLongIterator nodesGetFromIndexRangeSeekByNumber( IndexDescriptor index, Number lower, boolean includeLower, Number upper, boolean includeUpper )
throws IndexNotFoundKernelException;
/**
* Returns an iterator with the matched nodes.
*
* @throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException if no such index found.
*/
PrimitiveLongIterator nodesGetFromIndexRangeSeekByString( IndexDescriptor index, String lower, boolean includeLower, String upper, boolean includeUpper )
throws IndexNotFoundKernelException;
/**
* Returns an iterator with the matched nodes.
*
* @throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException if no such index found.
*/
PrimitiveLongIterator nodesGetFromIndexScan( IndexDescriptor index )
throws IndexNotFoundKernelException;
/**
* Returns an iterator with the matched nodes.
*
* @throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException if no such index found.
*/
PrimitiveLongIterator nodesGetFromIndexContainsScan( IndexDescriptor index, String term )
throws IndexNotFoundKernelException;
/**
* @return an iterator over all nodes in the database.
*/
PrimitiveLongIterator nodesGetAll();
/**
* @return an iterator over all relationships in the database.
*/
PrimitiveLongIterator relationshipsGetAll();
RelationshipIterator nodeGetRelationships( long nodeId,
Direction direction,
int... relTypes ) throws EntityNotFoundException;
RelationshipIterator nodeGetRelationships( long nodeId, Direction direction ) throws EntityNotFoundException;
/**
* Returns node id of unique node found in the given unique index for value or
* {@link StatementConstants#NO_SUCH_NODE} if the index does not contain a
* matching node.
*
* If a node is found, a READ lock for the index entry will be held. If no node
* is found (if {@link StatementConstants#NO_SUCH_NODE} was returned), a WRITE
* lock for the index entry will be held. This is to facilitate unique creation
* of nodes, to build get-or-create semantics on top of this method.
*
* @throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException if no such index found.
*/
long nodeGetFromUniqueIndexSeek( IndexDescriptor index, Object value ) throws IndexNotFoundKernelException,
IndexBrokenKernelException;
long nodesCountIndexed( IndexDescriptor index, long nodeId, Object value )
throws IndexNotFoundKernelException, IndexBrokenKernelException;
boolean nodeExists( long nodeId );
boolean relationshipExists( long relId );
/**
* Checks if a node is labeled with a certain label or not. Returns
* {@code true} if the node is labeled with the label, otherwise {@code false.}
*/
boolean nodeHasLabel( long nodeId, int labelId ) throws EntityNotFoundException;
int nodeGetDegree( long nodeId, Direction direction, int relType ) throws EntityNotFoundException;
int nodeGetDegree( long nodeId, Direction direction ) throws EntityNotFoundException;
boolean nodeIsDense(long nodeId) throws EntityNotFoundException;
/**
* Returns all labels set on node with id {@code nodeId}.
* If the node has no labels an empty {@link Iterable} will be returned.
*/
PrimitiveIntIterator nodeGetLabels( long nodeId ) throws EntityNotFoundException;
PrimitiveIntIterator nodeGetPropertyKeys( long nodeId ) throws EntityNotFoundException;
PrimitiveIntIterator relationshipGetPropertyKeys( long relationshipId ) throws EntityNotFoundException;
PrimitiveIntIterator graphGetPropertyKeys();
PrimitiveIntIterator nodeGetRelationshipTypes( long nodeId ) throws EntityNotFoundException;
boolean nodeHasProperty( long nodeId, int propertyKeyId ) throws EntityNotFoundException;
Object nodeGetProperty( long nodeId, int propertyKeyId ) throws EntityNotFoundException;
boolean relationshipHasProperty( long relationshipId, int propertyKeyId ) throws EntityNotFoundException;
Object relationshipGetProperty( long relationshipId, int propertyKeyId ) throws EntityNotFoundException;
boolean graphHasProperty( int propertyKeyId );
Object graphGetProperty( int propertyKeyId );
void relationshipVisit( long relId, RelationshipVisitor visitor )
throws EntityNotFoundException, EXCEPTION;
long nodesGetCount();
long relationshipsGetCount();
//===========================================
//== CURSOR ACCESS OPERATIONS ===============
//===========================================
Cursor nodeCursor( long nodeId );
Cursor relationshipCursor( long relId );
Cursor nodeCursorGetAll();
Cursor relationshipCursorGetAll();
Cursor nodeCursorGetForLabel( int labelId );
Cursor nodeCursorGetFromIndexSeek( IndexDescriptor index, Object value )
throws IndexNotFoundKernelException;
Cursor nodeCursorGetFromIndexRangeSeekByNumber( IndexDescriptor index, Number lower, boolean includeLower, Number upper, boolean includeUpper )
throws IndexNotFoundKernelException;
Cursor nodeCursorGetFromIndexRangeSeekByString( IndexDescriptor index, String lower, boolean includeLower, String upper, boolean includeUpper )
throws IndexNotFoundKernelException;
Cursor nodeCursorGetFromIndexRangeSeekByPrefix( IndexDescriptor index, String prefix )
throws IndexNotFoundKernelException;
Cursor nodeCursorGetFromIndexScan( IndexDescriptor index )
throws IndexNotFoundKernelException;
Cursor nodeCursorGetFromUniqueIndexSeek( IndexDescriptor index, Object value )
throws IndexNotFoundKernelException, IndexBrokenKernelException;
//===========================================
//== SCHEMA OPERATIONS ======================
//===========================================
/** Returns the index rule for the given labelId and propertyKey. */
IndexDescriptor indexGetForLabelAndPropertyKey( int labelId, int propertyKey )
throws SchemaRuleNotFoundException;
/** Get all indexes for a label. */
Iterator indexesGetForLabel( int labelId );
/** Returns all indexes. */
Iterator indexesGetAll();
/** Returns the constraint index for the given labelId and propertyKey. */
IndexDescriptor uniqueIndexGetForLabelAndPropertyKey( int labelId, int propertyKeyId )
throws SchemaRuleNotFoundException, DuplicateIndexSchemaRuleException;
/** Get all constraint indexes for a label. */
Iterator uniqueIndexesGetForLabel( int labelId );
/** Returns all constraint indexes. */
Iterator uniqueIndexesGetAll();
/** Retrieve the state of an index. */
InternalIndexState indexGetState( IndexDescriptor descriptor ) throws IndexNotFoundKernelException;
/** Retrieve the population progress of an index. */
PopulationProgress indexGetPopulationProgress( IndexDescriptor descriptor ) throws IndexNotFoundKernelException;
/** Get the index size. */
long indexSize( IndexDescriptor descriptor ) throws IndexNotFoundKernelException;
/** Calculate the index unique values percentage (range: {@code 0.0} exclusive to {@code 1.0} inclusive). */
double indexUniqueValuesSelectivity( IndexDescriptor descriptor ) throws IndexNotFoundKernelException;
/** Returns the failure description of a failed index. */
String indexGetFailure( IndexDescriptor descriptor ) throws IndexNotFoundKernelException;
/**
* Get all constraints applicable to label and propertyKey. There are only {@link NodePropertyConstraint}
* for the time being.
*/
Iterator constraintsGetForLabelAndPropertyKey( int labelId, int propertyKeyId );
/**
* Get all constraints applicable to label. There are only {@link NodePropertyConstraint}
* for the time being.
*/
Iterator constraintsGetForLabel( int labelId );
/**
* Get all constraints applicable to relationship type. There are only {@link RelationshipPropertyConstraint}
* for the time being.
*/
Iterator constraintsGetForRelationshipType( int typeId );
/**
* Get all constraints applicable to relationship type and propertyKey.
* There are only {@link RelationshipPropertyConstraint} for the time being.
*/
Iterator constraintsGetForRelationshipTypeAndPropertyKey( int typeId, int propertyKeyId );
/**
* Get all constraints. There are only {@link PropertyConstraint}
* for the time being.
*/
Iterator constraintsGetAll();
/**
* Get the owning constraint for a constraint index. Returns null if the index does not have an owning constraint.
*/
Long indexGetOwningUniquenessConstraintId( IndexDescriptor index ) throws SchemaRuleNotFoundException;
V schemaStateGetOrCreate( K key, Function creator );
void schemaStateFlush();
//===========================================
//== LOCKING OPERATIONS =====================
//===========================================
void acquireExclusive( ResourceType type, long id );
void acquireShared( ResourceType type, long id );
void releaseExclusive( ResourceType type, long id );
void releaseShared( ResourceType type, long id );
//===========================================
//== LEGACY INDEX OPERATIONS ================
//===========================================
Map nodeLegacyIndexGetConfiguration( String indexName )
throws LegacyIndexNotFoundKernelException;
Map relationshipLegacyIndexGetConfiguration( String indexName )
throws LegacyIndexNotFoundKernelException;
LegacyIndexHits nodeLegacyIndexGet( String indexName, String key, Object value )
throws LegacyIndexNotFoundKernelException;
LegacyIndexHits nodeLegacyIndexQuery( String indexName, String key, Object queryOrQueryObject )
throws LegacyIndexNotFoundKernelException;
LegacyIndexHits nodeLegacyIndexQuery( String indexName, Object queryOrQueryObject )
throws LegacyIndexNotFoundKernelException;
/**
* @param startNode -1 if ignored.
* @param endNode -1 if ignored.
*/
LegacyIndexHits relationshipLegacyIndexGet( String name, String key, Object valueOrNull, long startNode,
long endNode ) throws LegacyIndexNotFoundKernelException;
/**
* @param startNode -1 if ignored.
* @param endNode -1 if ignored.
*/
LegacyIndexHits relationshipLegacyIndexQuery( String indexName, String key, Object queryOrQueryObject,
long startNode, long endNode )
throws LegacyIndexNotFoundKernelException;
/**
* @param startNode -1 if ignored.
* @param endNode -1 if ignored.
*/
LegacyIndexHits relationshipLegacyIndexQuery( String indexName, Object queryOrQueryObject,
long startNode, long endNode )
throws LegacyIndexNotFoundKernelException;
String[] nodeLegacyIndexesGetAll();
String[] relationshipLegacyIndexesGetAll();
//===========================================
//== COUNTS OPERATIONS ======================
//===========================================
/**
* The number of nodes in the graph, including anything changed in the transaction state.
*
* If the label parameter is {@link #ANY_LABEL}, this method returns the total number of nodes in the graph, i.e.
* {@code MATCH (n) RETURN count(n)}.
*
* If the label parameter is set to any other value, this method returns the number of nodes that has that label,
* i.e. {@code MATCH (n:LBL) RETURN count(n)}.
*
* @param labelId the label to get the count for, or {@link #ANY_LABEL} to get the total number of nodes.
* @return the number of matching nodes in the graph.
*/
long countsForNode( int labelId );
/**
* The number of nodes in the graph, without taking into account anything in the transaction state.
*
* If the label parameter is {@link #ANY_LABEL}, this method returns the total number of nodes in the graph, i.e.
* {@code MATCH (n) RETURN count(n)}.
*
* If the label parameter is set to any other value, this method returns the number of nodes that has that label,
* i.e. {@code MATCH (n:LBL) RETURN count(n)}.
*
* @param labelId the label to get the count for, or {@link #ANY_LABEL} to get the total number of nodes.
* @return the number of matching nodes in the graph.
*/
long countsForNodeWithoutTxState( int labelId );
/**
* The number of relationships in the graph, including anything changed in the transaction state.
*
* Returns the number of relationships in the graph that matches the specified pattern,
* {@code (:startLabelId)-[:typeId]->(:endLabelId)}, like so:
*
*
*
*
{@code startLabelId}
{@code typeId}
{@code endLabelId}
*
Pattern
*
*
*
*
{@link #ANY_LABEL}
{@link #ANY_RELATIONSHIP_TYPE}
{@link #ANY_LABEL}
*
{@code MATCH}
{@code ()-[r]->()}
{@code RETURN count(r)}
*
*
*
{@link #ANY_LABEL}
{@code REL}
{@link #ANY_LABEL}
*
{@code MATCH}
{@code ()-[r:REL]->()}
{@code RETURN count(r)}
*
*
*
{@code LHS}
{@link #ANY_RELATIONSHIP_TYPE}
{@link #ANY_LABEL}
*
{@code MATCH}
{@code (:LHS)-[r]->()}
{@code RETURN count(r)}
*
*
*
{@link #ANY_LABEL}
{@link #ANY_RELATIONSHIP_TYPE}
{@code RHS}
*
{@code MATCH}
{@code ()-[r]->(:RHS)}
{@code RETURN count(r)}
*
*
*
{@code LHS}
{@code REL}
{@link #ANY_LABEL}
*
{@code MATCH}
{@code (:LHS)-[r:REL]->()}
{@code RETURN count(r)}
*
*
*
{@link #ANY_LABEL}
{@code REL}
{@code RHS}
*
{@code MATCH}
{@code ()-[r:REL]->(:RHS)}
{@code RETURN count(r)}
*
*
*
{@code LHS}
{@link #ANY_RELATIONSHIP_TYPE}
{@code RHS}
*
{@code MATCH}
{@code (:LHS)-[r]->(:RHS)}
{@code RETURN count(r)}
*
*
*
{@code LHS}
{@code REL}
{@code RHS}
*
{@code MATCH}
{@code (:LHS)-[r:REL]->(:RHS)}
{@code RETURN count(r)}
*
*
*
*
* @param startLabelId the label of the start node of relationships to get the count for, or {@link #ANY_LABEL}.
* @param typeId the type of relationships to get a count for, or {@link #ANY_RELATIONSHIP_TYPE}.
* @param endLabelId the label of the end node of relationships to get the count for, or {@link #ANY_LABEL}.
* @return the number of matching relationships in the graph.
*/
long countsForRelationship( int startLabelId, int typeId, int endLabelId );
/**
* The number of relationships in the graph, without taking into account anything in the transaction state.
*
* Returns the number of relationships in the graph that matches the specified pattern,
* {@code (:startLabelId)-[:typeId]->(:endLabelId)}, like so:
*
*
*
*
{@code startLabelId}
{@code typeId}
{@code endLabelId}
*
Pattern
*
*
*
*
{@link #ANY_LABEL}
{@link #ANY_RELATIONSHIP_TYPE}
{@link #ANY_LABEL}
*
{@code MATCH}
{@code ()-[r]->()}
{@code RETURN count(r)}
*
*
*
{@link #ANY_LABEL}
{@code REL}
{@link #ANY_LABEL}
*
{@code MATCH}
{@code ()-[r:REL]->()}
{@code RETURN count(r)}
*
*
*
{@code LHS}
{@link #ANY_RELATIONSHIP_TYPE}
{@link #ANY_LABEL}
*
{@code MATCH}
{@code (:LHS)-[r]->()}
{@code RETURN count(r)}
*
*
*
{@link #ANY_LABEL}
{@link #ANY_RELATIONSHIP_TYPE}
{@code RHS}
*
{@code MATCH}
{@code ()-[r]->(:RHS)}
{@code RETURN count(r)}
*
*
*
{@code LHS}
{@code REL}
{@link #ANY_LABEL}
*
{@code MATCH}
{@code (:LHS)-[r:REL]->()}
{@code RETURN count(r)}
*
*
*
{@link #ANY_LABEL}
{@code REL}
{@code RHS}
*
{@code MATCH}
{@code ()-[r:REL]->(:RHS)}
{@code RETURN count(r)}
*
*
*
{@code LHS}
{@link #ANY_RELATIONSHIP_TYPE}
{@code RHS}
*
{@code MATCH}
{@code (:LHS)-[r]->(:RHS)}
{@code RETURN count(r)}
*
*
*
{@code LHS}
{@code REL}
{@code RHS}
*
{@code MATCH}
{@code (:LHS)-[r:REL]->(:RHS)}
{@code RETURN count(r)}
*
*
*
*
* @param startLabelId the label of the start node of relationships to get the count for, or {@link #ANY_LABEL}.
* @param typeId the type of relationships to get a count for, or {@link #ANY_RELATIONSHIP_TYPE}.
* @param endLabelId the label of the end node of relationships to get the count for, or {@link #ANY_LABEL}.
* @return the number of matching relationships in the graph.
*/
long countsForRelationshipWithoutTxState( int startLabelId, int typeId, int endLabelId );
DoubleLongRegister indexUpdatesAndSize( IndexDescriptor index, DoubleLongRegister target )
throws IndexNotFoundKernelException;
DoubleLongRegister indexSample( IndexDescriptor index, DoubleLongRegister target )
throws IndexNotFoundKernelException;
//===========================================
//== PROCEDURE OPERATIONS ===================
//===========================================
/** For managed procedures, this gives access to the current statement. */
CallableProcedure.Key statement = CallableProcedure.Key.key("statement", Statement.class );
/** Fetch a procedure given its signature. */
ProcedureSignature procedureGet( ProcedureSignature.ProcedureName name ) throws ProcedureException;
/** Fetch all registered procedures */
Set proceduresGetAll();
/** Invoke a read-only procedure by name */
RawIterator procedureCallRead( ProcedureSignature.ProcedureName name, Object[] input ) throws ProcedureException;
}
