-
-
Notifications
You must be signed in to change notification settings - Fork 89
feat: backup scheduler plugin #3263
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
176 changes: 176 additions & 0 deletions
176
server/src/main/java/com/arcadedb/server/backup/AutoBackupConfig.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| /* | ||
| * Copyright © 2021-present Arcade Data Ltd ([email protected]) | ||
| * | ||
| * 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. | ||
| * | ||
| * SPDX-FileCopyrightText: 2021-present Arcade Data Ltd ([email protected]) | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| package com.arcadedb.server.backup; | ||
|
|
||
| import com.arcadedb.serializer.json.JSONObject; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Server-level auto-backup configuration loaded from config/backup.json. | ||
| * | ||
| * @author Luca Garulli ([email protected]) | ||
| */ | ||
| public class AutoBackupConfig { | ||
| public static final String CONFIG_FILE_NAME = "backup.json"; | ||
| public static final int CURRENT_VERSION = 1; | ||
| public static final String DEFAULT_BACKUP_DIR = "./backups"; | ||
| public static final String DEFAULT_RUN_SERVER = "$leader"; | ||
| public static final int DEFAULT_FREQUENCY = 60; | ||
| public static final int DEFAULT_MAX_FILES = 10; | ||
|
|
||
| private int version = CURRENT_VERSION; | ||
| private boolean enabled = true; | ||
| private String backupDirectory = DEFAULT_BACKUP_DIR; | ||
| private DatabaseBackupConfig defaults; | ||
| private final Map<String, DatabaseBackupConfig> databases = new HashMap<>(); | ||
|
|
||
| public static AutoBackupConfig fromJSON(final JSONObject json) { | ||
| final AutoBackupConfig config = new AutoBackupConfig(); | ||
|
|
||
| if (json.has("version")) | ||
| config.version = json.getInt("version"); | ||
|
|
||
| if (json.has("enabled")) | ||
| config.enabled = json.getBoolean("enabled"); | ||
|
|
||
| if (json.has("backupDirectory")) | ||
| config.backupDirectory = json.getString("backupDirectory"); | ||
|
|
||
| if (json.has("defaults")) | ||
| config.defaults = DatabaseBackupConfig.fromJSON("_defaults", json.getJSONObject("defaults")); | ||
|
|
||
| if (json.has("databases")) { | ||
| final JSONObject dbs = json.getJSONObject("databases"); | ||
| for (final String dbName : dbs.keySet()) { | ||
| final DatabaseBackupConfig dbConfig = DatabaseBackupConfig.fromJSON(dbName, dbs.getJSONObject(dbName)); | ||
| config.databases.put(dbName, dbConfig); | ||
| } | ||
| } | ||
|
|
||
| return config; | ||
| } | ||
|
|
||
| public static AutoBackupConfig createDefault() { | ||
| final AutoBackupConfig config = new AutoBackupConfig(); | ||
| config.defaults = createDefaultDatabaseConfig(); | ||
| return config; | ||
| } | ||
|
|
||
| private static DatabaseBackupConfig createDefaultDatabaseConfig() { | ||
| final DatabaseBackupConfig dbConfig = new DatabaseBackupConfig("_defaults"); | ||
| dbConfig.setEnabled(true); | ||
| dbConfig.setRunOnServer(DEFAULT_RUN_SERVER); | ||
|
|
||
| final DatabaseBackupConfig.ScheduleConfig schedule = new DatabaseBackupConfig.ScheduleConfig(); | ||
| schedule.setType(DatabaseBackupConfig.ScheduleConfig.Type.FREQUENCY); | ||
| schedule.setFrequencyMinutes(DEFAULT_FREQUENCY); | ||
| dbConfig.setSchedule(schedule); | ||
|
|
||
| final DatabaseBackupConfig.RetentionConfig retention = new DatabaseBackupConfig.RetentionConfig(); | ||
| retention.setMaxFiles(DEFAULT_MAX_FILES); | ||
| dbConfig.setRetention(retention); | ||
|
|
||
| return dbConfig; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the effective configuration for a specific database, merging database-specific | ||
| * settings with server-level defaults. | ||
| */ | ||
| public DatabaseBackupConfig getEffectiveConfig(final String databaseName) { | ||
| DatabaseBackupConfig dbConfig = databases.get(databaseName); | ||
|
|
||
| if (dbConfig == null) { | ||
| // No database-specific config, use defaults | ||
| dbConfig = new DatabaseBackupConfig(databaseName); | ||
| if (defaults != null) { | ||
| dbConfig.setEnabled(defaults.isEnabled()); | ||
| dbConfig.setRunOnServer(defaults.getRunOnServer()); | ||
| dbConfig.setSchedule(defaults.getSchedule()); | ||
| dbConfig.setRetention(defaults.getRetention()); | ||
| } | ||
| } else { | ||
| // Merge database-specific config with defaults | ||
| dbConfig.mergeWithDefaults(defaults); | ||
| } | ||
|
|
||
| return dbConfig; | ||
| } | ||
|
|
||
| public int getVersion() { | ||
| return version; | ||
| } | ||
|
|
||
| public boolean isEnabled() { | ||
| return enabled; | ||
| } | ||
|
|
||
| public void setEnabled(final boolean enabled) { | ||
| this.enabled = enabled; | ||
| } | ||
|
|
||
| public String getBackupDirectory() { | ||
| return backupDirectory; | ||
| } | ||
|
|
||
| public void setBackupDirectory(final String backupDirectory) { | ||
| this.backupDirectory = backupDirectory; | ||
| } | ||
|
|
||
| public DatabaseBackupConfig getDefaults() { | ||
| return defaults; | ||
| } | ||
|
|
||
| public void setDefaults(final DatabaseBackupConfig defaults) { | ||
| this.defaults = defaults; | ||
| } | ||
|
|
||
| public Map<String, DatabaseBackupConfig> getDatabases() { | ||
| return Collections.unmodifiableMap(databases); | ||
| } | ||
|
|
||
| public void addDatabaseConfig(final String databaseName, final DatabaseBackupConfig config) { | ||
| databases.put(databaseName, config); | ||
| } | ||
|
|
||
| /** | ||
| * Converts this configuration to a JSON object. | ||
| */ | ||
| public JSONObject toJSON() { | ||
| final JSONObject json = new JSONObject(); | ||
| json.put("version", version); | ||
| json.put("enabled", enabled); | ||
| json.put("backupDirectory", backupDirectory); | ||
|
|
||
| if (defaults != null) | ||
| json.put("defaults", defaults.toJSON()); | ||
|
|
||
| if (!databases.isEmpty()) { | ||
| final JSONObject dbs = new JSONObject(); | ||
| for (final Map.Entry<String, DatabaseBackupConfig> entry : databases.entrySet()) | ||
| dbs.put(entry.getKey(), entry.getValue().toJSON()); | ||
| json.put("databases", dbs); | ||
| } | ||
|
|
||
| return json; | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
getEffectiveConfigmethod modifies theDatabaseBackupConfiginstance from thedatabasesmap when merging with defaults. This side effect can be unexpected and makes the configuration mutable after being loaded. To promote immutability and prevent unintended side effects, consider creating a defensive copy of theDatabaseBackupConfigobject before merging. This would require adding a copy mechanism (e.g., a copy constructor or acopy()method) toDatabaseBackupConfigand its nested configuration classes.