tbrugz.sqldump.datadump.JSONDataDump Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sqldump Show documentation
Utility to dump schema and data from a RDBMS
There is a newer version: 0.9.17
package tbrugz.sqldump.datadump;

import java.io.IOException;
import java.io.Writer;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import tbrugz.sqldump.util.SQLUtils;
import tbrugz.sqldump.util.StringDecorator;
import tbrugz.sqldump.util.Utils;

/*
 * XXX: option to use 'milliseconds in Universal Coordinated Time (UTC) since epoch' as date
 *      dateformat? maybe with JSR-310 (http://threeten.sourceforge.net/)?
 * 
 * see: http://weblogs.asp.net/bleroy/archive/2008/01/18/dates-and-json.aspx
 *      http://msdn.microsoft.com/en-us/library/bb299886.aspx 
 *      
 * TODO: option to output as hash (using pkcols)
 * TODO: add prepend/append (JSONP option) / ?callback=xxx
 * 
 * see: http://dataprotocols.org/json-table-schema/
 */
public class JSONDataDump extends AbstractDumpSyntax {

	static final Log log = LogFactory.getLog(JSONDataDump.class);

	static final String JSON_SYNTAX_ID = "json";
	static final String PREFIX_JSON = "sqldump.datadump."+JSON_SYNTAX_ID;

	static final String DEFAULT_METADATA_ELEMENT = "$metadata"; // "@metadata"? "$metadata" ?
	// see http://json-schema.org/example1.html ('$' can be used in js identifier)
	static final String DEFAULT_DATE_FORMAT = "\"yyyy-MM-dd\"";
	
	static final String PROP_DATA_ELEMENT = PREFIX_JSON+".data-element";
	static final String PROP_ADD_METADATA = PREFIX_JSON+".add-metadata";
	static final String PROP_METADATA_ELEMENT = PREFIX_JSON+".metadata-element";
	static final String PROP_JSONP_CALLBACK = PREFIX_JSON+".callback";
	
	static final StringDecorator doubleQuoter = new StringDecorator.StringQuoterDecorator("\"");
	
	String dataElement = null; //XXX "data" as default dataElement? "rows"?
	boolean addMetadata = false;
	String metadataElement = DEFAULT_METADATA_ELEMENT;
	String callback = null;
	
	String padding = "";
	
	boolean usePK = false; //XXX: option to set prop usePK
	
	@Override
	public void procProperties(Properties prop) {
		procStandardProperties(prop);
		if(dateFormatter==null) {
			dateFormatter = new SimpleDateFormat(DEFAULT_DATE_FORMAT);
		}
		dataElement = prop.getProperty(PROP_DATA_ELEMENT);
		addMetadata = Utils.getPropBool(prop, PROP_ADD_METADATA, addMetadata);
		metadataElement = prop.getProperty(PROP_METADATA_ELEMENT, metadataElement);
		callback = prop.getProperty(PROP_JSONP_CALLBACK);
		postProcProperties();
	}

	@Override
	public void initDump(String schema, String tableName, List pkCols, ResultSetMetaData md) throws SQLException {
		super.initDump(schema, tableName, pkCols, md);
		if(lsColNames.size()!=lsColTypes.size()) {
			log.warn("diff lsColNames/lsColTypes sizes: "+lsColNames.size()+" ; "+lsColTypes.size());
		}
		//if(pkCols==null) { usePK = false; } else { usePK = true; }
	}
	
	@Override
	public void dumpHeader(Writer fos) throws IOException {
		String dtElem = dataElement!=null?dataElement:tableName;
		
		if(callback!=null) {
			out(callback+"(", fos);
		}
		
		if(dtElem!=null) {
			out("{", fos);
			//TODOne: add metadata
			if(addMetadata) {
				StringBuilder sb = new StringBuilder();
				//sb.append("\n\t\"schema\": \""+schema+"\"");
				sb.append("\n"+padding+"\t\t\"name\": \""+tableName+"\",");
				sb.append("\n"+padding+"\t\t\"columns\": ["+Utils.join(lsColNames, ", ", doubleQuoter)+"],");
				sb.append("\n"+padding+"\t\t\"columnTypes\": ["+Utils.join(getClassesSimpleName(lsColTypes), ", ", doubleQuoter)+"]");
				//sb.append("\n\t\"dataElement\": \""+dataElement+"\"");
				
				out("\n\t\""+metadataElement+"\": "
						+"{"
						+sb.toString()
						+"\n"+padding+"\t},"
						, fos);
			}
			outNoPadding("\n"+padding+"\t\""+dtElem+"\": "
				+(usePK?"{":"[")
				+"\n", fos);
		}
		else {
			outNoPadding((usePK?"{":"[")
				+"\n", fos);
		}
	}

	@Override
	public void dumpRow(ResultSet rs, long count, Writer fos) throws IOException, SQLException {
		StringBuilder sb = new StringBuilder();
		sb.append("\t\t"+(count==0?"":","));
		if(usePK) {
			sb.append("\"");
			for(int i=0;i0) { sb.append("_"); }
				sb.append(rs.getString(pkCols.get(i)));
			}
			sb.append("\": ");
		}
		sb.append("{");
		
		List