Learn more
 

Ready to get started?

Download a free trial of the SQL Server Driver to get started:

 Download Now

Learn more:

Microsoft SQL Server Icon SQL Server Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft SQL Server.

In this article

Related articles

Use JayDeBeApi to access SQL Server Data in Python


Use standard Python scripting and the development environment of your choice to access live SQL Server data.

Access SQL Server data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for SQL Server and the JayDeBeApi module to work with remote SQL Server data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to SQL Server and visualize SQL Server data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with SQL Server data in Python using SQL.

Connecting to Microsoft SQL Server

Connect to Microsoft SQL Server using the following properties:

  • Server: The name of the server running SQL Server.
  • User: The username provided for authentication with SQL Server.
  • Password: The password associated with the authenticating user.
  • Database: The name of the SQL Server database.

Connecting to Azure SQL Server and Azure Data Warehouse

You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

  • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
  • User: The name of the user authenticating to Azure.
  • Password: The password associated with the authenticating user.
  • Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the SQL Server JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.sql.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:sql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;"

Access SQL Server data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.sql.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from SQL Server:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:sql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.sql.jar" conn = jaydebeapi.connect( "cdata.jdbc.sql.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Orders;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for SQL Server and start working with your live SQL Server data in Python. Reach out to our Support Team if you have any questions.