Skip to content

Add old method signatures of SchemaLoader's load(), unload() and repairAll() for backward compatibility #2760

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.

Sign up for GitHub

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 4 commits into from
Jun 13, 2025
Merged

Add old method signatures of SchemaLoader's load(), unload() and repairAll() for backward compatibility #2760

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
73863ff
Add old methods for backward compatibility
komamitsu Jun 12, 2025
7676ad3
Remove unused methods
komamitsu Jun 12, 2025
e7b6082
Remove comments
komamitsu Jun 13, 2025
d63fa02
Merge branch 'master' into backward-compatible-for-schema-loader
komamitsu Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
213 changes: 213 additions & 0 deletions schema-loader/src/main/java/com/scalar/db/schemaloader/SchemaLoader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,219 @@ private static void repairAll(
}
}

// For backward compatibility.
Copy link
Collaborator

@brfrn169 brfrn169 Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we don’t need this comment if we’re not planning to remove these methods in a future release. Or do we plan to?

Copy link
Contributor Author

@komamitsu komamitsu Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed it in e7b6082


/**
* Creates tables defined in the schema file. See {@link #load(Properties, Path, Map, boolean,
* boolean)} for details.
*
* @param configProperties ScalarDB config properties.
* @param schemaFilePath path to schema file.
* @param options specific options for creating tables.
* @param createCoordinatorTables create coordinator tables or not.
* @throws SchemaLoaderException thrown when creating tables fails.
*/
Copy link

Copilot AI Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These backward-compatibility overloads should be annotated with @deprecated to signal that they will be removed in a future release and guide users towards the new signatures.

Suggested change
*/
*/
@Deprecated

Copilot uses AI. Check for mistakes.
public static void load(
Properties configProperties,
@Nullable Path schemaFilePath,
Map<String, String> options,
boolean createCoordinatorTables)
throws SchemaLoaderException {
load(configProperties, schemaFilePath, options, createCoordinatorTables, false);
}

/**
* Creates tables defined in the schema file. See {@link #load(Path, Path, Map, boolean, boolean)}
* for details.
*
* @param configFilePath path to ScalarDB config file.
* @param schemaFilePath path to schema file.
* @param options specific options for creating tables.
* @param createCoordinatorTables create coordinator tables or not.
* @throws SchemaLoaderException thrown when creating tables fails.
*/
public static void load(
Path configFilePath,
@Nullable Path schemaFilePath,
Map<String, String> options,
boolean createCoordinatorTables)
throws SchemaLoaderException {
load(configFilePath, schemaFilePath, options, createCoordinatorTables, false);
}

/**
* Creates tables defined in the schema. See {@link #load(Properties, String, Map, boolean,
* boolean)} for details.
*
* @param configProperties ScalarDB config properties.
* @param serializedSchemaJson serialized json string schema.
* @param options specific options for creating tables.
* @param createCoordinatorTables create coordinator tables or not.
* @throws SchemaLoaderException thrown when creating tables fails.
*/
public static void load(
Properties configProperties,
@Nullable String serializedSchemaJson,
Map<String, String> options,
boolean createCoordinatorTables)
throws SchemaLoaderException {
load(configProperties, serializedSchemaJson, options, createCoordinatorTables, false);
}

/**
* Creates tables defined in the schema. See {@link #load(Path, String, Map, boolean, boolean)}
* for details.
*
* @param configFilePath path to ScalarDB config file.
* @param serializedSchemaJson serialized json string schema.
* @param options specific options for creating tables.
* @param createCoordinatorTables create coordinator tables or not.
* @throws SchemaLoaderException thrown when creating tables fails.
*/
public static void load(
Path configFilePath,
@Nullable String serializedSchemaJson,
Map<String, String> options,
boolean createCoordinatorTables)
throws SchemaLoaderException {
load(configFilePath, serializedSchemaJson, options, createCoordinatorTables, false);
}

/**
* Delete tables defined in the schema file. See {@link #unload(Properties, Path, boolean,
* boolean)} for details.
*
* @param configProperties ScalarDB config properties.
* @param schemaFilePath path to schema file.
* @param deleteCoordinatorTables delete coordinator tables or not.
* @throws SchemaLoaderException thrown when deleting tables fails.
*/
public static void unload(
Properties configProperties, @Nullable Path schemaFilePath, boolean deleteCoordinatorTables)
throws SchemaLoaderException {
unload(configProperties, schemaFilePath, deleteCoordinatorTables, false);
}

