SubmitDeleteDatabase Method

Deletes a Touchstone® Exposure or Results Database.

Syntax

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

Public Function SubmitDeleteDatabase( _
   ByVal request As SubmitDeleteDatabaseRequest _
) As SubmitDeleteDatabaseResponse

Dim instance As DataSourceManagementServiceClient
Dim request As SubmitDeleteDatabaseRequest
Dim value As SubmitDeleteDatabaseResponse
 
value = instance.SubmitDeleteDatabase(request)

public SubmitDeleteDatabaseResponse SubmitDeleteDatabase( 
   SubmitDeleteDatabaseRequest request
)

Parameters

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

Return Value

A SubmitDeleteDatabaseResponse containing the Activity SID that uniquely identifies the asynchronous web service call that you made to delete 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 SubmitDeleteDatabaseRequest, the corresponding SubmitDeleteDatabaseResponse still returns a StatusCode of Success. However, the console displays the message, "Database not found."

Example

The following example shows how to delete a Touchstone Database using the SubmitDeleteDatabase() method:

using System;
using System.Linq;
using AIR.Services.Common.Data;
using AIR.Services.DataSourceManagement.Api;
using AIR.Services.DataSourceManagement.Data;
            
class SnippetSubmitDeleteDatabaseRequest
{
    private static void SubmitDeleteDatabase(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;
            }
            SubmitDeleteDatabaseRequest deleteRequest = new SubmitDeleteDatabaseRequest();
            deleteRequest.BusinessUnitSid = businessUnitSid;
            deleteRequest.SqlInstanceSid = sqlInstanceSid;
            deleteRequest.Database = db;
            SubmitDeleteDatabaseResponse deleteResponse = dsClient.SubmitDeleteDatabase(deleteRequest);
            if (deleteResponse.Status.Code == StatusCode.Success)
            {
                Console.WriteLine("Submitted successfully to HPC with Activity ID: " + deleteResponse.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