org.voltdb.sysprocs.saverestore.SnapshotRequestConfig Maven / Gradle / Ivy

Go to download
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.saverestore;

import java.util.List;
import java.util.ListIterator;
import java.util.Set;

import org.json_voltpatches.JSONArray;
import org.json_voltpatches.JSONException;
import org.json_voltpatches.JSONObject;
import org.json_voltpatches.JSONStringer;
import org.voltcore.logging.VoltLogger;
import org.voltdb.catalog.Database;
import org.voltdb.catalog.Table;

import com.google_voltpatches.common.base.Joiner;
import com.google_voltpatches.common.base.Preconditions;
import com.google_voltpatches.common.collect.Sets;

public class SnapshotRequestConfig {
    protected static final VoltLogger SNAP_LOG = new VoltLogger("SNAPSHOT");

    public final Table[] tables;

    /**
     * @param tables    Tables to snapshot, cannot be null.
     */
    public SnapshotRequestConfig(List tables)
    {
        Preconditions.checkNotNull(tables);
        this.tables = tables.toArray(new Table[0]);
    }

    public SnapshotRequestConfig(JSONObject jsData, Database catalogDatabase)
    {
        tables = getTablesToInclude(jsData, catalogDatabase);
    }

    private static Table[] getTablesToInclude(JSONObject jsData,
                                              Database catalogDatabase)
    {
        final List tables = SnapshotUtil.getTablesToSave(catalogDatabase);
        Set tableNamesToInclude = null;
        Set tableNamesToExclude = null;

        if (jsData != null) {
            JSONArray tableNames = jsData.optJSONArray("tables");
            if (tableNames != null) {
                tableNamesToInclude = Sets.newHashSet();
                for (int i = 0; i < tableNames.length(); i++) {
                    try {
                        final String s = tableNames.getString(i).trim().toUpperCase();
                        if (!s.isEmpty()) {
                            tableNamesToInclude.add(s);
                        }
                    } catch (JSONException e) {
                        SNAP_LOG.warn("Unable to parse tables to include for snapshot", e);
                    }
                }
            }

            JSONArray excludeTableNames = jsData.optJSONArray("skiptables");
            if (excludeTableNames != null) {
                tableNamesToExclude = Sets.newHashSet();
                for (int i = 0; i < excludeTableNames.length(); i++) {
                    try {
                        final String s = excludeTableNames.getString(i).trim().toUpperCase();
                        if (!s.isEmpty()) {
                            tableNamesToExclude.add(s);
                        }
                    } catch (JSONException e) {
                        SNAP_LOG.warn("Unable to parse tables to exclude for snapshot", e);
                    }
                }
            }
        }

        if (tableNamesToInclude != null && tableNamesToInclude.isEmpty()) {
            // Stream snapshot may specify empty snapshot sometimes.
            tables.clear();
        } else {
            ListIterator iter = tables.listIterator();
            while (iter.hasNext()) {
                Table table = iter.next();
                if ((tableNamesToInclude != null && !tableNamesToInclude.remove(table.getTypeName())) ||
                    (tableNamesToExclude != null && tableNamesToExclude.remove(table.getTypeName()))) {
                    // If the table index is not in the list to include or
                    // is in the list to exclude, remove it
                    iter.remove();
                }
            }
        }

        if (tableNamesToInclude != null && !tableNamesToInclude.isEmpty()) {
            throw new IllegalArgumentException(
                    "The following tables were specified to include in the snapshot, but are not present in the database: " +
                    Joiner.on(", ").join(tableNamesToInclude));
        }
        if (tableNamesToExclude != null && !tableNamesToExclude.isEmpty()) {
            throw new IllegalArgumentException(
                    "The following tables were specified to exclude from the snapshot, but are not present in the database: " +
                    Joiner.on(", ").join(tableNamesToExclude));
        }

        return tables.toArray(new Table[0]);
    }

    public void toJSONString(JSONStringer stringer) throws JSONException
    {
        if (tables != null) {
            stringer.key("tables");
            stringer.array();
            for (Table table : tables) {
                stringer.value(table.getTypeName());
            }
            stringer.endArray();
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy