@@ -46,12 +46,12 @@ possible experience, with relevant helper APIs, documentation and tutorials.
4646
4747Indexes are managed by ` IndexLogEntry ` which consists of
4848
49- * name: Name of the index.
50- * derivedDataset: Data that has been derived from one or more datasets and may be optionally used by
49+ * ` name ` : Name of the index.
50+ * ` derivedDataset ` : Data that has been derived from one or more datasets and may be optionally used by
5151an arbitrary query optimizer to improve the speed of data retrieval.
52- * content: File contents used by the index.
53- * source: Data source.
54- * properties: Hash map for managing properties of the index.
52+ * ` content ` : File contents used by the index.
53+ * ` source ` : Data source.
54+ * ` properties ` : Hash map for managing properties of the index.
5555
5656Indexes can have the following states:
5757* Stable states
@@ -110,7 +110,7 @@ Available modes:
110110
111111A user can drop an existing index by using the deleteIndex API and providing the index name.
112112Index deletion is a soft-delete operation i.e., only the index's status in the Hyperspace metadata from is changed
113- from " ACTIVE" to " DELETED" . This will exclude the deleted index from any future query optimization and Hyperspace
113+ from ` ACTIVE ` to ` DELETED ` . This will exclude the deleted index from any future query optimization and Hyperspace
114114no longer picks that index for any query. However, index files for a deleted index still remain available
115115(since it is a soft-delete), so if you accidentally deleted the index, you could still restore it.
116116
@@ -131,20 +131,20 @@ This will bring back the latest version of index into ACTIVE status and makes it
131131### Cancel
132132
133133Cancel API to bring back index from an inconsistent state to the last known stable state.
134- E.g. if index fails during creation, in " CREATING" state.
134+ E.g. if index fails during creation, in ` CREATING ` state.
135135The index will not allow any index modifying operations unless a cancel is called.
136136
137- > Note: Cancel from " VACUUMING" state will move it forward to " DOESNOTEXIST" state.
137+ > Note: Cancel from ` VACUUMING ` state will move it forward to ` DOESNOTEXIST ` state.
138138
139- > Note: If no previous stable state exists, cancel will move it to " DOESNOTEXIST" state.
139+ > Note: If no previous stable state exists, cancel will move it to ` DOESNOTEXIST ` state.
140140
141141
142142# Index Type
143143
144144Hyperspace provides several index types.
145145
146146* Covering Index
147- * Roughly speaking, index data for CoveringIndex is just a vertical
147+ * Roughly speaking, index data for ` CoveringIndex ` is just a vertical
148148 slice of the source data, including only the indexed and included columns,
149149 bucketed and sorted by the indexed columns for efficient access.
150150* Data Skipping Index
@@ -182,7 +182,7 @@ automatically if it is applicable.
182182## Explain
183183
184184Explains how indexes will be applied to the given dataframe.
185- Explain API from Hyperspace is very similar to Spark's df.explain API but allows users to compare their original plan
185+ Explain API from Hyperspace is very similar to Spark's ` df.explain ` API but allows users to compare their original plan
186186vs the updated index-dependent plan before running their query.
187187You have an option to choose from html/plaintext/console mode to display the command output.
188188
0 commit comments