Skip to content

Gaffer Docs

Introduction

gchq/gaffer-doc

Gaffer Docs

gchq/gaffer-doc

Home
User Guide
User Guide
- Introduction
- Gaffer Basics
  Gaffer Basics
- Available APIs
  Available APIs
- Querying
  Querying
  - Gaffer Query Syntax
    Gaffer Query Syntax
    
    Operations
    
    Filtering Data
    
    FAQs
    
    Import/Export
    Import/Export
    
    Using CSV Data
  - Apache Gremlin
    Apache Gremlin
    
    Gremlin in Gaffer
    
    GafferPop Limitations
- Graph Schemas
Developer Guide
Developer Guide
- Introduction
- Ways of Working
- Remote Coding Environments
- Extending Gaffer
- Sketches Custom Deserialisation
- Project Structure
  Project Structure
  - Components
    Components
    
    Components/Maven Modules
    
    Cache
    
    Data
    
    Graph
    
    Store
    
    User
    
    Operation
    
    Serialisation
    
    Integration Tests
    
    Core REST
    
    Spring REST
    
    Accumulo Store
    
    Libraries
    Libraries
    
    Bitmap Library
    
    Flink Library
    
    Sketches Library
    
    Spark Library
    
    Time Library
  - Maven Dependencies
    Maven Dependencies
    
    Spring
- Example Deployment
  Example Deployment
Administration Guide
Administration Guide
- Introduction
- Quickstart
- Deployment
  Deployment
  - Docker
    Docker
    
    Gaffer Images
    
    How to Deploy with Accumulo on Docker
  - Kubernetes
    Kubernetes
    
    Running Gaffer on Kubernetes
    
    Creating a Simple Deployment
    
    Configuring Gaffer with Helm
  - Gremlin Connection
- Store Types
  Store Types
- Configuration
  Configuration
- Aggregation Guide
  Aggregation Guide
  - Overview
  - Ingest Example
- Named Operations
- Operation Score
- Job Tracker
- Security
  Security
Change Notes
Change Notes
- Changelist
  Changelist
  - 2.1.0 Changes
  - 2.0.0 Changes
- Migrating from V1 to V2
  Migrating from V1 to V2
Reference
Reference
- Introduction
- Glossary
- Javadoc
- Properties
  Properties
- Predicates
  Predicates
- Binary Operators
  Binary Operators
  - Binary Operators Guide
  - Koryphe Operators Guide
- Functions
  Functions
- Operations
  Operations
- Endpoints
  Endpoints
  - Endpoints Guide

Introduction

These Reference pages contain documentation for the Properties, Operations, Predicates, Functions and Binary Operators in Gaffer.

There are also reference pages for the Map, Accumulo, Proxy and Federated Gaffer stores.

Info

In general, this documentation covers the most common use cases, it doesn't cover everything. The Javadocs for Gaffer and Koryphe have more specialised information.

Last update: November 6, 2023
Created: May 18, 2023