Skip to main content

KQL HELP Audit

This page is the exhaustive appendix for the docs refresh. It compares the current docs structure to the live KFDB HELP registry accessed during the audit.

Audit Method

The audit was grounded in live HELP output from the KFDB MCP server using:

HELP
HELP syntax
HELP clauses
HELP operators
HELP functions
HELP window_functions
HELP ai
HELP temporal
HELP examples
HELP schema

Coverage Matrix

HELP bucketStatusNotes
syntaxCoveredClause order, WITH, parameters, RETURN *, RETURN n.*, UNION added to KQL Syntax
clausesCoveredMATCH, OPTIONAL MATCH, WHERE, RETURN, WITH, ORDER BY, LIMIT, OFFSET, GROUP BY, HAVING, UNWIND, UNION, AT TIMESTAMP, HISTORY documented
operatorsCoveredComparison, logical, string, null, list, arithmetic, vector similarity summarized in syntax page
patternsPartially coveredCore node/relationship patterns covered in narrative pages; complex pattern grammar still consolidated here rather than broken into its own page
typesCovered in appendixValue families called out below; existing docs do not need a dedicated page yet
window_functionsCoveredROW_NUMBER, RANK, DENSE_RANK, LAG, LEAD added to syntax page
aiCoveredAI.IF and AI.SIMILARITY now included in syntax page
temporalCoveredAT TIMESTAMP and HISTORY FROM ... TO ... added
examplesCoveredDiscovery, pattern, aggregation, conditional, EXISTS, list comprehension, multi-stage, UNION ALL, window, temporal, AI examples reflected
schemaCoveredSHOW LABELS, SHOW EDGE_TYPES, SHOW PROPERTIES, SHOW SCHEMA promoted to first-class discovery workflow
functionsCovered in appendixFamilies and signatures summarized below

Newly Surfaced Gaps That Were Missing Before

The older docs were materially missing or under-emphasizing:

  • WITH
  • OPTIONAL MATCH
  • UNION / UNION ALL
  • UNWIND
  • HAVING
  • RETURN *
  • RETURN n.*
  • parameter syntax ($param_name)
  • SHOW LABELS, SHOW EDGE_TYPES, SHOW PROPERTIES, SHOW SCHEMA
  • temporal clauses (AT TIMESTAMP, HISTORY)
  • AI expressions (AI.IF, AI.SIMILARITY)
  • window functions
  • most built-in function families beyond a small subset

Function Families from Live HELP

Graph

  • labels(node): array
  • id(node): string
  • type(relationship): string
  • properties(node|edge): object
  • keys(object): array

String

  • toString(value): string
  • toUpper(string): string
  • toLower(string): string
  • trim(string): string
  • ltrim(string): string
  • rtrim(string): string
  • left(string, length): string
  • right(string, length): string
  • substring(string, start[, length]): string
  • replace(string, search, replacement): string
  • split(string, delimiter): array
  • reverse(string|array): string|array

Numeric

  • abs(number): number
  • ceil(number): integer
  • floor(number): integer
  • round(number[, precision]): number
  • sign(number): integer
  • sqrt(number): float
  • pow(base, exponent): float
  • exp(number): float
  • log(number): float
  • log10(number): float
  • sin, cos, tan, asin, acos, atan, atan2
  • radians(degrees): float
  • degrees(radians): float
  • pi(): float
  • e(): float
  • rand(): float

Type conversion

  • toInteger(value): integer
  • toFloat(value): float
  • toBoolean(value): boolean

List / size / collection

  • head(list): any
  • tail(list): array
  • last(list): any
  • range(start, end[, step]): array
  • size(list|string): integer
  • length(string|array): integer
  • any(list): boolean
  • all(list): boolean
  • none(list): boolean
  • single(list): boolean

Null helpers

  • coalesce(expr1, expr2, ...): any
  • isNull(value): boolean
  • isNotNull(value): boolean
  • search(text, query[, options]): object
  • match(text, pattern): boolean
  • highlight(text, query): string
  • snippet(text, query[, length]): string
  • score(text, query): float

Vector

  • vector(array): vector
  • cosine_similarity(vec1, vec2): float
  • euclidean_distance(vec1, vec2): float
  • dot_product(vec1, vec2): float

Path

  • shortestPath(start, end): path
  • shortestPathLength(start, end): integer

Aggregate

  • COUNT(expr): integer
  • SUM(expr): number
  • AVG(expr): float
  • MIN(expr): any
  • MAX(expr): any
  • COLLECT(expr): array

Temporal

  • timestamp(): integer

Window Functions from Live HELP

  • ROW_NUMBER() OVER ([PARTITION BY expr] ORDER BY expr)
  • RANK() OVER ([PARTITION BY expr] ORDER BY expr)
  • DENSE_RANK() OVER ([PARTITION BY expr] ORDER BY expr)
  • LAG(expr[, offset[, default]]) OVER ([PARTITION BY expr] ORDER BY expr)
  • LEAD(expr[, offset[, default]]) OVER ([PARTITION BY expr] ORDER BY expr)

AI Expressions from Live HELP

  • AI.IF(prompt => <expression>, model => <string>)
  • AI.SIMILARITY(expr1, expr2)

Schema / Discovery Commands from Live HELP

  • SHOW LABELS
  • SHOW EDGE_TYPES
  • SHOW PROPERTIES
  • SHOW PROPERTIES <Label>
  • SHOW SCHEMA

Recommended discovery order:

SHOW LABELS
SHOW PROPERTIES File
SHOW EDGE_TYPES
SHOW SCHEMA

Remaining Documentation Debt

The audit is now materially complete, but a few deeper expansions are still optional future work rather than blockers:

  • dedicated page for pattern grammar details
  • dedicated page for built-in function cookbook examples
  • dedicated page for temporal/query-history caveats and retention behavior
  • dedicated page for AI-expression guardrails and cost guidance