Получение схемы таблицы

Запрос

GET /api/<db>/<table>/_schema

Описание

Используется для получения информации о структуре указанной таблицы. Этот интерфейс в настоящее время используется в Spark/Flink Doris Connector. Получает информацию о структуре таблицы Doris.

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

• <db>

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

• <table>

  Укажите таблицу

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

Нет

Тело запроса

Нет

Ответ

• Интерфейс http возвращает следующий ответ:

{
	"msg": "success",
	"code": 0,
	"data": {
		"properties": [{
			"type": "INT",
			"name": "k1",
			"comment": "",
			"aggregation_type":""
		}, {
			"type": "INT",
			"name": "k2",
			"comment": "",
			"aggregation_type":"MAX"
		}],
		"keysType":UNIQUE_KEYS,
		"status": 200
	},
	"count": 0
}

• Интерфейс http v2 возвращает следующий ответ:

{
	"msg": "success",
	"code": 0,
	"data": {
		"properties": [{
			"type": "INT",
			"name": "k1",
			"comment": ""
		}, {
			"type": "INT",
			"name": "k2",
			"comment": ""
		}],
		"keysType":UNIQUE_KEYS,
		"status": 200
	},
	"count": 0
}

Примечание: отличие заключается в том, что метод http возвращает дополнительные поля aggregation_type по сравнению с методом http v2. Интерфейс http v2 включается с помощью параметра enable_http_server_v2. Подробное описание параметров см. в разделе Настройка параметров FE

Примеры

1. Получение информации о структуре указанной таблицы через интерфейс http.

   GET /api/db1/tbl1/_schema
   
   Response:
   {
   	"msg": "success",
   	"code": 0,
   	"data": {
   		"properties": [{
   			"type": "INT",
   			"name": "k1",
   			"comment": "",
   			"aggregation_type":""
   		}, {
   			"type": "INT",
   			"name": "k2",
   			"comment": "",
   			"aggregation_type":"MAX"
   		}],
   		"keysType":UNIQUE_KEYS,
   		"status": 200
   	},
   	"count": 0
   }

2. Получение информации о структуре указанной таблицы через интерфейс http v2.

   GET /api/db1/tbl1/_schema
   
   Response:
   {
   	"msg": "success",
   	"code": 0,
   	"data": {
   		"properties": [{
   			"type": "INT",
   			"name": "k1",
   			"comment": ""
   		}, {
   			"type": "INT",
   			"name": "k2",
   			"comment": ""
   		}],
   		"keysType":UNIQUE_KEYS,
   		"status": 200
   	},
   	"count": 0
   }