Link Search Menu Expand Document

Getting Started with the CHCD

Table of contents
  1. Download CHCD CSVs
  2. Setting Up the CHCD with CSV Files
  3. Neo4j & Cypher

Unlike traditional relational databases, the CHCD runs on the Neo4j graph database platform. Specifically, it utilizes the free-to-use Community Edition. Below are detailed instructions which explain how to download the CHCD CSV data and how to turn it into an operable Neo4j database.


Download CHCD CSVs

CSV files are a widely used and flexible storage option for large datasets. AS such, the CHCD team chose to distribute our database in this format so it can be easily adapted for multiple use-cases. We have also placed it in a Github repository so it is accessible to the general public.

Download CHCD CSVs


Setting Up the CHCD with CSV Files

The CHCD CSV files can be used in many different applications. However, if you would like to setup a local Neo4j version of the CHCD, follow the below set of instructions.

  • Download CHCD CSV: See above.
  • Download and Install Neo4j: Follow these instructions to download and install the Neo4j desktop client.
  • Create a Database: Follow these instructions to create a blank graph database. Note: Do not start the graph database. If a database has been started, it will interfere with the importation of CSV data.
  • Move the CHCD CSVs: Use the three dot menu icon to open up the import folder (See image below). Place chcd-v-1-nodes.csv and chcd-v-1-rels.csv into this folder.

  • Run CSV Import Command: Use the three dot menu icon to open up the terminal for the database (See image below).

    Once the terminal is open, run the following commands.

    cd bin
    
    neo4j-admin import --multiline-fields=true --database=neo4j --nodes=../import/chcd-v-1-nodes.csv --relationships=../import/chcd-v-1-rels.csv
    
  • Start Database: Press the Start button start the database. Then, press the Open button to open Neo4j Desktop Browser.

Neo4j & Cypher

Users must utilize the Cypher language to write queries in Neo4j. Neo4j maintains a full suite of documentation and training to help new users learn the basics of graph databases in general, Neo4j in particular, and the Cypher query language.


Back to top

Copyright © 2021 China Historical Christian Database.