Retrieving SQL Connection Data

Contents
[ ]

In Microsoft Excel, connect to a database by:

  1. Clicking the Data menu and selecting From Other Sources followed by From SQL Server.
  2. Then select Data followed by Connections.
  3. Use the Connections wizard to connect to the database and create a database query.

Aspose.Cells provides the Workbook.DataConnections property for retrieving external connections. It returns a collection of ExternalConnection objects in the workbook.

If the ExternalConnection object contains SQL connection data, it can be type-caste to a DBConnection object and its properties can be used to retrieve database command, command type, connection description, connection information, credentials, and so on.

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
// Create a workbook object from source file
Workbook workbook = new Workbook(dataDir+ "connection.xlsx");
// Access the external collections
ExternalConnectionCollection connections = workbook.DataConnections;
int connectionCount = connections.Count;
ExternalConnection connection = null;
for (int i = 0; i < connectionCount; i++)
{
connection = connections[i];
// Check if the Connection is DBConnection, then retrieve its various properties
if (connection is DBConnection)
{
DBConnection dbConn = (DBConnection)connection;
// Retrieve DB Connection Command
Console.WriteLine("Command: " + dbConn.Command);
// Retrieve DB Connection Command Type
Console.WriteLine("Command Type: " + dbConn.CommandType);
// Retrieve DB Connection Description
Console.WriteLine("Description: " + dbConn.ConnectionDescription);
// Retrieve DB Connection ID
Console.WriteLine("Id: " + dbConn.Id);
// Retrieve DB Connection Info
Console.WriteLine("Info: " + dbConn.ConnectionString);
// Retrieve DB Connection Credentials
Console.WriteLine("Credentials: " + dbConn.CredentialsMethodType);
// Retrieve DB Connection Name
Console.WriteLine("Name: " + dbConn.Name);
// Retrieve DB Connection ODC File
Console.WriteLine("OdcFile: " + dbConn.OdcFile);
// Retrieve DB Connection Source File
Console.WriteLine("Source file: " + dbConn.SourceFile);
// Retrieve DB Connection Type
Console.WriteLine("Type: " + dbConn.SourceType);
// Retrieve DB Connection Parameters Collection
ConnectionParameterCollection paramCollection = dbConn.Parameters;
int paramCount = paramCollection.Count;
// Iterate the Parameter Collection
for (int j = 0; j < paramCount; j++)
{
ConnectionParameter param = paramCollection[j];
// Retrieve Parameter Cell Reference
Console.WriteLine("Cell reference: " + param.CellReference);
// Retrieve Parameter Name
Console.WriteLine("Parameter name: " + param.Name);
// Retrieve Parameter Prompt
Console.WriteLine("Prompt: " + param.Prompt);
// Retrieve Parameter SQL Type
Console.WriteLine("SQL Type: " + param.SqlType);
// Retrieve Parameter Type
Console.WriteLine("Param Type: " + param.Type);
// Retrieve Parameter Value
Console.WriteLine("Param Value: " + param.Value);
}// End for
}// End if
}// End for