Package: falkordb-bulk-loader
falkordb-bulk-loaderA Python utility for building falkordb databases from CSV inputsRequirementsThe bulk loader utility requires a Python 3 interpreter.A FalkorDB server must be running, installation instructions may be found atFalkorDB documentation.InstallationThe bulk loader can be installed using pip:pipinstallfalkordb-bulk-loaderOrpipinstallgit+https://github.com/falkordb/falkordb-bulk-loader.git@masterUsagePip installation exposesfalkordb-bulk-insertas a command to invoke this tool:falkordb-bulk-insertGRAPHNAME[OPTIONS]Installation by cloning the repository allows the script to be invoked via Python like so:python3falkordb_bulk_loader/bulk_insert.pyGRAPHNAME[OPTIONS]FlagsExtended flagsParameter-u--redis-url TEXTServer url (default: redis://127.0.0 1:6379)-n--nodes TEXTPath to Node CSV file with the filename as the Node Label-N--nodes-with-label TEXTNode Label followed by path to Node CSV file-r--relations TEXTPath to Relationship CSV file with the filename as the Relationship Type-R--relations-with-type TEXTRelationship Type followed by path to relationship CSV file-o--separator CHARField token separator in CSV files (default: comma)-d--enforce-schemaRequires each cell to adhere to the schema defined in the CSV header-j--id-type TEXTThe data type of unique node ID properties (either STRING or INTEGER)-s--skip-invalid-nodesSkip nodes that reuse previously defined IDs instead of exiting with an error-e--skip-invalid-edgesSkip edges that use invalid IDs for endpoints instead of exiting with an error-q--quote INTThe quoting format used in the CSV file. QUOTE_MINIMAL=0,QUOTE_ALL=1,QUOTE_NONNUMERIC=2,QUOTE_NONE=3-t--max-token-count INT(Debug argument) Max number of tokens sent in each query (default 1024)-b--max-buffer-size INT(Debug argument) Max batch size (MBs) of each query (default 64)-c--max-token-size INT(Debug argument) Max size (MBs) of each token sent to the server (default 64)-i--index Label:PropertyAfter bulk import, create an Index on provided Label:Property pair (optional)-f--full-text-index Label:PropertyAfter bulk import, create an full text index on provided Label:Property pair (optional)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.falkordb-bulk-insertGRAPH_DEMO-nexample/Person.csv-nexample/Country.csv-rexample/KNOWS.csv-rexample/VISITED.csvThe 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, labeledPersonandCountry, and two types of relationships -KNOWSandVISITED.FalkorDB does not impose a schema on properties, so the same property key can have values of differing types, such as strings and integers. As such, the bulk loader's default behavior is to infer the type for each field independently for each value. This can cause unexpected behaviors when, for example, a property expected to always have string values has a field that can be cast to an integer or double. To avoid this, use the--enforce-schemaflag and update your CSV headers as described inInput Schemas.Extended parameter descriptionsThe flags formax-token-count,max-buffer-size, andmax-token-sizeare typically not required. They should only be specified if the memory overhead of graph creation is too high, or raised if the volume of server calls is too high. The bulk loader builds large graphs by sending binary tokens (each of which holds multiple nodes or relations) to FalkorDB in batches.--quoteis maintained for backwards compatibility, and allows some control over Python's type inference in the default mode.--enforce-schema-typeis preferred.--enforce-schema-typeindicates that input CSV headers will follow the form described inInput Schemas.--nodes-with-labeland--relations-with-typeallows the node label or relationship type to be explicitly written instead of inferring them from the filename. For example,--relations-with-type HAS_TAG post_hasTag_tag.csvwill add all relationships described in the specified CSV with the typeHAS_TAG. To specify multiple labels separate them with ':'. For example,--nodes-with-label Actor:Director actors.csvwill add all nodes described in the specified CSV with the labelsActorandDirector.Input constraintsNode identifiersIf both nodes and relations are being created, each node must be associated with a unique identifier.If not using--enforce-schema, 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.ID namespacescan be used to write more granular identifiers.Source and destination nodes in relation CSV files should be referred to by their identifiers.The uniqueness restriction is lifted if only nodes are being created.Entity propertiesProperty types do not need to be explicitly provided.Properties are not required to be exclusively composed of any type.The types currently supported by the bulk loader are:bool: eithertrueorfalse(case-insensitive, not quote-interpolated).integer: an unquoted value that can be read as an integer type.double: an unquoted value that can be read as a floating-point type.string: any field that is either quote-interpolated or cannot be casted to a numeric or boolean type.array: A bracket-interpolated array of elements of any types. Strings within the array must be explicitly quote-interpolated. Array properties require use of a non-comma delimiter for the CSV (-o).Cypher does not allow NULL values to be assigned to properties.The default behavior is to infer the property type, attempting to cast it to integer, float, boolean, or string in that order.The--enforce-schemaflag and anInput Schemashould be used if type inference is not desired.Label file formatEach row must have the same number of fields.Leading and trailing whitespace is ignored.If not using anInput Schema, the first field of a label file will be the node identifier, as described inNode Identifiers.All fields are property keys that will be associated with each node.Relationship filesEach row must have the same number of fields.Leading and trailing whitespace is ignored.If not using anInput Schema, the first two fields of each row are the source and destination node identifiers. The names of these fields in the header do not matter.If the file has more than 2 fields, all subsequent fields are relationship properties that adhere to the same rules as node properties.Described relationships are always considered to be directed (source->destination).Input CSV exampleStore.csvstoreNum | Location | daysOpen |
118 | 123 Main St | ['Mon', 'Wed', 'Fri']
136 | 55 Elm St | ['Sat', 'Sun']This CSV would be inserted with the command:falkordb-bulk-insert StoreGraph --separator \| --nodes Store.csv(Since the pipe character has meaning in the terminal, it must be backslash-escaped.)AllstoreNumproperties will be inserted as integers,Locationwill be inserted as strings, anddaysOpenwill be inserted as arrays of strings.Input SchemasIf the--enforce-schemaflag is specified, all input CSVs will be expected to specify each column's data type in the header.This format lifts some constraints of the default CSV format, such as ID fields being the first column.Most header fields should be a colon-separated pair of the property name and its data type, such asName:STRING. Certain data types do not require a name string, as indicated below.The accepted data types are:Type StringDescriptionRequires name stringIDLabel files only - Unique identifier for a nodeOptionalSTART_IDRelation files only - The ID field of this relation's sourceNoEND_IDRelation files only - The ID field of this relation's destinationNoIGNOREThis column will not be added to the graphOptionalDOUBLE / FLOATA signed 64-bit floating-point valueYesINT / INTEGER / LONGA signed 64-bit integer valueYesBOOL / BOOLEANA boolean value indicated by the string 'true' or 'false'YesSTRINGA string valueYesARRAYAn array valueYesIf anIDcolumn has a name string, the value will be added to each node as a property. This property will be a string by default, though it may be switched to integer using the--id-typeargument. If the name string is not provided, the ID is internal to the bulk loader operation and will not appear in the graph.START_IDandEND_IDcolumns will never be added as properties.ID NamespacesTypically, node identifiers need to be unique across all input CSVs. When using an input schema, it is (optionally) possible to create ID namespaces, and the identifier only needs to be unique across its namespace. This is particularly useful when each input CSV has primary keys which overlap with others.To introduce a namespace, follow the:IDtype string with a parentheses-interpolated namespace string, such as:ID(User). The same namespace should be specified in the:START_IDor:END_IDfield of relation files, as in:START_ID(User).Input Schema CSV examplesUser.csv:ID(User), name:STRING, rank:INT
0, "Jeffrey", 5
1, "Filipe", 8FOLLOWS.csv:START_ID(User), :END_ID(User), reaction_count:INT
0, 1, 25
1, 0, 10Inserting these CSVs with the command:falkordb-bulk-insert SocialGraph --enforce-schema --nodes User.csv --relations FOLLOWS.csvWill produce a graph named SocialGraph with 2 users, Jeffrey and Filipe. Jeffrey follows Filipe, and that relation has a reaction_count of 25. Filipe also follows Jeffrey, with a reaction_count of 10.Performing bulk updatesPip installation also exposes the commandfalkordb-bulk-update:falkordb-bulk-updateGRAPHNAME[OPTIONS]Installation by cloning the repository allows the bulk updater to be invoked via Python like so:python3falkordb_bulk_loader/bulk_update.pyGRAPHNAME[OPTIONS]FlagsExtended flagsParameter-h--host TEXTServer host (default: 127.0.0.1)-p--port INTEGERServer port (default: 6379)-a--password TEXTServer password (default: none)-u--unix-socket-path TEXTUnix socket path (default: none)-q--query TEXTQuery to run on server-v--variable-name TEXTVariable name for row array in queries (default: row)-c--csv TEXTPath to CSV input file-o--separator TEXTField token separator in CSV file-n--no-headerIf set, the CSV file has no header-t--max-token-size INTEGERMax size of each token in megabytes (default 500, max 512)The bulk updater allows a CSV file to be read in batches and committed to falkordb according to the provided query.For example, given the CSV files described inInput Schema CSV examples, the bulk loader could create the same nodes and relationships with the commands:falkordb-bulk-updateSocialGraph--csvUser.csv--query"MERGE (:User {id: row[0], name: row[1], rank: row[2]})"falkordb-bulk-updateSocialGraph--csvFOLLOWS.csv--query"MATCH (start {id: row[0]}), (end {id: row[1]}) MERGE (start)-[f:FOLLOWS]->(end) SET f.reaction_count = row[2]"When using the bulk updater, it is essential to sanitize CSV inputs beforehand, as falkordbwillcommit changes to the graph incrementally. As such, malformed inputs may leave the graph in a partially-updated state.