aaGetReplicationGroups
- Last UpdatedMar 10, 2025
- 1 minute read
Returns the groups configured in the Historian database for a given replication server and type. If you specify all the parameters, then the specific group identified by the parameters is returned.
Syntax
aaGetReplicationGroups ConfigurationToReturn, ReplicationServerName, ReplicationTypeKey, ReplicationGroupName, IncludeEmptyGroups, ReplicationGroupKey, RowsToReturn
where:
|
Argument |
Description |
|---|---|
|
ConfigurationToReturn |
The return configuration for the replication service.This value is of data type tinyint, with a default of 1. |
|
ReplicationServerName |
The name of the replication server. This value is nvarchar(255), with a default of NULL. |
|
ReplicationTypeKey |
The type of replication. Value values are: 1 - Simple Replication 2 - Analog Summary Replication 3 - State Summary Replication This value is of data type tinyint, with a default of 2. |
|
ReplicationGroupName |
The name of the replication group. This value is nvarchar(255), with a default of NULL. |
|
IncludeEmptyGroups |
Bit that specifies whether to include empty groups in the return. This value is of data type bit, with a default of 0. |
|
ReplicationGroupKey |
Unique identifier for the replication group. This value is of data type int, with a default of NULL. |
|
RowsToReturn |
The number of rows to return. This value is of data type int, with a default of NULL. |
Permission
Execute permission defaults to the aaUsers, aaPowerUsers, and aaAdministrators groups.