Meta Info Action 用于获取集群内的元数据信息。如数据库列表,表结构等。

数据库列表

Request

  1. GET /api/meta/namespaces/<ns_name>/databases

Description

获取所有数据库名称列表,按字母序排列。

Path parameters

Query parameters

  • limit

    限制返回的结果行数

  • offset

    分页信息,需要和 limit 一起使用

Request body

Response

  1. {
  2. "msg": "OK",
  3. "code": 0,
  4. "data": [
  5. "db1", "db2", "db3", ...
  6. ],
  7. "count": 3
  8. }
  • data 字段返回数据库名列表。

表列表

Request

  1. GET /api/meta/namespaces/<ns_name>/databases/<db_name>/tables

Description

获取指定数据库中的表列表,按字母序排列。

Path parameters

  • <db_name>

    指定数据库名称

Query parameters

  • limit

    限制返回的结果行数

  • offset

    分页信息,需要和 limit 一起使用

Request body

Response

  1. {
  2. "msg": "OK",
  3. "code": 0,
  4. "data": [
  5. "tbl1", "tbl2", "tbl3", ...
  6. ],
  7. "count": 0
  8. }
  • data 字段返回表名称列表。

表结构信息

Request

  1. GET /api/meta/namespaces/<ns_name>/databases/<db_name>/tables/<tbl_name>/schema

Description

获取指定数据库中,指定表的表结构信息。

Path parameters

  • <db_name>

    指定数据库名称

  • <tbl_name>

    指定表名称

Query parameters

  • with_mv

    可选项,如果未指定,默认返回 base 表的表结构。如果指定,则还会返回所有 rollup 的信息。

Request body

Response

  1. GET /api/meta/namespaces/default/databases/db1/tables/tbl1/schema
  2. {
  3. "msg": "success",
  4. "code": 0,
  5. "data": {
  6. "tbl1": {
  7. "schema": [{
  8. "Field": "k1",
  9. "Type": "INT",
  10. "Null": "Yes",
  11. "Extra": "",
  12. "Default": null,
  13. "Key": "true"
  14. },
  15. {
  16. "Field": "k2",
  17. "Type": "INT",
  18. "Null": "Yes",
  19. "Extra": "",
  20. "Default": null,
  21. "Key": "true"
  22. }
  23. ],
  24. "is_base": true
  25. }
  26. },
  27. "count": 0
  28. }
  1. GET /api/meta/namespaces/default/databases/db1/tables/tbl1/schema?with_mv?=1
  2. {
  3. "msg": "success",
  4. "code": 0,
  5. "data": {
  6. "tbl1": {
  7. "schema": [{
  8. "Field": "k1",
  9. "Type": "INT",
  10. "Null": "Yes",
  11. "Extra": "",
  12. "Default": null,
  13. "Key": "true"
  14. },
  15. {
  16. "Field": "k2",
  17. "Type": "INT",
  18. "Null": "Yes",
  19. "Extra": "",
  20. "Default": null,
  21. "Key": "true"
  22. }
  23. ],
  24. "is_base": true
  25. },
  26. "rollup1": {
  27. "schema": [{
  28. "Field": "k1",
  29. "Type": "INT",
  30. "Null": "Yes",
  31. "Extra": "",
  32. "Default": null,
  33. "Key": "true"
  34. }],
  35. "is_base": false
  36. }
  37. },
  38. "count": 0
  39. }
  • data 字段返回 base 表或 rollup 表的表结构信息。