Metadata-Version: 2.4
Name: cypherglot
Version: 0.1.0
Summary: Cypher frontend compiler that lowers Neo4j-like Cypher into SQLGlot AST
Project-URL: Homepage, https://github.com/humemai/cypherglot
Project-URL: Documentation, https://docs.humem.ai/cypherglot/
Project-URL: Repository, https://github.com/humemai/cypherglot
Project-URL: Issues, https://github.com/humemai/cypherglot/issues
Author: HumemAI
License:                                  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.
License-File: LICENSE
Keywords: compiler,cypher,database,graph,sqlglot
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Compilers
Requires-Python: >=3.10
Requires-Dist: antlr4-python3-runtime<5,>=4.13
Requires-Dist: sqlglot[c]<31,>=30.6.0
Description-Content-Type: text/markdown

# CypherGlot

CypherGlot is the Cypher frontend compiler for the HumemAI stack.

[![Docs](https://img.shields.io/badge/docs-humem.ai-0f766e)](https://docs.humem.ai/cypherglot/)
[![Test](https://github.com/humemai/cypherglot/actions/workflows/test.yml/badge.svg)](https://github.com/humemai/cypherglot/actions/workflows/test.yml)
[![Build Docs](https://github.com/humemai/cypherglot/actions/workflows/build-docs.yml/badge.svg)](https://github.com/humemai/cypherglot/actions/workflows/build-docs.yml)
[![Generated Frontend](https://github.com/humemai/cypherglot/actions/workflows/generated-cypher.yml/badge.svg)](https://github.com/humemai/cypherglot/actions/workflows/generated-cypher.yml)
[![Publish PyPI](https://github.com/humemai/cypherglot/actions/workflows/publish-pypi.yml/badge.svg)](https://github.com/humemai/cypherglot/actions/workflows/publish-pypi.yml)

---

## ✨ What CypherGlot is

It takes Neo4j-like Cypher, enforces an explicit admitted subset, normalizes the
accepted shape, and lowers it into SQLGlot-backed output that another runtime can
plan and execute.

The compatibility target is Neo4j-valid first: admitted queries should ideally
be valid on Neo4j unchanged, while other Cypher runtimes such as ArcadeDB and
Ladybug may still require small compatibility rewrites around that same subset.

```text
raw Cypher string
→ parse
→ validate admitted subset
→ normalize
→ graph-relational IR
→ backend-aware lowering
→ SQLGlot AST or SQL-backed program
```

CypherGlot is intentionally compiler-only.

- It parses and lowers Cypher.
- It does not execute SQL.
- It does not own storage.
- It does not execute vector search.

## 🎯 What it is for

- a reusable Cypher frontend compiler
- a stable boundary between Cypher parsing and host-runtime execution
- SQLGlot-backed output for embedded runtimes such as HumemDB

## Current backend direction

CypherGlot targets equal multi-dialect SQL support through a backend-neutral IR
plus backend-aware lowering.

- the intended compiler path is now `Cypher AST -> normalize ->
  graph-relational IR -> backend-aware lowering -> SQLGlot AST/program -> SQL`
- SQLite has an executable lowering path through the shared IR
- DuckDB now has an explicit lowering path from the same shared architecture;
  support claims remain strict
- PostgreSQL is part of the same IR-based backend path
- `dialect=...` rendering support remains useful for string output experiments
  and host integration work, but rendering alone is still not a portability
  guarantee
- a backend counts as supported only when admitted Cypher shapes execute
  correctly against that backend's schema and runtime contract

HumemDB is the main reference host runtime for the current SQLite-backed
execution contract.

## Graph-to-table schema contract

CypherGlot’s output is schema-aware. If you want to execute its compiled SQL,
your runtime needs to provide the graph-to-table layout that the compiler
expects.

CypherGlot uses a generated type-aware schema contract.

The target contract is:

- one table per node type
- one table per edge type
- typed property columns instead of one catch-all `properties` blob
- explicit `from_id` and `to_id` foreign keys on edge tables
- traversal-oriented indexes on generated edge tables

For a graph schema with node types `User` and `Company`, and an edge type
`WORKS_AT(User -> Company)`, the target SQLite contract looks like:

```sql
PRAGMA foreign_keys = ON;
PRAGMA journal_mode = WAL;
PRAGMA synchronous = NORMAL;

CREATE TABLE cg_node_user (
  id INTEGER PRIMARY KEY,
  name TEXT NOT NULL,
  age INTEGER
) STRICT;

CREATE TABLE cg_node_company (
  id INTEGER PRIMARY KEY,
  name TEXT NOT NULL
) STRICT;

CREATE TABLE cg_edge_works_at (
  id INTEGER PRIMARY KEY,
  from_id INTEGER NOT NULL,
  to_id INTEGER NOT NULL,
  since INTEGER,
  FOREIGN KEY (from_id) REFERENCES cg_node_user(id) ON DELETE CASCADE,
  FOREIGN KEY (to_id) REFERENCES cg_node_company(id) ON DELETE CASCADE
) STRICT;

CREATE INDEX idx_cg_edge_works_at_from_id ON cg_edge_works_at(from_id);
CREATE INDEX idx_cg_edge_works_at_to_id ON cg_edge_works_at(to_id);
CREATE INDEX idx_cg_edge_works_at_from_to ON cg_edge_works_at(from_id, to_id);
CREATE INDEX idx_cg_edge_works_at_to_from ON cg_edge_works_at(to_id, from_id);
```

Recommended baseline indexes:

```sql
CREATE INDEX idx_cg_edge_works_at_from_id ON cg_edge_works_at(from_id);
CREATE INDEX idx_cg_edge_works_at_to_id ON cg_edge_works_at(to_id);
CREATE INDEX idx_cg_edge_works_at_from_to ON cg_edge_works_at(from_id, to_id);
CREATE INDEX idx_cg_edge_works_at_to_from ON cg_edge_works_at(to_id, from_id);
```

CypherGlot's schema contract is the generated type-aware layout rather than a
generic `nodes` / `edges` / `node_labels` family.

That contract is intentionally performance-oriented and currently assumes one
stored node type per physical node table row rather than native multi-label
nodes. This is a storage-contract tradeoff, not a claim about Cypher
semantics; broader label membership would require a different schema path.

See the dedicated guide for the full schema contract, column semantics, and
indexing notes:

- [Schema Contract](https://docs.humem.ai/cypherglot/guide/schema-contract/)

## ✅ Current status

CypherGlot targets a strong onboarding-oriented, read-heavy Neo4j subset with
narrow write flows and bounded traversal support, not broad Neo4j parity.

Neo4j is the reference Cypher engine for this admitted surface.
CypherGlot's SQL backends execute that subset through compilation, while direct
Cypher runtimes outside Neo4j may still need light query adaptation in a few
compatibility-path cases.

The public surface covers:

- parsing through the vendored openCypher grammar
- admitted-subset validation
- normalization into repo-owned statement objects
- compilation of admitted single-statement shapes into one SQLGlot `Expression`
- compilation of admitted multi-step write shapes into a small SQL-backed program
- thin SQL rendering helpers over the compiled output

The most useful admitted families are:

- `MATCH ... RETURN`
- narrow standalone `OPTIONAL MATCH ... RETURN`
- narrow `MATCH ... WITH ... RETURN`
- narrow standalone `UNWIND ... RETURN`
- standalone `CREATE`
- `MATCH ... SET`
- `MATCH ... DELETE`
- narrow `MATCH ... CREATE` relationship writes
- grouped `count(...)`, `count(*)`, `sum(...)`, `avg(...)`, `min(...)`, and `max(...)`
- common scalar, predicate, graph-introspection, string, numeric, conversion, and
  narrow multi-argument computed projections over already admitted inputs

Vector-aware `CALL db.index.vector.queryNodes(...)` shapes are validated and
normalized for host runtimes, but they are not compiled into SQLGlot output yet.

## Benchmark evidence

Current checked-in benchmark artifacts live under `scripts/benchmarks/results/`.
The current repo evidence set includes:

- a checked-in compiler summary Markdown artifact
- a checked-in large runtime matrix summary Markdown artifact across the current
  `11` backend/index paths
- a checked-in repeated schema-shape summary Markdown artifact across the
  small, medium, and large presets

See the benchmark guide for methodology, result interpretation, and the
important caveat that SQLite, DuckDB, and PostgreSQL are compile-plus-execute
paths while Neo4j, ArcadeDB Embedded, and LadybugDB are direct Cypher runtimes.

## Public API at a glance

The stable entrypoints are:

- `parse_cypher_text(text)`
- `validate_cypher_text(text)`
- `normalize_cypher_text(text)`
- `graph_schema_from_text(text)`
- `schema_ddl_from_text(text, backend)`
- `to_sqlglot_ast(text)`
- `to_sqlglot_program(text)`
- `to_sql(text, dialect=...)`
- `render_cypher_program_text(text, dialect=...)`

Lower-level `compile_*`, `normalize_*`, and `render_compiled_*` helpers remain
available for implementation-facing use.

## Schema definition surface

CypherGlot now also accepts a small graph-native schema-definition surface above
the raw `GraphSchema(...)` Python API. That lets hosts define graph types in
graph terms and lower them through the same generated backend DDL path.

```python
import cypherglot

schema = cypherglot.graph_schema_from_text(
  """
  CREATE NODE User (name STRING NOT NULL, age INTEGER);
  CREATE NODE Company (name STRING NOT NULL);
  CREATE EDGE WORKS_AT FROM User TO Company (since INTEGER);
  """
)

ddl = cypherglot.schema_ddl_from_text(
  """
  CREATE NODE User (name STRING NOT NULL, age INTEGER);
  CREATE NODE Company (name STRING NOT NULL);
  CREATE EDGE WORKS_AT FROM User TO Company (since INTEGER);
  CREATE INDEX user_name_idx ON NODE User(name);
  """,
  backend="sqlite",
)
```

`CREATE INDEX` is admitted only for workload-specific property indexes on typed
node or edge properties. Baseline edge traversal indexes are still generated
automatically and should not be re-declared through this surface.

## Logging

CypherGlot uses the standard library `logging` module.

- it stays silent by default
- it does not configure the root logger
- it installs a `NullHandler` on the `cypherglot` package logger so library use
  does not emit warnings or force host logging policy

When a host runtime wants compiler diagnostics, enable `DEBUG` on the
`cypherglot` logger:

```python
import logging

logging.basicConfig(level=logging.INFO)
logging.getLogger("cypherglot").setLevel(logging.DEBUG)
```

Current level semantics:

- `DEBUG`: parse, validate, normalize, compile, and render pipeline events,
  including schema-layout and dialect decisions at public entrypoints
- `INFO`: reserved for explicit high-value lifecycle events; CypherGlot does not
  currently emit routine `INFO` logs
- `WARNING`: reserved for degraded or compatibility-path behavior
- `ERROR`: reserved for internal failures rather than ordinary admitted-subset
  rejection

Ordinary validation rejection remains an exception path, not an `ERROR` log.

## 🔗 Documentation

- [CypherGlot docs](https://docs.humem.ai/cypherglot/)

The admitted language boundary is documented in the docs site and kept honest by
regression tests.

## 🧠 What is supported today

- parsing through the vendored openCypher grammar
- admitted-subset validation
- normalization into repo-owned statement objects
- compilation of admitted single-statement shapes into one SQLGlot `Expression`
- compilation of admitted multi-step write shapes into a small SQL-backed program
- thin SQL rendering helpers over the compiled output

Main admitted query families today:

- `MATCH ... RETURN`
- narrow standalone `OPTIONAL MATCH ... RETURN`
- narrow `MATCH ... WITH ... RETURN`
- narrow standalone `UNWIND ... RETURN`
- standalone `CREATE`
- `MATCH ... SET`
- `MATCH ... DELETE`
- narrow `MATCH ... CREATE` relationship writes
- grouped `count(...)`, `count(*)`, `sum(...)`, `avg(...)`, `min(...)`, and `max(...)`
- common scalar, predicate, graph-introspection, string, numeric, conversion, and
  narrow multi-argument computed projections over already admitted inputs

That is intentionally a practical mainstream single-hop subset for onboarding,
not a full Cypher compatibility claim.

## ⚡ Quick examples

Parse and validate one admitted read:

```python
import cypherglot

text = "MATCH (u:User) WHERE u.name = $name RETURN u.name ORDER BY u.name LIMIT 1"

parsed = cypherglot.parse_cypher_text(text)
assert not parsed.has_errors

cypherglot.validate_cypher_text(text)
normalized = cypherglot.normalize_cypher_text(text)

print(type(normalized).__name__)
```

Compile a single-statement read to SQLGlot AST or SQL text:

```python
expression = cypherglot.to_sqlglot_ast(
    "MATCH (u:User) WHERE u.name = $name RETURN u.name ORDER BY u.name LIMIT 1"
)

print(expression.sql())

sql = cypherglot.to_sql(
    "MATCH (u:User) WHERE u.name = $name RETURN u.name ORDER BY u.name LIMIT 1"
)

print(sql)
```

Compile a multi-step write shape to a SQL-backed program:

```python
program = cypherglot.to_sqlglot_program(
    "MATCH (x:Begin) CREATE (x)-[:TYPE]->(:End {name: 'finish'})"
)

rendered = cypherglot.render_cypher_program_text(
    "MATCH (x:Begin) CREATE (x)-[:TYPE]->(:End {name: 'finish'})"
)

print(type(program).__name__)
print(rendered.steps[0])
```

## Install

CypherGlot supports Python 3.10 and newer.

Install from PyPI:

```bash
uv pip install cypherglot
```

Install from source in editable mode:

```bash
uv pip install -e .
```

## Development

Set up the local environment:

```bash
uv sync --group test --group docs
```

Run the tests:

```bash
uv run pytest
```

Run the PostgreSQL runtime suite against a disposable local container:

```bash
scripts/dev/run_postgresql_runtime_docker.sh
```

Check the generated frontend state:

```bash
scripts/dev/regenerate_cypher_frontend_docker.sh --check
```

Build the docs locally:

```bash
uv run mkdocs build --strict
```

## 🔗 Quick links

- Docs: [docs.humem.ai/cypherglot](https://docs.humem.ai/cypherglot/)
- Repository: [github.com/humemai/cypherglot](https://github.com/humemai/cypherglot)
- Issues: [github.com/humemai/cypherglot/issues](https://github.com/humemai/cypherglot/issues)

## 📦 Packaging

CypherGlot is a pure Python package today. It ships compiler code and generated
frontend artifacts, but it does not ship a database runtime or platform-specific
service layer.

The public package version comes from Git tags through Hatch VCS.

## 📄 License

CypherGlot is licensed under MIT. See `LICENSE`.
