Export (0) Print
Expand All

PullSubscription.DatabaseName Property


Applies To: SQL Server 2016 Preview

Gets or sets the name of the subscription database.

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

public string DatabaseName { get; set; }

Property Value

Type: System.String

The name of the subscription database.

DatabaseName is a required property and must be set before the subscription is created on the server. Once the subscription exists on the server, the DatabaseName property cannot be changed.

The DatabaseName property can only be retrieved by members of the sysadmin fixed server role at the Subscriber or by members of the db_owner fixed database role on the subscription database.

The DatabaseName property can only be set by members of the sysadmin fixed server role at the Subscriber or by members of the db_owner fixed database role on the subscription database.

Retrieving the DatabaseName property is equivalent to executing sp_helppullsubscription (Transact-SQL) or sp_helpmergepullsubscription (Transact-SQL).

Setting the DatabaseName property is equivalent to executing sp_addpullsubscription (Transact-SQL) or sp_addmergepullsubscription (Transact-SQL).

Legacy Code Example

			// Define the Publisher, publication, and databases.
			string publicationName = "AdvWorksProductTran";
			string publisherName = publisherInstance;
			string subscriberName = subscriberInstance;
			string subscriptionDbName = "AdventureWorks2012Replica";
			string publicationDbName = "AdventureWorks2012";

			//Create connections to the Publisher and Subscriber.
			ServerConnection subscriberConn = new ServerConnection(subscriberName);
			ServerConnection publisherConn = new ServerConnection(publisherName);

			// Create the objects that we need.
			TransPublication publication;
			TransPullSubscription subscription;

				// Connect to the Publisher and Subscriber.

				// Ensure that the publication exists and that 
				// it supports pull subscriptions.
				publication = new TransPublication();
				publication.Name = publicationName;
				publication.DatabaseName = publicationDbName;
				publication.ConnectionContext = publisherConn;

				if (publication.IsExistingObject)
					if ((publication.Attributes & PublicationAttributes.AllowPull) == 0)
						publication.Attributes |= PublicationAttributes.AllowPull;

					// Define the pull subscription.
					subscription = new TransPullSubscription();
					subscription.ConnectionContext = subscriberConn;
					subscription.PublisherName = publisherName;
					subscription.PublicationName = publicationName;
					subscription.PublicationDBName = publicationDbName;
					subscription.DatabaseName = subscriptionDbName;

					// Specify the Windows login credentials for the Distribution Agent job.
					subscription.SynchronizationAgentProcessSecurity.Login = winLogin;
					subscription.SynchronizationAgentProcessSecurity.Password = winPassword;

					// Make sure that the agent job for the subscription is created.
					subscription.CreateSyncAgentByDefault = true;

                    // By default, subscriptions to transactional publications are synchronized 
                    // continuously, but in this case we only want to synchronize on demand.
                    subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.OnDemand;

                    // Create the pull subscription at the Subscriber.

					Boolean registered = false;

					// Verify that the subscription is not already registered.
					foreach (TransSubscription existing
						in publication.EnumSubscriptions())
						if (existing.SubscriberName == subscriberName
							&& existing.SubscriptionDBName == subscriptionDbName)
							registered = true;
					if (!registered)
						// Register the subscription with the Publisher.
							subscriberName, subscriptionDbName,
					// Do something here if the publication does not exist.
					throw new ApplicationException(String.Format(
						"The publication '{0}' does not exist on {1}.",
						publicationName, publisherName));
			catch (Exception ex)
				// Implement the appropriate error handling here.
				throw new ApplicationException(String.Format(
					"The subscription to {0} could not be created.", publicationName), ex);
Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft