org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapperExtension Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sql-bootstrapper Show documentation
edc :: sql-bootstrapper
The newest version!
/*
 *  Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
 *
 */

package org.eclipse.edc.sql.bootstrapper;

import org.eclipse.edc.runtime.metamodel.annotation.Extension;
import org.eclipse.edc.runtime.metamodel.annotation.Inject;
import org.eclipse.edc.runtime.metamodel.annotation.Provider;
import org.eclipse.edc.spi.monitor.Monitor;
import org.eclipse.edc.spi.persistence.EdcPersistenceException;
import org.eclipse.edc.spi.system.ServiceExtension;
import org.eclipse.edc.spi.system.ServiceExtensionContext;
import org.eclipse.edc.sql.QueryExecutor;
import org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry;
import org.eclipse.edc.transaction.spi.TransactionContext;

import static org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapperExtension.NAME;

@Extension(value = NAME, categories = { "sql", "persistence", "storage" })
public class SqlSchemaBootstrapperExtension implements ServiceExtension {
    public static final String NAME = "SQL Schema Bootstrapper Extension";
    public static final String SCHEMA_AUTOCREATE_PROPERTY = "edc.sql.schema.autocreate";
    public static final boolean SCHEMA_AUTOCREATE_DEFAULT = false;

    @Inject
    private TransactionContext transactionContext;
    @Inject
    private QueryExecutor queryExecutor;
    @Inject
    private DataSourceRegistry datasourceRegistry;
    @Inject
    private Monitor monitor;

    private SqlSchemaBootstrapperImpl bootstrapper;
    private Boolean shouldAutoCreate;

    @Override
    public void initialize(ServiceExtensionContext context) {
        shouldAutoCreate = context.getConfig().getBoolean(SCHEMA_AUTOCREATE_PROPERTY, SCHEMA_AUTOCREATE_DEFAULT);
    }

    @Override
    public void prepare() {
        if (shouldAutoCreate) {
            var statements = getBootstrapper().getStatements();
            new SqlDmlStatementRunner(transactionContext, queryExecutor, monitor, datasourceRegistry).executeSql(statements)
                    .orElseThrow(f -> new EdcPersistenceException("Failed to bootstrap SQL schema, error '%s'".formatted(f.getFailureDetail())));

        } else {
            monitor.debug("Automatic SQL schema creation is disabled. To enable it, set '%s' = true".formatted(SCHEMA_AUTOCREATE_PROPERTY));
        }
    }

    @Provider
    public SqlSchemaBootstrapper getBootstrapper() {
        if (bootstrapper == null) {
            bootstrapper = new SqlSchemaBootstrapperImpl();
        }
        return bootstrapper;
    }
}