[ksqlDB.RestApi.Client]: separated configuration for pull and push qu…

…eries. Added SetupPullQuery configuration option docs.
tomasfabian · Apr 26, 2024 · 9b6c8a6 · 9b6c8a6
1 parent eea7263
commit 9b6c8a6
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/docs/breaking_changes.md b/docs/breaking_changes.md
@@ -2,8 +2,10 @@
 
 # v6.0.0
 - `QueryType` enum was renamed to `EndpointType`
-- removed `CreateQuery` from `IKSqlDBContext` interface in the netstandard version. It was replaced with `CreateQueryStream`.
-
+- removed `CreateQuery` from `IKSqlDBContext` interface, it was merged with `CreateQueryStream`.
+- removed `SetupQuery` from `KSqlDbContextOptionsBuilder`, it was merged with `SetupQueryStream`.
+- introduced distinct parameters designed specifically for pull queries. Before this update, the parameters sent to both the 'query' and 'query-stream' endpoints were shared between pull and push queries.
+
 # v5.0.0
 - removed static modifier from `StatementGenerator` class
 

diff --git a/docs/ksqldbcontext.md b/docs/ksqldbcontext.md
@@ -391,6 +391,21 @@ public static KSqlDBContextOptions CreateQueryStreamOptions(string ksqlDbUrl)
 }
 ```
 
+> ⚠ In version 6.0.0 `SetupQuery` was unified with `SetupQueryStream`.
+
+### SetupPullQuery
+**v6.0.0**
+
+- configures the parameters for setting up a pull query
+
+```C#
+contextOptions
+  .SetupPullQuery(options =>
+  {
+    options[KSqlDbConfigs.KsqlQueryPullTableScanEnabled] = "true";
+  })
+```
+
 ### Setting processing guarantee with KSqlDbContextOptionsBuilder
 **v1.0.0**