Skip to content

Commit fb32a84

Browse files
Node.js: disclaimer for streaming apis (#2050)
1 parent 544d388 commit fb32a84

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

node.js/cds-ql.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -738,6 +738,10 @@ Since the SELECT query implements the async iterator protocol, you can also use
738738
for await (const book of SELECT.from(Books)) { ... }
739739
```
740740

741+
:::warning Streaming APIs only implemented by Database Services
742+
As of now, `SELECT.foreach()` and `SELECT.pipeline()` are only supported by `cds.DatabaseService`. `cds.RemoteService` does not support the streaming APIs yet.
743+
:::
744+
741745
## INSERT {.class}
742746

743747
Fluent API to construct [CQN INSERT](../cds/cqn#insert) query objects in a [CQL](../cds/cql)/SQL-like style. In contrast to SQL, though, the clauses can be arrayed in arbitrary order.

node.js/core-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1065,7 +1065,7 @@ function foreach(
10651065

10661066
Executes the statement and processes the result set row by row. Use this API instead of [`cds.run`](#srv-run-query) if you expect large result sets. Then they're processed in a streaming-like fashion instead of materializing the full result set in memory before processing.
10671067

1068-
> Please note that this API is only implemented by `cds.DatabaseService`. For all other subclasses, the full result set is currently materialized in memory.
1068+
> As of now, this API is only implemented by `cds.DatabaseService`. For all other subclasses, the full result set is currently materialized in memory.
10691069

10701070
_**Common Usage:**_
10711071

0 commit comments

Comments
 (0)