Repository navigation
Conversation
Brings the docs in line with turingdb 3.1 (PyPI 3.1, npm 3.1.0). Every Cypher example in query/ (382 of them) was run against a 3.1 server, and the Python and JavaScript snippets against fresh 3.1 servers. Protocol and clients: - the server speaks only the binary protocol over HTTP/1.1, so the HTTP API section, USE_TURING_PROTO, TURINGDB_TYPE and type="json" are gone; commands.mdx gains a "Connecting clients" section; - TuringDB(host="localhost", port=6666) replaces the URL form, which 3.1 rejects, on every page; the Python SDK reference covers the two backends, the new connection errors, turingdb.Point and parameter types; - troubleshooting is rewritten around the errors 3.1 raises. New JavaScript SDK pages (jssdk/): get started for Node.js, TypeScript and the browser (same-origin proxy, Vite optimizeDeps.exclude, nginx), and a reference for options, columns, value and parameter types, versioning and errors. Query language: parameters for values, map projection and m['key'], SET n = map / SET n += map, points and spatial functions, exists() over a pattern, allReduce, IS label tests, elementId, isEmpty, coll.indexOf, split on a list, datetime of a map, sum/avg of durations, /* */ comments, keywords as names, UNION/NEXT/WHEN inside every subquery, COLLECT of maps and paths, paths as flat ID lists, writes from map rows without conversion, ID lookups with literal lists and parameters, and the 3.0 -> 3.1 behaviour changes. Release notes: a new "Release Notes" group with an overview of all releases and a TuringDB 3.1 page built around query parameters, the binary protocol over HTTP/1.1, the WebAssembly-based TypeScript client, allReduce, COLLECT and other subqueries, and points with haversine distance, plus six pixel icons for its highlight cards and a banner on the home page.
Rewraps the code lines that made a block scroll sideways, on every page, and makes the opening of the 3.1 release page gentler. Code layout (128 overflowing blocks before, 6 after): - Cypher breaks before relationships, after RETURN items, and around CASE, FOREACH, COLLECT bodies and point calls; VECTOR SEARCH and CALL put YIELD on its own line; - Python splits long query strings by implicit concatenation and moves trailing comments above their line; JavaScript does the same with +; - the six blocks left are JSONL records, a Jupyter log and CLI sessions, which must stay one line per record or command. Checked against the previous text: Python ASTs and JavaScript token streams are unchanged, and every changed Cypher query gives the same result on a 3.1 server. The few intended changes were run too: - the shortest-path recipe passes node IDs as a $ids parameter instead of an f-string (same stations); - the vector CSV writer, the release and JS reference parameter examples, and the JS get-started loop use a named variable (same output); - allReduce examples name the accumulator t, and query/functions names its columns under10 and under5 (same values); - the cosine/euclidean pair in vector-search is two queries. Release page: simpler intro paragraphs, and a first point in the parser section on its speed (23 µs instead of 54 µs for a 12-line query).
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
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.
Updates the docs for TuringDB 3.1 and adds a Release Notes section with a 3.1 release page.
What changes
Protocol and clients
USE_TURING_PROTO,TURINGDB_TYPEandtype="json"are removed.commands.mdxgains a "Connecting clients" section.TuringDB(host="http://localhost:6666")raises in 3.1, so every page now usesTuringDB(host="localhost", port=6666).native,embedded), the new connection errors,turingdb.Point, parameter types and the result types.fetch/CORS/Vite issues.New JavaScript SDK section (
jssdk/)Column, value and parameter types, versioning (LOAD COMMIT) and errors.Query language
m['key'],SET n = map/SET n += map, points and spatial functions,exists()over a pattern,allReduce,ISlabel tests,elementId,isEmpty,coll.indexOf,spliton a list,datetimeof a map,sum/avgof durations,/* */comments, keywords as names.UNION,NEXTandWHENinside every subquery, andCOLLECTof maps and paths.Release Notes
allReduce, COLLECT and other subqueries, and points with haversine distance.How it was checked
turingdb==3.1and npmturingdb@3.1.0, both identical to thev3.1tag.npm run buildprerenders 47/47 pages,tsc --noEmitand the anchor test (293/293) pass, and there are no broken internal links or anchors.Worth flagging
UNWIND $rows AS r MATCH (n ...) SET n += r.props RETURN n.newProp, theRETURNreadsnullfor a property that theSETcreates. The stored value is correct, and a singleSET n += $preads back fine. The docs avoid this pattern.WHERE n = $idis a direct lookup, butid(n) = $idandn IN $idsscan every node. The docs point to the fast forms.vite devfails to load the.wasmdecoder withoutoptimizeDeps: { exclude: ["turingdb"] }. The production build works as is.host="http://localhost:6666", which raises on 3.1. The old publicturingdb-typescript-sdkrepo (HTTP/JSON, v0.1) predates the npm package.