/**
* Delete tables defined in the schema file. See {@link #unload(Path, Path, boolean, boolean)} for
* details.
*
* @param configFilePath path to ScalarDB config file.
* @param schemaFilePath path to schema file.
* @param deleteCoordinatorTables delete coordinator tables or not.
* @throws SchemaLoaderException thrown when deleting tables fails.
*/
public static void unload(
Path configFilePath, @Nullable Path schemaFilePath, boolean deleteCoordinatorTables)
throws SchemaLoaderException {
unload(configFilePath, schemaFilePath, deleteCoordinatorTables, false);
}

/**
* Delete tables defined in the schema. See {@link #unload(Properties, String, boolean, boolean)}
* for details.
*
* @param configProperties ScalarDB config properties.
* @param serializedSchemaJson serialized json string schema.
* @param deleteCoordinatorTables delete coordinator tables or not.
* @throws SchemaLoaderException thrown when deleting tables fails.
*/
public static void unload(
Properties configProperties,
@Nullable String serializedSchemaJson,
boolean deleteCoordinatorTables)
throws SchemaLoaderException {
unload(configProperties, serializedSchemaJson, deleteCoordinatorTables, false);
}

/**
* Delete tables defined in the schema. See {@link #unload(Path, String, boolean, boolean)} for
* details.
*
* @param configFilePath path to ScalarDB config file.
* @param serializedSchemaJson serialized json string schema.
* @param deleteCoordinatorTables delete coordinator tables or not.
* @throws SchemaLoaderException thrown when deleting tables fails.
*/
public static void unload(
Path configFilePath, @Nullable String serializedSchemaJson, boolean deleteCoordinatorTables)
throws SchemaLoaderException {
unload(configFilePath, serializedSchemaJson, deleteCoordinatorTables, false);
}

/**
* Repair namespaces and tables. See {@link #repairAll(Properties, String, Map, boolean, boolean)}
* for details.
*
* @param configProperties ScalarDB config properties
* @param serializedSchemaJson serialized json string schema.
* @param options specific options for repairing.
* @param repairCoordinatorTable repair coordinator tables or not.
* @throws SchemaLoaderException thrown when repairing fails.
*/
public static void repairAll(
Properties configProperties,
String serializedSchemaJson,
Map<String, String> options,
boolean repairCoordinatorTable)
throws SchemaLoaderException {
repairAll(configProperties, serializedSchemaJson, options, repairCoordinatorTable, false);
}

/**
* Repair namespaces and tables. See {@link #repairAll(Path, String, Map, boolean, boolean)} for
* details.
*
* @param configProperties ScalarDB properties.
* @param schemaPath path to the schema file.
* @param options specific options for repairing.
* @param repairCoordinatorTable repair coordinator tables or not.
* @throws SchemaLoaderException thrown when repairing fails.
*/
public static void repairAll(
Properties configProperties,
Path schemaPath,
Map<String, String> options,
boolean repairCoordinatorTable)
throws SchemaLoaderException {
repairAll(configProperties, schemaPath, options, repairCoordinatorTable, false);
}

/**
* Repair namespaces and tables. See {@link #repairAll(Path, String, Map, boolean, boolean)} for
* details.
*
* @param configPath path to the ScalarDB config.
* @param serializedSchemaJson serialized json string schema.
* @param options specific options for repairing.
* @param repairCoordinatorTable repair coordinator tables or not.
* @throws SchemaLoaderException thrown when repairing fails.
*/
public static void repairAll(
Path configPath,
String serializedSchemaJson,
Map<String, String> options,
boolean repairCoordinatorTable)
throws SchemaLoaderException {
repairAll(configPath, serializedSchemaJson, options, repairCoordinatorTable, false);
}

/**
* Repair namespaces and tables. See {@link #repairAll(Path, Path, Map, boolean, boolean)} for
* details.
*
* @param configPath path to the ScalarDB config.
* @param schemaPath path to the schema file.
* @param options specific options for repairing.
* @param repairCoordinatorTable repair coordinator tables or not.
* @throws SchemaLoaderException thrown when repairing fails.
*/
public static void repairAll(
Path configPath, Path schemaPath, Map<String, String> options, boolean repairCoordinatorTable)
throws SchemaLoaderException {
repairAll(configPath, schemaPath, options, repairCoordinatorTable, false);
}

/**
* Alter the tables defined in the schema. Supported alter operations are:
*
Expand Down
Loading