请求属性
适用于:✅Azure 数据资源管理器
请求属性控制查询或命令的执行方式并返回结果。
支持的请求属性
下表对支持的请求属性进行了概述。
属性名称 | 类型 | 描述 |
---|---|---|
best_effort |
bool |
如果设置为 true ,则允许数据源的模糊解析和连接问题(联合分支)。联合源集被简化为一组存在并在执行时可访问的表引用。 如果找到至少一个可访问表,则查询将执行。 任何失败都会生成查询状态结果中的警告,但不会阻止执行查询。 |
client_max_redirect_count |
long |
控制客户端在处理期间遵循的最大 HTTP 重定向数。 |
client_results_reader_allow_varying_row_widths |
bool |
如果设置为 true ,则结果读取器可容忍其行宽因行而异的表。 |
deferpartialqueryfailures |
bool |
如果设置为 true ,则取消报告结果集中的部分查询失败。 |
materialized_view_shuffle_query |
dynamic |
提供一个提示,提示你将无序策略用于在查询中引用的具体化视图。 此属性仅影响具体化视图,不会影响查询中的任何后续操作(例如联接)。 它采用一个数组,其中包含具体化视图名称及其对应的无序键。 例如, dynamic([{ "Name": "V1", "Keys" : [ "K1", "K2" ] }]) 指示按 K1 和 K2 键排布视图 V1 ,而 dynamic([ { "Name": "V1" } ]) 按所有键排布视图 V1 。 |
max_memory_consumption_per_query_per_node |
long |
替代查询可以为每个节点分配的默认最大内存量。 |
maxmemoryconsumptionperiterator |
long |
替代查询运算符可以分配的默认最大内存量。 |
maxoutputcolumns |
long |
替代允许查询生成的默认最大列数。 |
norequesttimeout |
bool |
将请求超时设置为其最大值。 此选项不能作为 set 语句的一部分进行修改。 |
notruncation |
bool |
禁止截断返回给调用方的查询结果。 |
push_selection_through_aggregation |
bool |
如果设置为 true ,则允许通过聚合推送简单选择。 |
query_bin_auto_at |
literal | 指定计算 bin_auto() 函数时要使用的起始值。 |
query_bin_auto_size |
literal | 指定计算 bin_auto() 函数时要使用的 bin 大小值。 |
query_cursor_after_default |
string |
设置在不使用参数的情况下调用时 cursor_after() 函数的默认参数值。 |
query_cursor_before_or_at_default |
string |
设置在不使用参数的情况下调用时 cursor_before_or_at() 函数的默认参数值。 |
query_cursor_current |
string |
替代 cursor_current() 函数返回的游标值。 |
query_cursor_disabled |
bool |
在查询上下文中禁止使用游标函数。 |
query_cursor_scoped_tables |
dynamic |
列出作用域应限定为 cursor_after_default .. cursor_before_or_at() (上限为可选项)的表名。 |
query_datascope |
string |
控制查询应用到的数据。 支持的值为 default 、all 或 hotcache 。 |
query_datetimescope_column |
string |
指定查询的日期/时间范围 (query_datetimescope_to / query_datetimescope_from ) 的列名。 |
query_datetimescope_from |
datetime |
设置查询范围的最小日期和时间限制。 若已定义,它将充当 query_datetimescope_column 的自动应用筛选器。 |
query_datetimescope_to |
datetime |
设置查询范围的最大日期和时间限制。 若已定义,它将充当 query_datetimescope_column 的自动应用筛选器。 |
query_distribution_nodes_span |
int |
控制子查询合并行为。 执行节点将在查询层次结构中为每个节点子组引入一个附加级别,而且此选项设置子组的大小。 |
query_fanout_nodes_percent |
int |
指定用于执行扇出的节点所占的百分比。 |
query_fanout_threads_percent |
int |
指定用于执行扇出的线程所占的百分比。 |
query_force_row_level_security |
bool |
如果设置为 true ,则强制实施行级别安全性规则,即使禁用了策略也是如此。 |
query_language |
string |
确定解释查询文本的方式。 支持的值为 csl 、kql 或 sql 。 此选项不能作为 set 语句的一部分进行修改。 |
query_log_query_parameters |
bool |
启用查询参数日志记录,以便稍后在 .show 查询日记中进行查看。 |
query_max_entities_in_union |
long |
替代允许查询生成的默认最大列数。 |
query_now |
datetime |
替代 now() 函数返回的日期/时间值。 |
query_optimize_fts_at_relop |
bool |
设置为 true 时,为执行昂贵的自由文本搜索操作的查询启用试验性优化。 例如:\|where * has "pattern" 。 |
query_python_debug |
bool 或 int |
如果设置为 true ,则将为枚举的 Python 节点生成一个 Python 调试查询。 |
query_results_apply_getschema |
bool |
如果设置为 true ,则将检索查询结果中每个表格数据的架构而不检索数据本身。 |
query_results_cache_force_refresh |
bool |
如果设置为 true ,则会强制特定查询的查询结果缓存刷新。 必须与 query_results_cache_max_age 结合使用,并通过 Kusto Data ClientRequestProperties 类发送,而不是作为 set 语句。 |
query_results_cache_max_age |
timespan |
控制服务可以返回的缓存查询结果的最长期限。 |
query_results_cache_per_shard |
bool |
如果设置为 true ,则会启用每个盘区查询高速缓存。 |
query_results_progressive_row_count |
long |
提供要在每个更新中发送多少条记录的相关提示。 仅在设置了 results_progressive_enabled 时生效。 |
query_results_progressive_update_period |
timespan |
提供发送进度帧的频率的相关提示。 仅在设置了 results_progressive_enabled 时生效。 |
query_take_max_records |
long |
将查询结果限制为指定数量的记录。 |
query_weakconsistency_session_id |
string |
设置查询弱一致性会话 ID。 当 queryconsistency 模式设置为 weakconsistency_by_session_id 时生效。 此选项不能作为 set 语句的一部分进行修改。 |
queryconsistency |
string |
控制查询一致性。 支持的值为 strongconsistency 、weakconsistency 、weakconsistency_by_query 、weakconsistency_by_database 或 weakconsistency_by_session_id 。 使用 weakconsistency_by_session_id 时,务必还设置 query_weakconsistency_session_id 属性。 此选项不能作为 set 语句的一部分进行修改。 |
request_app_name |
string |
指定要在报告中使用的请求应用程序名称。 例如,.show 查询。 此选项不能作为 set 语句的一部分进行修改。 |
request_block_row_level_security |
bool |
如果设置为 true ,则阻止访问已启用行级别安全性策略的表。 |
request_callout_disabled |
bool |
如果设置为 true ,则阻止请求调出用户提供的服务。 |
request_description |
string |
允许包含任意文本作为请求说明。 |
request_external_data_disabled |
bool |
如果设置为 true ,则阻止请求使用 externaldata 运算符访问外部数据或者访问外部表。 |
request_external_table_disabled |
bool |
如果设置为 true ,则阻止请求访问外部表。 |
request_impersonation_disabled |
bool |
如果设置为 true ,则表示服务不应模拟调用方的标识。 |
request_readonly |
bool |
如果设置为 true ,则阻止对请求的写入访问。 此选项不能作为 set 语句的一部分进行修改。 |
request_readonly_hardline |
bool |
如果设置为 true ,则请求以严格的只读模式运行。 请求无法写入任何内容,并且任何不合规的功能(如插件)会被禁用。 此选项不能作为 set 语句的一部分进行修改。 |
request_remote_entities_disabled |
bool |
如果设置为 true ,则阻止请求访问远程数据库和远程实体。 |
request_sandboxed_execution_disabled |
bool |
如果设置为 true ,则阻止请求调用沙盒中的代码。 |
request_user |
string |
指定要在报告中使用的请求用户。 例如,.show 查询。 此选项不能作为 set 语句的一部分进行修改。 |
results_error_reporting_placement |
string |
确定错误在结果集中的放置位置。 选项包括 in_data 、end_of_table 和 end_of_dataset 。 |
results_progressive_enabled |
bool |
如果设置为 true ,则会启用渐进式查询流。 此选项不能作为 set 语句的一部分进行修改。 |
results_v2_fragment_primary_tables |
bool |
导致主表在多个片段中发送,每个片段都包含行的子集。 此选项不能作为 set 语句的一部分进行修改。 |
results_v2_newlines_between_frames |
bool |
在结果中的帧之间添加新行,以便更轻松地分析它们。 |
servertimeout |
timespan |
替代默认的请求超时。 此选项不能作为 set 语句的一部分进行修改。 请改用仪表板设置来修改选项。 |
truncation_max_records |
long |
替代查询可以返回给调用方的默认最大记录数(截断)。 |
truncationmaxsize |
long |
替代允许查询返回给调用方的默认最大数据大小(截断)。 此选项不能作为 set 语句的一部分进行修改。 |
validatepermissions |
bool |
验证用户执行查询的权限,但不实际运行查询。 此属性的可能结果为:OK (权限存在且有效)、Incomplete (由于动态架构评估而无法完成验证)或 KustoRequestDeniedException (未设置权限)。 |
如何设置请求属性
可通过以下方式设置请求属性:
- HTTP 请求的 POST 正文
- Kusto 查询语言 set 语句
ClientRequestProperties
类的 set 选项方法
注意
以下请求属性不能使用 set 语句进行设置:
norequesttimeout
queryconsistency
query_language
query_weakconsistency_session_id
request_app_name
request_readonly
request_readonly_hardline
request_user
results_progressive_enabled
results_v2_fragment_primary_tables
servertimeout
truncationmaxsize
注意
- 若要从仪表板设置中设置
norequesttimeout
和servertimeout
,请参阅设置超时限制。 - 若要通过仪表板设置将
queryconsistency
设置为弱一致性,请选择“设置”>“连接”。 有关详细信息,请参阅在 Azure 数据资源管理器 Web UI 中自定义设置。