GroovySqlExtensions.java

/*
 * JBoss, Home of Professional Open Source.
 * See the COPYRIGHT.txt file distributed with this work for information
 * regarding copyright ownership.  Some portions may be licensed
 * to Red Hat, Inc. under one or more contributor license agreements.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General public static
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General public static License for more details.
 * 
 * You should have received a copy of the GNU Lesser General public static
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

package org.teiid.adminshell;

import groovy.sql.TeiidSql;

import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.sql.SQLXML;
import java.sql.Types;
import java.util.Properties;

import org.teiid.jdbc.TeiidDriver;
import org.teiid.net.TeiidURL;
import org.teiid.script.io.ResultSetReader;

/**
 * Extensions of Groovy Sql support, which somewhat bridges the gap to our old adminshell sql logic
 */
public class GroovySqlExtensions {
	
	private static Help help = new Help(GroovySqlExtensions.class);
	
	@Help.Doc(text = "Get a Teiid connection with a URL")
	public static TeiidSql connect(
			@Help.Doc(text = "url") String url) throws SQLException {
		return connect(url, null, null);
	}

	@Help.Doc(text = "Get a Teiid connection")
	public static TeiidSql connect(
			@Help.Doc(text = "url") String url, 
			@Help.Doc(text = "user") String user, 
			@Help.Doc(text = "password") String password) throws SQLException {
		Properties info = new Properties();
		if (user != null) {
			info.setProperty(TeiidURL.CONNECTION.USER_NAME, user);
		}
		if (password != null) {
			info.setProperty(TeiidURL.CONNECTION.PASSWORD, password);
		}
		Connection c = TeiidDriver.getInstance().connect(url, info);
		if (c == null) {
			throw new SQLException("Invalid url " + url);
		}
		return new TeiidSql(c);
	}
	
	@SuppressWarnings("nls")
	@Help.Doc(text = "Get a SQL connection using the defaults from connection.properties")
	public static TeiidSql connect() throws SQLException {
		AdminShell.loadConnectionProperties();
		return connect(AdminShell.p.getProperty("jdbc.url", "jdbc:teiid:VDB@mm://localhost:31000"), 
				AdminShell.p.getProperty("jdbc.user", "admin"), AdminShell.p.getProperty("jdbc.password", "teiid"));
	}
	
	@Help.Doc(text = "Alternate row to String method that pretty prints SQL/XML",
		moreText = "e.g. sql.eachRow(\"select * from tables\", {row -> println rowToString(row) })")
	public static String rowToString(ResultSet results) throws SQLException {
		StringBuilder sb = new StringBuilder();
		//alternative toString - see GroovyResultSetExtension
		int columnCount = results.getMetaData().getColumnCount();
		for (int col = 1; col <= columnCount; col++) {
		    int type = results.getMetaData().getColumnType(col);
		    if (type == Types.BLOB) {
		    	Object anObj = results.getObject(col);
		        sb.append(anObj != null ? "BLOB" : "null"); //$NON-NLS-1$ //$NON-NLS-2$
		    }
		    else if (type == Types.SQLXML) {
		    	SQLXML xml = results.getSQLXML(col);
		    	sb.append(xml != null ? ResultSetReader.prettyPrint(xml) : "null"); //$NON-NLS-1$
		    }
		    else {
		    	String str = results.getString(col);
		        sb.append(str != null ? str : "null"); //$NON-NLS-1$
		    }
		    if (col != columnCount) {
		        sb.append("    "); //$NON-NLS-1$ 
		    }                    
		}
		return sb.toString();
	}
	
	@Help.Doc(text = "Pretty prints the ResultSetMetadata",
			moreText = {"e.g. sql.eachRow(\"select * from tables\", {rsmd -> println resultSetMetaDataToString(rsmd)},",
					    "                {row -> println rowToString(row) })"})
	public static String resultSetMetaDataToString(ResultSetMetaData rsmd) throws SQLException {
		return ResultSetReader.resultSetMetaDataToString(rsmd, "    "); //$NON-NLS-1$
	}
	
	@Help.Doc(text = "Show help for all SQL Extension methods")
	public static void sqlHelp() {
		help.help();
	}
	
	@Help.Doc(text = "Show help for the given SQL Extension method")
	public static void sqlHelp(
			@Help.Doc(text = "method name") String method) {
		help.help(method);
	}

}