Skip to content

Operations Guide

These pages contain examples of most operations in Gaffer. The examples are given in Java, JSON and Python.

Table of all Operations

Note

Some Operations below are missing a link because they have not been documented on this site yet. Details may be found in the Javadoc.

Operation Type
operation.impl.add.AddElements Core
operation.impl.get.GetAdjacentIds Get
operation.impl.get.GetAllElements Get
operation.impl.get.GetElements Get
operation.impl.get.GetFromEndpoint Get
operation.impl.GetWalks Get
operation.impl.Count Core
operation.impl.CountGroups Core
operation.impl.DiscardOutput Core
operation.impl.join.Join Core
operation.impl.compare.Min Core
operation.impl.compare.Max Core
operation.impl.compare.Sort Core
operation.impl.function.Aggregate Core
operation.impl.function.Filter Core
operation.impl.function.Transform Core
operation.impl.GetVariable Core
operation.impl.GetVariables Core
operation.impl.Limit Core
operation.impl.Map Core
operation.impl.Reduce Core
operation.impl.SampleElementsForSplitPoints Core
operation.impl.SetVariable Core
operation.impl.SplitStoreFromFile Core
operation.impl.SplitStoreFromIterable Core
operation.impl.Validate Core
operation.impl.If Flow
operation.impl.ForEach Flow
operation.impl.While Flow
operation.impl.output.ToArray Output
operation.impl.output.ToCsv Output
operation.impl.output.ToEntitySeeds Output
operation.impl.output.ToList Output
operation.impl.output.ToMap Output
operation.impl.output.ToSet Output
operation.impl.output.ToSingletonList Output
operation.impl.output.ToStream Output
operation.impl.output.ToVertices Output
operation.OperationChain Chain
operation.OperationChainDAO Chain
operation.impl.ScoreOperationChain Chain
operation.impl.ValidateOperationChain Chain
operation.impl.add.ImportCsv Import
operation.export.graph.ExportToOtherAuthorisedGraph Export
operation.export.graph.ExportToOtherGraph Export
operation.impl.export.GetExports Export
operation.impl.export.localfile.ExportToLocalFile Export
operation.impl.export.localfile.ImportFromLocalFile Export
operation.impl.export.resultcache.ExportToGafferResultCache Export
operation.impl.export.resultcache.GetGafferResultCacheExport Export
operation.impl.export.set.ExportToSet Export
operation.impl.export.set.GetSetExport Export
operation.impl.job.CancelScheduledJob Job
operation.impl.job.GetAllJobDetails Job
operation.impl.job.GetJobDetails Job
operation.impl.job.GetJobResults Job
operation.impl.add.AddElementsFromFile Flink
operation.impl.add.AddElementsFromKafka Flink
operation.impl.add.AddElementsFromSocket Flink
operation.impl.generate.GenerateElements Generate
operation.impl.generate.GenerateObjects Generate
operation.impl.GenerateSplitPointsFromSample Generate
named.operation.AddNamedOperation Named
named.operation.DeleteNamedOperation Named
named.operation.GetAllNamedOperations Named
named.operation.NamedOperation Named
named.view.AddNamedView Named
named.view.DeleteNamedView Named
named.view.GetAllNamedViews Named
store.operation.DeleteAllData Store
store.operation.GetSchema Store
store.operation.GetTraits Store
store.operation.HasTrait Store
store.operation.add.AddSchemaToLibrary Store
store.operation.add.AddStorePropertiesToLibrary Store
federatedstore.operation.AddGraph Federated
federatedstore.operation.AddGraphWithHooks Federated
federatedstore.operation.ChangeGraphAccess Federated
federatedstore.operation.ChangeGraphId Federated
federatedstore.operation.FederatedOperation Federated
federatedstore.operation.GetAllGraphIds Federated
federatedstore.operation.GetAllGraphInfo Federated
federatedstore.operation.RemoveGraph Federated
federatedstore.operation.RemoveGraphAndDeleteAllData Federated
proxystore.operation.GetProxyProperties Proxy
proxystore.operation.GetProxyUrl Proxy
accumulostore.operation.hdfs.operation.ImportAccumuloKeyValueFiles Accumulo
accumulostore.operation.impl.GetElementsBetweenSets Accumulo
accumulostore.operation.impl.GetElementsBetweenSetsPairs Accumulo
accumulostore.operation.impl.GetElementsInRanges Accumulo
accumulostore.operation.impl.GetElementsWithinSet Accumulo
accumulostore.operation.impl.SummariseGroupOverRanges Accumulo
hdfs.operation.AddElementsFromHdfs HDFS
hdfs.operation.SampleDataForSplitPoints HDFS
mapstore.operation.CountAllElementsDefaultView Map
spark.operation.dataframe.GetDataFrameOfElements Spark
spark.operation.graphframe.GetGraphFrameOfElements Spark
spark.operation.javardd.GetJavaRDDOfAllElements Spark
spark.operation.javardd.GetJavaRDDOfElements Spark
spark.operation.javardd.ImportJavaRDDOfElements Spark
spark.operation.javardd.SplitStoreFromJavaRDDOfElements Spark
spark.operation.scalardd.GetRDDOfAllElements Spark
spark.operation.scalardd.GetRDDOfElements Spark
spark.operation.scalardd.ImportRDDOfElements Spark
spark.operation.scalardd.SplitStoreFromRDDOfElements Spark
sparkaccumulo.operation.javardd.GetJavaRDDOfElementsInRanges Spark
sparkaccumulo.operation.javardd.ImportKeyValueJavaPairRDDToAccumulo Spark
sparkaccumulo.operation.scalardd.GetRDDOfElementsInRanges Spark
sparkaccumulo.operation.scalardd.ImportKeyValuePairRDDToAccumulo Spark

Last update: October 10, 2023
Created: May 18, 2023