CD2H gitForager

neo4j-contrib/neo4j-faker

Name: neo4j-faker

Owner: Neo4j Contrib

Description: Use faker cypher functions to generate demo and test data with cypher

Created: 2017-05-31 13:50:00.0

Updated: 2018-01-26 18:33:46.0

Pushed: 2017-06-12 15:07:26.0

Homepage: null

Size: 506

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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.

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=*
```
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
```
  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:

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


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

xslt

enerating a Person City structure with relationships

te index on :City(name);


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



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



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

rn 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

| name | signature | description | | —- | ——— | ———– | | fkr.createRelations | fkr.createRelations(startNodes :: LIST? OF ANY?, relationshipType :: STRING?, endNodes :: LIST? OF ANY?, cardinality :: STRING?) :: (relationships :: LIST? OF RELATIONSHIP?) | Create Relationships between a list of start nodes and a list of end nodes. cardinality can be '1-n' (The end node may have max 1 relation from the start node), 'n-1' (The start node may have max one relation to the end node) or '1-1' (The start and end node may have max one relationship of this type). Note that the procure returns one row with a list of relationships in it|

Functions

Special Functions (generating multiple property values)

| name | signature | description | | —- | ——— | ———– | | fkr.user | fkr.user(dateFrom :: STRING?, dateTo :: STRING?, companyDomain :: STRING?) :: (MAP?) | generates a system User with firstname, lastname, userId, mail and startdate | | fkr.person | fkr.person(dateFrom :: STRING?, dateTo :: STRING?) :: (MAP?) | generates a Person with firstname, lastname, fullName, birthdate and ssn | | fkr.fromToDate | fkr.fromToDate(dateFromFrom :: STRING?, dateFromTo :: STRING?, dateToFrom :: STRING?, dateToTo :: STRING?) :: (MAP?) | This will generate a from and a to date property (number value generated with date YYYYMMDD) | | fkr.fromToDateTime | fkr.fromToDateTime(dateFromFrom :: STRING?, dateFromTo :: STRING?, dateToFrom :: STRING?, dateToTo :: STRING?) :: (MAP?) | This will generate a from and a to timestamp property (number value generated with date YYYYMMDD) | | fkr.dateAndTime | fkr.dateAndTime(dateFrom :: STRING?, dateTo :: STRING?) :: (MAP?) | This will generate a date and seperate time property | | fkr.dateAndTimeNowR | fkr.dateAndTimeNowR(minutesRange :: INTEGER?) :: (MAP?) | This will generate a random date between 'now' minus a minutes range |

Person Functions

Company Functions

Internet Functions

Location Functions

Other Functions

Sequence Array and List Functions

| name | signature | description | | —- | ——— | ———– | | fkr.sequence | fkr.sequence(sequenceName :: STRING?) :: (INTEGER?) | generate a sequence number for the given 'sequence' name | | fkr.stringElement | fkr.stringElement(values :: STRING?) :: (STRING?) | generate an element from comma separated list of strings \ |'a','b','c'\ | | | fkr.stringElementsFrom | fkr.stringElementsFrom(values :: STRING?) :: (LIST? OF ANY?) | generate an String array from semicolon separated list of String arrays 'a','b','c';'d','e','f' | | fkr.stringFromFile | fkr.stringFromFile(fileName :: STRING?) :: (STRING?) | get a string value from a provided file. File must be in the plugins/ddgres folder | | fkr.nextStringElement | fkr.nextStringElement(values :: STRING?) :: (STRING?) | get the next element from comma separated list of strings 'a,b,c' | | fkr.nextStringFromFile | fkr.nextStringFromFile(fileName :: STRING?, identifier :: STRING?) :: (STRING?) | get the next string value from a provided file (per identifier). File must be in the plugins/ddgres folder. | | fkr.doubleElement | fkr.doubleElement(values :: STRING?) :: (FLOAT?) | generate a double element from comma separated list of numbers '1,2,3' | | fkr.doubleFromFile | fkr.doubleFromFile(fileName :: STRING?) :: (FLOAT?) | get double value from a provided file. File must be in the plugins/ddgres folder | | fkr.doubleElementsFrom | fkr.doubleElementsFrom(values :: STRING?) :: (LIST? OF ANY?) | generate an double array from semicolon separated list of double arrays 1.1,2,0.3;3,8.0,23 | | fkr.nextDoubleElement | fkr.nextDoubleElement(values :: STRING?) :: (FLOAT?) | generate a double element from comma separated list of numbers '1.1,2.3,0.3' | | fkr.nextDoubleFromFile | fkr.nextDoubleFromFile(fileName :: STRING?, identifier :: STRING?) :: (FLOAT?) | get next double value from a provided file (per identifier). File must be in the plugins/ddgres folder | | fkr.longElement | fkr.longElement(values :: STRING?) :: (INTEGER?) | generate a long element from comma separated list of longs '1,2,3' | | fkr.longFromFile | fkr.longFromFile(fileName :: STRING?) :: (INTEGER?) | get a long value from a provided file. File must be in the plugins/ddgres folder | | fkr.nextLongElement | fkr.nextLongElement(values :: STRING?) :: (INTEGER?) | generate an element from comma separated list of longs '1,2,3' | | fkr.nextLongFromFile | fkr.nextLongFromFile(fileName :: STRING?, identifier :: STRING?) :: (INTEGER?) | get the next long value from a provided file (per identifier). File must be in the plugins/ddgres folder |

Range Functions

Date Functions

Boolean Functions

Code Generating Functions

Text Generating Functions

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.