Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
pgms_stats.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_stats.is_enabled_fs |
pgms_wait_sampling.history_period
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type | integer |
| Default value | 100 |
| Allowed values | 1-600000 |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type | enumeration |
| Default value | none |
| Allowed values | all,none |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.query_capture_mode |
pg_qs.emit_query_text
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Controls whether query text is emitted in telemetry pipeline. Need to reload the config for the change to take effect |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.emit_query_text |
pg_qs.interval_length_minutes
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type | integer |
| Default value | 15 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on |
| Parameter type | read-only |
| Documentation | pg_qs.is_enabled_fs |
pg_qs.max_captured_queries
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Specifies the number of most relevant queries for which query store captures runtime statistics at each interval. |
| Data type | integer |
| Default value | 500 |
| Allowed values | 100-500 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_captured_queries |
pg_qs.max_plan_size
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum number of bytes that will be saved for query plan text; longer plans will be truncated. Need to reload the config for this change to take effect. |
| Data type | integer |
| Default value | 7500 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum query text length that will be saved; longer queries will be truncated. Need to reload the config to make change take effect. |
| Data type | integer |
| Default value | 6000 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects how positional query parameters are captured by pg_qs. Need to reload the config for the change to take effect. |
| Data type | enumeration |
| Default value | capture_parameterless_only |
| Allowed values | capture_parameterless_only,capture_first_sample |
| Parameter type | dynamic |
| Documentation | pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects which statements are tracked by pg_qs. Need to reload the config to make change take effect. |
| Data type | enumeration |
| Default value | top |
| Allowed values | top,all,none |
| Parameter type | dynamic |
| Documentation | pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the retention period window in days for pg_qs - after this time data will be deleted. Need to restart the server to make change take effect. |
| Data type | integer |
| Default value | 7 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Turns saving query plans on or off. Need to reload the config for the change to take effect. |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects whether utility commands are tracked by pg_qs. Need to reload the config to make change take effect. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.track_utility |
pgms_stats.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_stats.is_enabled_fs |
pgms_wait_sampling.history_period
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type | integer |
| Default value | 100 |
| Allowed values | 1-600000 |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type | enumeration |
| Default value | none |
| Allowed values | all,none |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.query_capture_mode |
pg_qs.emit_query_text
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Controls whether query text is emitted in telemetry pipeline. Need to reload the config for the change to take effect |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.emit_query_text |
pg_qs.interval_length_minutes
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type | integer |
| Default value | 15 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on |
| Parameter type | read-only |
| Documentation | pg_qs.is_enabled_fs |
pg_qs.max_captured_queries
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Specifies the number of most relevant queries for which query store captures runtime statistics at each interval. |
| Data type | integer |
| Default value | 500 |
| Allowed values | 100-500 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_captured_queries |
pg_qs.max_plan_size
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type | integer |
| Default value | 7500 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type | integer |
| Default value | 6000 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Whether and when to capture query positional parameters. |
| Data type | enumeration |
| Default value | capture_parameterless_only |
| Allowed values | capture_parameterless_only,capture_first_sample |
| Parameter type | dynamic |
| Documentation | pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets query capture mode for query store. None disables any capturing. |
| Data type | enumeration |
| Default value | top |
| Allowed values | top,all,none |
| Parameter type | dynamic |
| Documentation | pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type | integer |
| Default value | 7 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Turns saving query plans on or off for pg_qs |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects whether utility commands are tracked by pg_qs. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.track_utility |
pgms_stats.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_stats.is_enabled_fs |
pgms_wait_sampling.history_period
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type | integer |
| Default value | 100 |
| Allowed values | 1-600000 |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type | enumeration |
| Default value | none |
| Allowed values | all,none |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.query_capture_mode |
pg_qs.emit_query_text
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Controls whether query text is emitted in telemetry pipeline. Need to reload the config for the change to take effect |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.emit_query_text |
pg_qs.interval_length_minutes
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type | integer |
| Default value | 15 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on |
| Parameter type | read-only |
| Documentation | pg_qs.is_enabled_fs |
pg_qs.max_captured_queries
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Specifies the number of most relevant queries for which query store captures runtime statistics at each interval. |
| Data type | integer |
| Default value | 500 |
| Allowed values | 100-500 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_captured_queries |
pg_qs.max_plan_size
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type | integer |
| Default value | 7500 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type | integer |
| Default value | 6000 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Whether and when to capture query positional parameters. |
| Data type | enumeration |
| Default value | capture_parameterless_only |
| Allowed values | capture_parameterless_only,capture_first_sample |
| Parameter type | dynamic |
| Documentation | pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets query capture mode for query store. None disables any capturing. |
| Data type | enumeration |
| Default value | top |
| Allowed values | top,all,none |
| Parameter type | dynamic |
| Documentation | pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type | integer |
| Default value | 7 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Turns saving query plans on or off for pg_qs |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects whether utility commands are tracked by pg_qs. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.track_utility |
pgms_stats.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_stats.is_enabled_fs |
pgms_wait_sampling.history_period
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type | integer |
| Default value | 100 |
| Allowed values | 1-600000 |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type | enumeration |
| Default value | none |
| Allowed values | all,none |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.query_capture_mode |
pg_qs.emit_query_text
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Controls whether query text is emitted in telemetry pipeline. Need to reload the config for the change to take effect |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.emit_query_text |
pg_qs.interval_length_minutes
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type | integer |
| Default value | 15 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on |
| Parameter type | read-only |
| Documentation | pg_qs.is_enabled_fs |
pg_qs.max_captured_queries
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Specifies the number of most relevant queries for which query store captures runtime statistics at each interval. |
| Data type | integer |
| Default value | 500 |
| Allowed values | 100-500 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_captured_queries |
pg_qs.max_plan_size
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type | integer |
| Default value | 7500 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type | integer |
| Default value | 6000 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Whether and when to capture query positional parameters. |
| Data type | enumeration |
| Default value | capture_parameterless_only |
| Allowed values | capture_parameterless_only,capture_first_sample |
| Parameter type | dynamic |
| Documentation | pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets query capture mode for query store. None disables any capturing. |
| Data type | enumeration |
| Default value | top |
| Allowed values | top,all,none |
| Parameter type | dynamic |
| Documentation | pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type | integer |
| Default value | 7 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Turns saving query plans on or off for pg_qs |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects whether utility commands are tracked by pg_qs. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.track_utility |
pgms_stats.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_stats.is_enabled_fs |
pgms_wait_sampling.history_period
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type | integer |
| Default value | 100 |
| Allowed values | 1-600000 |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type | enumeration |
| Default value | none |
| Allowed values | all,none |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.query_capture_mode |
pg_qs.emit_query_text
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Controls whether query text is emitted in telemetry pipeline. Need to reload the config for the change to take effect |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.emit_query_text |
pg_qs.interval_length_minutes
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type | integer |
| Default value | 15 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on |
| Parameter type | read-only |
| Documentation | pg_qs.is_enabled_fs |
pg_qs.max_captured_queries
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Specifies the number of most relevant queries for which query store captures runtime statistics at each interval. |
| Data type | integer |
| Default value | 500 |
| Allowed values | 100-500 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_captured_queries |
pg_qs.max_plan_size
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type | integer |
| Default value | 7500 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type | integer |
| Default value | 6000 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Whether and when to capture query positional parameters. |
| Data type | enumeration |
| Default value | capture_parameterless_only |
| Allowed values | capture_parameterless_only,capture_first_sample |
| Parameter type | dynamic |
| Documentation | pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets query capture mode for query store. None disables any capturing. |
| Data type | enumeration |
| Default value | top |
| Allowed values | top,all,none |
| Parameter type | dynamic |
| Documentation | pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type | integer |
| Default value | 7 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Turns saving query plans on or off for pg_qs |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects whether utility commands are tracked by pg_qs. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.track_utility |
pgms_stats.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_stats.is_enabled_fs |
pgms_wait_sampling.history_period
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type | integer |
| Default value | 100 |
| Allowed values | 1-600000 |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type | enumeration |
| Default value | none |
| Allowed values | all,none |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.query_capture_mode |
pg_qs.emit_query_text
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Controls whether query text is emitted in telemetry pipeline. Need to reload the config for the change to take effect |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.emit_query_text |
pg_qs.interval_length_minutes
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type | integer |
| Default value | 15 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on |
| Parameter type | read-only |
| Documentation | pg_qs.is_enabled_fs |
pg_qs.max_captured_queries
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Specifies the number of most relevant queries for which query store captures runtime statistics at each interval. |
| Data type | integer |
| Default value | 500 |
| Allowed values | 100-500 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_captured_queries |
pg_qs.max_plan_size
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type | integer |
| Default value | 7500 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type | integer |
| Default value | 6000 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Whether and when to capture query positional parameters. |
| Data type | enumeration |
| Default value | capture_parameterless_only |
| Allowed values | capture_parameterless_only,capture_first_sample |
| Parameter type | dynamic |
| Documentation | pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets query capture mode for query store. None disables any capturing. |
| Data type | enumeration |
| Default value | none |
| Allowed values | top,all,none |
| Parameter type | dynamic |
| Documentation | pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type | integer |
| Default value | 7 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Turns saving query plans on or off for pg_qs |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects whether utility commands are tracked by pg_qs. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.track_utility |
pgms_stats.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_stats.is_enabled_fs |
pgms_wait_sampling.history_period
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type | integer |
| Default value | 100 |
| Allowed values | 1-600000 |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type | enumeration |
| Default value | none |
| Allowed values | all,none |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.query_capture_mode |
pg_qs.interval_length_minutes
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type | integer |
| Default value | 15 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on |
| Parameter type | read-only |
| Documentation | pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type | integer |
| Default value | 7500 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type | integer |
| Default value | 6000 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Whether and when to capture query positional parameters. |
| Data type | enumeration |
| Default value | capture_parameterless_only |
| Allowed values | capture_parameterless_only,capture_first_sample |
| Parameter type | dynamic |
| Documentation | pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets query capture mode for query store. None disables any capturing. |
| Data type | enumeration |
| Default value | none |
| Allowed values | top,all,none |
| Parameter type | dynamic |
| Documentation | pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type | integer |
| Default value | 7 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Turns saving query plans on or off for pg_qs |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects whether utility commands are tracked by pg_qs. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.track_utility |
pgms_stats.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_stats.is_enabled_fs |
pgms_wait_sampling.history_period
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Set the frequency, in milliseconds, at which wait events are sampled. |
| Data type | integer |
| Default value | 100 |
| Allowed values | 1-600000 |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.history_period |
pgms_wait_sampling.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, wait sampling will be disabled despite the value set for pgms_wait_sampling.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | read-only |
| Documentation | pgms_wait_sampling.is_enabled_fs |
pgms_wait_sampling.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Customized Options |
| Description | Selects which statements are tracked by the pgms_wait_sampling extension. |
| Data type | enumeration |
| Default value | none |
| Allowed values | all,none |
| Parameter type | dynamic |
| Documentation | pgms_wait_sampling.query_capture_mode |
pg_qs.interval_length_minutes
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the query_store capture interval in minutes for pg_qs - this is the frequency of data persistence. |
| Data type | integer |
| Default value | 15 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.interval_length_minutes |
pg_qs.is_enabled_fs
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Internal Use Only: This parameter is used as a feature override switch. If it shows as off, Query Store will be disabled despite the value set for pg_qs.query_capture_mode. |
| Data type | boolean |
| Default value | on |
| Allowed values | on |
| Parameter type | read-only |
| Documentation | pg_qs.is_enabled_fs |
pg_qs.max_plan_size
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum number of bytes that will be saved for query plan text for pg_qs; longer plans will be truncated. |
| Data type | integer |
| Default value | 7500 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_plan_size |
pg_qs.max_query_text_length
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the maximum query text length that will be saved; longer queries will be truncated. |
| Data type | integer |
| Default value | 6000 |
| Allowed values | 100-10000 |
| Parameter type | dynamic |
| Documentation | pg_qs.max_query_text_length |
pg_qs.parameters_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Whether and when to capture query positional parameters. |
| Data type | enumeration |
| Default value | capture_parameterless_only |
| Allowed values | capture_parameterless_only,capture_first_sample |
| Parameter type | dynamic |
| Documentation | pg_qs.parameters_capture_mode |
pg_qs.query_capture_mode
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets query capture mode for query store. None disables any capturing. |
| Data type | enumeration |
| Default value | none |
| Allowed values | top,all,none |
| Parameter type | dynamic |
| Documentation | pg_qs.query_capture_mode |
pg_qs.retention_period_in_days
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Sets the retention period window in days for pg_qs - after this time data will be deleted. |
| Data type | integer |
| Default value | 7 |
| Allowed values | 1-30 |
| Parameter type | dynamic |
| Documentation | pg_qs.retention_period_in_days |
pg_qs.store_query_plans
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Turns saving query plans on or off for pg_qs |
| Data type | boolean |
| Default value | off |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.store_query_plans |
pg_qs.track_utility
| Attribute | Value |
|---|---|
| Category | Query store |
| Description | Selects whether utility commands are tracked by pg_qs. |
| Data type | boolean |
| Default value | on |
| Allowed values | on,off |
| Parameter type | dynamic |
| Documentation | pg_qs.track_utility |