Skip to content

Add HANA connector #21034

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
beinan merged 1 commit into from
Oct 25, 2023
Merged

Add HANA connector #21034

Show file tree
Hide file tree
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
13 changes: 13 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@
<module>presto-open-telemetry</module>
<module>redis-hbo-provider</module>
<module>presto-singlestore</module>
<module>presto-hana</module>
</modules>

<dependencyManagement>
Expand Down Expand Up @@ -415,6 +416,12 @@
<version>${project.version}</version>
</dependency>

<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-hana</artifactId>
<version>${project.version}</version>
</dependency>

<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-bigquery</artifactId>
Expand Down Expand Up @@ -1164,6 +1171,12 @@
<version>3.18.1</version>
</dependency>

<dependency>
<groupId>com.sap.cloud.db.jdbc</groupId>
<artifactId>ngdbc</artifactId>
<version>2.17.12</version>
</dependency>

<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
Expand Down
1 change: 1 addition & 0 deletions presto-docs/src/main/sphinx/connector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ from different data sources.
connector/druid
connector/elasticsearch
connector/googlesheets
connector/hana
connector/hive
connector/hive-security
connector/hudi
Expand Down
100 changes: 100 additions & 0 deletions presto-docs/src/main/sphinx/connector/hana.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
====================
HANA Connector
====================

The HANA connector allows querying and creating tables in an
external HANA database. This can be used to join data between
different systems like HANA and Hive, or between two different
HANA instances.
Comment on lines +5 to +8
Copy link
Contributor

@kiersten-stokes kiersten-stokes Oct 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused about the support for creating tables. It's mentioned here that creating tables is supported, but then it says in the limitations section below that it isn't. We should probably clarify that and then add some tests as well if applicable

Copy link
Contributor Author

@JiamingMai JiamingMai Oct 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @kiersten-stokes. I just removed the redundant codes according to your comments. I have tested and clarified that CREATE TABLE and DROP TABLE statements are supported. But it is difficult to add the tests for similar reasons as SQL Server. It is very heavy to create an embedded HANA server. The only way to create an embedded HANA server is to build with docker image SAP HANA, express edition. Unfortunately, it is no longer maintained (it takes a large amount of RAM to create even if it still works).


Configuration
-------------

To configure the HANA connector, create a catalog properties file
in ``etc/catalog`` named, for example, ``hana.properties``, to
mount the HANA connector as the ``hana`` catalog.

Create the file with the following contents, replacing the
connection properties as appropriate for your setup:

.. code-block:: none

connector.name=hana
connection-url=jdbc:sap://[serverName[\instanceName][:portNumber]]
connection-user=root
connection-password=secret

Multiple HANA Databases or Servers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The HANA connector can only access a single database within
a HANA server. If you have multiple HANA databases,
or want to connect to multiple HANA instances, you must configure
multiple catalogs, one for each instance.

To add another catalog, add another properties file to ``etc/catalog``
with a different name (making sure it ends in ``.properties``). For example,
if you name the property file ``sales.properties``, Presto will create a
catalog named ``sales`` using the configured connector.

General Configuration Properties
---------------------------------

================================================== ==================================================================== ===========
Property Name Description Default
================================================== ==================================================================== ===========
``user-credential-name`` Name of the ``extraCredentials`` property whose value is the JDBC
driver's user name. See ``extraCredentials`` in `Parameter Reference
<https://prestodb.io/docs/current/installation/jdbc.html
#parameter-reference>`_.

``password-credential-name`` Name of the ``extraCredentials`` property whose value is the JDBC
driver's user password. See ``extraCredentials`` in `Parameter
Reference <https://prestodb.io/docs/current/installation/jdbc.html
#parameter-reference>`_.

``case-insensitive-name-matching`` Match dataset and table names case-insensitively. ``false``

``case-insensitive-name-matching.cache-ttl`` Duration for which remote dataset and table names will be
cached. Set to ``0ms`` to disable the cache. ``1m``
================================================== ==================================================================== ===========

Querying HANA
-------------------

The HANA connector provides access to all schemas visible to the specified user in the configured database.
For the following examples, assume the HANA catalog is ``hana``.

You can see the available schemas by running ``SHOW SCHEMAS``::

SHOW SCHEMAS FROM hana;

If you have a schema named ``web``, you can view the tables
in this schema by running ``SHOW TABLES``::

SHOW TABLES FROM hana.web;

You can see a list of the columns in the ``clicks`` table in the ``web`` database
using either of the following::

DESCRIBE hana.web.clicks;
SHOW COLUMNS FROM hana.web.clicks;

Finally, you can query the ``clicks`` table in the ``web`` schema::

SELECT * FROM hana.web.clicks;

If you used a different name for your catalog properties file, use
that catalog name instead of ``hana`` in the above examples.

HANA Connector Limitations
--------------------------------

The following SQL statements are not supported:

* :doc:`/sql/delete`
* :doc:`/sql/grant`
* :doc:`/sql/revoke`
* :doc:`/sql/show-grants`
* :doc:`/sql/show-roles`
* :doc:`/sql/show-role-grants`
177 changes: 177 additions & 0 deletions presto-hana/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
<?xml version="1.0"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-root</artifactId>
<version>0.285-SNAPSHOT</version>
</parent>

<artifactId>presto-hana</artifactId>
<description>Presto - HANA Connector</description>
<packaging>presto-plugin</packaging>

<properties>
<air.main.basedir>${project.parent.basedir}</air.main.basedir>
</properties>

<dependencies>
<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-base-jdbc</artifactId>
</dependency>

<dependency>
<groupId>com.facebook.airlift</groupId>
<artifactId>log</artifactId>
</dependency>

<dependency>
<groupId>com.facebook.airlift</groupId>
<artifactId>configuration</artifactId>
</dependency>

<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
</dependency>

<dependency>
<groupId>com.google.inject</groupId>
<artifactId>guice</artifactId>
</dependency>

<dependency>
<groupId>com.sap.cloud.db.jdbc</groupId>
<artifactId>ngdbc</artifactId>
</dependency>

<dependency>
<groupId>javax.inject</groupId>
<artifactId>javax.inject</artifactId>
</dependency>

<!-- Presto SPI -->
<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-spi</artifactId>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-common</artifactId>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>com.facebook.drift</groupId>
<artifactId>drift-api</artifactId>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>io.airlift</groupId>
<artifactId>slice</artifactId>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>io.airlift</groupId>
<artifactId>units</artifactId>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<scope>provided</scope>
</dependency>

<!-- for testing -->
<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-testng-services</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-testing-docker</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.facebook.airlift</groupId>
<artifactId>testing</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.facebook.airlift</groupId>
<artifactId>json</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-main</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-tpch</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>io.airlift.tpch</groupId>
<artifactId>tpch</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.facebook.presto</groupId>
<artifactId>presto-tests</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.jetbrains</groupId>
<artifactId>annotations</artifactId>
<version>19.0.0</version>
<scope>test</scope>
</dependency>
</dependencies>

<profiles>
<profile>
<id>ci</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<excludes combine.self="override" />
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>
Loading