docs: standardize table/label naming to LDBC/Neo4j convention and fix Cypher keyword casing#573
Open
longbinlai wants to merge 10 commits into
Open
docs: standardize table/label naming to LDBC/Neo4j convention and fix Cypher keyword casing#573longbinlai wants to merge 10 commits into
longbinlai wants to merge 10 commits into
Conversation
…on.md and merge_clause.md - transaction.md: WorksAt → WORKS_AT - merge_clause.md: follows → FOLLOWS
…KNOWS/CREATED/Software)
…des, UPPERCASE rels)
…NOWS/Software/CREATED)
Standardize all documentation to use: - Node labels: PascalCase (Person, Software, Company, User) - Relationship labels: UPPERCASE_SNAKE (KNOWS, CREATED, WORKS_FOR, FRIENDS) - Cypher keywords: ALL-CAPS (MATCH, RETURN, WHERE, etc.) - DDL: CREATE NODE TABLE / CREATE REL TABLE (not CREATE TABLE) This fixes inconsistencies where different docs mixed lowercase (person, knows), PascalCase (Person, Company), UPPERCASE (KNOWS, WORKS_FOR), and even camelCase (WorksAt) labels. Fixes alibaba#572
…s_api database - ddl_clause.md: person→Person, knows→KNOWS in all DDL examples - load_parquet.md: person→Person, knows→KNOWS in COPY TO examples - nodejs_api/database.md: person→Person, knows→KNOWS, CREATE TABLE→CREATE NODE/REL TABLE
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #572
This PR standardizes table/label naming and Cypher keyword casing across all NeuG documentation to eliminate inconsistencies that could confuse users.
Naming Convention (LDBC/Neo4j Style)
Person,Software,Company,UserKNOWS,CREATED,WORKS_FOR,FRIENDSMATCH,RETURN,WHERE,ORDER BY,LIMITCREATE NODE TABLE,CREATE REL TABLEChanges
Label Naming (Node → PascalCase, Rel → UPPERCASE_SNAKE)
Cypher Manual:
match_clause.md,where_clause.md,return_clause.md,order_clause.md,limit_clause.md,with_clause.md,union_clause.md,merge_clause.md,dml_clause.md,index.mdperson→Person,software→Softwareknows→KNOWS,created→CREATED_LABEL,_SRC_LABEL,_DST_LABEL)Data I/O:
import_data.md: Unified all examples toPerson/KNOWS/User/FRIENDS/WORKS_FORexport_data.md:person→Person,knows→KNOWS(including JSON output)load_data.md: Updated label referencesOther Docs:
transaction.md:WorksAt→WORKS_ATdata_types.md: All label references in tables and examplesextensions/load_httpfs.md:Personin COPY TO examplesPython API Reference:
database.md,connection.md:CREATE TABLE→CREATE NODE TABLE/CREATE REL TABLETutorials:
benchmark-neug-dual-mode.md: Labels in descriptive textCypher Keyword Casing (Title Case → ALL-CAPS)
9 files updated:
Match→MATCH,Return→RETURN,Where→WHERE,Order BY→ORDER BY,Limit→LIMIT,Skip→SKIP,With→WITHTest Updates
test_data_io_docs.py: Updated to match new doc examples (Person/KNOWS/Software/CREATED)test_merge.py:follows→FOLLOWSNode.js API Reference
connection.md: Fixed DDL syntax referencesNot Changed
studyAt/workAt, CodeGraphFunction/CALLS) — these match their actual datasetsperson.csv,knows.csv) — only Cypher labels changed