Перейти к содержимому
Последнее обновление

Получение метаданных

Meta Info Action используется для получения метаданных кластера, например списка баз данных, структуры таблиц и т. д.

Список баз данных​

Запрос​

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

Описание​

Получение списка имён всех баз данных в алфавитном порядке.

Параметры пути​

Нет

Параметры запроса​

  • limit

    Ограничивает количество возвращаемых строк результата

  • offset

    Параметр постраничного вывода, который необходимо использовать вместе с limit

Тело запроса​

Нет

Ответ​

{
	"msg": "OK",
	"code": 0,
	"data": [
	   "db1", "db2", "db3", ...  
	],
	"count": 3
}
  • В поле data возвращается список имён баз данных.

Список таблиц​

Запрос​

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

Описание​

Получение списка таблиц указанной базы данных в алфавитном порядке.

Параметры пути​

  • <db_name>

    Указывает базу данных

Параметры запроса​

  • limit

    Ограничивает количество возвращаемых строк результата

  • offset

    Параметр постраничного вывода, который необходимо использовать вместе с limit

Тело запроса​

Нет

Ответ​

{
	"msg": "OK",
	"code": 0,
	"data": [
	   "tbl1", "tbl2", "tbl3", ...  
	],
	"count": 0
}
  • В поле data возвращается список имён таблиц.

Сведения о схеме​

Запрос​

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

Описание​

Получение сведений о структуре указанной таблицы в указанной базе данных.

Параметры пути​

  • <db_name>

    Указывает имя базы данных

  • <tbl_name>

    Указывает имя таблицы

Параметры запроса​

  • with_mv

    Необязательный параметр. Если он не указан, по умолчанию возвращается структура базовой таблицы. Если указан, также возвращаются все индексы rollup.

Тело запроса​

Нет

Ответ​

GET /api/meta/namespaces/default/databases/db1/tables/tbl1/schema

{
	"msg": "success",
	"code": 0,
	"data": {
		"tbl1": {
			"schema": [{
					"Field": "k1",
					"Type": "INT",
					"Null": "Yes",
					"Extra": "",
					"Default": null,
					"Key": "true"
				},
				{
					"Field": "k2",
					"Type": "INT",
					"Null": "Yes",
					"Extra": "",
					"Default": null,
					"Key": "true"
				}
			],
			"is_base": true
		}
	},
	"count": 0
}
GET /api/meta/namespaces/default/databases/db1/tables/tbl1/schema?with_mv=1

{
	"msg": "success",
	"code": 0,
	"data": {
		"tbl1": {
			"schema": [{
					"Field": "k1",
					"Type": "INT",
					"Null": "Yes",
					"Extra": "",
					"Default": null,
					"Key": "true"
				},
				{
					"Field": "k2",
					"Type": "INT",
					"Null": "Yes",
					"Extra": "",
					"Default": null,
					"Key": "true"
				}
			],
			"is_base": true
		},
		"rollup1": {
			"schema": [{
				"Field": "k1",
				"Type": "INT",
				"Null": "Yes",
				"Extra": "",
				"Default": null,
				"Key": "true"
			}],
			"is_base": false
		}
	},
	"count": 0
}
  • В поле data возвращаются сведения о структуре базовой таблицы или таблицы rollup.
Report issue