Skip to content

Update with link to documentation #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 31, 2020
Merged

Update with link to documentation #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 1 addition & 71 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,71 +1 @@
# Database Connector

The **Database connector** can be used to seamlessly connect to external databases without limiting you in your choice of database or SQL dialect, enabling you to incorporate your external data directly in your Mendix application.
This document will focus on executing an SQL (Structured Query Language) Select Query and executing an SQL Statement on **external relational databases**.

The **Execute query** action (present in the Database connector) provides a consistent environment for Mendix projects to perform an arbitrary Select SQL query on relational external databases. JDBC (Java Database Connectivity) API, a standard Java API,
is used when this Java action attempts to connect with a relational database for which a JDBC driver exists.

The **Execute statement** action (present in the Database connector) internally works in the same manner as **Execute query** action.
However, it is used for INSERT, UPDATE, DELETE, STORED PROCEDURE or DDL statements.

# Dependencies
* [HikariCP](http://brettwooldridge.github.io/HikariCP/), a high-performance JDBC connection pool.

# Installation
### Prerequisities
* A database **URL** address that points to your database.
* The **username** for logging into the database, relative to the database URL address.
* The **password** for logging into the database, relative to the database URL address.
* The **JDBC driver** libraries (.jar extension) (see also [here](#links-to-common-jdbc-drivers)), for the databases you want to connect to, must be placed inside the userlib directory of your Mendix application.
So if you want to connect to Amazon RDS PostgreSQL database (For e.g. *jdbc:postgresql://xyz-rds-instance.ccnapcvoeosh.eu-west-1.rds.amazonaws.com:5432/postgres*),
you need to place PostgreSQL Jdbc driver jar inside the userlib folder.
* **Specific to the Execute query action:**
An entity in the domain model, to be used for the results of the executed query.
Let's say that you want to execute a query like `select name, number from stock`. This query has two columns of type String and Integer respectively. In order to use the Execute query action, you have to add an entity in the domain model that has the same attributes as the columns in the query.

## Installation
Import the module **Database connector** in your project (from the Mendix AppStore or by downloading and exporting the module from this project)

# Getting Started
Once you have imported the DatabaseConnector module in your mendix application, you will have *Database connector* available in the Toolbox. It supports two actions *Execute query* and *Execute statement*.
In order to use any of these in your Mendix application, you can just drag and drop them to your microflow.
Next step would be to provide all the arguments to the selected action and choose the output result name.

### Execute query action
The result of this action is a list of objects of type Row, which is also the output of the SELECT SQL query.

### Execute statement action
The result of this action is either an Integer or a Long value which usually represents the amount of affected rows.

# Remarks
* It is a good practice to avoid having user input as part of your dynamic SQL queries and statements. In the future we will support using parameters with the queries or statements.
* Avoid fetching large amounts of data as it can lead to memory issues because all the ResultSet data is being loaded into memory at once.

# Links to common JDBC drivers
* [Amazon Redshift](http://docs.aws.amazon.com/redshift/latest/mgmt/configure-jdbc-connection.html#download-jdbc-driver)
* [Apache Derby](http://db.apache.org/derby/derby_downloads.html)
* [Firebird](http://www.firebirdsql.org/en/jdbc-driver/)
* [H2 Database Engine](http://www.h2database.com/)
* [HSQLDB](https://sourceforge.net/projects/hsqldb/files/)
* [IBM DB2](http://www-01.ibm.com/support/docview.wss?uid=swg21385217)
* [IBM Informix](https://www-01.ibm.com/marketing/iwm/tnd/search.jsp?go=y&rs=ifxjdbc)
* [MariaDB](https://downloads.mariadb.org/connector-java/)
* [Microsoft SQL Server/SQL Database](https://www.microsoft.com/en-us/download/details.aspx?id=11774)
* [MySQL](http://dev.mysql.com/downloads/connector/j/)
* [Oracle Database](http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html)
* [OrientDB](https://orientdb.com/download-2/)
* [PostgreSQL](https://jdbc.postgresql.org/download.html)
* [Presto](https://prestodb.io/docs/current/installation/jdbc.html)
* [SQLite](https://bitbucket.org/xerial/sqlite-jdbc/downloads)

# License
Licensed under the Apache license.

# Developers notes
* `git clone https://github.com/mendix/database-connector.git`
* Open the DatabaseConnector.mpr in the Mendix Modeler.
* Use *Deploy for Eclipse* option (F6) and you can then import this module as an Eclipse project to the Eclipse IDE.

# Version history
None
Please see [Database Connector](https://docs.mendix.com/appstore/connectors/database-connector) in the Mendix documentation for details.