User Guide

Welcome to the Gaffer user guide. The pages under this section are intended to help a user of Gaffer understand the core concepts and quickly get started querying a currently deployed graph.

The Basics

If you are brand new to Gaffer and graph databases in general, the Gaffer basics pages contain useful information to give an overview and foundation.

• What is Graph?
• What is Gaffer?

Available APIs

Gaffer comes with a few different APIs, the pages in the user guide give an introduction to these APIs and how to use them to query a graph. Also included is an introduction to some of the core languages used for the APIs.

• What is JSON?
• What is Python?
• REST API
• Python API (gafferpy)
• Java API

Graph Querying

To query a graph Gaffer uses a custom querying format based around isolated functions called Operations. This user guide gives an introduction to this format and provides examples to help users formulate their own.

• Gaffer Operations Introduction
• Applying Filters to Queries