#132 Fix wording in hands-on-guide for Minio (#133)

exasol · Aug 29, 2023 · f846965 · f846965
1 parent e97286c
commit f846965
Show file tree

Hide file tree

Showing 11 changed files with 48 additions and 29 deletions.
diff --git a/cloudSetup/variables.tf b/cloudSetup/variables.tf
@@ -6,7 +6,7 @@ variable "deputy" {
 
 # Use a short project tag. Long tags will cause the exasol cluster creation to fail (see https://github.com/exasol/cloudformation-aws-exasol/issues/3)
 variable "project" {
-  default = "S3VS"
+  default = "VSS3"
 }
 
 variable "additional_tags" {

diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md
diff --git a/doc/changes/changes_2.8.1.md b/doc/changes/changes_2.8.1.md
@@ -0,0 +1,18 @@
+# S3 Document Files Virtual Schema 2.8.1, released 2023-??-??
+
+Code name:
+
+## Summary
+
+## Documentation
+
+* #132: Fixed wording in hands-on-guide for MinIO
+
+## Dependency Updates
+
+### Virtual Schema for Document Data in Files on AWS S3
+
+#### Plugin Dependency Updates
+
+* Updated `com.exasol:project-keeper-maven-plugin:2.9.10` to `2.9.11`
+* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.3.0` to `3.4.0`
diff --git a/doc/hands_on/hands_on.md b/doc/hands_on/hands_on.md
@@ -62,7 +62,7 @@ For the document Virtual Schemas, and by that also the S3 Virtual Schema, this i
 To install the Virtual Schema adapter, download its latest jar from the [releases](https://github.com/exasol/s3-document-files-virtual-schema/releases) and upload to BucketFS:
 
 ``` shell script
-curl -I -X PUT -T document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar http://w:writepw@<YOUR_DB_IP>:2580/default/
+curl -I -X PUT -T document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar http://w:writepw@<YOUR_DB_IP>:2580/default/
 ```
 
 (If you have never used BucketFS, you can check out [its documentation](https://docs.exasol.com/database_concepts/bucketfs/bucketfs.htm))
@@ -75,7 +75,7 @@ CREATE SCHEMA ADAPTER;
 --/
 CREATE OR REPLACE JAVA ADAPTER SCRIPT ADAPTER.S3_FILES_ADAPTER AS
     %scriptclass com.exasol.adapter.RequestDispatcher;
-    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar;
+    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar;
 /
 
 --/
@@ -85,7 +85,7 @@ CREATE OR REPLACE JAVA SET SCRIPT ADAPTER.IMPORT_FROM_S3_DOCUMENT_FILES(
   CONNECTION_NAME VARCHAR(500))
   EMITS(...) AS
     %scriptclass com.exasol.adapter.document.UdfEntryPoint;
-    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar;
+    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar;
 /
 ```
 

diff --git a/doc/hands_on/hands_on_minio.md b/doc/hands_on/hands_on_minio.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-VSS3 supports using two different variants of S3 buckets:
+Virtual Schema for Document Files in S3 (VSS3) supports using two different variants of S3 buckets:
 * Real S3 buckets in the AWS cloud
 * S3 buckets as emulated by [MinIO](https://min.io)'s S3-compatible interface
 
@@ -18,8 +18,8 @@ This Hands-On Guide describes how to access an S3 bucket emulated by a MinIO Doc
 
 Select a user name and a password for the MinIO Docker Container. Throughout this Hands On Guide these strings will be named as specified in column *Reference*:
 
-| MinIO Terminology                    | AWS terminology       | Reference |
-|--------------------------------------|-----------------------|-----------|
+| MinIO Terminology                    | AWS terminology       | Reference      |
+|--------------------------------------|-----------------------|----------------|
 | User name for MinIO Docker Container | `<AWS ACCESS KEY ID>` | `$MINIO_USER`  |
 | Password for MinIO Docker Container  | `<AWS SECRET KEY>`    | `$MINIO_PASS`  |
 
@@ -50,8 +50,8 @@ export MINIO_BUCKET=my-bucket
 docker run --detach --name minio \
   -p 9000:9000 \
   -p 9001:9001 \
-  -e "MINIO_ROOT_USER=$MUSER" \
-  -e "MINIO_ROOT_PASSWORD=$MPASS" \
+  -e "MINIO_ROOT_USER=$MINIO_USER" \
+  -e "MINIO_ROOT_PASSWORD=$MINIO_PASS" \
   -it minio/minio:latest \
   server /data --console-address ":9001"
 ```
@@ -73,7 +73,7 @@ In the output of `docker ps` you can also see the ports forwarded to your localh
 For adding content to MinIO you can use the MinIO client `mc`.
 Its [manual](https://min.io/docs/minio/linux/reference/minio-mc.html#quickstart) also contains links to download a binary for various platforms.
 
-The following following comand defines alias `myminio` for your MinIO server using the [selected credentials](#credentials):
+The following following command defines alias `myminio` for your MinIO server using the [selected credentials](#credentials):
 
 ```shell
 mc alias set myminio http://$MINIO_HOST:9000/ $MINIO_USER $MINIO_PASS
@@ -90,9 +90,9 @@ mc mb myminio/$MINIO_BUCKET
 Download the [sample Json files](./books) and upload them to the emulated S3 bucket:
 
 ```shell
-mc cp book-1.json myminio/$MBUCKET/
-mc cp book-2.json myminio/$MBUCKET/
-mc cp book-3.json myminio/$MBUCKET/
+mc cp book-1.json myminio/$MINIO_BUCKET/
+mc cp book-2.json myminio/$MINIO_BUCKET/
+mc cp book-3.json myminio/$MINIO_BUCKET/
 ```
 
 ## Setting up the Exasol Database
@@ -102,7 +102,7 @@ mc cp book-3.json myminio/$MBUCKET/
 Run Exasol database, e.g. as [Docker-DB](https://hub.docker.com/r/exasol/docker-db/tags) in a Docker Container and follow the instructions in the following sections of document [Hands-on S3-Virtual-Schema](hands_on.md) to execute the required SQL statements:
 
 * Section [ Installation](hands_on.md#installation)
-  * Download S3VS latest jar and upload it to BucketFS
+  * Download VSS3 latest jar and upload it to BucketFS
   * Create Java Adapter Script
   * Create Java Set Script
 * Section [Creating a Mapping Definition](hands_on.md#creating-a-mapping-definition) to create a mapping definition and upload it to BucketFS.
@@ -127,11 +127,11 @@ CREATE OR REPLACE CONNECTION S3_CONNECTION
 ```
 
 Please note:
-* Your SQL client (e.g. [DbVisualizer](https://confluence.dbvis.com)) may not be able to resolve shell variables `$MUSER`, `MPASS`, `$MHOST`, `$MBUCKET`.
+* Your SQL client (e.g. [DbVisualizer](https://confluence.dbvis.com)) may not be able to resolve shell variables `$MINIO_USER`, `MINIO_PASS`, `$MINIO_HOST`, `$MINIO_BUCKET`.
 * So please replace these variables by the actual values described in section [Variables](#variables).
 
 ### Create a Virtual Schema and Run Your First Query
 
 Follow additional instructions in document *Hands-on S3-Virtual-Schema*:
-* [Creating the Virtual Schema](#creating-the-virtual-schema)
+* [Creating the Virtual Schema](hands_on.md#creating-the-virtual-schema)
 * [First Query](hands_on.md#first-query) to execute your first query and watch the results in your SQL client.
diff --git a/doc/hands_on/hands_on_parquet.md b/doc/hands_on/hands_on_parquet.md
@@ -47,7 +47,7 @@ For the document Virtual Schemas, and by that also the S3 Virtual Schema, this i
 To install the Virtual Schema adapter, download its latest jar from the [releases](https://github.com/exasol/s3-document-files-virtual-schema/releases) and upload to BucketFS:
 
 ``` shell script
-curl -I -X PUT -T document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar http://w:writepw@<YOUR_DB_IP>:2580/default/
+curl -I -X PUT -T document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar http://w:writepw@<YOUR_DB_IP>:2580/default/
 ```
 
 (If you have never used BucketFS, you can check out [its documentation](https://docs.exasol.com/database_concepts/bucketfs/bucketfs.htm))
@@ -59,7 +59,7 @@ CREATE SCHEMA ADAPTER;
 
 CREATE OR REPLACE JAVA ADAPTER SCRIPT ADAPTER.S3_FILES_ADAPTER AS
     %scriptclass com.exasol.adapter.RequestDispatcher;
-    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar;
+    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar;
 /
 
 CREATE OR REPLACE JAVA SET SCRIPT ADAPTER.IMPORT_FROM_S3_DOCUMENT_FILES(
@@ -68,7 +68,7 @@ CREATE OR REPLACE JAVA SET SCRIPT ADAPTER.IMPORT_FROM_S3_DOCUMENT_FILES(
   CONNECTION_NAME VARCHAR(500))
   EMITS(...) AS
     %scriptclass com.exasol.adapter.document.UdfEntryPoint;
-    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar;
+    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar;
 /
 ```
 

diff --git a/doc/user_guide/user_guide.md b/doc/user_guide/user_guide.md
@@ -17,7 +17,7 @@ Next create the Adapter Script:
 ```sql
 CREATE OR REPLACE JAVA ADAPTER SCRIPT ADAPTER.S3_FILES_ADAPTER AS
     %scriptclass com.exasol.adapter.RequestDispatcher;
-    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar;
+    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar;
 /
 ```
 
@@ -30,7 +30,7 @@ CREATE OR REPLACE JAVA SET SCRIPT ADAPTER.IMPORT_FROM_S3_DOCUMENT_FILES(
   CONNECTION_NAME VARCHAR(500))
   EMITS(...) AS
     %scriptclass com.exasol.adapter.document.UdfEntryPoint;
-    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar;
+    %jar /buckets/bfsdefault/default/document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar;
 /
 ```
 
@@ -126,7 +126,7 @@ In DbVisualizer use exactly this command:
 --/
 CREATE OR REPLACE JAVA ADAPTER SCRIPT ADAPTER.S3_FILES_ADAPTER AS
    %scriptclass com.exasol.adapter.RequestDispatcher;
-   %jar /buckets/bfsdefault/default/vs/document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar;
+   %jar /buckets/bfsdefault/default/vs/document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar;
 /
 ```
 

diff --git a/pk_generated_parent.pom b/pk_generated_parent.pom
diff --git a/pom.xml b/pom.xml
@@ -2,7 +2,7 @@
 <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>
     <artifactId>s3-document-files-virtual-schema</artifactId>
-    <version>2.8.0</version>
+    <version>2.8.1</version>
     <name>Virtual Schema for document data in files on AWS S3</name>
     <description>Adapter for document data access from files from AWS S3.</description>
     <url>https://github.com/exasol/s3-document-files-virtual-schema/</url>
@@ -229,7 +229,7 @@
             <plugin>
                 <groupId>com.exasol</groupId>
                 <artifactId>project-keeper-maven-plugin</artifactId>
-                <version>2.9.10</version>
+                <version>2.9.11</version>
                 <executions>
                     <execution>
                         <goals>
@@ -348,7 +348,7 @@
     <parent>
         <artifactId>s3-document-files-virtual-schema-generated-parent</artifactId>
         <groupId>com.exasol</groupId>
-        <version>2.8.0</version>
+        <version>2.8.1</version>
         <relativePath>pk_generated_parent.pom</relativePath>
     </parent>
 </project>
diff --git a/src/test/java/com/exasol/adapter/document/files/IntegrationTestSetup.java b/src/test/java/com/exasol/adapter/document/files/IntegrationTestSetup.java
@@ -28,7 +28,7 @@
 
 public class IntegrationTestSetup implements AutoCloseable {
     public static final Path CLOUD_SETUP_CONFIG = Path.of("cloudSetup/generated/testConfig.json");
-    public static final String ADAPTER_JAR = "document-files-virtual-schema-dist-7.3.3-s3-2.8.0.jar";
+    public static final String ADAPTER_JAR = "document-files-virtual-schema-dist-7.3.3-s3-2.8.1.jar";
     public static final Path ADAPTER_JAR_LOCAL_PATH = Path.of("target", ADAPTER_JAR);
     public final String s3BucketName;
     private final ExasolTestSetup exasolTestSetup = new ExasolTestSetupFactory(CLOUD_SETUP_CONFIG).getTestSetup();

diff --git a/src/test/java/com/exasol/adapter/document/files/S3DocumentFilesAdapterIT.java b/src/test/java/com/exasol/adapter/document/files/S3DocumentFilesAdapterIT.java
@@ -216,7 +216,7 @@ private String getMappingDefinitionForSmallJsonFiles() {
     private void createTestSetupWithSmallJsonFiles(final int numberOfJsonFiles) throws IOException {
         createBucketIfNotExists(SMALL_JSON_FILES_FIXTURE_BUCKET);
         final AwsCredentialsProvider awsCredentialsProvider = TestConfig.instance().getAwsCredentialsProvider();
-        final Map<String, String> tags = Map.of("exa:project", "S3VS", "exa:owner", TestConfig.instance().getOwner());
+        final Map<String, String> tags = Map.of("exa:project", "VSS3", "exa:owner", TestConfig.instance().getOwner());
         new SmallJsonFilesTestSetup(awsCredentialsProvider, tags, SMALL_JSON_FILES_FIXTURE_BUCKET)
                 .setup(numberOfJsonFiles);
     }