neo4j-faker

With this tool you can generate fake Demo or Test data into the neo4j database via Cypher Functions (neo4j 3.1+) and or by using the Data Generator. You can see it as a Swiss Army knife to build a fake data set.

The tool is inspired by GraphGen and the faker libraries (java faker), However to make it possible to generate larger datasets the person name generator (firstname, lastname and fullname) is implemented in a different way.

From neo4j-faker 0.9.1 and higher the Neo4j database version should at least be 4.x and higher.

Note: The Cypher Functions and Data Denerator scripts are meant/build to run in a single thread!!

Getting started

• Download the latest release from github
• Unzip the distribution zip file into a directory
• Copy all the contents of the dist directory to the neo4j server plugin directory

  • Faker Cypher Functions

    • Add the following line in the noo4j.conf file to allow access to the faker functions.

      dbms.security.procedures.unrestricted=fkr.*

  • Data Generator Only

    • Register the Data Generator Unmanaged Plugin on the neo4j server

    • You have to add the following line to your neo4j.conf file

      dbms.unmanaged_extension_classes=org.neo4j.faker.ump=/testdata

    • For convenience you can disable the authentication. The curl examples in this documentation are without authentication.

      dbms.security.authorization_enabled=false

• (re) Start the neo4j server
  • Data Generator Only

    • Test the plugin

    • Test the availability of the plugin by calling it with a non existing property file name from you local browser

      http://127.0.0.1:7474/testdata/tdg/pfile/test.props
      

      Since version 0.9.1 (Neo4j version 4 and higher) you can add the target database as an URL parameter:

      http://127.0.0.1:7474/testdata/tdg/pfile/test.props?dbname=mydb
      

      The browser will now give an error message stating that the file test.props cannot be found.

Data Generator Help

The complete help with detailed instructions and examples on how to create the property files with the data definitions for the data loader can be found in the doc directory (doc/index.html).

Cypher Faker Functions and Procedures

You can call dbms.function() in the browser to see the available fkr. functions. There is one procedure to create relationships: fkr.createRelations.

examples:

// generating 1000 Person nodes
foreach (i in range(0,1000) |
    create (p:Person { uid : i })
    set p += fkr.person('1960-01-01','2000-01-01')
)

// generating 500 CreditCards
foreach (a in range(0,500) |
    create (c:CreditCard {uid : fkr.code('Demo #### #### #### ####')})
    set c.limit = fkr.longElement('5000,5000,5000,1000,1000,1000,1000,10000')
    set c.balance = fkr.number(10,1000)
)

//
// generating a Person City structure with relationships
//
create index on :City(name);


foreach (i in range(0,100000) |
    create (p:Person:Proc { uid : i })
    set p += fkr.person('1960-01-01','2000-01-01')
)
;

foreach (ci in range(0,40) |
    merge (cit:City:Proc { name : fkr.stringFromFile("cities.txt") })
)
;

match (c:City:Proc) remove c:Proc with collect(c) as cities
match (p:Person:Proc) remove p:Proc with cities, collect(p) as persons
with cities
,    persons
call fkr.createRelations(persons, "LIVES_IN" , cities, "n-1") yield relationships as livesRelations
call fkr.createRelations(persons, "IS_MARE" , cities , "1-n") yield relationships as mareRelations
call fkr.createRelations(cities, "HAS_POLICE_CHIEF" , persons, "1-1") yield relationships as chiefRelations
foreach ( rel in livesRelations |
set rel.likes = fkr.long(0,100)
)
return size(cities), size(persons), size(livesRelations), size(mareRelations), size(chiefRelations) 
;

In this example we use a temporary extra Label 'Proc' to match only the nodes just created for creating relationships.

Procedures

Functions

Special Functions (generating multiple property values)

Person Functions

Company Functions

Internet Functions

Location Functions

Other Functions

Sequence Array and List Functions

Range Functions

Date Functions

Boolean Functions

Code Generating Functions

Text Generating Functions