Справочник по HTTP API¶

Ответ¶

Тело ответа¶

Сообщение об удалении и идентификатор удаленного запроса:

"successfully cancel request with id=1-ddc44da9-f994-40d4-8d53-930575740751"

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

{
    "sql": "PREPARE plan(INT) AS SELECT count(*) FROM db.public.users"
}

• sql – текст SQL-оператора PREPARE для вычисления результата расчета.

Ответ¶

Тело ответа¶

Название созданного расчета:

"plan"

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

Массив пар название расчета-аргументы вызова:

[
	{
    "name": "plan",
    "args": [ 1 ]
  },
	{
    "name": "plan",
    "args": [ 2 ]
   }
]

• name – название расчета;

• args – массив аргументов вызова в порядке объявления.

Ответ¶

Тело ответа¶

{
	"success": {
		"plan": [
			{
				"COUNT(*)": 1
			}
		]
	},
	"fail": {
		"no": "prepared statement '\"no\"' is not found"
	}
}

• success – результаты успешно выполненных запросов;

• fail – информация о запросах, которые не удалось выполнить;

• timings – время, потраченное на разные этапы обработки запроса;

• plans – вывод EXPLAIN ANALYZE для планов, указанных в заголовке запроса.

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

Параметры¶

По умолчанию аналитические расчеты выполняются последовательно, в одном потоке. Если же указан параметр run_concurrent=true, то расчеты выполняются параллельно, в несколько потоков. Например:

POST http://localhost:7777/computation/run?run_concurrent=true HTTP/1.1

[тело_запроса]

Ответ¶

Тело ответа¶

Название удаленного расчета:

"plan"

Ответ¶

Тело ответа¶

Массив имен существующих аналитических расчетов:

[
	"plan"
]

Ответ¶

Тело ответа¶

{
	"query": "PREPARE plan(INT) AS SELECT count(*) FROM db.public.users"
}

• query – текст запроса, выполняемого в рамках расчета.

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

Тело запроса должно содержать SQL-выражение одного из следующих видов:

• создание нового SQL-представления (или замещение существующего):

  CREATE OR REPLACE VIEW name[(column_name [, ...])] AS query
  

  где:

  • name – название SQL-представления;

  • query – текст SQL-оператора SELECT для вычисления результата SQL-представления.

  Например:

  CREATE OR REPLACE VIEW adults AS SELECT name FROM db.public.users WHERE age >= 18
  

  Примечание

  Создание SQL-представления также возможно с помощью POST-запроса на адрес /ddl/view/$name/create.

• удаление SQL-представления:

  DROP VIEW name
  

  где name – название SQL-представления.

  Например:

  DROP VIEW adults
  

  Примечание

  Удаление SQL-представления также возможно с помощью POST-запроса на адрес /ddl/view/$name/delete.

Ответ¶

Тело ответа¶

Название созданного, замещенного или удаленного SQL-представления:

"adults"

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

{
    "sql": "SELECT name FROM db.public.users WHERE age >= 18"
}

• sql – текст SQL-оператора SELECT для вычисления результата SQL-представления.

Ответ¶

Тело ответа¶

Название созданного SQL-представления:

"adults"

Ответ¶

Тело ответа¶

Название удаленного SQL-представления:

"adults"

Ответ¶

Тело ответа¶

Массив имен существующих нематериализованных представлений:

[
	"adults"
]

Ответ¶

Тело ответа¶

{
	"query": "SELECT name FROM db.public.users WHERE age >= 18"
}

• query – текст запроса, выполняемого в рамках SQL-представления.

Тело запроса оператора CREATE¶

CREATE TABLE db.public.users(col1 u8, col2 u64 CAPACITY 1000, col3 utf8) ENGINE=memtx

Ответ на запрос CREATE TABLE¶

Тело запроса оператора DROP TABLE¶

DROP TABLE [IF EXISTS] table_name

Ответ на запрос DROP TABLE¶

Тело ответа¶

[]

Тело запроса:¶

{
  "table_name": "table_name",
  "rows": [
    {
      "column0": 1,
      "column1": true,
      "column2": "string",
      "column3": 1234
    },
    {
      "column0": 1,
      "column1": false
    }
  ]
}

• table_name – название таблицы;

• rows – массив описаний объектов для вставки.

Ответ¶

Тело запроса:¶

{
  "table_name": "table_name",
  "rows": [
    {
      "column0": 1,
      "column1": true,
      "column2": "string",
      "column3": 1234
    },
    {
      "column0": 1,
      "column1": false
    }
  ]
}

• table_name – название таблицы;

• rows – массив описаний объектов для вставки.

Ответ¶

Тело ответа¶

Тело ответа содержит количество записей, которые были вставлены:

curl 
λ:~/Code/tcs$ curl localhost:7777/v2/insert -d '{ "table_name": "foo", "rows": [ {"i64_0": 1, "utf8_0": "bar1" }, {"i64_0": 2, "utf8_0": "bar2"}] }'
inserted 2 records

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

Тело запроса должно содержать SQL-оператор, например запрос SELECT:

SELECT * FROM catalog.schema.table WHERE column1=1"

Ответ¶

Тело ответа¶

Массив описаний выбранных объектов:

[
  {
    "column1": "2024-03-13T10:14:08",
    "column0": "1",
    "column2": false,
    "column3": "alice"
  }
]

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

Тело запроса должно содержать SQL-оператор, например, запрос SELECT:

SELECT * FROM attributes

Ответ¶

Тело ответа¶

Массив JSON-объектов, где каждая строка из выборки возвращается как отдельный JSON-объект на отдельной строке:

[
  {"Attribute0":555,"Attribute1":null,"Attribute2":null,"Attribute3":null,"Attribute4":foo}
  {"Attribute0":1,"Attribute1":1,"Attribute2":null,"Attribute3":null,"Attribute4":null}
  {"Attribute0":1,"Attribute1":55,"Attribute2":777,"Attribute3":1234,"Attribute4":foo}
]

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

{
    "table_name": "table_name",
    "ops": [
        {
            "op": "set",
            "column_name": "column1",
            "value": 123
        },
        {
            "op": "set",
            "column_name": "column2",
            "value": "test"
        }
    ],
    "conditions": [
        {
            "column_name": "column0",
            "value": 1
        }
    ]
}

• table_name – название таблицы;

• ops – массив описаний операций обновления:

  • op – операция. Возможные значения:

    • set – установить новое значение;

    • append – добавить строку к строчному значению;

    • add – прибавить число к числовому значению;

    • sub – вычесть число из числового значения;

  • column_name – название колонки для обновления;

  • value – новое значение;

• conditions – массив условий выбора объектов. Поддерживается выбор объектов по полному совпадению.

  • column_name – название колонки, используемой для выбора объектов;

  • value – текущее значение или массив значений.

Ответ¶

Ответ¶

Тело ответа¶

Массив параметров текущей версии (номер версии, тип сборки, компилятор):

{
    "version": "0.23.0-37-g4dde2fcd",
    "target": "release",
    "compiler": "rustc 1.81.0 (eeb90cda1 2024-09-04) (gentoo)"
}