ai.grakn.kb.internal

Class EmbeddedGraknTx<G extends org.apache.tinkerpop.gremlin.structure.Graph>

java.lang.Object

ai.grakn.kb.internal.EmbeddedGraknTx<G>

Type Parameters:

G - A vendor specific implementation of a Tinkerpop Graph.

All Implemented Interfaces:

GraknTx, GraknAdmin, AutoCloseable

Direct Known Subclasses:

GraknTxTinker

public abstract class EmbeddedGraknTx<G extends org.apache.tinkerpop.gremlin.structure.Graph>
extends Object
implements GraknAdmin

The GraknTx Base Implementation. This defines how a grakn graph sits on top of a Tinkerpop Graph. It mostly act as a construction object which ensure the resulting graph conforms to the Grakn Object model.

Author:

Grakn Warriors

Constructor Summary

Constructors

Constructor and Description
EmbeddedGraknTx(EmbeddedGraknSession session, G graph)

Method Summary

Modifier and Type	Method and Description
VertexElement	addVertexElement(Schema.BaseType baseType, ConceptId... conceptIds)
GraknAdmin	admin()
<T extends Concept> T	buildConcept(org.apache.tinkerpop.gremlin.structure.Edge edge)
<T extends Concept> T	buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex)
void	checkMutationAllowed()
void	checkSchemaMutationAllowed()
void	clearGraph()
void	close() Close the transaction without committing
void	closeSession() Closes the root session this graph stems from.
void	commit() Commits and closes the transaction without returning CommitLog
Optional<CommitLog>	commitAndGetLogs() Commits, closes transaction and returns CommitLog.
LabelId	convertToId(Label label) Converts a Type Label into a type Id for this specific graph.
boolean	duplicateResourcesExist(String index, Set<ConceptId> resourceVertexIds) Check if there are duplicate resources in the provided set of vertex IDs
ElementFactory	factory()
boolean	fixDuplicateResources(String index, Set<ConceptId> resourceVertexIds) Merges the provided duplicate resources
<V> Collection<Attribute<V>>	getAttributesByValue(V value)
<V> AttributeType<V>	getAttributeType(String label)
<T extends Concept> T	getConcept(ConceptId id)
<T extends Concept> Optional<T>	getConcept(Schema.VertexProperty key, Object value)
EntityType	getEntityType(String label)
RelationshipType	getRelationshipType(String label)
Role	getRole(String label)
Rule	getRule(String label)
<T extends SchemaConcept> T	getSchemaConcept(Label label)
<T extends SchemaConcept> T	getSchemaConcept(LabelId id)
long	getShardCount(Type concept) Returns the current number of shards the provided Type has.
G	getTinkerPopGraph()
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	getTinkerTraversal() Utility function to get a read-only Tinkerpop traversal.
<T extends Type> T	getType(Label label)
QueryBuilder	graql()
boolean	isBatchTx() A flag to check if batch loading is enabled and consistency checks are switched off
boolean	isClosed()
abstract boolean	isTinkerPopGraphClosed()
boolean	isValidElement(org.apache.tinkerpop.gremlin.structure.Element element)
abstract int	numOpenTx()
void	openTransaction(GraknTxType txType) Opens the thread bound transaction
<V> AttributeType<V>	putAttributeType(Label label, AttributeType.DataType<V> dataType)
EntityType	putEntityType(Label label)
RelationshipType	putRelationshipType(Label label)
RelationshipType	putRelationTypeImplicit(Label label)
Role	putRole(Label label)
Role	putRoleTypeImplicit(Label label)
Rule	putRule(Label label, Pattern when, Pattern then)
QueryExecutor	queryExecutor()
TxRuleCache	ruleCache()
EmbeddedGraknSession	session()
void	shard(ConceptId conceptId) Creates a new shard for the concept
long	shardingThreshold() Gets the config option which determines the number of instances a Type must have before the Type if automatically sharded.
java.util.stream.Stream<SchemaConcept>	sups(SchemaConcept schemaConcept)
TxCache	txCache()
GraknTxType	txType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.grakn.kb.admin.GraknAdmin

getMetaAttributeType, getMetaConcept, getMetaEntityType, getMetaRelationType, getMetaRole, getMetaRule

Methods inherited from interface ai.grakn.GraknTx

abort, keyspace, putAttributeType, putEntityType, putRelationshipType, putRole, putRule

Constructor Detail

EmbeddedGraknTx

public EmbeddedGraknTx(EmbeddedGraknSession session,
                       G graph)

Method Detail

session

public EmbeddedGraknSession session()

Specified by:

session in interface GraknTx

ruleCache

public TxRuleCache ruleCache()

convertToId

public LabelId convertToId(Label label)

Converts a Type Label into a type Id for this specific graph. Mapping labels to ids will differ between graphs so be sure to use the correct graph when performing the mapping.

Parameters:

label - The label to be converted to the id

Returns:

The matching type id

numOpenTx

public abstract int numOpenTx()

Returns:

The number of open transactions currently.

openTransaction

public void openTransaction(GraknTxType txType)

Opens the thread bound transaction

shardingThreshold

public long shardingThreshold()

Gets the config option which determines the number of instances a Type must have before the Type if automatically sharded.

Returns:

the number of instances a Type must have before it is shareded

txCache

public TxCache txCache()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface GraknTx

isTinkerPopGraphClosed

public abstract boolean isTinkerPopGraphClosed()

txType

public GraknTxType txType()

Specified by:

txType in interface GraknTx

admin

public GraknAdmin admin()

Specified by:

admin in interface GraknTx

