[GitHub] [carbondata] Indhumathi27 commented on a change in pull request #3708: [CARBONDATA-3772] Update index documents

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[GitHub] [carbondata] Indhumathi27 commented on a change in pull request #3708: [CARBONDATA-3772] Update index documents

GitBox

Indhumathi27 commented on a change in pull request #3708:
URL: https://github.com/apache/carbondata/pull/3708#discussion_r411157552



##########
File path: docs/index-developer-guide.md
##########
@@ -18,17 +18,18 @@
 # Index Developer Guide
 
 ### Introduction
-DataMap is a data structure that can be used to accelerate certain query of the table. Different DataMap can be implemented by developers.
-Currently, there are two types of DataMap supported:
-1. IndexDataMap: DataMap that leverages index to accelerate filter query. Lucene DataMap and BloomFiler DataMap belong to this type of DataMaps.
-2. MVDataMap: DataMap that leverages Materialized View to accelerate olap style query, like SPJG query (select, predicate, join, groupby). Preaggregate, timeseries and mv DataMap belong to this type of DataMaps.
+Index is a data structure that can be used to accelerate certain query of the table. Different Index can be implemented by developers.
+Currently, Carbondata supports three types of Indexes:
+1. BloomFilter Index: A space-efficient probabilistic data structure that is used to test whether an element is a member of a set.
+2. Lucene Index: High performance, full-featured text search engine.
+3. Secondary Index: Sencondary index tables to hold blocklets are created as indexes and managed as child tables internally by Carbondata.
 
 ### Index Provider
-When user issues `CREATE INDEX index_name ON TABLE main AS 'provider'`, the corresponding DataMapProvider implementation will be created and initialized.
+When user issues `CREATE INDEX index_name ON TABLE main AS 'provider'`, the corresponding IndexProvider implementation will be created and initialized.
 Currently, the provider string can be:
-1. class name IndexDataMapFactory implementation: Developer can implement new type of IndexDataMap by extending IndexDataMapFactory
+1. class name IndexFactory implementation: Developer can implement new type of Index by extending IndexFactory
 
-When user issues `DROP INDEX index_name ON TABLE main`, the corresponding DataMapProvider interface will be called.
+When user issues `DROP INDEX index_name ON TABLE main`, the corresponding IndexProvider interface will be called.

Review comment:
       Change to `IndexFactory class` instead of `IndexProvider interface`




----------------------------------------------------------------
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.

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