getCachedResourceStatisticsConfig
Get the Cost Based Optimizer (CBO) statistics configuration for a data source. Cache must be configured before configuring statistics.
Location
/services/webservices/system/admin/resource/operations/
Request Elements
path: The path of a cacheable resource.
type: The type of the resource. Can only be TABLE.
Response Elements
cachedStatisticsConfig: The statistics configuration of the given resource.
| • | configured (optional): TRUE if statistics gathering is configured otherwise FALSE. |
| • | useEnabled (optional): TRUE if gathered statistics are to be used by CBO; otherwise FALSE. Can be used to temporarily disable CBO. |
| • | cardinalityMin (optional): Minimum cardinality for this resource. Setting this value overrides gathered statistics. |
| • | cardinalityMax (optional): Maximum cardinality for this resource. Setting this value overrides gathered statistics. |
| • | cardinalityExpected (optional): Expected cardinality for this resource. Setting this value overrides gathered statistics. |
| • | gatherEnabled (optional): Defines what statistics should be gathered for this resource. Valid values are TABLE_BOUNDARY or CUSTOM. |
| • | maxTime (optional): Integer 0 to n in minutes; maximum amount of time the process should spend gathering data; 0 means no limit. |
| • | columns (optional): Only applicable if gatherEnabled is set to CUSTOM. |
| — | column: List indicating what specific data to get for each column. |
| — | name: Simple column name. |
| — | flags: Valid values are NONE, BOUNDARY or ALL. |
| — | columnMin (optional): Minimum value for this resource. Setting this value overrides gathered statistics. |
| — | columnMax (optional): Maximum value for this resource. Setting this value overrides gathered statistics. |
| — | columnDistinct (optional): Distinct value this resource. Setting this value overrides gathered statistics. |
| • | onCacheRefresh (optional): If TRUE, statistics gathering should be automatically triggered by cache refresh. If FALSE, refresh mode can be specified. |
| • | refresh (optional): How the statistics data should be refreshed. See Refresh Element. |
Faults
IllegalArgument: If the path is malformed or an illegal type is provided.
NotAllowed: If the resource is of the wrong type.
NotFound: If the resource or any portion of the path to the resource does not exist.
Security: If the user does not have READ access on all items in path.
Security: If the user does not have the ACCESS_TOOLS right.