Skip to content

Commit e5e4068

Browse files
committed
docs(gfql): clarify cypher translation intent
1 parent 34d25af commit e5e4068

3 files changed

Lines changed: 10 additions & 4 deletions

File tree

docs/source/gfql/hop_bounds.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"source": [
88
"# Hop ranges, slices, and labels\n",
99
"\n",
10-
"GFQL examples for bounded hops, output slices, and labeling (Cypher-style patterns like `(a)-[*2..4]->(b)`).\n",
10+
"GFQL examples for bounded hops, output slices, and labeling, including the same traversal intent often written in Cypher as `(a)-[*2..4]->(b)` after translation into native GFQL.\n",
1111
"\n",
1212
"- Exact and ranged hops (`min_hops`/`max_hops`)\n",
1313
"- Post-filtered output slices (`output_min_hops`/`output_max_hops`)\n",
@@ -558,7 +558,7 @@
558558
"id": "3468c224",
559559
"metadata": {},
560560
"source": [
561-
"Range 1..3 hops from 'a' (unlabeled) to mirror a Cypher pattern like `(a)-[*1..3]->(?)`.\n"
561+
"Range 1..3 hops from 'a' (unlabeled), expressing the same traversal intent as a Cypher pattern like `(a)-[*1..3]->(?)` after translation into native GFQL.\n"
562562
]
563563
},
564564
{

docs/source/gfql/spec/cypher_mapping.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,8 @@ Rows using `[*...]` below show the native GFQL rewrite for the same traversal
256256
intent. They are semantic mappings, not a claim that direct
257257
`g.gfql("MATCH ...")` currently accepts those `[*...]` string forms.
258258

259-
| Cypher | Python | Wire Protocol (compact) |
260-
|--------|--------|-------------------------|
259+
| Cypher / intent | Python | Wire Protocol (compact) |
260+
|-----------------|--------|-------------------------|
261261
| `-[]->` | `e_forward()` | `{"type": "Edge", "direction": "forward"}` |
262262
| `-[r:KNOWS]->` | `e_forward({"type": "KNOWS"}, name="r")` | `{"type": "Edge", "direction": "forward", "edge_match": {"type": "KNOWS"}, "name": "r"}` |
263263
| `<-[r]-` | `e_reverse(name="r")` | `{"type": "Edge", "direction": "reverse", "name": "r"}` |

docs/source/gfql/translate.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ GFQL (GraphFrame Query Language) is designed to be intuitive for users familiar
1212

1313
GFQL operates on graph DataFrames - graphs represented as node and edge DataFrames. This DataFrame-native approach enables seamless integration with the PyData ecosystem and natural vectorization for both CPU and GPU processing.
1414

15+
This page is translation-first rather than a support matrix for direct
16+
``g.gfql("MATCH ...")`` string execution. Some Cypher snippets below express
17+
the same graph-query intent as native GFQL but are not yet accepted verbatim by
18+
the current direct Cypher surface. For the currently supported direct string
19+
forms, see :doc:`/gfql/cypher`.
20+
1521
Who Is This Guide For?
1622
----------------------
1723

0 commit comments

Comments
 (0)