REST APIs

Important Information

• As REST APIs interact with the OpenMLDB servers via APIServer, the APIServer must be deployed. The APIServer is an optional module, please refer to this document for the deployment.

• Currently, APIServer is mainly designed for function development and testing, thus it is not suggested to use it for performance benchmarking and deployed in production. There is no high-availability for the APIServer, and it also introduces overhead of networking and encoding/decoding.

Data Insertion

The request URL: http://ip:port/dbs/{db_name}/tables/{table_name}

HTTP method: PUT

The request body:

{
    "value": [
    	[v1, v2, v3]
    ]
}

• Only one record can be inserted at a time.

• The data layout should be arranged according to the schema strictly.

Example

curl http://127.0.0.1:8080/dbs/db/tables/trans -X PUT -d '{
"value": [
    ["bb",24,34,1.5,2.5,1590738994000,"2020-05-05"]
]}'

The response:

{
    "code":0,
    "msg":"ok"
}

Real-Time Feature Extraction

The request URL: http://ip:port/dbs/{db_name}/deployments/{deployment_name}

HTTP method: POST

The request body:

• array style

{
    "input": [["row0_value0", "row0_value1", "row0_value2"], ["row1_value0", "row1_value1", "row1_value2"], ...],
    "need_schema": false
}

• json style

{
    "input": [
      {"col0":"row0_value0", "col1":"row0_value1", "col2":"row0_value2", "foo": "bar"}, 
      {"col0":"row1_value0", "col1":"row1_value1", "col2":"row1_value2"}, 
      ...
    ]
}

• Multiple rows of input are supported, whose returned values correspond to the fields in the data.data array.

• A schema will be returned if need_schema is true. Optional, default is false.

• If input is array style, the response data is array style. If input is json style, the response data is json style. DO NOT use multi styles in one request input.

• Json style input can provide redundancy columns.

Example

• array style

curl http://127.0.0.1:8080/dbs/demo_db/deployments/demo_data_service -X POST -d'{
        "input": [["aaa", 11, 22, 1.2, 1.3, 1635247427000, "2021-05-20"]]
    }'

response:

{
    "code":0,
    "msg":"ok",
    "data":{
        "data":[["aaa",11,22]]
    }
}

• json style

curl http://127.0.0.1:8080/dbs/demo_db/deployments/demo_data_service -X POST -d'{
        "input": [{"c1":"aaa", "c2":11, "c3":22, "c4":1.2, "c5":1.3, "c6":1635247427000, "c7":"2021-05-20", "foo":"bar"}]
    }'

response:

{
    "code":0,
    "msg":"ok",
    "data":{
        "data":[{"c1":"aaa","c2":11,"w1_c3_sum":22}]
    }
}

Query

The request URL: http://ip:port/dbs/{db_name}

HTTP method: POST

request body:

{
    "mode": "",
    "sql": "",
    "input": {
        "schema": [],
        "data": []
    }
}

• “mode” can be: “offsync”, “offasync”, “online”

• “input” is optional

• “schema” all supported types (case-insensitive): Bool, Int16, Int32, Int64, Float, Double, String, Date and Timestamp.

Request Body Example

• Normal query:

{
  "mode": "online",
  "sql": "select 1"
}

The response:

{
  "code":0,
  "msg":"ok",
  "data": {
    "schema":["Int32"],
    "data":[[1]]
  }
}

• Parameterized query:

{
  "mode": "online",
  "sql": "SELECT c1, c2, c3 FROM demo WHERE c1 = ? AND c2 = ?",
  "input": {
    "schema": ["Int32", "String"],
    "data": [1, "aaa"]
  }
}

The response:

{
    "code":0,
    "msg":"ok",
    "data": {
      "schema": ["Int32", "String", "Float"],
      "data": [[1, "aaa", 1.2], [1, "aaa", 3.4]]
    }
}

Get Deployment Info

The request URL: http://ip:port/dbs/{db_name}/deployments/{deployment_name}

HTTP method: Get

The response:

{
  "code": 0,
  "msg": "ok",
  "data": {
    "name": "",
    "procedure": "",
    "input_schema": [

    ],
    "input_common_cols": [
      
    ],
    "output_schema": [

    ],
    "output_common_cols": [
      
    ],
    "dbs": [

    ],
    "tables": [

    ]
  }
}

List Database

The request URL: http://ip:port/dbs

HTTP method: Get

The response:

{
  "code": 0,
  "msg": "ok",
  "dbs": [

  ]
}

List Table

The request URL: http://ip:port/dbs/{db}/tables

HTTP method: Get

The response:

{
  "code": 0,
  "msg": "ok",
  "tables": [
    {
      "name": "",
      "table_partition_size": 8,
      "tid": ,
      "partition_num": 8,
      "replica_num": 2,
      "column_desc": [
        {
          "name": "",
          "data_type": "",
          "not_null": false
        }
      ],
      "column_key": [
        {
          "index_name": "",
          "col_name": [

          ],
          "ttl": {
            
          }
        }
      ],
      "added_column_desc": [
        
      ],
      "format_version": 1,
      "db": "",
      "partition_key": [
        
      ],
      "schema_versions": [
        
      ]
    }
  ]
}

Refresh APIServer metadata cache

The request URL: http://ip:port/refresh

HTTP method: POST

Empty request body.

The response:

{
    "code":0,
    "msg":"ok"
}