https://github.com/neo4j-graph-examples/template
Template repository with code rendering and checks
https://github.com/neo4j-graph-examples/template
dataset example example-data model template template-data
Last synced: 10 months ago
JSON representation
Template repository with code rendering and checks
- Host: GitHub
- URL: https://github.com/neo4j-graph-examples/template
- Owner: neo4j-graph-examples
- Created: 2020-05-17T01:55:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-17T14:25:16.000Z (over 2 years ago)
- Last Synced: 2025-03-28T13:44:53.738Z (10 months ago)
- Topics: dataset, example, example-data, model, template, template-data
- Language: Shell
- Homepage:
- Size: 747 KB
- Stars: 4
- Watchers: 1
- Forks: 6
- Open Issues: 13
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
//name of the graph example
:name: template
//graph example description
:long-name: Template
:description: Template example
//icon representing graph example
:icon: documentation/img/icon.svg
//associated search tags, separate multiple tags with comma
:tags: example-data, dataset, template-data, example, template, model
//graph example author
:author: Neo4j Devrel
//true if this example is available on the demodb. Set to false if not used
:demodb: false
//data flat files (csv, json, etc). Set to false if not used
:data: false
//use a script to generate/process data? Set to either path for script, or false if not used
:use-load-script: scripts/template.cypher
//use a graph dump file for initial data set? Set to either path for dump file, or false if not used
:use-dump-file: false
//if a zip file exists for the data, specify here. Set to false if not used
:zip-file: false
//use a plugin for the database, separate multiple plugins with comma. 'public' plugins are apoc, graph-algorithms.
//other algorithms are specified by path, e.g. apoc,graph-algorithms; Set to false if not used
:use-plugin: false
//target version of the database this example should run on
:target-db-version: 3.5,4.0
//specify a Bloom perspective, or false if not used
:bloom-perspective: bloom/bloom.perspective
//guide for the graph example. Should be friendly enough to be converted into various document formats
:guide: documentation/template.neo4j-browser-guide
//temporary for rendered guides
:rendered-guide: https://guides.neo4j.com/{name}/index.html
//guide for modeling decisions. Should be friendly enough to be converted into various document formats
:model: documentation/img/model.svg
:example: documentation/img/example.png
:todo: false
image::{icon}[width=100]
== {long-name} Graph Example
Description: _{description}_
ifeval::[{todo} != false]
To Do: {todo}
endif::[]
.Model
image::{model}[]
.Example
image::{example}[width=600]
.Example Query:
:param-name: param
:param-value: param-value
[source,cypher,role=query-example-params,subs=+attributes]
----
:param {param-name} => "{param-value}"
----
[source,cypher,role=query-example,param-name={param-name},param-value={param-value},result-column=name,expected-result="A value"]
----
MATCH (n:Node {name:$param})
RETURN n.name as name
----
=== Setup
This is for Neo4j version: {target-db-version}
ifeval::[{use-plugin} != false]
Required plugins: {use-plugin}
endif::[]
ifeval::[{demodb} != false]
The database is also available on https://demo.neo4jlabs.com:7473
Username "{name}", password: "{name}", database: "{name}"
endif::[]
Rendered guide available via: `:play {rendered-guide}`
Unrendered guide: link:{guide}[]
Load graph data via the following:
ifeval::[{data} != false]
==== Data files: `{data}`
Import flat files (csv, json, etc) using Cypher's https://neo4j.com/docs/cypher-manual/current/clauses/load-csv/[`LOAD CSV`], https://neo4j.com/labs/apoc/[APOC library], or https://neo4j.com/developer/data-import/[other methods].
endif::[]
ifeval::[{use-dump-file} != false]
==== Dump file: `{use-dump-file}`
* Drop the file into the `Files` section of a project in Neo4j Desktop. Then choose the option to `Create new DBMS from dump` option from the file options.
* Use the neo4j-admin tool to load data from the command line with the command below.
[source,shell,subs=attributes]
----
bin/neo4j-admin load --from {use-dump-file} [--database "database"]
----
* Upload the dump file to Neo4j Aura via https://console.neo4j.io/#import-instructions
endif::[]
ifeval::[{use-load-script} != false]
==== Data load script: `{use-load-script}`
[source,shell,subs=attributes]
----
bin/cypher-shell -u neo4j -p "password" -f {use-load-script} [-d "database"]
----
Or import in Neo4j Browser by dragging or pasting the content of {use-load-script}.
endif::[]
ifeval::[{zip-file} != false]
==== Zip file
Download the zip file link:{repo}/raw/master/{name}.zip[{name}.zip] and add it as "project from file" to https://neo4j.com/developer/neo4j-desktop[Neo4j Desktop^].
endif::[]
=== Code Examples
* link:code/javascript/example.js[JavaScript]
* link:code/java/Example.java[Java]
* link:code/csharp/Example.cs[C#]
* link:code/python/example.py[Python]
* link:code/go/example.go[Go]
=== relate.project-install.json
Defining DBMSs:
The `dbms` key is an array containing information about sample dbms installation. It has four potential keys which of `targetNeo4jVersion` is required. See link:relate.project-install.json[relate.project-install.json] for reference.
* `targetNeo4jVersion`: [required] A semver formatted version number defining which version of Neo4j to use. Use the https://semver.npmjs.com[semver calculator] to verify the version.
* `plugins`: (optional) An array of plugin IDs. For example `["apoc", "graph-data-science"]`.
* `dumpFile`: (optional) Path to a local neo4j dump file or an http link that will be imported after the dbms has been created.
* `scriptFile`: (optional) Path to a local cypher script or an http link that will be imported after the dbms has been created.
=== Feedback
Feel free to submit issues or pull requests for improvement on this repository.