Add Flint client and index management API

[dai-chen]

Description

1. Add FlintClient interface with basic Flint index management API
2. Add OpenSearch implementation for the client
3. Copy and remove Spark dependency in OpenSearchSuite (will discuss with @penghuo if we want to move all IT stuff from flint-spark-integration to integ-test module)

Please see detailed design in opensearch-project/opensearch-spark#2 and read on below for more details. Later I will convert everything into individual doc in future PR.

Flint Specification

Note that Flint spec is subject to change during development and thus FlintMetadata stores everything in Map. Will change this to strong type once finalized.

Flint metadata sample:

{
  "version": "0.1",
  "indexConfig": {
    "kind": "SkippingIndex",
    "properties": {
      "indexedColumns": ...
     }
  },
  "source": "alb_logs",
  "state": "active",
  "enabled": true
}

Flint Java SDK

API:

• createIndex
• exists
• getIndexMetadata

Usage (more details in FlintOpenSearchClientSuite):

// Initialized Flint client for a specific storage
FlintClient flintClient = new FlintOpenSearchClient("localhost", 9200);

Map<String, String> schema =
  Map.of(
    "file_path", "keyword",
    "elb_status_code": "integer");
Map<String, Object> meta =
  Map.of(
    "version": "0.1",
    "indexConfig": Map.of(...));

FlintMetadata metadata = new FlintMetadata(schema, meta)
flintClient.createIndex("alb_logs_skipping_index", metadata)

Flint OpenSearch Storage

OpenSearch index mapping sample:

alb_logs_skipping_index
{
  "_meta": {
    "version": "0.1",
    "indexConfig": {
        "kind": "SkippingIndex",
        "properties": {
          "indexedColumns": [
            "elb_status_code": "value_list"
          ]
        }
    }
    ......
  },
  "properties": {
     "file_path": {
       "type": "keyword"
     },
     "elb_status_code": {
         "type": "integer"
     }
   }
}

Testing

Followed developer guide: https://github.com/opensearch-project/sql/blob/feature/flint/flint/DEVELOPER_GUIDE.md

$ sbt scalafmtAll

$ sbt integtest/test 
...
[info] FlintOpenSearchClientSuite:
[info] Flint OpenSearch client
[info] - should create index successfully
[info] - should return false if index not exist

Issues Resolved

#1635

Check List

• New functionality includes testing.
  • All tests pass, including unit test, integration test and doctest
• New functionality has been documented.
  • New functionality has javadoc added
  • New functionality has user manual doc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[codecov]

Codecov Report

Merging #1634 (9d3c2fd) into feature/flint (b19db71) will not change coverage.
The diff coverage is n/a.

❗ Current head 9d3c2fd differs from pull request most recent head 66f49a7. Consider uploading reports for the commit 66f49a7 to get more accurate results

@@               Coverage Diff                @@
##             feature/flint    opensearch-project/sql#1634   +/-   ##
================================================
  Coverage            97.19%   97.19%           
  Complexity            4107     4107           
================================================
  Files                  371      371           
  Lines                10464    10464           
  Branches               706      706           
================================================
  Hits                 10170    10170           
  Misses                 287      287           
  Partials                 7        7           

Flag	Coverage Δ
sql-engine	97.19% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.