Create a InterSystems IRIS database type apache#2515

nadment · May 14, 2023 · 0dec94d · 0dec94d
1 parent c4a34f6
commit 0dec94d
Show file tree

Hide file tree

Showing 13 changed files with 580 additions and 4 deletions.
diff --git a/assemblies/plugins/databases/iris-assemblies/pom.xml b/assemblies/plugins/databases/iris-assemblies/pom.xml
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to You under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~       http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  ~
+  -->
+
+<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>
+        <artifactId>hop-assemblies-plugins-databases</artifactId>
+        <groupId>org.apache.hop</groupId>
+        <version>2.4.0-SNAPSHOT</version>
+    </parent>
+
+
+    <artifactId>hop-assemblies-plugins-databases-iris</artifactId>
+    <version>2.4.0-SNAPSHOT</version>
+    <packaging>pom</packaging>
+
+    <name>Hop Assemblies Plugins Databases InterSystems Iris</name>
+    <description />
+
+    <properties>
+        <iris.version>3.6.1</iris.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.hop</groupId>
+            <artifactId>hop-databases-iris</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/assemblies/plugins/databases/iris-assemblies/src/assembly/assembly.xml b/assemblies/plugins/databases/iris-assemblies/src/assembly/assembly.xml
@@ -0,0 +1,55 @@
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to You under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~       http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  ~
+  -->
+
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
+    <id>hop-assemblies-plugins-databases-iris</id>
+    <formats>
+        <format>zip</format>
+    </formats>
+    <baseDirectory>databases/iris</baseDirectory>
+    <files>
+        <file>
+            <source>${project.basedir}/src/main/resources/version.xml</source>
+            <outputDirectory>.</outputDirectory>
+            <filtered>true</filtered>
+        </file>
+        <file>
+            <source>${project.basedir}/src/main/resources/PUT_JDBC_HERE</source>
+            <outputDirectory>lib</outputDirectory>
+            <filtered>true</filtered>
+        </file>        
+    </files>
+    <fileSets>
+        <fileSet>
+            <outputDirectory>lib</outputDirectory>
+            <excludes>
+                <exclude>**/*</exclude>
+            </excludes>
+        </fileSet>
+    </fileSets>
+    <dependencySets>
+        <dependencySet>
+            <useProjectArtifact>false</useProjectArtifact>
+            <includes>
+                <include>org.apache.hop:hop-databases-iris:jar</include>
+            </includes>
+        </dependencySet>        
+    </dependencySets>
+</assembly>
diff --git a/assemblies/plugins/databases/iris-assemblies/src/main/resources/version.xml b/assemblies/plugins/databases/iris-assemblies/src/main/resources/version.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to You under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~       http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  ~
+  -->
+
+<version>${project.version}</version>
diff --git a/assemblies/plugins/databases/pom.xml b/assemblies/plugins/databases/pom.xml
@@ -51,6 +51,7 @@
     <module>duckdb-assemblies</module>
     <module>monetdb-assemblies</module>
     <module>cache-assemblies</module>
+    <module>iris-assemblies</module>
     <module>exasol4-assemblies</module>
     <module>sqlbase-assemblies</module>
     <module>h2-assemblies</module>

diff --git a/docs/hop-user-manual/modules/ROOT/pages/database/databases/cache.adoc b/docs/hop-user-manual/modules/ROOT/pages/database/databases/cache.adoc
@@ -18,7 +18,7 @@ under the License.
 :documentationPath: /database/databases/
 :language: en_US
 
-= Cache
+= InterSystems Cache
 
 [cols="2*",options="header"]
 |===
@@ -31,3 +31,5 @@ under the License.
 |JDBC Url  | jdbc:Cache://hostname:1972/database
 |Driver folder | Hop Installation/plugins/databases/cache/lib
 |===
+
+NOTE: Old driver connection, prefer new InterSystems Iris connection.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/database/databases/iris.adoc b/docs/hop-user-manual/modules/ROOT/pages/database/databases/iris.adoc
@@ -0,0 +1,33 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+  http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+[[database-plugins-cache]]
+:documentationPath: /database/databases/
+:language: en_US
+
+= InterSystems Iris
+
+[cols="2*",options="header"]
+|===
+| Option | Info
+|Type | Relational
+|Driver | https://intersystems-community.github.io/iris-driver-distribution/[Driver Link]
+|Version Included | None
+|Hop Dependencies | None
+|Documentation | https://docs.intersystems.com/iris20223/csp/docbook/Doc.View.cls?KEY=BJAVA_connecting[Documentation Link]
+|JDBC Url  | jdbc:IRIS://hostname:port/database
+|Driver folder | Hop Installation/plugins/databases/iris/lib
+|===
diff --git a/plugins/databases/cache/pom.xml b/plugins/databases/cache/pom.xml
@@ -29,5 +29,5 @@
 
     <packaging>jar</packaging>
 
-    <name>Hop Plugins Databases Cache</name>
+    <name>Hop Plugins Databases InterSystem Cache</name>
 </project>
diff --git a/plugins/databases/cache/src/main/java/org/apache/hop/databases/cache/CacheDatabaseMeta.java b/plugins/databases/cache/src/main/java/org/apache/hop/databases/cache/CacheDatabaseMeta.java
@@ -26,9 +26,9 @@
 import org.apache.hop.core.row.IValueMeta;
 
 /**
- * Contains Intersystems Cache specific information through static final members
+ * Contains InterSystems Cache specific information through static final members
  */
-@DatabaseMetaPlugin(type = "CACHE", typeDescription = "Intersystems Cache", documentationUrl = "/database/databases/cache.html")
+@DatabaseMetaPlugin(type = "CACHE", typeDescription = "InterSystems Cache", documentationUrl = "/database/databases/cache.html")
 @GuiPlugin(id = "GUI-CacheDatabaseMeta")
 public class CacheDatabaseMeta extends BaseDatabaseMeta implements IDatabase {
   @Override

diff --git a/plugins/databases/iris/pom.xml b/plugins/databases/iris/pom.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to You under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~       http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  ~
+  -->
+
+<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">
+    <parent>
+        <artifactId>hop-plugins-databases</artifactId>
+        <groupId>org.apache.hop</groupId>
+        <version>2.4.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>hop-databases-iris</artifactId>
+
+    <packaging>jar</packaging>
+
+    <name>Hop Plugins Databases InterSystems Iris</name>
+</project>