descriptive parameter name and update comment

Signed-off-by: Sean Kao <[email protected]>
opensearch-project · Jun 13, 2024 · 6b86c11 · 6b86c11
1 parent 819f711
commit 6b86c11
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/flint-core/src/main/scala/org/opensearch/flint/core/FlintClient.java b/flint-core/src/main/scala/org/opensearch/flint/core/FlintClient.java
@@ -31,10 +31,10 @@ public interface FlintClient {
    * Start a new optimistic transaction.
    *
    * @param indexName index name
-   * @param initIfNotExist initIfNotExist create empty translog if not exist.
+   * @param forceInit force init transaction and create empty translog if not exist
    * @return transaction handle
    */
-  <T> OptimisticTransaction<T> startTransaction(String indexName, boolean initIfNotExist);
+  <T> OptimisticTransaction<T> startTransaction(String indexName, boolean forceInit);
 
   /**
    * Create a Flint index with the metadata given.

diff --git a/...t-core/src/main/scala/org/opensearch/flint/core/metadata/log/FlintMetadataLogService.java b/...t-core/src/main/scala/org/opensearch/flint/core/metadata/log/FlintMetadataLogService.java
@@ -17,10 +17,10 @@ public interface FlintMetadataLogService {
    * Start a new optimistic transaction.
    *
    * @param indexName index name
-   * @param initIfNotExist initIfNotExist create empty metadata log if not exist.
+   * @param forceInit force init transaction and create empty metadata log if not exist
    * @return transaction handle
    */
-  <T> OptimisticTransaction<T> startTransaction(String indexName, boolean initIfNotExist);
+  <T> OptimisticTransaction<T> startTransaction(String indexName, boolean forceInit);
 
   /**
    * Start a new optimistic transaction.
@@ -36,10 +36,10 @@ default <T> OptimisticTransaction<T> startTransaction(String indexName) {
    * Get metadata log for index.
    *
    * @param indexName index name
-   * @param forceInit forceInit create empty metadata log if not exist
+   * @param initIfNotExist create empty metadata log if not exist
    * @return optional metadata log
    */
-  Optional<FlintMetadataLog<FlintMetadataLogEntry>> getIndexMetadataLog(String indexName, boolean forceInit);
+  Optional<FlintMetadataLog<FlintMetadataLogEntry>> getIndexMetadataLog(String indexName, boolean initIfNotExist);
 
   /**
    * Get metadata log for index.

diff --git a/flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchClient.java b/flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchClient.java
@@ -80,8 +80,8 @@ public FlintOpenSearchClient(FlintOptions options) {
   }
 
   @Override
-  public <T> OptimisticTransaction<T> startTransaction(String indexName, boolean initIfNotExist) {
-    return metadataLogService.startTransaction(indexName, initIfNotExist);
+  public <T> OptimisticTransaction<T> startTransaction(String indexName, boolean forceInit) {
+    return metadataLogService.startTransaction(indexName, forceInit);
   }
 
   @Override

diff --git a/...e/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchMetadataLogService.java b/...e/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchMetadataLogService.java
@@ -51,13 +51,13 @@ public <T> OptimisticTransaction<T> startTransaction(String indexName, boolean f
   }
 
   @Override
-  public Optional<FlintMetadataLog<FlintMetadataLogEntry>> getIndexMetadataLog(String indexName, boolean forceInit) {
+  public Optional<FlintMetadataLog<FlintMetadataLogEntry>> getIndexMetadataLog(String indexName, boolean initIfNotExist) {
     LOG.info("Getting metadata log for index " + indexName + " and data source " + dataSourceName);
     try (IRestHighLevelClient client = createOpenSearchClient()) {
       if (client.doesIndexExist(new GetIndexRequest(metaLogIndexName), RequestOptions.DEFAULT)) {
         LOG.info("Found metadata log index " + metaLogIndexName);
       } else {
-        if (forceInit) {
+        if (initIfNotExist) {
           initIndexMetadataLog();
         } else {
           String errorMsg = "Metadata log index not found " + metaLogIndexName;