{"id":22768423,"url":"https://github.com/neo4j-graph-examples/template","last_synced_at":"2025-04-15T01:51:12.155Z","repository":{"id":42655193,"uuid":"264564044","full_name":"neo4j-graph-examples/template","owner":"neo4j-graph-examples","description":"Template repository with code rendering and checks","archived":false,"fork":false,"pushed_at":"2023-05-17T14:25:16.000Z","size":765,"stargazers_count":4,"open_issues_count":13,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T13:44:53.738Z","etag":null,"topics":["dataset","example","example-data","model","template","template-data"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neo4j-graph-examples.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-17T01:55:33.000Z","updated_at":"2025-01-02T23:53:18.000Z","dependencies_parsed_at":"2024-12-11T14:11:32.565Z","dependency_job_id":"5f049557-7c97-4c49-a92b-f966cc432072","html_url":"https://github.com/neo4j-graph-examples/template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neo4j-graph-examples%2Ftemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neo4j-graph-examples%2Ftemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neo4j-graph-examples%2Ftemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neo4j-graph-examples%2Ftemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neo4j-graph-examples","download_url":"https://codeload.github.com/neo4j-graph-examples/template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248991539,"owners_count":21194894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dataset","example","example-data","model","template","template-data"],"created_at":"2024-12-11T14:11:30.168Z","updated_at":"2025-04-15T01:51:12.137Z","avatar_url":"https://github.com/neo4j-graph-examples.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"//name of the graph example\n:name: template\n//graph example description\n:long-name: Template\n:description: Template example\n//icon representing graph example\n:icon: documentation/img/icon.svg\n//associated search tags, separate multiple tags with comma\n:tags: example-data, dataset, template-data, example, template, model\n//graph example author\n:author: Neo4j Devrel\n//true if this example is available on the demodb. Set to false if not used\n:demodb: false\n//data flat files (csv, json, etc). Set to false if not used\n:data: false\n//use a script to generate/process data? Set to either path for script, or false if not used\n:use-load-script: scripts/template.cypher\n//use a graph dump file for initial data set? Set to either path for dump file, or false if not used\n:use-dump-file: false\n//if a zip file exists for the data, specify here. Set to false if not used\n:zip-file: false\n//use a plugin for the database, separate multiple plugins with comma. 'public' plugins are apoc, graph-algorithms.\n//other algorithms are specified by path, e.g. apoc,graph-algorithms; Set to false if not used\n:use-plugin: false\n//target version of the database this example should run on\n:target-db-version: 3.5,4.0\n//specify a Bloom perspective, or false if not used\n:bloom-perspective: bloom/bloom.perspective\n//guide for the graph example. Should be friendly enough to be converted into various document formats\n:guide: documentation/template.neo4j-browser-guide\n//temporary for rendered guides\n:rendered-guide: https://guides.neo4j.com/{name}/index.html\n//guide for modeling decisions. Should be friendly enough to be converted into various document formats\n:model: documentation/img/model.svg\n:example: documentation/img/example.png\n\n:todo: false\nimage::{icon}[width=100]\n\n== {long-name} Graph Example\n\nDescription: _{description}_\n\nifeval::[{todo} != false]\nTo Do: {todo}\nendif::[]\n\n.Model\nimage::{model}[]\n\n.Example\nimage::{example}[width=600]\n\n.Example Query:\n\n:param-name: param\n:param-value: param-value\n\n[source,cypher,role=query-example-params,subs=+attributes]\n----\n:param {param-name} =\u003e \"{param-value}\"\n----\n\n[source,cypher,role=query-example,param-name={param-name},param-value={param-value},result-column=name,expected-result=\"A value\"]\n----\nMATCH (n:Node {name:$param})\nRETURN n.name as name\n----\n\n=== Setup\n\nThis is for Neo4j version: {target-db-version}\n\nifeval::[{use-plugin} != false]\nRequired plugins: {use-plugin}\nendif::[]\n\nifeval::[{demodb} != false]\nThe database is also available on https://demo.neo4jlabs.com:7473\n\nUsername \"{name}\", password: \"{name}\", database: \"{name}\"\nendif::[]\n\nRendered guide available via: `:play {rendered-guide}`\n\nUnrendered guide: link:{guide}[]\n\nLoad graph data via the following:\n\nifeval::[{data} != false]\n==== Data files: `{data}`\n\nImport 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].\nendif::[]\n\nifeval::[{use-dump-file} != false]\n==== Dump file: `{use-dump-file}`\n\n* 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.\n\n* Use the neo4j-admin tool to load data from the command line with the command below.\n\n[source,shell,subs=attributes]\n----\nbin/neo4j-admin load --from {use-dump-file} [--database \"database\"]\n----\n\n* Upload the dump file to Neo4j Aura via https://console.neo4j.io/#import-instructions\nendif::[]\n\nifeval::[{use-load-script} != false]\n==== Data load script: `{use-load-script}`\n\n[source,shell,subs=attributes]\n----\nbin/cypher-shell -u neo4j -p \"password\" -f {use-load-script} [-d \"database\"]\n----\n\nOr import in Neo4j Browser by dragging or pasting the content of {use-load-script}.\nendif::[]\n\nifeval::[{zip-file} != false]\n==== Zip file\n\nDownload 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^].\nendif::[]\n\n=== Code Examples\n\n* link:code/javascript/example.js[JavaScript]\n* link:code/java/Example.java[Java]\n* link:code/csharp/Example.cs[C#]\n* link:code/python/example.py[Python]\n* link:code/go/example.go[Go]\n\n=== relate.project-install.json\n\nDefining DBMSs:\n\nThe `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.\n\n* `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.\n* `plugins`: (optional) An array of plugin IDs. For example `[\"apoc\", \"graph-data-science\"]`.\n* `dumpFile`: (optional) Path to a local neo4j dump file or an http link that will be imported after the dbms has been created.\n* `scriptFile`: (optional) Path to a local cypher script or an http link that will be imported after the dbms has been created.\n\n=== Feedback\n\nFeel free to submit issues or pull requests for improvement on this repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneo4j-graph-examples%2Ftemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneo4j-graph-examples%2Ftemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneo4j-graph-examples%2Ftemplate/lists"}