buildConcept

public <T extends Concept> T buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex)

Type Parameters:

T - The type of the concept being built

Parameters:

vertex - A vertex which contains properties necessary to build a concept from.

Returns:

A concept built using the provided vertex

buildConcept

public <T extends Concept> T buildConcept(org.apache.tinkerpop.gremlin.structure.Edge edge)

Type Parameters:

T - The type of the Concept being built

Parameters:

edge - An Edge which contains properties necessary to build a Concept from.

Returns:

A Concept built using the provided Edge

isBatchTx

public boolean isBatchTx()

A flag to check if batch loading is enabled and consistency checks are switched off

Returns:

true if batch loading is enabled

getTinkerPopGraph

public G getTinkerPopGraph()

getTinkerTraversal

public org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource getTinkerTraversal()

Utility function to get a read-only Tinkerpop traversal.

Returns:

A read-only Tinkerpop traversal for manually traversing the graph

graql

public QueryBuilder graql()

Specified by:

graql in interface GraknTx

factory

public ElementFactory factory()

getConcept

public <T extends Concept> Optional<T> getConcept(Schema.VertexProperty key,
                                                  Object value)

Parameters:

key - The concept property tp search by.

value - The value of the concept

Returns:

A concept with the matching key and value

sups

public final java.util.stream.Stream<SchemaConcept> sups(SchemaConcept schemaConcept)

Specified by:

sups in interface GraknAdmin

checkSchemaMutationAllowed

public void checkSchemaMutationAllowed()

checkMutationAllowed

public void checkMutationAllowed()

addVertexElement

public VertexElement addVertexElement(Schema.BaseType baseType,
                                      ConceptId... conceptIds)

putEntityType

public EntityType putEntityType(Label label)

Specified by:

putEntityType in interface GraknTx

putRelationshipType

public RelationshipType putRelationshipType(Label label)

Specified by:

putRelationshipType in interface GraknTx

putRelationTypeImplicit

public RelationshipType putRelationTypeImplicit(Label label)

putRole

public Role putRole(Label label)

Specified by:

putRole in interface GraknTx

putRoleTypeImplicit

public Role putRoleTypeImplicit(Label label)

putAttributeType

public <V> AttributeType<V> putAttributeType(Label label,
                                             AttributeType.DataType<V> dataType)

Specified by:

putAttributeType in interface GraknTx

putRule

public Rule putRule(Label label,
                    Pattern when,
                    Pattern then)

Specified by:

putRule in interface GraknTx

getConcept

public <T extends Concept> T getConcept(ConceptId id)

Specified by:

getConcept in interface GraknTx

getSchemaConcept

@Nullable
public <T extends SchemaConcept> T getSchemaConcept(LabelId id)

getAttributesByValue

public <V> Collection<Attribute<V>> getAttributesByValue(V value)

Specified by:

getAttributesByValue in interface GraknTx

getSchemaConcept

public <T extends SchemaConcept> T getSchemaConcept(Label label)

Specified by:

getSchemaConcept in interface GraknTx

getType

public <T extends Type> T getType(Label label)

Specified by:

getType in interface GraknTx

getEntityType

public EntityType getEntityType(String label)

Specified by:

getEntityType in interface GraknTx

getRelationshipType

public RelationshipType getRelationshipType(String label)

Specified by:

getRelationshipType in interface GraknTx

getAttributeType

public <V> AttributeType<V> getAttributeType(String label)

Specified by:

getAttributeType in interface GraknTx

getRole

public Role getRole(String label)

Specified by:

getRole in interface GraknTx

getRule

public Rule getRule(String label)

Specified by:

getRule in interface GraknTx

clearGraph

public void clearGraph()

closeSession

public void closeSession()

Closes the root session this graph stems from. This will automatically rollback any pending transactions.

close

public void close()

Close the transaction without committing

Specified by:

close in interface GraknTx

Specified by:

close in interface AutoCloseable

commit

public void commit()
            throws InvalidKBException

Commits and closes the transaction without returning CommitLog

Specified by:

commit in interface GraknTx

Throws:

InvalidKBException

commitAndGetLogs

public Optional<CommitLog> commitAndGetLogs()
                                     throws InvalidKBException

Commits, closes transaction and returns CommitLog.

Returns:

the commit log that would have been submitted if it is needed.

Throws:

InvalidKBException - when the graph does not conform to the object concept

isValidElement

public boolean isValidElement(org.apache.tinkerpop.gremlin.structure.Element element)

duplicateResourcesExist

public boolean duplicateResourcesExist(String index,
                                       Set<ConceptId> resourceVertexIds)

Check if there are duplicate resources in the provided set of vertex IDs

Parameters:

index - index of the resource to find duplicates of

resourceVertexIds - vertex Ids containing potential duplicates

Returns:

true if there are duplicate resources and PostProcessing can proceed

fixDuplicateResources

public boolean fixDuplicateResources(String index,
                                     Set<ConceptId> resourceVertexIds)

Merges the provided duplicate resources

Parameters:

resourceVertexIds - The resource vertex ids which need to be merged.

Returns:

True if a commit is required.

shard

public void shard(ConceptId conceptId)

Creates a new shard for the concept

Parameters:

conceptId - the id of the concept to shard

getShardCount

public long getShardCount(Type concept)

Returns the current number of shards the provided Type has. This is used in creating more efficient query plans.

Parameters:

concept - The Type which may contain some shards.

Returns:

the number of Shards the Type currently has.

queryExecutor

public final QueryExecutor queryExecutor()

Specified by:

queryExecutor in interface GraknAdmin