Skip to content

IGNITE-21928 Describe Catalog operation flow in README#3585

Merged
korlov42 merged 5 commits intoapache:mainfrom
gridgain:ignite-21928
Apr 17, 2024
Merged

IGNITE-21928 Describe Catalog operation flow in README#3585
korlov42 merged 5 commits intoapache:mainfrom
gridgain:ignite-21928

Conversation

@korlov42
Copy link
Copy Markdown
Contributor

Thank you for submitting the pull request.

To streamline the review process of the patch and ensure better code quality
we ask both an author and a reviewer to verify the following:

The Review Checklist

  • Formal criteria: TC status, codestyle, mandatory documentation. Also make sure to complete the following:
    - There is a single JIRA ticket related to the pull request.
    - The web-link to the pull request is attached to the JIRA ticket.
    - The JIRA ticket has the Patch Available state.
    - The description of the JIRA ticket explains WHAT was made, WHY and HOW.
    - The pull request title is treated as the final commit message. The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
  • Design: new code conforms with the design principles of the components it is added to.
  • Patch quality: patch cannot be split into smaller pieces, its size must be reasonable.
  • Code quality: code is clean and readable, necessary developer documentation is added if needed.
  • Tests code quality: test set covers positive/negative scenarios, happy/edge cases. Tests are effective in terms of execution time and resources.

Notes

CatalogManager -> CatalogManager : Acquire catalog of version equal to version from update minus 1
CatalogManager -> CatalogManager : Applies updates to the catalog
CatalogManager -> CatalogManager : Registers new catalog in a local cache
CatalogManager -> CatalogManager : Notifies other components about changes in catalog
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

seems to need to be mentioned in the documentation that CatalogManager can register listeners and notify these listeners about changes

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done, mention this is in Base components description section (see definition of CatalogService)

* [CatalogObjectDescriptor](src/main/java/org/apache/ignite/internal/catalog/descriptors/CatalogObjectDescriptor.java) --
base class for objects managed by catalog, like tables, indexes, zones, etc.
* [CatalogService](src/main/java/org/apache/ignite/internal/catalog/CatalogService.java) -- provides
methods to access catalog's objects' descriptors of exact version and/or last actual version at
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is an apostrophe needed in objects'?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yep. Apostrophe goes after s in case of possessive form of a noun that ends with -s

korlov42 added 2 commits April 16, 2024 16:25
- rephrase summary a little bit
- add information about events
- introduce "guarantee" section
korlov42 added 2 commits April 17, 2024 14:54
- add notes about update log entry serialisation
@korlov42 korlov42 merged commit 66ef243 into apache:main Apr 17, 2024
@korlov42 korlov42 deleted the ignite-21928 branch April 17, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants