ai.grakn.graph.admin

Interface GraknAdmin

All Known Implementing Classes:

AbstractGraknGraph, GraknTinkerGraph, GraknTitanGraph

public interface GraknAdmin

Admin interface for GraknGraph.

Author:

Filipe Teixeira

Method Summary

Modifier and Type	Method and Description
<T extends Concept> T	buildConcept(org.apache.tinkerpop.gremlin.structure.Vertex vertex)
void	clear(ConceptCache conceptCache) Clears the graph and empties the provided cache.
void	commit(ConceptCache conceptCache) Commits the graph and adds concepts for post processing directly to the cache bypassing the REST API.
void	commitNoLogs() Commits to the graph without submitting any commit logs.
boolean	fixDuplicateCastings(String index, Set<ConceptId> castingVertexIds) Merges the provided duplicate castings.
boolean	fixDuplicateResources(String index, Set<ConceptId> resourceVertexIds) Merges the provided duplicate resources
<T extends Concept> T	getConcept(Schema.ConceptProperty key, String value)
Type	getMetaConcept() Get the root of all Types.
EntityType	getMetaEntityType() Get the root of all the Entity Types.
RelationType	getMetaRelationType() Get the root of all Relation Types.
ResourceType	getMetaResourceType() Get the root of all the Resource Types.
RoleType	getMetaRoleType() Get the root of all the Role Types.
RuleType	getMetaRuleConstraint() Get the root of all constraint rules.
RuleType	getMetaRuleInference() Get the root of all inference rules.
RuleType	getMetaRuleType() Get the root of all Rule Types;
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<org.apache.tinkerpop.gremlin.structure.Vertex,org.apache.tinkerpop.gremlin.structure.Vertex>	getTinkerTraversal() Utility function to get a read-only Tinkerpop traversal.
boolean	isBatchLoadingEnabled() A flag to check if batch loading is enabled and consistency checks are switched off
void	updateTypeCounts(Map<TypeLabel,Long> typeCounts) Updates the counts of all the types

Method Detail

buildConcept

<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

getTinkerTraversal

org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<org.apache.tinkerpop.gremlin.structure.Vertex,org.apache.tinkerpop.gremlin.structure.Vertex> getTinkerTraversal()

Utility function to get a read-only Tinkerpop traversal.

Returns:

A read-only Tinkerpop traversal for manually traversing the graph

isBatchLoadingEnabled

boolean isBatchLoadingEnabled()

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

Returns:

true if batch loading is enabled

getMetaConcept

Type getMetaConcept()

Get the root of all Types.

Returns:

The meta type -> type.

getMetaRelationType

RelationType getMetaRelationType()

Get the root of all Relation Types.

Returns:

The meta relation type -> relation-type.

getMetaRoleType

RoleType getMetaRoleType()

Get the root of all the Role Types.

Returns:

The meta role type -> role-type.

getMetaResourceType

ResourceType getMetaResourceType()

Get the root of all the Resource Types.

Returns:

The meta resource type -> resource-type.

getMetaEntityType

EntityType getMetaEntityType()

Get the root of all the Entity Types.

Returns:

The meta entity type -> entity-type.

getMetaRuleType

RuleType getMetaRuleType()

Get the root of all Rule Types;

Returns:

The meta rule type -> rule-type.

getMetaRuleInference

RuleType getMetaRuleInference()

Get the root of all inference rules.

Returns:

The meta rule -> inference-rule.

getMetaRuleConstraint

RuleType getMetaRuleConstraint()

Get the root of all constraint rules.

Returns:

The meta rule -> constraint-rule.

commit

void commit(ConceptCache conceptCache)
     throws GraknValidationException

Commits the graph and adds concepts for post processing directly to the cache bypassing the REST API.

Parameters:

conceptCache - The concept Cache to store concepts in for processing later

Throws:

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

clear

void clear(ConceptCache conceptCache)

Clears the graph and empties the provided cache.

Parameters:

conceptCache - The concept Cache to store concepts in for processing later

commitNoLogs

void commitNoLogs()
           throws GraknValidationException

Commits to the graph without submitting any commit logs.

Throws:

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

fixDuplicateCastings

boolean fixDuplicateCastings(String index,
                             Set<ConceptId> castingVertexIds)

Merges the provided duplicate castings.

Parameters:

castingVertexIds - The vertex Ids of the duplicate castings

Returns:

if castings were merged and a commit is required.

fixDuplicateResources

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.

updateTypeCounts

void updateTypeCounts(Map<TypeLabel,Long> typeCounts)

Updates the counts of all the types

Parameters:

typeCounts - The types and the changes to put on their counts

getConcept

<T extends Concept> T getConcept(Schema.ConceptProperty key,
                                 String value)

Parameters:

key - The concept property tp search by.

value - The value of the concept

Returns:

A concept with the matching key and value