SQLiteDB.java

/*
 * Copyright 2014 Gregory Graham.
 *
 * Licensed 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
 *
 *      http://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.
 */
package nz.co.gregs.dbvolution.databases;

import java.io.File;
import java.io.IOException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.sql.Statement;
import javax.sql.DataSource;
import nz.co.gregs.dbvolution.databases.metadata.DBDatabaseMetaData;
import nz.co.gregs.dbvolution.databases.metadata.Options;
import nz.co.gregs.dbvolution.databases.metadata.SQLiteDBDatabaseMetaData;
import nz.co.gregs.dbvolution.databases.settingsbuilders.SQLiteSettingsBuilder;
import org.sqlite.SQLiteConfig;
import nz.co.gregs.dbvolution.exceptions.ExceptionDuringDatabaseFeatureSetup;
import nz.co.gregs.dbvolution.internal.query.StatementDetails;
import nz.co.gregs.dbvolution.internal.sqlite.*;
import nz.co.gregs.regexi.Regex;

/**
 * Creates a DBDatabase for an SQLite database.
 *
 *
 * @author Gregory Graham
 */
public class SQLiteDB extends DBDatabaseImplementation {

	public static final String SQLITE_DRIVER_NAME = "org.sqlite.JDBC";
	public static final long serialVersionUID = 1l;

	/**
	 * Creates a DBDatabase tweaked for a SQLite database on the DataSource
	 * provided.
	 *
	 * @param ds	ds
	 * @throws java.sql.SQLException database errors
	 */
	public SQLiteDB(DataSource ds) throws SQLException {
		super(
				new SQLiteSettingsBuilder().setDataSource(ds)
		);
	}

	/**
	 * Creates a DBDatabase tweaked for a SQLite database on the DataSource
	 * provided.
	 *
	 * @param ds	ds
	 * @throws java.sql.SQLException database errors
	 */
	public SQLiteDB(DatabaseConnectionSettings ds) throws SQLException {
		this(new SQLiteSettingsBuilder().fromSettings(ds));
	}

	/**
	 * Creates a DBDatabase tweaked for a SQLite database on the DataSource
	 * provided.
	 *
	 * @param ds	ds
	 * @throws java.sql.SQLException database errors
	 */
	public SQLiteDB(SQLiteSettingsBuilder ds) throws SQLException {
		super(ds);
	}

	/**
	 * Creates a DBDatabase tweaked for a SQLite database using the parameters
	 * provided.
	 *
	 * @param jdbcURL jdbcURL
	 * @param username username
	 * @param password password
	 * @throws java.sql.SQLException database errors
	 */
	public SQLiteDB(String jdbcURL, String username, String password) throws SQLException {
		this(new SQLiteSettingsBuilder().fromJDBCURL(jdbcURL, username, password));
	}

	/**
	 * Creates a DBDatabase tweaked for a SQLite database using the parameters
	 * provided.
	 *
	 * @param databaseFile the SQLite file to be used with this database
	 * @param username username
	 * @param password password
	 * @throws java.io.IOException file system errors
	 * @throws java.sql.SQLException database errors
	 */
	public SQLiteDB(File databaseFile, String username, String password) throws IOException, SQLException {
		this(
				new SQLiteSettingsBuilder()
						.setFilename(databaseFile.getCanonicalFile().toString())
						.setDatabaseName(databaseFile.getCanonicalFile().toString())
						.setUsername(username)
						.setPassword(password)
		);
	}

	/**
	 * Creates a DBDatabase tweaked for a SQLite database using the parameters
	 * provided.
	 *
	 * @param filename the SQLite file to connect to.
	 * @param username username
	 * @param password password
	 * @param dummy just use TRUE
	 * @throws java.io.IOException file system errors
	 * @throws java.sql.SQLException database errors
	 */
	public SQLiteDB(String filename, String username, String password, boolean dummy) throws IOException, SQLException {
		this(
				new SQLiteSettingsBuilder()
						.setFilename(filename)
						.setDatabaseName(new File(filename).getCanonicalFile().toString())
						.setUsername(username)
						.setPassword(password)
		);
	}

	@Override
	public Connection getConnectionFromDriverManager() throws SQLException {
		SQLiteConfig config = new SQLiteConfig();
		config.enableCaseSensitiveLike(true);
		Connection connection = DriverManager.getConnection(getJdbcURL(), getUsername(), getPassword());
		config.apply(connection);
		addMissingFunctions(connection);
		return connection;
	}

	private void addMissingFunctions(Connection connection) throws SQLException {
		MissingStandardFunctions.addFunctions(this, connection);
		DateRepeatFunctions.addFunctions(connection);
		Point2DFunctions.addFunctions(connection);
		MultiPoint2DFunctions.addFunctions(connection);
		LineSegment2DFunctions.addFunctions(connection);
		Line2DFunctions.addFunctions(connection);
		Polygon2DFunctions.addFunctions(connection);
	}

	@Override
	public DBDatabase clone() throws CloneNotSupportedException {
		return super.clone(); //To change body of generated methods, choose Tools | Templates.
	}

	@Override
	public void addDatabaseSpecificFeatures(Statement statement) throws ExceptionDuringDatabaseFeatureSetup {
		;
	}

	@Override
	public Integer getDefaultPort() {
		return 5432;
	}

	private static final Regex TABLE_ALREADY_EXISTS = Regex.empty()
			.literal("[SQLITE_ERROR] SQL error or missing database (table ").noneOfThisCharacter(' ').optionalMany()
			.literal(" already exists)").toRegex();
	private static final Regex TABLE_DOESNT_EXIST_REGEX = Regex.empty()
			.literal("[SQLITE_ERROR] SQL error or missing database (no such table: ")
			.toRegex();

	@Override
	public ResponseToException addFeatureToFixException(Exception exp, QueryIntention intent, StatementDetails details) throws Exception {
		String message = exp.getMessage();
		if (intent.is(QueryIntention.CREATE_TABLE) && TABLE_ALREADY_EXISTS.matchesWithinString(message)) {
			return ResponseToException.SKIPQUERY;
		} else if (intent.is(QueryIntention.CHECK_TABLE_EXISTS)) {
			if (TABLE_DOESNT_EXIST_REGEX.matchesWithinString(message)) {
				return ResponseToException.SKIPQUERY;
			}
		}
		return super.addFeatureToFixException(exp, intent, details);
	}

	@Override
	public SQLiteSettingsBuilder getURLInterpreter() {
		return new SQLiteSettingsBuilder();
	}

	@Override
	public boolean supportsMicrosecondPrecision() {
		return false;
	}

	@Override
	public boolean supportsNanosecondPrecision() {
		return false;
	}

	@Override
	public boolean supportsGeometryTypesFullyInSchema() {
		return true;
	}

	@Override
	public DBDatabaseMetaData getDBDatabaseMetaData(Options options) throws SQLException {
		return new SQLiteDBDatabaseMetaData(options);
	}

}