org.voltdb.sysprocs.UpdateApplicationCatalog Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of voltdb Show documentation
VoltDB server libraries
There is a newer version: 10.1.1
/* This file is part of VoltDB.
 * Copyright (C) 2008-2018 VoltDB Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with VoltDB.  If not, see .
 */

package org.voltdb.sysprocs;

import java.util.concurrent.CompletableFuture;

import org.voltdb.VoltDB;
import org.voltdb.client.ClientResponse;

/**
 * Non-transactional procedure to implement public @UpdateApplicationCatalog system
 * procedure.
 *
 */
public class UpdateApplicationCatalog extends UpdateApplicationBase {

    public CompletableFuture run(byte[] catalogJarBytes, String deploymentString) {
        if (!allowPausedModeWork(isRestoring(), isAdminConnection())) {
            return makeQuickResponse(
                    ClientResponse.SERVER_UNAVAILABLE,
                    "Server is paused and is available in read-only mode - please try again later.");
        }

        // catalogJarBytes if null, when passed along, will tell the
        // catalog change planner that we want to use the current catalog.
        // normalize empty string and null
        if ((catalogJarBytes != null) && (catalogJarBytes.length == 0)) {
            catalogJarBytes = null;
        }

        boolean useDDLSchema = VoltDB.instance().getCatalogContext().cluster.getUseddlschema() && !isRestoring();
        // If we weren't provided operationBytes, it's a deployment-only change and okay to take
        // master and adhoc DDL method chosen
        if (catalogJarBytes != null && useDDLSchema) {
            return makeQuickResponse(
                    ClientResponse.GRACEFUL_FAILURE,
                    "Cluster is configured to use AdHoc DDL to change application schema. " +
                    "Use of @UpdateApplicationCatalog is forbidden.");
        }

        logCatalogUpdateInvocation("@UpdateApplicationCatalog");

        return updateApplication("@UpdateApplicationCatalog",
                                catalogJarBytes,
                                deploymentString,
                                new String[0],
                                null,
                                false, /* isPromotion */
                                useDDLSchema);

    }
}