CHANGELOG and comment

ydb-platform · Jan 29, 2025 · d1870fe · d1870fe
1 parent e90761a
commit d1870fe
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,7 @@
-* Added `ydb.WithExecuteDataQueryOverQueryClient(bool)` option for execute data queries from table service client using query client API 
+* Added `ydb.WithExecuteDataQueryOverQueryClient(bool)` option to execute data queries from table service 
+  client using query client API. Using this option you can execute queries from legacy table service client 
+  through `table.Session.Execute` using internal query client API without limitation of 1000 rows in response.
+  Be careful: an OOM problem may happen because bigger result requires more memory
 
 ## v3.98.0
 * Supported pool of encoders, which implement ResetableWriter interface

diff --git a/options.go b/options.go
@@ -556,8 +556,10 @@ func WithSessionPoolIdleThreshold(idleThreshold time.Duration) Option {
 	}
 }
 
-// WithExecuteDataQueryOverQueryClient overrides table.Session.Execute with query service
-// execute with materialized result
+// WithExecuteDataQueryOverQueryClient option enables execution data queries from legacy table service client over
+// query client API. Using this option you can execute queries from legacy table service client through
+// `table.Session.Execute` using internal query client API without limitation of 1000 rows in response.
+// Be careful: an OOM problem may happen because bigger result requires more memory
 func WithExecuteDataQueryOverQueryClient(b bool) Option {
 	return func(ctx context.Context, d *Driver) error {
 		d.tableOptions = append(d.tableOptions, tableConfig.ExecuteDataQueryOverQueryService(b))