Merge pull request #1 from K-Jo/renaming-relation

Renaming relation to relationship

Author: swilly22

README.md

@@ -11,7 +11,7 @@ A Redis server with the [RedisGraph](https://github.com/RedisLabsModules/RedisGr
 https://oss.redislabs.com/redisgraph/
 
 ## Usage
-bulk_insert.py [OPTIONS] GRAPHNAME
+bulk_insert.py GRAPHNAME [OPTIONS]
 
 | Flags   | Extended flags        |    Parameter                                 |
 |---------|-----------------------|----------------------------------------------|
@@ -20,15 +20,15 @@ bulk_insert.py [OPTIONS] GRAPHNAME
 |  -P     | --password TEXT       |    Redis server password                     |
 |  -s     | --ssl TEXT            |    Server is SSL-enabled                     |
 |  -n     | --nodes TEXT          |    path to node csv file  [required]         |
-|  -r     | --relations TEXT      |    path to relation csv file                 |
+|  -r     | --relationships TEXT  |    path to relationship csv file             |
 
 The only required arguments are the name to give the newly-created graph (which can appear anywhere) and at least one node CSV file.
-The nodes and relations flags should be specified once per input file.
+The nodes and relationship flags should be specified once per input file.
 
 ```
-python bulk_insert.py GRAPH_DEMO  -n demo/person.csv -n demo/country.csv -r demo/knows.csv -r demo/visited.csv
+python bulk_insert.py GRAPH_DEMO -n example/Person.csv -n example/Country.csv -r example/KNOWS.csv -r example/VISITED.csv
 ```
-The label (for nodes) or relation type (for relations) is derived from the base name of the input CSV file. In this query, we'll construct two node labels, `person` and `country`, and two relation types - `knows` and `visited`.
+The label (for nodes) or relationship type (for relationships) is derived from the base name of the input CSV file. In this query, we'll construct two sets of nodes, labeled `Person` and `Country`, and two types of relationships - `KNOWS` and `VISITED`.
 
 ## Input constraints
 ### Node files
@@ -38,22 +38,22 @@ The label (for nodes) or relation type (for relations) is derived from the base
 - Value types do not need to be provided. Properties are not required to be exclusively composed of numeric or string types.
 - There is no uniqueness constraint on nodes.
 
-### Relation files
-- Relation inputs have no headers.
+### Relationship files
+- Relationship inputs have no headers.
 - Each row should specify a source and destination node ID.
-- Described relations are always considered to be directed (source->destination).
-- The bulk insert script does not yet support adding properties to relations (though this can be done after the fact with RedisGraph queries).
-- _NOTE_ Relation processing does not yet include node lookups. The entries in a relation file should all be integers corresponding to node IDs.
+- Described relationships are always considered to be directed (source->destination).
+- The bulk insert script does not yet support adding properties to relationships (though this can be done after the fact with RedisGraph queries).
+- _NOTE_ Relationship processing does not yet include node lookups. The entries in a relationship file should all be integers corresponding to node IDs.
 
 
 ### Determining Node IDs
-Node IDs are assigned in order of insertion. Node files are processed in the order specified by the user on the command line (though all label files are processed before relation files).
+Node IDs are assigned in order of insertion. Node files are processed in the order specified by the user on the command line (though all Node files are processed before Relationship files).
 
-The first node in the first label file will have an ID of 0, and subsequent nodes across all files are ordered consecutively.
+The first node in the first node file will have an ID of 0, and subsequent nodes across all files are ordered consecutively.
 
-If a relation file has the line:
+If a relationship file has the line:
 ```
 0,11
 ```
-This indicates that there is an edge from the first node in the first label file to the 12th node to be inserted, regardless of which file it may appear in.
+This indicates that there is a relationship from the first node in the first node file to the 12th node to be inserted, regardless of which file it may appear in.
 

bulk_insert.py

@@ -241,11 +241,11 @@ def help():
 @click.option('--ssl', '-s', default=False, help='Server is SSL-enabled')
 # CSV file paths
 @click.option('--nodes', '-n', required=True, multiple=True, help='path to node csv file')
-@click.option('--relations', '-r', multiple=True, help='path to relation csv file')
+@click.option('--relationships', '-r', multiple=True, help='path to relation csv file')
 # Debug options
 @click.option('--max_buffer_size', '-m', default=1024*1024, help='(DEBUG ONLY) - max token count per Redis query')
 
-def bulk_insert(graph, host, port, password, ssl, nodes, relations, max_buffer_size):
+def bulk_insert(graph, host, port, password, ssl, nodes, relationships, max_buffer_size):
     global graphname
     global redis_client
     global max_tokens
@@ -260,8 +260,8 @@ def bulk_insert(graph, host, port, password, ssl, nodes, relations, max_buffer_s
     print("Building label descriptors...")
     label_descriptors = build_descriptors(nodes, "NODES")
     relation_count = 0
-    if relations:
-        relation_descriptors = build_descriptors(relations, "RELATIONS")
+    if relationships:
+        relation_descriptors = build_descriptors(relationships, "RELATIONS")
         relation_count = relation_descriptors.total_entities
 
     # Send prefix tokens to RedisGraph
@@ -272,7 +272,7 @@ def bulk_insert(graph, host, port, password, ssl, nodes, relations, max_buffer_s
     # Process input CSVs and commit their contents to RedisGraph
     # Possibly make this a method on Argument
     label_descriptors.batch_insert_descriptors()
-    if relations:
+    if relationships:
         relation_descriptors.batch_insert_descriptors()
     finalize_graph()
 

demo/country.csv renamed to example/Country.csv

@@ -1,3 +1,3 @@
 name,population
 Israel,7000000
-Japan,127000000
+Japan,127000000

demo/knows.csv renamed to example/KNOWS.csv

@@ -26,4 +26,4 @@
 5,2
 5,3
 5,4
-6,0
+6,0

demo/person.csv renamed to example/Person.csv

@@ -9,4 +9,4 @@ Noam,Nativ
 Hila,Rahamani
 Lucy,Fital
 Jane,Velger
-Shelly,Laslo
+Shelly,Laslo

demo/visited.csv renamed to example/VISITED.csv

@@ -1,3 +1,3 @@
 0,11
 0,12
-1,12
+1,12