lance-csr 0.1.0__tar.gz

lance_csr-0.1.0/Cargo.toml

@@ -0,0 +1,9 @@
+[workspace]
+members = [
+    "crates/lance-graph",
+    "crates/lance-graph-catalog",
+    "crates/lance-graph-benches",
+]
+# Python package needs to be built by maturin.
+exclude = ["crates/lance-graph-python"]
+resolver = "2"

lance_csr-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lance_csr-0.1.0/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: lance-csr
+Version: 0.1.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering
+Requires-Dist: pyarrow>=14
+Requires-Dist: pylance>=13.0.0,<14
+Requires-Dist: ruff ; extra == 'dev'
+Requires-Dist: pyright ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'tests'
+Requires-Dist: pandas ; extra == 'tests'
+Requires-Dist: ruff ; extra == 'tests'
+Provides-Extra: dev
+Provides-Extra: tests
+License-File: LICENSE
+Summary: Cypher graph queries over Lance datasets, built on DataFusion with a CSR adjacency index (a fork of lance-graph)
+Keywords: graph,cypher,lance,arrow
+Author-email: Lance Devs <dev@lancedb.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# lance-csr
+
+A fork of [lance-graph](https://github.com/lance-format/lance-graph): a Rust Cypher query engine over
+Lance datasets and Arrow tables, built on Apache DataFusion, with Python bindings. Not affiliated with or
+endorsed by the lance-graph maintainers.
+
+## Installation
+
+```bash
+pip install lance-csr
+```
+
+Prebuilt wheels are published for Linux x86-64 (glibc 2.28 or newer: RHEL 8, Ubuntu 20.04 and later)
+and native Apple Silicon (macOS 11 or newer), for CPython 3.12 and later. Installing from a wheel needs
+no Rust toolchain; to make sure pip never falls back to compiling from source, use:
+
+```bash
+pip install --only-binary=:all: lance-csr
+```
+
+Other platforms install from the source distribution, which needs Rust and `protoc`.
+
+## Quick Start
+
+### 1. Simple Cypher Query
+
+```python
+import pyarrow as pa
+from lance_csr import CypherQuery, GraphConfig
+
+cfg = (
+    GraphConfig.builder()
+    .with_node_label("Person", "id")
+    .with_node_label("City", "id")
+    .with_relationship("lives_in", "src", "dst")
+    .build()
+)
+
+datasets = {
+    "Person": pa.table({"id": [1, 2], "name": ["Alice", "Bob"]}),
+    "City": pa.table({"id": [10, 20], "name": ["London", "Sydney"]}),
+    "lives_in": pa.table({"src": [1, 2], "dst": [10, 20]}),
+}
+
+query = """
+    MATCH (p:Person)-[:lives_in]->(c:City)
+    RETURN p.name, c.name
+"""
+
+result = CypherQuery(query).with_config(cfg).execute(datasets)
+print(result.to_pylist())
+
+[{'p.name': 'Alice', 'c.name': 'London'}, {'p.name': 'Bob', 'c.name': 'Sydney'}]
+```
+
+### 2. Multi-Query Execution with CypherEngine
+
+For executing multiple queries against the same datasets, use `CypherEngine` to cache the catalog and achieve better performance:
+
+```python
+import pyarrow as pa
+from lance_csr import CypherEngine, GraphConfig
+
+cfg = (
+    GraphConfig.builder()
+    .with_node_label("Person", "id")
+    .with_node_label("City", "id")
+    .with_relationship("lives_in", "src", "dst")
+    .build()
+)
+
+datasets = {
+    "Person": pa.table({"id": [1, 2], "name": ["Alice", "Bob"], "age": [30, 25]}),
+    "City": pa.table({"id": [10, 20], "name": ["London", "Sydney"]}),
+    "lives_in": pa.table({"src": [1, 2], "dst": [10, 20]}),
+}
+
+# Create engine once - builds catalog
+engine = CypherEngine(cfg, datasets)
+
+# Execute multiple queries efficiently - catalog is reused
+result1 = engine.execute("MATCH (p:Person) WHERE p.age > 25 RETURN p.name")
+result2 = engine.execute("MATCH (p:Person)-[:lives_in]->(c:City) RETURN p.name, c.name")
+result3 = engine.execute("MATCH (p:Person) RETURN count(*) as total")
+
+print(result1.to_pylist())
+# [{'p.name': 'Alice'}]
+```
+
+### 3. Lance datasets: snapshots, refresh and streaming
+
+`CypherEngine` reads Lance datasets lazily from storage (projections and filters are pushed into the
+scan). Each dataset is pinned to the version you pass in; later writes are visible only after
+`refresh()`. Use `execute_batches()` to stream large results instead of materializing a table.
+
+```python
+import lance
+from lance_csr import CypherEngine, GraphConfig
+
+config = GraphConfig.builder().with_node_label("Person", "id").build()
+engine = CypherEngine(config, {"Person": lance.dataset("people.lance")})
+
+engine.execute("MATCH (p:Person) RETURN count(*)")   # sees the pinned version
+engine.refresh()                                       # move to the latest version
+for batch in engine.execute_batches("MATCH (p:Person) RETURN p.id"):
+    ...                                                # pyarrow.RecordBatch, one at a time
+```
+
+Experimental: `CypherEngine(config, datasets, use_csr=True)` answers single-hop patterns over integer ids
+with an in-memory CSR adjacency, and fetches target rows by position instead of joining. The CSR is
+rebuilt on `refresh()` when the relationship table changes, and the per-label id index when its node
+table changes. Results are identical; peak memory grows by about 70 bytes per edge (both directions).
+
+Write Lance data with `pylance` 13.x: the engine is built against Lance 13 and older or newer
+majors may write files it cannot read.
+
+### 4. Tables created with LanceDB
+
+LanceDB tables are Lance datasets on disk. Pass the dataset behind each table with
+`table.to_lance()`. Passing the LanceDB `Table` object itself raises a `TypeError`.
+
+```python
+import lancedb
+from lance_csr import CypherEngine, GraphConfig
+
+db = lancedb.connect("./mydb")
+people, knows = db.open_table("Person"), db.open_table("KNOWS")
+
+config = (
+    GraphConfig.builder()
+    .with_node_label("Person", "id")
+    .with_relationship("KNOWS", "src", "dst")
+    .build()
+)
+engine = CypherEngine(config, {"Person": people.to_lance(), "KNOWS": knows.to_lance()})
+
+knows.add(new_edges)   # keep writing with the LanceDB API
+engine.refresh()       # the engine sees the new version
+```
+
+- Reads are lazy and pinned to the version you pass in, exactly as with `lance.dataset(...)`.
+- `table.to_arrow()` also works, but loads the whole table into memory and never refreshes.
+- Tested with LanceDB 0.40.0 on local tables, which write Lance file format 2.2. A LanceDB release that
+  bundles a newer Lance major may write files this engine cannot read.
+- Not supported: LanceDB Cloud (remote tables have no `to_lance()`), and tables opened through a
+  namespace connection, which are rejected rather than reopened without their credentials.
+  Object-store tables (S3 and similar) have not been tested.
+
+### 5. Direct SQL Queries
+
+For data analytics workflows where you prefer standard SQL over Cypher, use `SqlQuery` or `SqlEngine`. No `GraphConfig` is needed — write explicit JOINs against your tables directly:
+
+```python
+import pyarrow as pa
+from lance_csr import SqlQuery, SqlEngine
+
+person = pa.table({
+    "id": [1, 2, 3],
+    "name": ["Alice", "Bob", "Carol"],
+    "age": [28, 34, 29],
+})
+knows = pa.table({"src_id": [1, 1, 2], "dst_id": [2, 3, 3]})
+datasets = {"person": person, "knows": knows}
+
+# One-off query
+result = SqlQuery(
+    "SELECT p.name, p.age FROM person p WHERE p.age > 30"
+).execute(datasets)
+print(result.to_pylist())
+# [{'name': 'Bob', 'age': 34}]
+
+# Multi-query with cached context
+engine = SqlEngine(datasets)
+r1 = engine.execute("SELECT COUNT(*) AS cnt FROM person")
+r2 = engine.execute(
+    "SELECT p1.name AS person, p2.name AS friend "
+    "FROM person p1 "
+    "JOIN knows k ON p1.id = k.src_id "
+    "JOIN person p2 ON p2.id = k.dst_id"
+)
+```
+
+## Requirements
+
+- Python 3.12 or newer (3.12, 3.13 and 3.14 tested); macOS arm64 or Linux x86-64
+- `pylance` 13.x for writing Lance datasets
+
+## Contributing
+
+### Quick start
+
+```bash
+cd python
+uv venv --python 3.12 .venv
+source .venv/bin/activate
+uv pip install maturin[patchelf]
+uv pip install -e '.[tests]'
+maturin develop
+pytest python/tests/ -v
+```
+
+### Development workflow
+
+For linting and type checks:
+
+```bash
+# Install dev dependencies
+uv pip install -e '.[dev]'
+
+# Run linters and type checker
+ruff format python/              # format code
+ruff check python/               # lint code
+pyright                          # type check
+
+# Run specific tests
+pytest python/tests/test_graph.py::test_basic_node_selection -v
+
+# Rebuild extension after Rust changes
+maturin develop
+```
+
+> If another virtual environment is already active, run `deactivate` (or
+> `unset VIRTUAL_ENV`) before invoking `uv run` so uv binds to `.venv`.
+
+## Repository layout
+
+- `crates/lance-graph-python/src/` – PyO3 bridge that exposes graph APIs to Python
+- `python/python/lance_csr/` – pure-Python wrapper and `__init__`
+- `python/benchmarks/` – catalog-reuse and bounded-memory benchmarks
+- `python/python/tests/` – graph-centric functional tests
+
+For more information on development setup, building from source, running tests, and code quality guidelines, see [DEVELOPMENT.md](./DEVELOPMENT.md).
+
+## License
+
+Apache 2.0
+
+## Links
+
+- Upstream: [lance-format/lance-graph](https://github.com/lance-format/lance-graph)
+