Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFAdmin.RebuildPathCache Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFAdmin.RebuildPathCache Method
Rebuilds the path cache to each element in the PI AF SQL Server database.

Namespace:  OSIsoft.AF.Diagnostics
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public static void RebuildPathCache(
	PISystem system
)
Public Shared Sub RebuildPathCache ( 
	system As PISystem
)

Dim system As PISystem

AFAdmin.RebuildPathCache(system)
public:
static void RebuildPathCache(
	PISystem^ system
)
static member RebuildPathCache : 
        system : PISystem -> unit 

Parameters

system
Type: OSIsoft.AFPISystem
The operation will be performed on the specified PISystem.

Exceptions

ExceptionCondition
SecurityException This exception is thrown when attempting to execute without Admin security rights.
ArgumentNullException This exception is thrown when attempting to execute on a PISystem that is null or deleted.
NotSupportedException This exception is thrown when attempting to execute on a PISystem that does not support the AdminFunctionality feature.

Remarks

This method will Rebuilds the path cache to each element in the PI AF SQL Server database. The path cache can become outdated after significant data insertions, edits, and/or deletions. Rebuilding the path cache can improve the PI AF server’s performance.

Use the PISystem.Supports method to check if the PISystem supports the AdminFunctionality feature.

Security note Security Note
Requires the Admin right to execute.
Note Notes to Callers
This method will error on servers before AF 2018 R2 (2.10.5).

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5

See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in