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 for Python via .NET 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.

from aspose import pycore
from aspose.cells import Workbook
from aspose.cells.externalconnections import DBConnection
# For complete examples and data files, please go to https:# github.com/aspose-cells/Aspose.Cells-for-.NET
# The path to the documents directory.
dataDir = RunExamples.GetDataDir(".")
# Create a workbook object from source file
workbook = Workbook(dataDir + "connection.xlsx")
# Access the external collections
connections = workbook.data_connections
connectionCount = len(connections)
connection = None
for i in range(connectionCount):
connection = connections[i]
# Check if the Connection is DBConnection, then retrieve its various properties
if connection is DBConnection:
dbConn = pycore.cast(DBConnection, connection)
# Retrieve DB Connection Command
print("Command: " + dbConn.command)
# Retrieve DB Connection Command Type
print("Command Type: " + str(dbConn.command_type))
# Retrieve DB Connection Description
print("Description: " + dbConn.connection_description)
# Retrieve DB Connection ID
print("Id: " + str(dbConn.connection_id))
# Retrieve DB Connection Info
print("Info: " + dbConn.connection_info)
# Retrieve DB Connection Credentials
print("Credentials: " + str(dbConn.credentials_method_type))
# Retrieve DB Connection Name
print("Name: " + dbConn.name)
# Retrieve DB Connection ODC File
print("OdcFile: " + dbConn.odc_file)
# Retrieve DB Connection Source File
print("Source file: " + dbConn.source_file)
# Retrieve DB Connection Type
print("Type: " + str(dbConn.type))
# Retrieve DB Connection Parameters Collection
paramCollection = dbConn.parameters
paramCount = len(paramCollection)
# Iterate the Parameter Collection
for j in range(paramCount):
param = paramCollection[j]
# Retrieve Parameter Cell Reference
print("Cell reference: " + param.cell_reference)
# Retrieve Parameter Name
print("Parameter name: " + param.name)
# Retrieve Parameter Prompt
print("Prompt: " + param.prompt)
# Retrieve Parameter SQL Type
print("SQL Type: " + str(param.sql_type))
# Retrieve Parameter Type
print("Param Type: " + str(param.type))
# Retrieve Parameter Value
print("Param Value: " + str(param.value))