Script improvements

Author: jeffreylovitz

README.md

@@ -13,30 +13,34 @@ https://oss.redislabs.com/redisgraph/
 ## Usage
 bulk_insert.py GRAPHNAME [OPTIONS]
 
-| Flags   | Extended flags        |    Parameter                                 |
-|---------|-----------------------|----------------------------------------------|
-|  -h     | --host TEXT           |    Redis server host (default: 127.0.0.1)    |
-|  -p     | --port INTEGER        |    Redis server port   (default: 6379)       |
-|  -a     | --password TEXT       |    Redis server password                     |
-|  -c     | --ssl_certfile TEXT   |    path to certfile for SSL connection       |
-|  -k     | --ssl_keyfile TEXT    |    path to keyfile for SSL connection        |
-|  -n     | --nodes TEXT          |    path to node csv file  [required]         |
-|  -r     | --relationships TEXT  |    path to relationship csv file             |
+| Flags   | Extended flags        |    Parameter                                                    |
+|---------|-----------------------|-----------------------------------------------------------------|
+|  -h     | --host TEXT           |    Redis server host (default: 127.0.0.1)                       |
+|  -p     | --port INTEGER        |    Redis server port   (default: 6379)                          |
+|  -a     | --password TEXT       |    Redis server password                                        |
+|  -n     | --nodes TEXT          |    path to node csv file [required]                             |
+|  -r     | --relations TEXT      |    path to relationship csv file                                |
+|  -t     | --max-token-count INT |    max number of tokens sent in each Redis query (default 1024) |
+|  -b     | --max-buffer-size INT |    max batch size (MBs) of each Redis query (default 4096)      |
+|  -c     | --max-token-size INT  |    max size (MBs) of each token sent to Redis (default 500)     |
+
 
 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 relationship flags should be specified once per input file.
 
+The flags for `max-token-count`, `max-buffer-size`, and `max-token-size` should only be specified if the memory overhead of graph creation is too high. The bulk loader builds large graphs by sending binary tokens (each of which holds multiple nodes or relations) to Redis in batches. By lowering these limits from their defaults, the size of each transmission to Redis is lowered and fewer entities are held in memory, at the expense of a longer overall runtime.
+
 ```
 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 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`.
+The label (for nodes) or relationship type (for relationships) is derived from the base name of the input CSV file. In this example, we'll construct two sets of nodes, labeled `Person` and `Country`, and two types of relationships - `KNOWS` and `VISITED`.
 
 ## Input constraints
 ### Node identifiers
 - If both nodes and relations are being created, each node must be associated with a unique identifier.
 - The identifier is the first column of each label CSV file. If this column's name starts with an underscore (`_`), the identifier is internal to the bulk loader operation and does not appear in the resulting graph. Otherwise, it is treated as a node property.
+- Each identifier must be entirely unique across all label files.
 - Source and destination nodes in relation CSV files should be referred to by their identifiers.
-- The name of the identifier columns otherwise do not matter, so long as no node has a duplicated value.
 - The uniqueness restriction is lifted if only nodes are being created.
 
 ### Entity properties
@@ -52,7 +56,7 @@ The label (for nodes) or relationship type (for relationships) is derived from t
 - Each row must have the same number of fields.
 - Leading and trailing whitespace is ignored.
 - The first field of a label file will be the node identifier, as described in [Node Identifiers](#node-identifiers).
-- With the possible exception of the first, each field in the header is a property key. The value in that position for each node is the property associated with that key.
+- All fields are property keys that will be associated with each node.
 
 ### Relationship files
 - Each row must have the same number of fields.