Add strict SQL mode to allow d2-cloner to stop execution on error during cloning process #136
Conversation
This file contains 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
tokland
reviewed
Feb 10, 2025
src/d2_docker/cli.py
Outdated
| @@ -80,6 +80,9 @@ def main(): | |||
| args = parser.parse_args() | |||
| utils.logger.setLevel(args.log_level.upper()) | |||
|
|
|||
|
|
|||
src/d2_docker/cli.py
Outdated
| @@ -80,6 +80,9 @@ def main(): | |||
| args = parser.parse_args() | |||
| utils.logger.setLevel(args.log_level.upper()) | |||
|
|
|||
|
|
|||
| if getattr(args, "strict_sql", False) and not args.run_sql: | |||
| parser.error("--strict-sql requires --run-sql to be set") | |||
There was a problem hiding this comment.
We cannot do args checking of some specific command (start) in the main cli.
The check should be done in the "run" function of start.py.
src/d2_docker/commands/start.py
Outdated
| @@ -102,7 +108,8 @@ def start(args): | |||
| bind_ip=args.bind_ip, | |||
| core_image=core_image, | |||
| load_from_data=override_containers, | |||
| post_sql_dir=args.run_sql, | |||
| post_sql_dir=post_sql_dir, | |||
| post_strict_sql_dir=post_strict_sql_dir, | |||
There was a problem hiding this comment.
Instead of passing a new sql_dir param, we could pass the boolean flag so the script knows if the mode is "strict" or not. This would greatly simplify dhis2-core-start.sh (and support all kind of files, not only sql)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I have added a parameter (dependent on run-sql) and a folder to execute strict SQL scripts on database startup.
When this parameter is used and an SQL statement fails, execution stops immediately, displaying an error message.
This allows d2-cloner to detect the failure and halt the cloning process.
The goal is to ensure that if an SQL script fails during cloning, the instance does not go online with an incomplete execution.
We want to guarantee that either all SQL scripts run successfully or the process stops entirely to ensure that all mandatory rules are correctly applied.
Execution stops at the first error to prevent longer SQL operations from running unnecessarily, making it easier to identify and debug the issue.
I initially attempted to stop the instance and return an error status that d2-cloner could catch, but I couldn't achieve this.
Instead, I opted for logging an error message that d2-cloner can detect to handle the situation accordingly.
Issue:
https://app.clickup.com/t/8697kr4wf
To test you need do a d2-docker start with --run-sql and --strict-sql parameters.