PI Powershell

StartPIAFLinkBatchDatabaseMigration Class

Save PDF

TABLE OF CONTENTS

StartPIAFLinkBatchDatabaseMigration Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Starts PI Batch Database to AF Event Frame Migration

The Start-PIAFLinkBatchDatabaseMigration cmdlet starts the migration of the entire PI Batch Database to AF Event Frames. The AF Server, AF Database, and Root Element that this information is written to is determined by the settings used for PI Module Database to AF Synchronization. This can be found in the Module Database at %OSI\MDB-AFMigrationData, in the properties: PI System, AFDB, and RootElement, respectively.

WARNING: Once a PI Batch Database to Event Frames Migration has occurred, the Batch Database is read-only. PI Batch to Event Frames migration is a one-time operation and should only be done after any internal approvals, as well as PI Batch Database Analysis has been performed and any potential issues addressed.

See "Get-Help Start-PIAFLinkBatchDatabaseAnalysis -Full" for more information on running the analysis of the PI Batch database.

The connection parameter specifies the connection to a PI Data Archive to use.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellStartPIAFLinkBatchDatabaseMigration

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[CmdletAttribute("Start", "PIAFLinkBatchDatabaseMigration", SupportsShouldProcess = true)]
public class StartPIAFLinkBatchDatabaseMigration : OSICmdletBaseWithConnection

<CmdletAttribute("Start", "PIAFLinkBatchDatabaseMigration", SupportsShouldProcess := true)>
Public Class StartPIAFLinkBatchDatabaseMigration
	Inherits OSICmdletBaseWithConnection

Dim instance As StartPIAFLinkBatchDatabaseMigration

[CmdletAttribute(L"Start", L"PIAFLinkBatchDatabaseMigration", SupportsShouldProcess = true)]
public ref class StartPIAFLinkBatchDatabaseMigration : public OSICmdletBaseWithConnection

[<CmdletAttribute("Start", "PIAFLinkBatchDatabaseMigration", SupportsShouldProcess = true)>]
type StartPIAFLinkBatchDatabaseMigration =  
    class
        inherit OSICmdletBaseWithConnection
    end

The StartPIAFLinkBatchDatabaseMigration type exposes the following members.

Constructors

	Name	Description
	StartPIAFLinkBatchDatabaseMigration

Properties

	Name	Description
	Connection	Connection to a PI Data Archive to use (Overrides OSICmdletBaseWithConnectionConnection.)

Examples

Start-PIAFLinkBatchDatabaseMigration -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Starts the migration of the entire PI Batch Database to AF Event Frames.

See "Get-Help Start-PIAFLinkBatchDatabaseAnalysis -Full" for more information on running the analysis of the PI Batch database.

PI Powershell