org.polypheny.jdbc.PolyphenyDriver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of polypheny-jdbc-driver Show documentation
A standards-compliant JDBC driver for Polypheny-DB.
The newest version!
/*
 * Copyright 2019-2024 The Polypheny Project
 *
 * 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 org.polypheny.jdbc;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.DriverPropertyInfo;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.util.Properties;
import java.util.logging.Logger;
import org.polypheny.jdbc.meta.PolyphenyDatabaseMetadata;
import org.polypheny.jdbc.properties.DriverProperties;
import org.polypheny.jdbc.properties.PolyphenyConnectionProperties;
import org.polypheny.jdbc.properties.PropertyUtils;

public class PolyphenyDriver implements java.sql.Driver {

    static {
        new PolyphenyDriver().register();
    }


    private void register() {
        try {
            DriverManager.registerDriver( this );
        } catch ( SQLException e ) {
            System.out.println( "Error occurred while registering JDBC driver " + this + ": " + e );
        }
    }


    @Override
    public Connection connect( String url, Properties properties ) throws SQLException {
        if ( !acceptsURL( url ) ) {
            return null;
        }
        ConnectionString connectionString = new ConnectionString( url, properties );
        PrismInterfaceClient prismInterfaceClient = new PrismInterfaceClient( connectionString.getHost(), connectionString.getPort(), connectionString.getParameters() );
        PolyphenyConnectionProperties connectionProperties = new PolyphenyConnectionProperties( connectionString, prismInterfaceClient );
        PolyphenyDatabaseMetadata databaseMetadata = new PolyphenyDatabaseMetadata( prismInterfaceClient, connectionString );
        prismInterfaceClient.register( connectionProperties, connectionProperties.getNetworkTimeout() );
        return new PolyConnection( connectionProperties, databaseMetadata );
    }


    @Override
    public boolean acceptsURL( String url ) throws SQLException {
        if ( url == null ) {
            throw new PrismInterfaceServiceException( PrismInterfaceErrors.VALUE_ILLEGAL, "URL must no be null." );
        }
        return url.startsWith( DriverProperties.getDRIVER_URL_SCHEMA() );
    }


    @Override
    public DriverPropertyInfo[] getPropertyInfo( String url, Properties properties ) throws SQLException {
        ConnectionString connectionString = new ConnectionString( url, properties );

        DriverPropertyInfo[] infoProperties = new DriverPropertyInfo[7];

        // User Property
        infoProperties[0] = new DriverPropertyInfo(
                PropertyUtils.getUSERNAME_KEY(),
                connectionString.getUser() );
        infoProperties[0].description = "Specifies the username for authentication. If not specified, the database uses the default user.";
        infoProperties[0].required = false;

        // Password Property
        infoProperties[1] = new DriverPropertyInfo(
                PropertyUtils.getPASSWORD_KEY(),
                connectionString.getParameter( PropertyUtils.getPASSWORD_KEY() ) );
        infoProperties[1].description = "Specifies the password associated with the given username. If not specified the database assumes that the user does not have a password.";
        infoProperties[1].required = false;

        // Autocommit Property
        String autocommit = connectionString.getParameter( PropertyUtils.getAUTOCOMMIT_KEY() );
        infoProperties[2] = new DriverPropertyInfo(
                PropertyUtils.getAUTOCOMMIT_KEY(),
                autocommit == null ? String.valueOf( PropertyUtils.isDEFAULT_AUTOCOMMIT() ) : autocommit );
        infoProperties[2].description = "Determines if each SQL statement is treated as a transaction.";
        infoProperties[2].choices = new String[]{ "true", "false" };

        // Readonly Property
        String readOnly = connectionString.getParameter( PropertyUtils.getREAD_ONLY_KEY() );
        infoProperties[3] = new DriverPropertyInfo(
                PropertyUtils.getREAD_ONLY_KEY(),
                readOnly == null ? String.valueOf( PropertyUtils.isDEFAULT_READ_ONLY() ) : readOnly );
        infoProperties[3].description = "Indicates if the connection is in read-only mode. Currently ignored, reserved for future use.";
        infoProperties[3].choices = new String[]{ "true", "false" };

        // Holdability Property
        String holdability = connectionString.getParameter( PropertyUtils.getRESULT_SET_HOLDABILITY_KEY() );
        String defaultHoldability = PropertyUtils.getHoldabilityName( PropertyUtils.getDEFAULT_RESULTSET_HOLDABILITY() );
        infoProperties[4] = new DriverPropertyInfo(
                PropertyUtils.getRESULT_SET_HOLDABILITY_KEY(),
                holdability == null ? defaultHoldability : holdability );
        infoProperties[4].description = "Specifies the holdability of ResultSet objects.";
        infoProperties[4].choices = new String[]{ "HOLD", "CLOSE" };

        // Isolation Property
        String isolation = connectionString.getParameter( PropertyUtils.getTRANSACTION_ISOLATION_KEY() );
        String defaultIsolation = PropertyUtils.getTransactionIsolationName( PropertyUtils.getDEFAULT_TRANSACTION_ISOLATION() );
        infoProperties[5] = new DriverPropertyInfo(
                PropertyUtils.getTRANSACTION_ISOLATION_KEY(),
                isolation == null ? defaultIsolation : isolation );
        infoProperties[5].description = "Indicates the transaction isolation level.";
        infoProperties[5].choices = new String[]{ "COMMITTED", "DIRTY", "SERIALIZABLE", "REPEATABLE_READ" };

        // Network Timeout Property
        String timeout = connectionString.getParameter( PropertyUtils.getNETWORK_TIMEOUT_KEY() );
        infoProperties[6] = new DriverPropertyInfo(
                PropertyUtils.getNETWORK_TIMEOUT_KEY(),
                timeout == null ? String.valueOf( PropertyUtils.getDEFAULT_NETWORK_TIMEOUT() ) : timeout );
        infoProperties[6].description = "Specifies the network timeout in seconds. Corresponds to the JDBC network timeout.";

        return infoProperties;
    }


    @Override
    public int getMajorVersion() {
        return DriverProperties.getDRIVER_MAJOR_VERSION();
    }


    @Override
    public int getMinorVersion() {
        return DriverProperties.getDRIVER_MINOR_VERSION();
    }


    @Override
    public boolean jdbcCompliant() {
        return DriverProperties.isJDBC_COMPLIANT();
    }


    @Override
    public Logger getParentLogger() throws SQLFeatureNotSupportedException {
        throw new SQLFeatureNotSupportedException();
    }

}