Commit 9835072a authored by Rainer Türner's avatar Rainer Türner
Browse files

SQL-MS initial commit

parent 01d88330
Pipeline #389 failed with stages
/logs/
/target/
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
/out/
# Näited
Kui rakenduse konfiguratsioone ei ole kuidagi muudetud,
siis värske rakendus stardib test konfiguratsiooniga, mis loob "in-memory" andmebaasi ning "test" nimelise ühenduse
selle andmebaasiga. Rakenduse töötamise ajal on nüüd kasutajal võimalik rakenduse funktsionaalsusi katsetada.
Allpool toodud näited kasutavad seda eelpooltoodud test andmebaasi ja andembaasi ühendust.
Andmebaasi on kohe rakendumise käivitamisel automaatselt lisatud tabelid user ja user_type, koos mõnede kirjetega.
Esimese näite puhul toon välja terve curl päringu.
Edaspidi on näidetes näidatud REST päringu JSON keha, näidislõik vastusest ja selle päringuga samaväärne SQL käsk.
## Veergude valimine (SELECT)
Request :
```
curl -X POST http://localhost:8080/test/select -H 'Content-Type: application/json' -H 'cache-control: no-cache' -d '{
"tableName": "user",
"columns": ["username", "email"]
}'
```
Equivalent SQL:
```
select username, email
from user
```
Response:
```
[{"username":"user1","email":"user1@example.com"},{"username":"user2","email":"user2@example.com"}]
```
## Tagastatud ridade limiteerimine (LIMIT)
Request body:
```
{
"tableName": "user",
"columns": ["username", "email"],
"limit": 1
}
```
Equivalent SQL:
```
select user_name, email
from user
limit 1
```
Response:
```
[{"username":"user1","email":"user1@example.com"}]
```
## Tulemuste järjestamine (ORDER BY)
Request body:
```
{
"tableName": "user",
"columns": ["username", "email"],
"orderBy": [{"columnName": "username", "sortOrder": "DESC"}]
}
```
Equivalent SQL:
```
select user_name, first_access_date, document_id
from document_sharing
order by first_access_date desc nulls last
```
Response:
```
[{"username":"user2","email":"user2@example.com"},{"username":"user1","email":"user1@example.com"}]
```
## Tulemuste grupeerimine (GROUP BY)
Request body:
```
{
"tableName": "user",
"columns": ["user_name", "count(*)"],
"groups": ["username"]
}
```
Equivalent SQL:
```
select username, count(*)
from user
group by username
```
Response:
```
[
[{"username":"user1","count(*)":1},{"username":"user2","count(*)":1}]
```
## Tulemuste tingimuslik tagastamine (WHERE)
Request body:
```
{
"tableName": "user",
"columns": ["username", "email"],
"condition": "email LIKE 'user2@example.com'"
}
```
NB! kui curli kasutad siis on vaja curli jsoni blokis teha pagemist
"condition": "email LIKE '\''user2@example.com'\''
Equivalent SQL:
```
select username, email
from user
where (email LIKE 'user2@example.com')
```
Response:
```
[{"username":"user2","email":"user2@example.com"}]
```
## Mitmest tabelist andmete pärimine (JOIN)
Request body:
```
{
"tableName": "user",
"joins": [{"tableName": "user_type", "joinCondition": "user.user_type_id = user_type.id"}],
"columns": ["username", "user_type", "email"],
}
```
Equivalent SQL:
```
select username, type, email
from user
join user_type
on (user.user_type_id = user_type.id)
```
Response:
```
[
{"username":"user1","type":"type 1","email":"user1@example.com"},
{"username":"user2","type":"type 2","email":"user2@example.com"}
]
```
## Väljundi alguskoha valimine (OFFSET)
Request body:
```
{
"tableName": "user",
"columns": ["username", "email"],
"offset": 1
}
```
Equivalent SQL:
```
select username, email
from user
offset 1
```
Response:
```
[{"username":"user2","email":"user2@example.com"}]
```
## Uute ridade lisamine (INSERT)
Järgnev näide on tehtud "POST /test/insert" REST API-otsa suunas.
request body:
```
{
"tableName": "user",
"columnValueMaps": [
{
"id" : 3,
"username": "user3",
"email": "user3@example.com",
"name": "User Number 3",
"user_type_id" : 1
},
{
"id" : 4,
"username": "user4",
"email": "user4@example.com",
"name": "User Number 4",
"user_type_id" : 2
}
]
}
```
Equivalent SQL:
```
INSERT INTO user (id, username, email, name, user_type_id)
VALUES (3, 'user3', 'user3@example.com', 'User Number 3', 1), (4, 'user4', 'user4@example.com', 'User Number 4', 2);
```
Response:
```
2
```
## Lisafunktsionaalsus spetsiifiliselt üksiku rea lisamiseks andmebaasi (INSERT)
Järgnev näide on tehtud "POST /portaal/singleInsert" REST API-otsa suunas.
Eraldi funktsionaalsus, mis võimaldab sisestamiskäsus massiivi mitte kasutada.
Kui on soov ainult ühte uut rida lisada.
request body:
```
{
"tableName": "epost.eaadressid",
"columnValueMap": {
"aadress": "leet_haxxor@aol.com",
"aktiveeritud": true
}
}
```
Equivalent SQL:
```
insert into "epost.eaadressid" (aadress, aktiveeritud)
values ('leet_haxxor@aol.com', true)
```
Response:
```
1
```
## Eksisteerivate ridade muutmine (UPDATE)
Järgnev näide on tehtud "PATCH /adit/update" REST API-otsa suunas.
Request body:
```
{
"tableName": "document_type",
"columnValueMap": {
"short_name": "Word",
"description": "Wordi dokument"
},
"condition": "short_name = 'text'"
}
```
Equivalent SQL:
```
update "document_type"
set short_name = 'Word', description = 'Wordi dokument'
where (short_name = 'text')
```
Response:
```
2
```
# SQL-MS
REST service to describe (Postgre)SQL queries as JSON configuration files
\ No newline at end of file
## About
SQL-MS (SQL microservices) is used to define SQL queries as JSON configuration files.
## Development and licencing
| | |
|-|-|
| **Licence** | MIT |
| **Current version** | 0.1 |
| **Initially developed for** | State Portal eesti.ee, Information System Authority, Republic of Estonia |
| **Architect** | **Version 1.0** - Rainer Türner, Information System Authority, Republic of Estonia |
| **Developers** | **Version 1.0** - Reach-U AS / lead developer Kristian Hunt, developers Lauri All and Jens-Konrad Preem<br> |
| **Main usage** | Core backend component of Estonian State Portal eesti.ee |
| **Maturity** | Release candidate, not ready for use in production |
| **Plans for the future** | 1. Security fixes;<br>2. Docker images to easily test locally |
#!/bin/sh
# ----------------------------------------------------------------------------
# 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
#
# https://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.
# ----------------------------------------------------------------------------
# ----------------------------------------------------------------------------
# Maven2 Start Up Batch script
#
# Required ENV vars:
# ------------------
# JAVA_HOME - location of a JDK home dir
#
# Optional ENV vars
# -----------------
# M2_HOME - location of maven2's installed home dir
# MAVEN_OPTS - parameters passed to the Java VM when running Maven
# e.g. to debug Maven itself, use
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
# MAVEN_SKIP_RC - flag to disable loading of mavenrc files
# ----------------------------------------------------------------------------
if [ -z "$MAVEN_SKIP_RC" ] ; then
if [ -f /etc/mavenrc ] ; then
. /etc/mavenrc
fi
if [ -f "$HOME/.mavenrc" ] ; then
. "$HOME/.mavenrc"
fi
fi
# OS specific support. $var _must_ be set to either true or false.
cygwin=false;
darwin=false;
mingw=false
case "`uname`" in
CYGWIN*) cygwin=true ;;
MINGW*) mingw=true;;
Darwin*) darwin=true
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html
if [ -z "$JAVA_HOME" ]; then
if [ -x "/usr/libexec/java_home" ]; then
export JAVA_HOME="`/usr/libexec/java_home`"
else
export JAVA_HOME="/Library/Java/Home"
fi
fi
;;
esac
if [ -z "$JAVA_HOME" ] ; then
if [ -r /etc/gentoo-release ] ; then
JAVA_HOME=`java-config --jre-home`
fi
fi
if [ -z "$M2_HOME" ] ; then
## resolve links - $0 may be a link to maven's home
PRG="$0"
# need this for relative symlinks
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG="`dirname "$PRG"`/$link"
fi
done
saveddir=`pwd`
M2_HOME=`dirname "$PRG"`/..
# make it fully qualified
M2_HOME=`cd "$M2_HOME" && pwd`
cd "$saveddir"
# echo Using m2 at $M2_HOME
fi
# For Cygwin, ensure paths are in UNIX format before anything is touched
if $cygwin ; then
[ -n "$M2_HOME" ] &&
M2_HOME=`cygpath --unix "$M2_HOME"`
[ -n "$JAVA_HOME" ] &&
JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
[ -n "$CLASSPATH" ] &&
CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
fi
# For Mingw, ensure paths are in UNIX format before anything is touched
if $mingw ; then
[ -n "$M2_HOME" ] &&
M2_HOME="`(cd "$M2_HOME"; pwd)`"
[ -n "$JAVA_HOME" ] &&
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
# TODO classpath?
fi
if [ -z "$JAVA_HOME" ]; then
javaExecutable="`which javac`"
if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
# readlink(1) is not available as standard on Solaris 10.
readLink=`which readlink`
if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
if $darwin ; then
javaHome="`dirname \"$javaExecutable\"`"
javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
else
javaExecutable="`readlink -f \"$javaExecutable\"`"
fi
javaHome="`dirname \"$javaExecutable\"`"
javaHome=`expr "$javaHome" : '\(.*\)/bin'`
JAVA_HOME="$javaHome"
export JAVA_HOME
fi
fi
fi
if [ -z "$JAVACMD" ] ; then
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
else
JAVACMD="`which java`"
fi
fi
if [ ! -x "$JAVACMD" ] ; then
echo "Error: JAVA_HOME is not defined correctly." >&2
echo " We cannot execute $JAVACMD" >&2
exit 1
fi
if [ -z "$JAVA_HOME" ] ; then
echo "Warning: JAVA_HOME environment variable is not set."
fi
CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
# traverses directory structure from process work directory to filesystem root
# first directory with .mvn subdirectory is considered project base directory
find_maven_basedir() {
if [ -z "$1" ]
then
echo "Path not specified to find_maven_basedir"
return 1
fi
basedir="$1"
wdir="$1"
while [ "$wdir" != '/' ] ; do
if [ -d "$wdir"/.mvn ] ; then
basedir=$wdir
break
fi
# workaround for JBEAP-8937 (on Solaris 10/Sparc)
if [ -d "${wdir}" ]; then
wdir=`cd "$wdir/.."; pwd`
fi
# end of workaround
done
echo "${basedir}"
}
# concatenates all lines of a file
concat_lines() {
if [ -f "$1" ]; then
echo "$(tr -s '\n' ' ' < "$1")"
fi
}
BASE_DIR=`find_maven_basedir "$(pwd)"`
if [ -z "$BASE_DIR" ]; then
exit 1;
fi
##########################################################################################
# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
# This allows using the maven wrapper in projects that prohibit checking in binary data.
##########################################################################################
if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
if [ "$MVNW_VERBOSE" = true ]; then
echo "Found .mvn/wrapper/maven-wrapper.jar"
fi
else
if [ "$MVNW_VERBOSE" = true ]; then
echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
fi
jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"
while IFS="=" read key value; do
case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
esac
done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
if [ "$MVNW_VERBOSE" = true ]; then
echo "Downloading from: $jarUrl"
fi
wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
if command -v wget > /dev/null; then
if [ "$MVNW_VERBOSE" = true ]; then
echo "Found wget ... using wget"
fi
wget "$jarUrl" -O "$wrapperJarPath"
elif command -v curl > /dev/null; then
if [ "$MVNW_VERBOSE" = true ]; then
echo "Found curl ... using curl"
fi
curl -o "$wrapperJarPath" "$jarUrl"
else
if [ "$MVNW_VERBOSE" = true ]; then
echo "Falling back to using Java to download"
fi
javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
if [ -e "$javaClass" ]; then
if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
if [ "$MVNW_VERBOSE" = true ]; then
echo " - Compiling MavenWrapperDownloader.java ..."
fi
# Compiling the Java class
("$JAVA_HOME/bin/javac" "$javaClass")
fi
if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
# Running the downloader
if [ "$MVNW_VERBOSE" = true ]; then
echo " - Running MavenWrapperDownloader.java ..."
fi
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
fi
fi
fi
fi
##########################################################################################
# End of extension
##########################################################################################
export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
if [ "$MVNW_VERBOSE" = true ]; then
echo $MAVEN_PROJECTBASEDIR
fi
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.datasource") $MAVEN_OPTS"
# For Cygwin, switch paths to Windows format before running java
if $cygwin; then
[ -n "$M2_HOME" ] &&
M2_HOME=`cygpath --path --windows "$M2_HOME"`
[ -n "$JAVA_HOME" ] &&
JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
[ -n "$CLASSPATH" ] &&
CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
[ -n "$MAVEN_PROJECTBASEDIR" ] &&
MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
fi
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
exec "$JAVACMD" \
$MAVEN_OPTS \
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
"-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
@REM ----------------------------------------------------------------------------
@REM Licensed to the Apache Software Foundation (ASF) under one
@REM or more contributor license agreements. See the NOTICE file
@REM distributed with this work for additional information
@REM regarding copyright ownership. The ASF licenses this file
@REM to you under the Apache License, Version 2.0 (the
@REM "License"); you may not use this file except in compliance
@REM with the License. You may obtain a copy of the License at
@REM
@REM https://www.apache.org/licenses/LICENSE-2.0
@REM
@REM Unless required by applicable law or agreed to in writing,
@REM software distributed under the License is distributed on an
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@REM KIND, either express or implied. See the License for the
@REM specific language governing permissions and limitations
@REM under the License.
@REM ----------------------------------------------------------------------------
@REM ----------------------------------------------------------------------------
@REM Maven2 Start Up Batch script
@REM
@REM Required ENV vars:
@REM JAVA_HOME - location of a JDK home dir
@REM
@REM Optional ENV vars
@REM M2_HOME - location of maven2's installed home dir
@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending
@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
@REM e.g. to debug Maven itself, use
@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
@REM ----------------------------------------------------------------------------
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
@echo off
@REM set title of command window
title %0
@REM enable echoing my setting MAVEN_BATCH_ECHO to 'on'
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
@REM set %HOME% to equivalent of $HOME
if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
@REM Execute a user defined script before this one
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
@REM check for pre script, once with legacy .bat ending and once with .cmd ending
if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
:skipRcPre
@setlocal
set ERROR_CODE=0
@REM To isolate internal variables from possible post scripts, we use another setlocal
@setlocal
@REM ==== START VALIDATION ====
if not "%JAVA_HOME%" == "" goto OkJHome
echo.
echo Error: JAVA_HOME not found in your environment. >&2
echo Please set the JAVA_HOME variable in your environment to match the >&2
echo location of your Java installation. >&2
echo.
goto error
:OkJHome
if exist "%JAVA_HOME%\bin\java.exe" goto init
echo.
echo Error: JAVA_HOME is set to an invalid directory. >&2