Apache Derby Connector for C# Apache 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 C#. We will use high-performance Apache Derby Connector to easily connect to Apache Derby and then access the data inside C#. Let's follow the steps below to see how we can accomplish that! Download Documentation Apache Derby Connector for C# 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 Connect to Apache Derby in SSIS Connect to Apache Derby in SQL Server Connect to Apache Derby in Power BI Connect to Apache Derby in SSRS Connect to Apache Derby in Informatica Connect to Apache Derby in MS Access Connect to Apache Derby in MS Excel Connect to Apache Derby in SSAS Connect to Apache Derby in Python Connect to Apache Derby in JAVA Connect to Apache Derby in Tableau Connect to Apache Derby in SAP Crystal Reports Connect to Apache Derby in Azure Data Factory (Pipeline) Connect to Apache Derby in Azure Data Factory (SSIS) Connect to Apache Derby in Talend Studio Connect to Apache Derby in UiPath Connect to Apache Derby in PowerShell Connect to Apache Derby in ODBC

Prerequisites

Before we begin, make sure you meet the following prerequisite:

• Java 8 Runtime Environment (JRE) installed. It is recommended to use these distributions:

  • Amazon Corretto 8
  • Oracle JRE 8

Download Apache Derby JDBC driver

To connect to Apache Derby in C#, you will have to download JDBC driver for it, which we will use in later steps. Let's perform these little steps right away:

1. Visit Apache Derby website.
2. 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.
3. 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 C# 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 C#. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. 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.

4. 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:

   ApacheDerbyDSN

   jdbc:derby://hostname:1527/mydatabase

   org.apache.derby.jdbc.ClientDriver

   D:\Apache\derby\lib\derbyclient.jar

   admin

   **************

   []

   

   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

5. 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.

6. We are at the point where we can preview a SQL query. For more SQL query examples visit JDBC Bridge documentation:

   ApacheDerbyDSN

   SELECT * 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.

7. Click OK to finish creating the data source.

Video Tutorial

Read data in C#

Using ODBC DSN

1. Create a new Console project and use this code to read the data:
   

   "ApacheDerbyDSN";

   

2. Press F5 to run the code and read the data:
   

3. Here is the code in text format:

   using System;
   using System.Data.Odbc;
   
   namespace ConsoleApp {
       class Program {
           static void Main() {
               var dsn = "ApacheDerbyDSN";
               using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
               {
                   conn.Open();
                   var cmd = new OdbcCommand("SELECT * FROM Products", conn);
                   
                   //Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios
                   cmd.CommandTimeout=600; // 600-Seconds
                   
                   var rdr = cmd.ExecuteReader();
                   while (rdr.Read())
                   {
                       for (int i = 0; i < rdr.FieldCount; i++)
                       {
                               Console.Write("{0}\t", rdr[i]);
                       }
                       Console.WriteLine();
                   }
               }
               Console.ReadKey();
           }
       }
   }
   

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:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys JDBC Bridge Driver - Apache Derby

   Apache Derby Connector enables you to connect to Apache Derby, a lightweight, open-source relational database management system (RDBMS).

   ApacheDerbyDSN

   
2. The window opens, telling us the connection string was successfully copied to the clipboard:

3. Then in your C# code, pass the connection string as an argument when calling the OdbcConnection object's constructor, for example:

   var connectionString = @"DRIVER={ZappySys JDBC Bridge Driver};JdbcConnectionString='jdbc:derby://hostname:1527/mydatabase';ClassName='org.apache.derby.jdbc.ClientDriver';DriverPath='D:\Apache\derby\lib\derbyclient.jar';UserName='admin';UserPassword='**************';ConnParams='[]'";
   
   using (var conn = new OdbcConnection(connectionString))
   {
       // your code goes here
   }

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

1. Open your ODBC data source.
2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
4. Continue by pasting the copied connection string into a newly created file and save it.
5. Finally, the last step! Just construct a shorter ODBC connection string using this format:

   DRIVER={ZappySys JDBC Bridge Driver};SettingsFile=C:\temp\odbc-connection-string.txt

6. Our troubles are over! Now you should be able to use this connection string in C# with no problems.

Conclusion

In this article we showed you how to connect to Apache Derby in C# 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 C# 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 C# Documentation

More integrations

Other connectors for C#

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for Apache Derby

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Common Searches: