要求のプロパティ
要求プロパティは、クエリまたはコマンドの実行方法を制御し、結果を返します。
サポートされている要求プロパティ
次の表に、サポートされている要求プロパティの概要を示します。
Note
要求プロパティ query_weakconsistency_session_id
と queryconsistency
は Fabic では使用できません。
プロパティ名 | 種類 | 説明 |
---|---|---|
best_effort |
bool |
true に設定すると、データ ソース (共用体脚) のあいまい解決と接続の問題が許可されます。共用体ソースのセットは、実行時に存在し、アクセス可能なテーブル参照のセットに縮小されます。 アクセス可能なテーブルが少なくとも 1 つ見つかった場合、クエリが実行されます。 エラーが発生すると、クエリの状態の結果に警告が表示されますが、クエリの実行を妨げることはありません。 |
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 |
クエリ コンテキスト内での cursor 関数 の使用を無効にします。 |
query_cursor_scoped_tables |
dynamic |
cursor_after_default にスコープを設定するテーブル名を一覧表示します。 cursor_before_or_at() (上限は省略可能)。 |
query_datascope |
string |
クエリを適用するデータを制御します。 サポートされている値は、 default 、 all 、または hotcache です。 |
query_datetimescope_column |
string |
クエリの datetime スコープ (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()関数によって返される datetime 値をオーバーライドします。 |
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 と組み合わせて使用し、set ステートメントとしてではなく、Kusto Data ClientRequestProperties クラス経由で送信する必要があります。 |
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 に設定されている場合は、サービスが呼び出し元の ID を偽装しないことを示します。 |
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 (アクセス許可が設定されていません) です。 |
要求プロパティを設定する方法
要求プロパティは、次の方法で設定できます。
Note
次の要求プロパティは、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
Note
- ダッシュボードの設定から
norequesttimeout
とservertimeout
を設定するには、「タイムアウト制限の設定を参照してください。 - ダッシュボードの設定で
queryconsistency
を弱い整合性に設定するには、 Settings>Connection を選択します。 詳細については、「 Azure Data Explorer Web UI で設定をカスタマイズするを参照してください。