Standards & Best Practise

mmuthu · June 18, 2019, 7:39pm

Hi There,
We are planning to introduce Neo4J into our existing Data Architecture, As part of this I would like to publish some standards/guidelines, best practice for our development team. Do we have anything published from Neo4j ? or do anyone have done for their org?

Thanks,
Mahendar

elaine_rosenber · June 24, 2019, 10:39am

Hello Mahender,

We use these standards when we develop examples for our courseware:

github.com

opencypher/openCypher/blob/master/docs/style-guide.adoc

:numbered:
:toc:
:toc-placement: macro
:source-highlighter: pygments

= The Cypher Style Guide

toc::[]

This is the style guide for the Cypher language, in the context of its standardization through the openCypher project.
This document consists of two main sections: <<Rules>> and <<Recommendations>>.

In <<Rules>>, we list syntax guidelines for composing Cypher queries in a conventional, readability-oriented way.
The examples provided always transform _valid_, but poorly formatted, queries into a different query in the recommended format, whilst retaining the same semantics.

In <<Recommendations>>, we list guidelines that may have an effect on the semantics of queries, such as the way a graph schema is composed through label and relationship types.
Bear in mind that these recommendations will not work after-the-fact: if the graph has been constructed with one set of label and relationship types, queries in the associated workload cannot be re-formatted according to these recommendations without also refactoring the data graph.

== Why is style important?

This file has been truncated. show original

Elaine

mmuthu · June 24, 2019, 10:06pm

Thanks Elaine. This helps.