xtern commented on code in PR #3585:
URL: https://github.com/apache/ignite-3/pull/3585#discussion_r1562275155


##########
modules/catalog/README.md:
##########
@@ -1,7 +1,54 @@
 # Catalog module
 
-This module provides database catalog service implementation and descriptor 
for catalog objects.
+Catalog is a component that responsible for managing descriptors of objects 
available in cluster,
+as well as serving as single source of truth for other components to acquire 
an actual state of
+the schema.
 
-See 
[CatalogService](src/main/java/org/apache/ignite/internal/catalog/CatalogServiceImpl.java)
+This module provides implementation of catalog service as well as internal API 
for accessing the
+objects descriptors.
 
-TODO: IGNITE-19082 Add comprehensive description.
\ No newline at end of file
+## Base components description
+
+* 
[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 

Review Comment:
   Is an apostrophe needed in `objects'`?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to