Skip to content

docs(gfql): document cypher-style row pipeline RETURN semantics#932

Merged
lmeyerov merged 23 commits intomasterfrom
feat/gfql-cypher-return-pipeline-docs
Mar 7, 2026
Merged

docs(gfql): document cypher-style row pipeline RETURN semantics#932
lmeyerov merged 23 commits intomasterfrom
feat/gfql-cypher-return-pipeline-docs

Conversation

@lmeyerov
Copy link
Copy Markdown
Contributor

@lmeyerov lmeyerov commented Mar 5, 2026

Summary

  • document GFQL row-pipeline primitives for Cypher-style MATCH ... RETURN workflows
  • clarify where (same-path constraints) vs where_rows (row-table filtering)
  • add explicit Cypher -> GFQL -> wire-protocol mapping examples for RETURN, ORDER BY, LIMIT, and GROUP BY
  • add navigation/caveat updates in GFQL index docs

Dependency

New/updated examples

Graph-pattern WHERE (same-path constraint)

from graphistry import n, e_forward, col, compare

g.gfql(
    [
        n({"type": "account"}, name="a"),
        e_forward(name="e"),
        n({"type": "user"}, name="c"),
    ],
    where=[compare(col("a", "owner_id"), "==", col("c", "owner_id"))],
)

Row-pipeline RETURN flow

from graphistry import n, e_forward, gt
from graphistry.compute import rows, where_rows, return_, order_by, limit

result = g.gfql([
    n({"type": "Person"}),
    e_forward({"type": "FOLLOWS"}),
    n({"type": "Person", "score": gt(0)}, name="p"),
    rows(table="nodes", source="p"),
    where_rows(expr="score >= 50"),
    return_(["id", "name", "score"]),
    order_by([("score", "desc"), ("name", "asc")]),
    limit(10),
])

Validation

  • ruff check docs/source
  • python -m py_compile graphistry/compute/gfql/row_pipeline_mixin.py
  • PYTHONPATH=. pytest graphistry/tests/compute/gfql/test_expr_parser.py graphistry/tests/compute/gfql/test_row_pipeline_ops.py -q

@lmeyerov lmeyerov force-pushed the feat/gfql-cypher-return-pipeline branch from a64fc3f to 71aecf8 Compare March 6, 2026 05:30
@lmeyerov lmeyerov force-pushed the feat/gfql-cypher-return-pipeline-docs branch 3 times, most recently from 825042b to 0fb7d19 Compare March 7, 2026 23:22
lmeyerov added 23 commits March 7, 2026 15:25
@lmeyerov lmeyerov force-pushed the feat/gfql-cypher-return-pipeline-docs branch from 0fb7d19 to 739dea9 Compare March 7, 2026 23:26
@lmeyerov lmeyerov changed the base branch from feat/gfql-cypher-return-pipeline to master March 7, 2026 23:26
@lmeyerov lmeyerov merged commit 06027fd into master Mar 7, 2026
31 checks passed
@lmeyerov lmeyerov deleted the feat/gfql-cypher-return-pipeline-docs branch March 7, 2026 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant