ODBC: Document the new VarcharLimit and EarlyExecution params (#54632)
* Document VarcharLimit and EarlyExecution params Add the documentation for the newly added VarcharLimit and EarlyExecution DSN attributes. * Remove obsolete VersionChecking param This param had been removed already along the #53082 work. * Update docs/reference/sql/endpoints/odbc/configuration.asciidoc fix typo Co-Authored-By: Stuart Cam <stuart@codebrain.co.uk> * Update docs/reference/sql/endpoints/odbc/configuration.asciidoc fix typo Co-Authored-By: Stuart Cam <stuart@codebrain.co.uk> (cherry picked from commit f38761631a12b38f7f075635f7ac61dc96656cd7)
This commit is contained in:
parent
195345b09e
commit
7cef89e084
|
@ -199,6 +199,11 @@ This corresponds to the `MaxFetchSize` setting in <<odbc-cfg-dsnparams>>.
|
||||||
The maximum number of megabytes that the driver will accept for one page.
|
The maximum number of megabytes that the driver will accept for one page.
|
||||||
This corresponds to the `MaxBodySizeMB` setting in <<odbc-cfg-dsnparams>>.
|
This corresponds to the `MaxBodySizeMB` setting in <<odbc-cfg-dsnparams>>.
|
||||||
+
|
+
|
||||||
|
* Varchar limit
|
||||||
|
+
|
||||||
|
The maximum character length of the string type columns.
|
||||||
|
this correspeonds to the `VarcharLimit` setting in <<odbc-cfg-dsnparams>>.
|
||||||
|
+
|
||||||
* Floats format
|
* Floats format
|
||||||
+
|
+
|
||||||
How should the floating point numbers be printed, when these are converted to string by the driver.
|
How should the floating point numbers be printed, when these are converted to string by the driver.
|
||||||
|
@ -214,30 +219,36 @@ This corresponds to the `Packing` setting in <<odbc-cfg-dsnparams>>.
|
||||||
Should the data between the server and the driver be compressed?
|
Should the data between the server and the driver be compressed?
|
||||||
This corresponds to the `Compression` setting in <<odbc-cfg-dsnparams>>.
|
This corresponds to the `Compression` setting in <<odbc-cfg-dsnparams>>.
|
||||||
+
|
+
|
||||||
* Follow HTTP redirects?
|
* Follow HTTP redirects
|
||||||
+
|
+
|
||||||
Should the driver follow HTTP redirects of the requests to the server?
|
Should the driver follow HTTP redirects of the requests to the server?
|
||||||
This corresponds to the `Follow` setting in <<odbc-cfg-dsnparams>>.
|
This corresponds to the `Follow` setting in <<odbc-cfg-dsnparams>>.
|
||||||
+
|
+
|
||||||
* Use local timezone?
|
* Use local timezone
|
||||||
+
|
+
|
||||||
Should the driver use machine's local timezone? The default is UTC.
|
Should the driver use machine's local timezone? The default is UTC.
|
||||||
This corresponds to the `ApplyTZ` setting in <<odbc-cfg-dsnparams>>.
|
This corresponds to the `ApplyTZ` setting in <<odbc-cfg-dsnparams>>.
|
||||||
+
|
+
|
||||||
* Auto-escape PVAs?
|
* Auto-escape PVAs
|
||||||
+
|
+
|
||||||
Should the driver auto-escape the pattern-value arguments?
|
Should the driver auto-escape the pattern-value arguments?
|
||||||
This corresponds to the `AutoEscapePVA` setting in <<odbc-cfg-dsnparams>>.
|
This corresponds to the `AutoEscapePVA` setting in <<odbc-cfg-dsnparams>>.
|
||||||
+
|
+
|
||||||
* Multi value field lenient?
|
* Multi value field lenient
|
||||||
+
|
+
|
||||||
Should the server return one value out of a multi-value field (instead of rejecting the request)?
|
Should the server return one value out of a multi-value field (instead of rejecting the request)?
|
||||||
This corresponds to the `MultiFieldLenient` setting in <<odbc-cfg-dsnparams>>.
|
This corresponds to the `MultiFieldLenient` setting in <<odbc-cfg-dsnparams>>.
|
||||||
+
|
+
|
||||||
* Include frozen indices?
|
* Include frozen indices
|
||||||
+
|
+
|
||||||
Should the server consider the frozen indices when servicing a request?
|
Should the server consider the frozen indices when servicing a request?
|
||||||
This corresponds to the `IndexIncludeFrozen` setting in <<odbc-cfg-dsnparams>>.
|
This corresponds to the `IndexIncludeFrozen` setting in <<odbc-cfg-dsnparams>>.
|
||||||
|
+
|
||||||
|
* Early query execution
|
||||||
|
+
|
||||||
|
Should the driver execute a non-parameterized query as soon as it's submitted
|
||||||
|
for preparation?
|
||||||
|
This corresponds to the `EarlyExecution` setting in <<odbc-cfg-dsnparams>>.
|
||||||
|
|
||||||
|
|
||||||
[[dsn_editor_misc]]
|
[[dsn_editor_misc]]
|
||||||
|
@ -402,6 +413,18 @@ This is concerning the HTTP answer body of one page, not the cumulated data
|
||||||
volume that a query might generate.
|
volume that a query might generate.
|
||||||
|
|
||||||
|
|
||||||
|
`VarcharLimit` (default: `0`)::
|
||||||
|
The maximum width of the string columns.
|
||||||
|
If this setting is greater than zero, the driver will advertise all the string
|
||||||
|
type columns as having a maximum character length equal to this value and will
|
||||||
|
truncate any longer string to it. The string types are textual fields
|
||||||
|
(TEXT, KEYWORD etc.) and some specialized fields (IP, the GEOs etc.). Note that
|
||||||
|
no interpretation of the value is performed before trunctation, which can lead
|
||||||
|
to invalid values if the limit is set too low.
|
||||||
|
This is required for those applications that do not support column lengths as
|
||||||
|
large as {es} fields can be.
|
||||||
|
|
||||||
|
|
||||||
`ApplyTZ` (default: `no`)::
|
`ApplyTZ` (default: `no`)::
|
||||||
A boolean value controlling the timezone of:
|
A boolean value controlling the timezone of:
|
||||||
|
|
||||||
|
@ -429,21 +452,6 @@ This setting is not effective when the application fetches from the driver the
|
||||||
values as numbers and then does the conversion subsequently itself.
|
values as numbers and then does the conversion subsequently itself.
|
||||||
|
|
||||||
|
|
||||||
`VersionChecking` (default: `strict`)::
|
|
||||||
By default, the version of the driver and that of the server must be the same.
|
|
||||||
This parameter will allow a driver to connect to a server of different version.
|
|
||||||
The variation however can only be of the minor version, both endpoints must be
|
|
||||||
of same major version number.
|
|
||||||
Possible values:
|
|
||||||
|
|
||||||
* `strict`: the versions must be in sync;
|
|
||||||
|
|
||||||
* `major`: the versions must have the same major number.
|
|
||||||
|
|
||||||
WARNING: This parameter can only be used for troubleshooting purposes. Running
|
|
||||||
with versions out of sync is not supported.
|
|
||||||
|
|
||||||
|
|
||||||
`MultiFieldLenient` (default: `true`)::
|
`MultiFieldLenient` (default: `true`)::
|
||||||
This boolean parameter controls the behavior of the server in case a
|
This boolean parameter controls the behavior of the server in case a
|
||||||
multi-value field is queried. In case this is set and the server encounters
|
multi-value field is queried. In case this is set and the server encounters
|
||||||
|
@ -466,5 +474,12 @@ will escape these special characters if not already done by the application.
|
||||||
If this parameter is `true`, the server will include the frozen indices in the
|
If this parameter is `true`, the server will include the frozen indices in the
|
||||||
query execution.
|
query execution.
|
||||||
This corresponds to {es-sql}'s request parameter `index_include_frozen`
|
This corresponds to {es-sql}'s request parameter `index_include_frozen`
|
||||||
(see <<sql-rest-fields>>).
|
|
||||||
|
|
||||||
|
|
||||||
|
`EarlyExecution` (default: `true`)::
|
||||||
|
If this parameter is `true`, the driver will execute a statement as soon as the
|
||||||
|
application submits it for preparation, i.e. early and is functionally
|
||||||
|
equivalent to a direct execution. This will only happen if the query lacks
|
||||||
|
parameters. Early execution is useful with those applications that inspect the
|
||||||
|
result before actually executing the query. {es-sql} lacks a preparation API,
|
||||||
|
so early execution is required for interoperability with these applications.
|
||||||
|
|
Loading…
Reference in New Issue