SubmitDetachDatabase Method

Detaches a Touchstone® Exposure or Results Database from a SQL Database Server.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Function SubmitDetachDatabase( _
   ByVal request As SubmitDetachDatabaseRequest _
) As SubmitDetachDatabaseResponse

Dim instance As DataSourceManagementServiceClient
Dim request As SubmitDetachDatabaseRequest
Dim value As SubmitDetachDatabaseResponse
 
value = instance.SubmitDetachDatabase(request)

public SubmitDetachDatabaseResponse SubmitDetachDatabase( 
   SubmitDetachDatabaseRequest request
)

Parameters

request: Contains a SubmitDetachDatabaseRequest that identifies the properties of the Database that you want to detach, along with the associated Touchstone-generated Business Unit SID and SQL Instance SID.

Return Value

A SubmitDetachDatabaseResponse containing the Activity SID that uniquely identifies the asynchronous web service call that you made to detach the specified Database.

Remarks

To find the Business Unit SID to pass into this method, call the GetBusinessUnits() method.

To find the SQL Instance SID to pass into this method, call the GetSqlInstances() method.

Note: If you do not include the Database name as part of the Database that you specify in the SubmitDetachDatabaseRequest, the corresponding SubmitDetachDatabaseResponse still returns a StatusCode of Success. However, the console displays the message, "Database not found."

Example

The following example shows how to detach a Touchstone Database using the SubmitDetachDatabase() method:

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using AIR.Services.Common.Data;
using AIR.Services.DataSourceManagement.Api;
using AIR.Services.DataSourceManagement.Data;
            
class SnippetSubmitDetachDatabaseRequest
{
    private static void SubmitDetachDatabase(int businessUnitSid, int sqlInstanceSid, string dataServerName, string databaseName)
    {
        DataSourceManagementServiceClient dsClient = new DataSourceManagementServiceClient();
        GetDatabasesRequest request = new GetDatabasesRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.DataServerName = dataServerName;
        GetDatabasesResponse response = dsClient.GetDatabases(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Database db = response.Databases.FirstOrDefault(d => d.Name == databaseName);
            if (db == null)
            {
                Console.WriteLine("Database not found");
                return;
            }
            SubmitDetachDatabaseRequest detachRequest = new SubmitDetachDatabaseRequest();
            detachRequest.BusinessUnitSid = businessUnitSid;
            detachRequest.SqlInstanceSid = sqlInstanceSid;
            detachRequest.Database = db;
            SubmitDetachDatabaseResponse detachResponse = dsClient.SubmitDetachDatabase(detachRequest);
            if (detachResponse.Status.Code == StatusCode.Success)
            {
                Console.WriteLine("Submitted successfully to HPC with Activity ID: " + detachResponse.ActivitySid);
            }
        }
    }
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DataSourceManagementServiceClient Class
DataSourceManagementServiceClient Members