GetDatabases Method

Retrieves a list of all existing Touchstone® Exposure or Results Databases stored on a given Data Source within a specific Business Unit.

Syntax

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

Public Function GetDatabases( _
   ByVal request As GetDatabasesRequest _
) As GetDatabasesResponse

Dim instance As DataSourceManagementServiceClient
Dim request As GetDatabasesRequest
Dim value As GetDatabasesResponse
 
value = instance.GetDatabases(request)

public GetDatabasesResponse GetDatabases( 
   GetDatabasesRequest request
)

Parameters

request: Contains a GetDatabasesRequest that identifies the Data Server name, Business Unit SID, and SQL Instance SID associated with the list of Databases that you want to retrieve.

Return Value

A GetDatabasesResponse containing a list of Databases stored on the specified Data Source within the specified Business Unit.

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.

To find the Data Server name to pass into this method, call the GetDataServers() method.

Note: This method only returns the Databases for the Business Unit that you specify.

Example

The following example shows how to retrieve a list of all Touchstone Databases stored on a given Data Source within a specific Business Unit using the GetDatabases() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.DataSourceManagement.Api;
using AIR.Services.DataSourceManagement.Data;
            
class SnippetGetDatabasesRequest
{
    private static void GetDataBases(int businessUnitSid, int sqlInstanceSid, string dataServerName)
    {
        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)
        {
            foreach (Database db in response.Databases)
            {
                Console.WriteLine("SID: " + db.Sid);
                Console.WriteLine("Name: " + db.Name);
                Console.WriteLine("Description: " + db.Description);
                Console.WriteLine("Status: " + db.Status);
                Console.WriteLine("Registered: " + db.Registered);
                Console.WriteLine("Type: " + db.Type);
                Console.WriteLine("Version: " + db.Version);
            }
        }
    }
}

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