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

Update documentation for the repair feature #1300

Merged
merged 3 commits into from
Nov 30, 2023
Merged

Conversation

Torch3333
Copy link
Contributor

@Torch3333 Torch3333 commented Nov 20, 2023

Description

The Admin API repairTable() method has existed since v3.6, but its behavior has changed (cf. #1125). Also, a new repairNamespace method was added to the Admin API (#1107). Finally, the --repair-all command of the Schema Loader will not only repair table but also repair namespace. (#1203)

This PR will update the documentation for these changes.

Related issues and/or PRs

Changes made

  • Update javadoc for the Admin API repairTable and repairNamespace
  • Add sections in the api-guide and storage abstraction guide for the Admin API repairTable and repairNamespace
  • Update the Schema Loader doc

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • Tests (unit, integration, etc.) have been added for the changes.
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

Release notes

N/A

@Torch3333 Torch3333 self-assigned this Nov 20, 2023
@Torch3333 Torch3333 changed the title Update repair documentation Update documentation for the repair feature Nov 20, 2023
admin.repairNamespace("ns", options);
```

### Repair a table
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Even though the Admin API repairTable() method has existed since v3.6. A section in the api-guide and storage-abstraction docs was never added. Since the content will be different for the older doc versions since the method behavior is changing for the next release, I will create another PR for it.

@Torch3333 Torch3333 marked this pull request as ready for review November 20, 2023 23:33
Copy link
Contributor

@komamitsu komamitsu left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link
Member

@josh-wong josh-wong left a comment

Choose a reason for hiding this comment

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

I've added some minor suggestions. PTAL!

docs/api-guide.md Outdated Show resolved Hide resolved
docs/api-guide.md Outdated Show resolved Hide resolved
core/src/main/java/com/scalar/db/api/Admin.java Outdated Show resolved Hide resolved
core/src/main/java/com/scalar/db/api/Admin.java Outdated Show resolved Hide resolved
docs/schema-loader.md Outdated Show resolved Hide resolved
docs/storage-abstraction.md Outdated Show resolved Hide resolved
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com>
Copy link
Collaborator

@brfrn169 brfrn169 left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link
Contributor

@kota2and3kan kota2and3kan left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link
Member

@josh-wong josh-wong left a comment

Choose a reason for hiding this comment

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

I've left one formatting-related suggestions. Other than that, LGTM! Thank you🙇🏻‍♂️

docs/schema-loader.md Outdated Show resolved Hide resolved
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com>
Copy link
Contributor

@feeblefakie feeblefakie left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

@feeblefakie feeblefakie merged commit ce54066 into master Nov 30, 2023
@feeblefakie feeblefakie deleted the update_repair_doc branch November 30, 2023 03:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants