MariaDbScriptRunner.java
/*
** Module : MariaDbScriptRunner.java
** Abstract : Run DDL SQL script against the MariaDB database
**
** Copyright (c) 2022-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 IAS 20220816 Created initial version.
** 002 IAS 20230908 Add support for more SQL script types.
** 003 SP 20240627 Fixed typo.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.persist.deploy;
import java.io.*;
import java.sql.*;
import java.util.*;
import java.util.regex.*;
import java.util.stream.*;
import com.goldencode.p2j.cfg.*;
import com.goldencode.p2j.persist.*;
import com.goldencode.p2j.persist.dialect.*;
import com.goldencode.p2j.util.*;
/**
* Run SQL script against the MariaDB database
*/
public class MariaDbScriptRunner
extends ScriptRunner
{
/** pattern for the MaridDBC URL parsing */
private static final Pattern JDBC = Pattern.compile("^jdbc:mariadb://[^/]*/([^?]*)\\?*");
/**
* PostgreSQL query for counting the number of UDFs with a spicefic name.
*/
private static final List<String> COUNT = Collections.unmodifiableList(
Arrays.asList(
"SELECT COUNT(*)",
"FROM information_schema.routines",
"WHERE routine_schema = ?",
" AND routine_type = 'FUNCTION'",
" AND routine_name LIKE ?"
));
/**
* Constructor.
*
* @param dialect
* The target database dialect
*/
public MariaDbScriptRunner(Dialect dialect)
{
super(dialect);
}
/**
* Provide a list of default UDF scripts
*
* @return the list of default UDF scripts;
*/
@Override
protected List<String> defaultUdfScripts()
{
return Arrays.asList("udfs.sql");
}
/**
* Apply SQL scripts.
*
* @param conn
* Database connection.
*
* @throws SQLException
* on SQL error.
* @throws IOException
* on script reading error.
*/
@Override
protected void applyUdfScripts(Connection conn)
throws SQLException, IOException
{
ScriptSplitter splitter = dialect.scriptSplitter();
applyScripts(conn, splitter);
}
/**
* Check for missing UDFs and create them.
*
* @param dbname
* Database name.
* @param url
* Database JDBC URL.
* @param adm
* Admin login.
* @param pwd
* Admin password.
*
* @throws SQLException
* on SQL error.
* @throws PersistenceException
* on script reading error.
*/
@Override
protected void createMissingUdfs(String dbname, String url, String adm, String pwd)
throws SQLException,
PersistenceException
{
Matcher matcher = JDBC.matcher(url);
if (!matcher.find())
{
throw new IllegalArgumentException("Unexpected JDBC URL: [" + url + "]");
}
String db = matcher.group(1);
List<String> scriptNames = new ArrayList<>();
try(Connection conn = DriverManager.getConnection(url, adm, pwd))
{
if (countUDFs(conn, db, "getfwdversion") == 0)
{
LOG.info(String.format("%s UDF not found in %s(%s); %s SQL script will be applied",
"'udf.getfwdversion'", dbname, db, "'udfs.sql'"));
scriptNames.add("udfs.sql");
}
scripts = addScriptPath(scriptNames);
try
{
applyUdfScripts(conn);
}
catch (IOException e)
{
throw new PersistenceException(e);
}
}
}
/**
* Count number of UDFs with a given name.
*
* @param conn
* The database connection.
* @param schema
* Schema name.
* @param name
* UDF name.
*
* @return number of UDFs with a given name.
*
* @throws SQLException
* On error.
*/
private int countUDFs(Connection conn, String schema, String name)
throws SQLException
{
String eoln = EnvironmentOps.OS_WIN.equalsIgnoreCase(Configuration.getParameter("opsys"))
? "\r\n" /* express to WINDOWS */ : "\n" /* default to Linux */;
String sql = COUNT.stream().collect(Collectors.joining(eoln));
try (PreparedStatement pstmt = conn.prepareStatement(sql))
{
int n = 0;
pstmt.setString(1, schema);
pstmt.setString(2, name + "%");
ResultSet rs = pstmt.executeQuery();
if (rs.next())
{
n = rs.getInt(1);
}
return n;
}
}
}