Skip to content
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

Return error codes for merge failures #8191

Open
nicktobey opened this issue Aug 1, 2024 · 0 comments
Open

Return error codes for merge failures #8191

nicktobey opened this issue Aug 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request merge Issues relating to merge

Comments

@nicktobey
Copy link
Contributor

Sometimes when merges fail, there's more context / nuance than can reasonably be displayed in an error message.

The motivating example here is a case where a branch contains changes to the primary key schema. In these cases, we can't merge, and we instruct the user to manually make the table identical on both branches. If the user does this, then we can skip merging that table.

So when we hit this failure state, the user could be trying to do a couple different things:

  • The user is not aware that they need to manually make the tables identical, and we need to inform them.
  • The user attempted to make the tables identical, but did not succeed because there's a schema change they aren't aware of.
  • The user attempted to make the tables identical, but did not succeed because there's a data change they aren't aware of.

Conveying all of the necessary context and information to address all of these possible situations would make the error message unwieldy. But if Dolt returned a succinct message and an error code, we could have a section in the documentation that describes the error codes in more detail and proposes remedies.

@timsehn timsehn added documentation Improvements or additions to documentation enhancement New feature or request merge Issues relating to merge labels Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request merge Issues relating to merge
Projects
None yet
Development

No branches or pull requests

2 participants