Apache Derby Connector for PythonApache Derby Connector enables you to connect to Apache Derby, a lightweight, open-source relational database management system (RDBMS). In this article you will learn how to quickly and efficiently integrate Apache Derby data in Python. We will use high-performance Apache Derby Connector to easily connect to Apache Derby and then access the data inside Python. Let's follow the steps below to see how we can accomplish that! Apache Derby Connector for Python is based on ZappySys JDBC Bridge Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Apache Derby in other apps
|
Prerequisites
Before we begin, make sure you meet the following prerequisite:
-
Java 8 Runtime Environment (JRE) installed. It is recommended to use these distributions:
Download Apache Derby JDBC driver
To connect to Apache Derby in Python, you will have to download JDBC driver for it, which we will use in later steps. Let's perform these little steps right away:
- Visit Apache Derby website.
-
Follow the instructions there, download the JDBC drivers, and save them locally.
It is recommended to use JDBC driver compiled for Java 8, if possible.
- Done! That was easy, wasn't it? Let's proceed to the next step.
Create ODBC Data Source (DSN) based on ZappySys JDBC Bridge Driver
Step-by-step instructions
To get data from Apache Derby using Python we first need to create a DSN (Data Source) which will access data from Apache Derby. We will later be able to read data using Python. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys JDBC Bridge Driver
ZappySys JDBC Bridge Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
Now, we need to configure the JDBC connection in the new ODBC data source. Simply enter the Connection string, credentials, configure other settings, and then click Test Connection button to test the connection:
ApacheDerbyDSNjdbc:derby://hostname:1527/mydatabaseorg.apache.derby.jdbc.ClientDriverD:\Apache\derby\lib\derbyclient.jaradmin**************[]For Client/server Environment, use these values when setting parameters:
-
Connection string :jdbc:derby://hostname:1527/mydatabase
-
Driver class :org.apache.derby.jdbc.ClientDriver
-
JDBC driver file(s) :D:\Apache\derby\lib\derbyclient.jar
-
User name :admin
-
User password :**************
-
Connection parameters :[]
For Embedded Environment, use these values when setting parameters:
-
Connection string :jdbc:derby:c:\apache\derby\databases\mydatabase
-
Driver class :org.apache.derby.jdbc.EmbeddedDriver
-
JDBC driver file(s) :D:\Apache\derby\lib\derby.jar
-
-
You should see a message saying that connection test is successful:
Otherwise, if you are getting an error, check out our Community for troubleshooting tips.
-
We are at the point where we can preview a SQL query. For more SQL query examples visit JDBC Bridge documentation:
ApacheDerbyDSNSELECT * FROM "APP"."ORDERS"
SELECT * FROM "APP"."ORDERS"
You can also click on the <Select Table> dropdown and select a table from the list.The ZappySys JDBC Bridge Driver acts as a transparent intermediary, passing SQL queries directly to the Trino JDBC driver, which then handles the query execution. This means the Bridge Driver simply relays the SQL query without altering it.
Some JDBC drivers don't support
INSERT/UPDATE/DELETE
statements, so you may get an error saying "action is not supported" or a similar one. Please, be aware, this is not the limitation of ZappySys JDBC Bridge Driver, but is a limitation of the specific JDBC driver you are using. -
Click OK to finish creating the data source.
Video Tutorial
Read data in Python
Using ODBC DSN
-
Python code to get the data:
ApacheDerbyDSN') -
When you run the code it will make the API call and read the data:
-
Here is Python program's code in text format:
import pyodbc conn = pyodbc.connect('DSN=ApacheDerbyDSN') cursor = conn.cursor() #execute query to fetch data from API service cursor.execute("SELECT id,title FROM products") row = cursor.fetchone() while row: print(row) row = cursor.fetchone() ##For loop example #for row in cursor: # print(row)
Using a full ODBC connection string
If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:
-
Open ODBC data source configuration and click Copy settings:
ZappySys JDBC Bridge Driver - Apache DerbyApache Derby Connector enables you to connect to Apache Derby, a lightweight, open-source relational database management system (RDBMS).ApacheDerbyDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then in your Python code use Connection String when initializing OdbcConnection object, for example:
conn = pyodbc.connect('DRIVER={ZappySys JDBC Bridge Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')
How to install `pyodbc` in the Python?
You would need to install pyodbc
in Python if you intend to establish connections to databases that support ODBC (Open Database Connectivity). This module facilitates communication between Python applications and various database management systems, enabling you to perform operations such as querying, retrieving data, and managing databases. Here's how you can install pyodbc
in Python:
Installation Steps:
Ensure you have Python installed on your system. If not, download it from the official Python website and follow the installation instructions.
Open your terminal or command prompt.
-
Use the following command to install
pyodbc
using pip, the Python package installer:python -m pip install "pyodbc"
Make sure you have a stable internet connection and the necessary permissions to install Python packages.
Reasons to Install:
- If pyodbc is not installed, your Python script will generate the following error:
"ModuleNotFoundError: No module named 'pyodbc'"
. Database Connectivity:
pyodbc
allows Python to connect to various databases that support ODBC, such as Microsoft SQL Server, PostgreSQL, MySQL, and more.Data Operations: It facilitates the execution of SQL queries, retrieval of data, and other database operations from within Python scripts.
Cross-Platform Support:
pyodbc
is designed to work across different operating systems, including Windows, macOS, and various Linux distributions.Simplicity and Efficiency: The module provides an intuitive interface for managing database transactions and connections, simplifying the process of working with databases in Python.
By installing pyodbc
, you can seamlessly integrate your Python applications with a wide range of ODBC-supported databases, enabling efficient and effective data management and analysis.
Conclusion
In this article we showed you how to connect to Apache Derby in Python and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys JDBC Bridge Driver allows you to connect not only to Apache Derby, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Apache Derby Connector for Python and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Apache Derby Connector for Python Documentation
More integrations
Other connectors for Python
Other application integration scenarios for Apache Derby
How to connect Apache Derby in Python?
How to get Apache Derby data in Python?
How to read Apache Derby data in Python?
How to load Apache Derby data in Python?
How to import Apache Derby data in Python?
How to pull Apache Derby data in Python?
How to push data to Apache Derby in Python?
How to write data to Apache Derby in Python?
How to POST data to Apache Derby in Python?
Call Apache Derby API in Python
Consume Apache Derby API in Python
Apache Derby Python Automate
Apache Derby Python Integration
Integration Apache Derby in Python
Consume real-time Apache Derby data in Python
Consume real-time Apache Derby API data in Python
Apache Derby ODBC Driver | ODBC Driver for Apache Derby | ODBC Apache Derby Driver | SSIS Apache Derby Source | SSIS Apache Derby Destination
Connect Apache Derby in Python
Load Apache Derby in Python
Load Apache Derby data in Python
Read Apache Derby data in Python
Apache Derby API Call in Python