lance-csr 0.0.0 → 0.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,57 @@
1
1
  # lance-csr
2
2
 
3
- This is a placeholder for the Node.js package of [lance-csr](https://github.com/hyperdimensionalcomputingai/lance-csr), an openCypher graph query engine over Lance datasets. The first release is coming soon.
3
+ A fast [openCypher](https://opencypher.org/) graph query engine over [Lance](https://lancedb.github.io/lance/)
4
+ datasets and Arrow tables, for Node.js. It is written in Rust on Apache DataFusion, and its compressed sparse row
5
+ (CSR) adjacency index turns each relationship hop into an array lookup, which makes multi-hop traversals fast.
6
+ The same engine ships as the `lance-csr` Python package and Rust crate.
7
+
8
+ **Documentation:** [lance-csr.hdclabs.ai](https://lance-csr.hdclabs.ai/), with a
9
+ [TypeScript guide](https://lance-csr.hdclabs.ai/typescript/).
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ npm install lance-csr apache-arrow
15
+ ```
16
+
17
+ Prebuilt binaries cover Linux x86-64 and aarch64 (glibc 2.28+) and Apple Silicon (macOS 11+), on Node.js 22 or
18
+ newer. The x86-64 binaries need a CPU with AVX2. On Windows, use WSL2, where the Linux binary installs. `apache-arrow` 21 is a peer dependency.
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { tableFromArrays } from "apache-arrow";
24
+ import { CypherEngine, GraphConfig } from "lance-csr";
25
+
26
+ const config = GraphConfig.builder()
27
+ .nodeTable("Person", "id")
28
+ .relTable("KNOWS", "Person", "Person", "src", "dst")
29
+ .build();
30
+ const engine = await CypherEngine.create(
31
+ config,
32
+ {
33
+ Person: tableFromArrays({
34
+ id: BigInt64Array.from([1n, 2n, 3n]),
35
+ name: ["Alice", "Bob", "Carol"],
36
+ }),
37
+ KNOWS: tableFromArrays({
38
+ src: BigInt64Array.from([1n, 2n]),
39
+ dst: BigInt64Array.from([2n, 3n]),
40
+ }),
41
+ },
42
+ { useCsr: true },
43
+ );
44
+ const result = await engine.execute(
45
+ "MATCH (a:Person {name: 'Alice'})-[:KNOWS*1..2]->(b) RETURN b.name AS friend ORDER BY friend",
46
+ );
47
+ console.log(result.toArray().map((row) => row.toJSON()));
48
+ // [ { friend: 'Bob' }, { friend: 'Carol' } ]
49
+ ```
50
+
51
+ Lance datasets on disk or object storage are passed as `{ uri, version?, storageOptions? }` and read lazily,
52
+ pinned to a version until `engine.checkoutLatest()`.
53
+
54
+ ## License
55
+
56
+ Apache-2.0. lance-csr is a fork of [lance-graph](https://github.com/lance-format/lance-graph); see the
57
+ [repository](https://github.com/hyperdimensionalcomputingai/lance-csr).
@@ -0,0 +1,73 @@
1
+ /**
2
+ * Graph configuration: which tables are nodes and which are relationships.
3
+ *
4
+ * @module
5
+ */
6
+ /**
7
+ * An immutable mapping from tables to a property graph.
8
+ *
9
+ * Create one with {@link GraphConfig.builder}; there is no public constructor. See
10
+ * [Graph schema](https://lance-csr.hdclabs.ai/graph-schema/).
11
+ */
12
+ export declare class GraphConfig {
13
+ #private;
14
+ private constructor();
15
+ /** Start a new, empty builder: the same as `new GraphConfigBuilder()`. */
16
+ static builder(): GraphConfigBuilder;
17
+ /** The configured node labels, lower-cased, in no particular order. */
18
+ nodeLabels(): string[];
19
+ /** The configured relationship types, lower-cased, in no particular order. */
20
+ relationshipTypes(): string[];
21
+ toString(): string;
22
+ }
23
+ /**
24
+ * Builds a {@link GraphConfig} from node and relationship tables.
25
+ *
26
+ * `new GraphConfigBuilder()` is the same as `GraphConfig.builder()`. Every method returns
27
+ * a new builder and leaves this one unchanged.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const config = GraphConfig.builder()
32
+ * .nodeTable("Person", "id")
33
+ * .relTable("KNOWS", "Person", "Person", "src_id", "dst_id")
34
+ * .build();
35
+ * ```
36
+ */
37
+ export declare class GraphConfigBuilder {
38
+ #private;
39
+ constructor();
40
+ /**
41
+ * Add a node table.
42
+ *
43
+ * The nodes labelled `label` are the rows of the dataset named `label`, each
44
+ * identified by its `primaryKey` column.
45
+ *
46
+ * @param label - The node label, and the name of its dataset (for example `"Person"`).
47
+ * @param primaryKey - The column that identifies each node.
48
+ * @returns A new builder with the node table added.
49
+ */
50
+ nodeTable(label: string, primaryKey: string): GraphConfigBuilder;
51
+ /**
52
+ * Add a relationship table.
53
+ *
54
+ * The edges of type `relType` are the rows of the dataset named `relType`, from
55
+ * `fromTable` nodes to `toTable` nodes. Both node tables must be added by the time
56
+ * {@link GraphConfigBuilder.build} runs.
57
+ *
58
+ * @param relType - The relationship type, and the name of its dataset (for example `"KNOWS"`).
59
+ * @param fromTable - The node table at the source end.
60
+ * @param toTable - The node table at the target end.
61
+ * @param src - The column holding the source node's primary key.
62
+ * @param dst - The column holding the target node's primary key.
63
+ * @returns A new builder with the relationship table added.
64
+ */
65
+ relTable(relType: string, fromTable: string, toTable: string, src: string, dst: string): GraphConfigBuilder;
66
+ /**
67
+ * Validate the tables and return the config.
68
+ *
69
+ * @throws {@link LanceCsrError} with code `InvalidArgument` if the configuration is
70
+ * invalid, for example when a relationship's endpoint label has no node table.
71
+ */
72
+ build(): GraphConfig;
73
+ }
package/dist/config.js ADDED
@@ -0,0 +1,120 @@
1
+ /**
2
+ * Graph configuration: which tables are nodes and which are relationships.
3
+ *
4
+ * @module
5
+ */
6
+ var _a;
7
+ import * as native from "../native.js";
8
+ import { callSync } from "./types.js";
9
+ /**
10
+ * An immutable mapping from tables to a property graph.
11
+ *
12
+ * Create one with {@link GraphConfig.builder}; there is no public constructor. See
13
+ * [Graph schema](https://lance-csr.hdclabs.ai/graph-schema/).
14
+ */
15
+ export class GraphConfig {
16
+ #spec;
17
+ #info;
18
+ constructor(spec, info) {
19
+ this.#spec = spec;
20
+ this.#info = info;
21
+ }
22
+ /** @internal Validate `spec` and wrap it; `GraphConfigBuilder.build()` calls this. */
23
+ static _build(spec) {
24
+ return new GraphConfig(spec, callSync(() => native.buildGraphConfig(spec)));
25
+ }
26
+ /** @internal The spec the native module rebuilds the config from. */
27
+ _spec() {
28
+ return this.#spec;
29
+ }
30
+ /** Start a new, empty builder: the same as `new GraphConfigBuilder()`. */
31
+ static builder() {
32
+ return new GraphConfigBuilder();
33
+ }
34
+ /** The configured node labels, lower-cased, in no particular order. */
35
+ nodeLabels() {
36
+ return [...this.#info.nodeLabels];
37
+ }
38
+ /** The configured relationship types, lower-cased, in no particular order. */
39
+ relationshipTypes() {
40
+ return [...this.#info.relationshipTypes];
41
+ }
42
+ toString() {
43
+ return `GraphConfig(nodes=${JSON.stringify(this.#info.nodeLabels)}, relationships=${JSON.stringify(this.#info.relationshipTypes)})`;
44
+ }
45
+ }
46
+ /**
47
+ * Builds a {@link GraphConfig} from node and relationship tables.
48
+ *
49
+ * `new GraphConfigBuilder()` is the same as `GraphConfig.builder()`. Every method returns
50
+ * a new builder and leaves this one unchanged.
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const config = GraphConfig.builder()
55
+ * .nodeTable("Person", "id")
56
+ * .relTable("KNOWS", "Person", "Person", "src_id", "dst_id")
57
+ * .build();
58
+ * ```
59
+ */
60
+ export class GraphConfigBuilder {
61
+ #spec;
62
+ constructor() {
63
+ this.#spec = { nodes: [], relationships: [] };
64
+ }
65
+ #with(spec) {
66
+ const builder = new _a();
67
+ builder.#spec.nodes.push(...spec.nodes);
68
+ builder.#spec.relationships.push(...spec.relationships);
69
+ return builder;
70
+ }
71
+ /**
72
+ * Add a node table.
73
+ *
74
+ * The nodes labelled `label` are the rows of the dataset named `label`, each
75
+ * identified by its `primaryKey` column.
76
+ *
77
+ * @param label - The node label, and the name of its dataset (for example `"Person"`).
78
+ * @param primaryKey - The column that identifies each node.
79
+ * @returns A new builder with the node table added.
80
+ */
81
+ nodeTable(label, primaryKey) {
82
+ return this.#with({
83
+ nodes: [...this.#spec.nodes, { label, primaryKey }],
84
+ relationships: this.#spec.relationships,
85
+ });
86
+ }
87
+ /**
88
+ * Add a relationship table.
89
+ *
90
+ * The edges of type `relType` are the rows of the dataset named `relType`, from
91
+ * `fromTable` nodes to `toTable` nodes. Both node tables must be added by the time
92
+ * {@link GraphConfigBuilder.build} runs.
93
+ *
94
+ * @param relType - The relationship type, and the name of its dataset (for example `"KNOWS"`).
95
+ * @param fromTable - The node table at the source end.
96
+ * @param toTable - The node table at the target end.
97
+ * @param src - The column holding the source node's primary key.
98
+ * @param dst - The column holding the target node's primary key.
99
+ * @returns A new builder with the relationship table added.
100
+ */
101
+ relTable(relType, fromTable, toTable, src, dst) {
102
+ return this.#with({
103
+ nodes: this.#spec.nodes,
104
+ relationships: [...this.#spec.relationships, { relType, fromTable, toTable, src, dst }],
105
+ });
106
+ }
107
+ /**
108
+ * Validate the tables and return the config.
109
+ *
110
+ * @throws {@link LanceCsrError} with code `InvalidArgument` if the configuration is
111
+ * invalid, for example when a relationship's endpoint label has no node table.
112
+ */
113
+ build() {
114
+ return GraphConfig._build({
115
+ nodes: [...this.#spec.nodes],
116
+ relationships: [...this.#spec.relationships],
117
+ });
118
+ }
119
+ }
120
+ _a = GraphConfigBuilder;