subjects-rw-neo4j

README

Subjects Reader/Writer for Neo4j (subjects-rw-neo4j)

An API for reading/writing subjects into Neo4j. Expects the subjects json supplied to be in the format that comes out of the subjects transformer.

Installation

For the first time:

go get github.com/Financial-Times/subjects-rw-neo4j

or update:

go get -u github.com/Financial-Times/subjects-rw-neo4j

Running

export|set PORT=8080
export|set NEO_URL={neo4jUrl}
export|set BATCH_SIZE=50
export|set GRAPHITE_TCP_ADDRESS=graphite.ft.com:2003
export|set GRAPHITE_PREFIX=coco.{env}.services.subjects-rw-neo4j.{instanceNumber}
export|set LOG_METRICS=true
$GOPATH/bin/subjects-rw-neo4j

With Docker:

docker build -t coco/subjects-rw-neo4j .

docker run -ti --env NEO_URL=<base url> coco/subjects-rw-neo4j

All arguments are optional, they default to a local Neo4j install on the default port (7474), application running on port 8080, batchSize of 1024, graphiteTCPAddress of "" (meaning metrics won't be written to Graphite), graphitePrefix of "" and logMetrics false.

NB: the default batchSize is much higher than the throughput the instance data ingester currently can cope with.

Endpoints

/subjects/{uuid}

PUT

The only mandatory fields are the uuid, the prefLabel and the alternativeIdentifier uuids (because the uuid is also listed in the alternativeIdentifier uuids list).

Every request results in an attempt to update that subject: unlike with GraphDB there is no check on whether the subject already exists and whether there are any changes between what's there and what's being written. We just do a MERGE which is Neo4j for create if not there, update if it is there.

A successful PUT results in 200.

We run queries in batches. If a batch fails, all failing requests will get a 500 server error response.

Invalid json body input, or uuids that don't match between the path and the body will result in a 400 bad request response.

Example: curl -XPUT -H "X-Request-Id: 123" -H "Content-Type: application/json" localhost:8080/subjects/bba39990-c78d-3629-ae83-808c333c6dbc --data '{"uuid":"bba39990-c78d-3629-ae83-808c333c6dbc","prefLabel":"Metals Markets", "alternativeIdentifiers":{"TME":["MTE3-U3ViamVjdHM="],"uuids": ["bba39990-c78d-3629-ae83-808c333c6dbc","6a2a0170-6afa-4bcc-b427-430268d2ac50"],"type":"Subject"}}'

The type field is not currently validated - instead, the Subject Writer writes type Subject and its parent types (Thing, Concept, Classification) as labels for the Subject.

GET

The internal read should return what got written

If not found, you'll get a 404 response.

Empty fields are omitted from the response. curl -H "X-Request-Id: 123" localhost:8080/subjects/bba39990-c78d-3629-ae83-808c333c6dbc

DELETE

Will return 204 if successful, 404 if not found curl -XDELETE -H "X-Request-Id: 123" localhost:8080/subjects/bba39990-c78d-3629-ae83-808c333c6dbc

Admin endpoints

Healthchecks: http://localhost:8080/__health

Ping: http://localhost:8080/ping or http://localhost:8080/__ping