Skip to content

Commit

Permalink
Update client_spec.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gkorland authored Aug 15, 2023
1 parent e6251fb commit a0e6db7
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions design/client_spec.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: "Technical specification for writing RedisGraph client libraries"
linkTitle: "Client Specification"
weight: 10
title: "Client Specification"
description: >
By design, there is not a full standard for RedisGraph clients to adhere to. Areas such as pretty-print formatting, query validation, and transactional and multithreaded capabilities have no canonically correct behavior, and the implementer is free to choose the approach and complexity that suits them best.
RedisGraph does, however, provide a compact result set format for clients that minimizes the amount of redundant data transmitted from the server. Implementers are encouraged to take advantage of this format, as it provides better performance and removes ambiguity from decoding certain data. This approach requires clients to be capable of issuing procedure calls to the server and performing a small amount of client-side caching.
Technical specification for writing FalkorDB client libraries
---

By design, there is not a full standard for RedisGraph clients to adhere to. Areas such as pretty-print formatting, query validation, and transactional and multithreaded capabilities have no canonically correct behavior, and the implementer is free to choose the approach and complexity that suits them best.
RedisGraph does, however, provide a compact result set format for clients that minimizes the amount of redundant data transmitted from the server. Implementers are encouraged to take advantage of this format, as it provides better performance and removes ambiguity from decoding certain data. This approach requires clients to be capable of issuing procedure calls to the server and performing a small amount of client-side caching.


## Retrieving the compact result set

Appending the flag `--compact` to any query issued to the GRAPH.QUERY endpoint will cause the server to issue results in the compact format. Because we don't store connection-specific configurations, all queries should be issued with this flag.
Expand Down

0 comments on commit a0e6db7

Please sign in to comment.