SnapshotGenerationAgent.PublisherDatabase Property

Gets or sets the name of the publication database.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)

Syntax

'Declaration
Public Property PublisherDatabase As String 
    Get 
    Set
'Usage
Dim instance As SnapshotGenerationAgent 
Dim value As String 

value = instance.PublisherDatabase

instance.PublisherDatabase = value

public string PublisherDatabase { get; set; }

public:
virtual property String^ PublisherDatabase {
    String^ get () sealed;
    void set (String^ value) sealed;
}

abstract PublisherDatabase : string with get, set 
override PublisherDatabase : string with get, set

final function get PublisherDatabase () : String 
final function set PublisherDatabase (value : String)

Property Value

Type: System.String
A String value.

Implements

ISnapshotGenerationAgent.PublisherDatabase

Remarks

PublisherDatabase is a required property. An exception is thrown if PublisherDatabase is nulla null reference (Nothing in Visual Basic).

Examples

          // Set the Publisher, publication database, and publication names.
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2012";
            string publisherName = publisherInstance;
            string distributorName = publisherInstance;

            SnapshotGenerationAgent agent;

            try
            {
                // Set the required properties for Snapshot Agent.
                agent = new SnapshotGenerationAgent();
                agent.Distributor = distributorName;
                agent.DistributorSecurityMode = SecurityMode.Integrated;
                agent.Publisher = publisherName;
                agent.PublisherSecurityMode = SecurityMode.Integrated;
                agent.Publication = publicationName;
                agent.PublisherDatabase = publicationDbName;
                agent.ReplicationType = ReplicationType.Transactional;

                // Start the agent synchronously.
                agent.GenerateSnapshot();

            }
            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "A snapshot could not be generated for the {0} publication."
                    , publicationName), ex);
            }

' Set the Publisher, publication database, and publication names.
Dim publicationName As String = "AdvWorksProductTran"
Dim publicationDbName As String = "AdventureWorks2012"
Dim publisherName As String = publisherInstance
Dim distributorName As String = publisherInstance

Dim agent As SnapshotGenerationAgent

Try
    ' Set the required properties for Snapshot Agent.
    agent = New SnapshotGenerationAgent()
    agent.Distributor = distributorName
    agent.DistributorSecurityMode = SecurityMode.Integrated
    agent.Publisher = publisherName
    agent.PublisherSecurityMode = SecurityMode.Integrated
    agent.Publication = publicationName
    agent.PublisherDatabase = publicationDbName
    agent.ReplicationType = ReplicationType.Transactional

    ' Start the agent synchronously.
    agent.GenerateSnapshot()

Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
     "A snapshot could not be generated for the {0} publication." _
     , publicationName), ex)
End Try

See Also

Reference

SnapshotGenerationAgent Class

Microsoft.SqlServer.Replication Namespace