@graphty/graph-io 0.3.25 → 0.3.26

package/dist/src/formats/neo4j/exporter.d.ts

@@ -20,51 +20,139 @@
  * `originalId` value (the id text the importer stored it under as `Space:id`), so a round trip
  * reproduces the source file.
  */
-import { type ExportCapabilities, type GraphExporter } from "../../types.js";
-/** The format-specific options of the Neo4j exporter. */
-export interface Neo4jExportOptions {
-    /** Which tables to write: both (node sections first; default), the node sections or the relationship sections. */
+import { type GraphSnapshot } from "@graphty/graph-format";
+import { type CommonExportOptions, type ExportCapabilities, type GraphExporter } from "../../types.js";
+/**
+ * The format-specific options of the Neo4j exporter.
+ * @category Built-in formats
+ */
+export interface Neo4jExportOptions extends CommonExportOptions {
+    /**
+     * Which tables to write: "all" (the node sections, then the relationship sections), "nodes" or
+     * "relationships".
+     * @defaultValue "all"
+     */
     part?: "all" | "nodes" | "relationships" | undefined;
-    /** The field delimiter; one character; "," by default. */
+    /**
+     * The field delimiter, one character. It must differ from `arrayDelimiter`: with
+     * `delimiter: ";"`, also pass `arrayDelimiter: ","` or `"|"`.
+     * @defaultValue ","
+     */
     delimiter?: string | undefined;
-    /** The array delimiter of list values and `:LABEL` cells; ";" by default. */
+    /**
+     * The delimiter inside list values and `:LABEL` cells. It must differ from `delimiter`.
+     * @defaultValue ";"
+     */
     arrayDelimiter?: ";" | "," | "|" | undefined;
-    /** The quote character; one character; a double quote by default. */
+    /**
+     * The quote character, one character. Cells that hold the delimiter, the quote character or a
+     * line break are quoted with it. Pass the same value as the `quote` import option to read the
+     * file back.
+     * @defaultValue '"'
+     */
     quote?: string | undefined;
     /**
-     * The property that receives explicit edge weights (`<name>:double`); "weight" by default (the
-     * importer's `weightFrom` default); null writes no weights.
+     * The relationship property that holds the edge weights, written as `<name>:double`; null
+     * writes no weights (checkExport() then returns W_WEIGHTS_DROPPED). graph-io reads the
+     * "weight" property back as the weight; for any other name, pass the same name as the
+     * `weightFrom` import option to read the weights back (`weightColumn: "strength"` with
+     * `weightFrom: "strength"`), or they come back as a plain edge attribute. A graph read from Neo4j
+     * CSV with `weightFrom` writes its weights back under the property they were read from.
+     * @defaultValue "weight", or the property a Neo4j import read the weights from
      */
     weightColumn?: string | null | undefined;
     /**
-     * The property name of the `:ID` column for nodes that have no stored-id column of their own
-     * (`<name>:ID`); null (default) writes a bare `:ID`.
+     * The property name of the `:ID` column (`<name>:ID`) for nodes that have no id property of
+     * their own; null writes a bare `:ID`.
+     * @defaultValue null
      */
     idColumn?: string | null | undefined;
 }
-/** Loss code: undirected edges (an undirected snapshot, or the folded pairs of a mixed one) written as directed relationships. */
+/**
+ * Neo4j relationships are always directed, so the edges of an undirected graph, and the undirected edges of a mixed
+ * graph, read back as directed.
+ * @category Built-in formats
+ */
 export declare const UNDIRECTED_LOSS = "W_NEO4J_UNDIRECTED_AS_DIRECTED";
-/** Loss code: node ids whose text re-imports as another type under the canonical id rule. */
+/**
+ * Node ids that read back as a different type, such as the text "7" as the number 7.
+ * @category Built-in formats
+ */
 export declare const ID_TEXT_TYPE_LOSS = "W_ID_TEXT_TYPE";
-/** Loss code: two node ids share one text; export() throws E_INVALID_ID. */
+/**
+ * Two node ids share one text; export() throws E_INVALID_ID.
+ * @category Built-in formats
+ */
 export declare const ID_TEXT_COLLISION_LOSS = "E_ID_TEXT_COLLISION";
-/** Loss code: an edge property column already uses the weight column name; export() throws E_COLUMN_EXISTS. */
+/**
+ * The `weightColumn` name is already an edge attribute; the save fails.
+ * @category Built-in formats
+ */
 export declare const WEIGHT_COLUMN_TAKEN_LOSS = "E_NEO4J_WEIGHT_COLUMN_TAKEN";
-/** Loss code: a node property column already uses the idColumn name; export() throws E_COLUMN_EXISTS. */
+/**
+ * The `idColumn` name is already a node attribute; the save fails.
+ * @category Built-in formats
+ */
 export declare const ID_COLUMN_TAKEN_LOSS = "E_NEO4J_ID_COLUMN_TAKEN";
-/** Loss code: a node has more than one stored-id column set; only the first is written. */
+/**
+ * A node has more than one stored-id column set; only the first is written.
+ * @category Built-in formats
+ */
 export declare const MULTIPLE_ID_PROPERTIES_LOSS = "W_NEO4J_MULTIPLE_ID_PROPERTIES";
-/** Loss code: a declared integer type holds non-integral values and is written as double. */
+/**
+ * A declared integer type holds non-integral values and is written as double.
+ * @category Built-in formats
+ */
 export declare const DECLARED_TYPE_CHANGED_LOSS = "W_NEO4J_DECLARED_TYPE_CHANGED";
-/** Loss code: a list item contains the array delimiter, which Neo4j cannot escape. */
+/**
+ * A list item contains the array delimiter, which Neo4j cannot escape.
+ * @category Built-in formats
+ */
 export declare const ARRAY_DELIMITER_LOSS = "W_NEO4J_ARRAY_DELIMITER";
 /**
- * The capabilities of neo4j-admin CSV (research note 07 section 9): declared scalar types and
+ * The capabilities of neo4j-admin CSV: declared scalar types and
  * arrays; a dict column reads back as string (the header has no enumeration type); a position or
  * visual column is written as a plain property (a point for a 2- or 3-component position) and
  * reads back without its role.
+ * @category Built-in formats
  */
 export declare const NEO4J_CAPABILITIES: ExportCapabilities;
-/** The Neo4j exporter. */
+/**
+ * The Neo4j exporter.
+ * @category Built-in formats
+ */
 export declare const neo4jExporter: GraphExporter<Neo4jExportOptions>;
+/**
+ * One file of exportNeo4jFiles(): the header row and the rows of one section kind.
+ * @category Built-in formats
+ */
+export interface Neo4jFile {
+    /** A file name made from the section: `nodes-Movie.csv`, `relationships-Person-Movie.csv`, or `nodes.csv` and `relationships.csv` without id spaces. */
+    readonly name: string;
+    /** Whether neo4j-admin takes the file with `--nodes` or with `--relationships`. */
+    readonly kind: "nodes" | "relationships";
+    /** The CSV text, one header row first. */
+    readonly text: string;
+}
+/**
+ * Write a graph as the separate CSV files `neo4j-admin database import` takes: one node file per id
+ * space and one relationship file per pair of endpoint id spaces, each with a single header row.
+ * `exportGraph(snapshot, "neo4j")` writes the same sections into one file, which graph-io reads
+ * back but neo4j-admin does not, since it reads one header per file. The options are the Neo4j
+ * export options (`part` limits the result to the node or the relationship files), and
+ * `checkExport(snapshot, "neo4j", options)` returns what the files lose.
+ * @param snapshot - the graph to write
+ * @param options - the Neo4j export options
+ * @returns the files, node files first
+ * @category Built-in formats
+ * @example
+ * ```ts
+ * for (const file of await exportNeo4jFiles(snapshot)) {
+ *     await writeFile(file.name, file.text);
+ * }
+ * // neo4j-admin database import full --nodes=nodes-Movie.csv --nodes=nodes-Person.csv \
+ * //     --relationships=relationships-Person-Movie.csv neo4j
+ * ```
+ */
+export declare function exportNeo4jFiles(snapshot: GraphSnapshot, options?: Neo4jExportOptions & CommonExportOptions): Promise<Neo4jFile[]>;
 //# sourceMappingURL=exporter.d.ts.map

package/dist/src/formats/neo4j/exporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exporter.d.ts","sourceRoot":"","sources":["../../../../src/formats/neo4j/exporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAuBH,OAAO,EAA4B,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAiB,MAAM,gBAAgB,CAAC;AAKtH,yDAAyD;AACzD,MAAM,WAAW,kBAAkB;IAC/B,kHAAkH;IAClH,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,eAAe,GAAG,SAAS,CAAC;IACrD,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,6EAA6E;IAC7E,cAAc,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;IAC7C,qEAAqE;IACrE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACzC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACxC;AAED,kIAAkI;AAClI,eAAO,MAAM,eAAe,mCAAmC,CAAC;AAEhE,6FAA6F;AAC7F,eAAO,MAAM,iBAAiB,mBAAoB,CAAC;AAEnD,4EAA4E;AAC5E,eAAO,MAAM,sBAAsB,wBAAyB,CAAC;AAE7D,+GAA+G;AAC/G,eAAO,MAAM,wBAAwB,gCAAgC,CAAC;AAEtE,yGAAyG;AACzG,eAAO,MAAM,oBAAoB,4BAA4B,CAAC;AAE9D,2FAA2F;AAC3F,eAAO,MAAM,2BAA2B,mCAAmC,CAAC;AAE5E,6FAA6F;AAC7F,eAAO,MAAM,0BAA0B,kCAAkC,CAAC;AAE1E,sFAAsF;AACtF,eAAO,MAAM,oBAAoB,4BAA4B,CAAC;AAkB9D;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAiB/B,CAAC;AA6nCH,0BAA0B;AAC1B,eAAO,MAAM,aAAa,EAAE,aAAa,CAAC,kBAAkB,CA8B1D,CAAC"}
+{"version":3,"file":"exporter.d.ts","sourceRoot":"","sources":["../../../../src/formats/neo4j/exporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAKH,KAAK,aAAa,EAGrB,MAAM,uBAAuB,CAAC;AAc/B,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAiB,MAAM,gBAAgB,CAAC;AAKtH;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC3D;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,eAAe,GAAG,SAAS,CAAC;IACrD;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;IAC7C;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACzC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACxC;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,mCAAmC,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,mBAAoB,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,wBAAyB,CAAC;AAE7D;;;GAGG;AACH,eAAO,MAAM,wBAAwB,gCAAgC,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,oBAAoB,4BAA4B,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,2BAA2B,mCAAmC,CAAC;AAE5E;;;GAGG;AACH,eAAO,MAAM,0BAA0B,kCAAkC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,oBAAoB,4BAA4B,CAAC;AAkB9D;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAiB/B,CAAC;AAmtCH;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,aAAa,CAAC,kBAAkB,CA+B1D,CAAC;AAQH;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,wJAAwJ;IACxJ,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mFAAmF;IACnF,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,eAAe,CAAC;IACzC,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB;AAcD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAC5B,QAAQ,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE,kBAAkB,GAAG,mBAAmB,GACnD,OAAO,CAAC,SAAS,EAAE,CAAC,CAMtB"}