Перейти к содержанию

База данных

/api/database методы.

DELETE /api/database/:id

Удалить базу данных.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • id целое число больше нуля.

  • include_editable_data_model логическое значение или null.

  • include_hidden логическое значение или null.

GET /api/database/:id/syncable_schemas

Возвращает список всех синхронизируемых схем, найденных для базы данных.

PARAMS:

  • id целое число больше нуля.

GET /api/database/:id/usage_info

Возвращает информацию об использовании базы данных. Возвращает карту с ключами, в которых хранятся модели и значениями, в которых хранится количество сущностей, которые используются эту базу данных.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • id целое число больше нуля.

GET /api/database/

Получить все базы данных.

  • include=tables означает, что мы должны заполнить таблицы, принадлежащие каждой БД. По умолчанию: false.

  • saved означает, что мы должны включить виртуальную базу данных сохранённых запросов. По умолчанию: false.

  • include_editable_data_model включает только БД, для которых у текущего пользователя есть разрешения на редактирование модели данных. (Если include=tables, это также применяется к списку таблиц в каждой базе данных). Должен использоваться только в том случае, если доступен код версии Enterprise и включена функция расширенных разрешений.

  • exclude_uneditable_details включает только БД, для которых текущий пользователь имеет право на редактирование. Работает только в случае Enterprise версии и с включенной функцией расширенных разрешений.

  • include_only_uploadable Включает только те БД, в которые GlarusBI может вставлять новые данные.

Независимо от этих флагов, реализация [[metabase.models.interface/to-json]] для :model/Database в [[metabase.models.database]] использует реализацию [[metabase.models.interface/can-write?]] для :model/Database в [[metabase.models.database]] для исключения поля details, если пользователь не имеет разрешения на изменение деталей базы данных.

Параметры:

  • include таблица или null.

  • saved логическое значение или null.

  • include_editable_data_model логическое значение или null.

  • exclude_uneditable_details логическое значение или null.

  • include_only_uploadable логическое значение или null.

  • include_analytics логическое значение или null.

GET /api/database/:id

Получить одну базу данных по её id. Опционально, при добавлении параметров ?include=tables или ?include=tables.fields возвращает таблицы или, соответственно, таблицы и поля этой базы данных. Если пользователь имеет разрешения на запись в БД (т.е. является администратором или имеет разрешения на модель данных), то определённые выводимые секретные значения также будут включены в возвращаемые данные.

Передача параметра include_editable_data_model вернёт только таблицы, для которых у текущего пользователя есть разрешения на редактирование модели данных (в случае Enterprise версии и с включенной функцией расширенных разрешений). Кроме того, если у пользователя нет доступа к данным для БД (т.н. блокированные разрешения), он вернёт только имя БД, ID и таблицы, без дополнительных метаданных.

Независимо от этих флагов, реализация [[metabase.models.interface/to-json]] для :model/Database в [[metabase.models.database]] использует реализацию [[metabase.models.interface/can-write?]] для :model/Database в [[metabase.models.database]] для исключения поля details, если пользователь не имеет разрешения на изменение деталей базы данных.

Параметры:

  • id целое число больше нуля.

  • include значение должно быть пустым или одним из tables, tables.fields.

  • include_editable_data_model

  • exclude_uneditable_details

GET /api/database/:id/autocomplete_suggestions

Возвращает список предложений автозаполнения для заданного prefix, или substring. Должно присутствовать только одно значение, но в случае наличия обоих, будет иметь приоритет значение substring.

Предназначено для использования с ACE Editor при вводе пользователем прямого SQL. Предложения включают соответствующие Tables и Fields в этой Database.

Таблицы возвращаются в формате [table_name "Table"]; Когда поля имеют semantic_type, они возвращаются в формате [field_name "table_name base_type semantic_type"] Когда у поля нет semantic_type, они возвращаются в формате [field_name "table_name base_type"].

Параметры:

  • id целое число больше нуля.

  • prefix непустая строка или null.

  • substring непустая строка или null.

GET /api/database/:id/card_autocomplete_suggestions

Возвращает список Card предложений автозаполнения для заданного query в данной Database.

Предназначено для использованию с редактором ACE, когда пользователь использует для Card синтаксис метки, например {{#...}}.

Параметры:

  • id целое число больше нуля.

  • query непустая строка.

GET /api/database/:id/fields

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

Параметры:

  • id целое число больше нуля.

GET /api/database/:id/idfields

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

Параметры:

  • id целое число больше нуля.

  • include_editable_data_model

GET /api/database/:id/metadata

Получить метаданные о базе данных, включая все её таблицы и поля. Возвращает базу данных, поля и значения полей. По умолчанию возвращаются только нескрытые поля и таблицы. Передача include_hidden=true включает так же показ и скрытых полей.

Передача include_editable_data_model вернёт только таблицы, для которых текущий пользователь имеет разрешения на редактирование модели данных (в случае Enterprise верс — и с включенной функцией расширенных разрешений). В дополнение, если пользователь не имеет доступа к данным БД (т.е. есть блокировка разрешений), то вернётся только название базы данных, ID и таблицы, без дополнительных метаданных.

Параметры:

  • id целое число больше нуля.

  • include_hidden допустимая логическая строка (true или false) или null.

  • include_editable_data_model допустимая логическая строка (true или false) или null.

  • remove_inactive допустимая логическая строка (true или false) или null.

  • skip_fields допустимая логическая строка (true или false) или null.

GET /api/database/:id/schema/

Возвращает список таблиц базы данных, чья схема является nil или пустой строкой.

Параметры:

  • id целое число больше нуля.

  • include_hidden логическое значение или null.

  • include_editable_data_model логическое значение или null.

GET /api/database/:id/schema/:schema

Возвращает список таблиц для заданной базы данных id и schema.

Параметры:

  • id целое число больше нуля.

  • include_hidden логическое значение или null.

  • include_editable_data_model логическое значение или null.

  • schema

GET /api/database/:id/schemas

Возвращает список всех схем с таблицами, найденных в базе данных id. Исключает из выборки те схемы, в которых нет таблиц.

Параметры:

  • id целое число больше нуля.

  • include_editable_data_model логическое значение или null.

  • include_hidden логическое значение или null.

GET /api/database/:virtual-db/datasets

Возвращает список всех найденных наборов данных для виртуальной базы данных сохранённых запросов.

GET /api/database/:virtual-db/datasets/:schema

Возвращает список таблиц наборов данных для виртуальной базы данных.

Параметры:

  • schema

GET /api/database/:virtual-db/metadata

Метод, который предоставляет метаданные для виртуальной базы данных сохранённых запросов. Используется для подстановке в пользовательском интерфейсе и позволяет работать пользователю с виртуальной базой данных "Сохранённые запросы" так же, как и с любой другой базой данных.

GET /api/database/:virtual-db/schema/:schema

Возвращает список таблиц для виртуальной базы данных "Сохранённые запросы".

Параметры:

  • schema

GET /api/database/:virtual-db/schemas

Возвращает список всех схем, найденных для виртуальной базы данных сохранённых запросов.

POST /api/database/

Добавляет новую базу данных.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • engine значение должно быть действительным двигателем базы данных.

  • schedules null или значение должно быть валидной картой карт расписания для БД.

  • connection_source null или перечисление из :admin, :setup.

  • auto_run_queries логическое значение или null.

  • name непустая строка.

  • is_full_sync null или допустимая логическая строка ('true' или 'false').

  • cache_ttl целое число больше нуля или null.

  • details значение должно быть картой.

  • is_on_demand null или допустимая логическая строка ('true' или 'false').

POST /api/database/:id/discard_values

Скрывает все сохранённые значения полей для данной базы данных.

Параметры:

  • id целое число больше нуля.

POST /api/database/:id/dismiss_spinner

В ручном режиме устанавливает первоначальный статус синхронизацииDatabase и соответствующих таблиц в значение complete (см. #20863).

Параметры:

  • id целое число больше нуля.

POST /api/database/:id/persist

Пытается включить сохранение модели для базы данных. Если уже включено, возвращает общий код ошибки 204.

Параметры:

  • id целое число больше нуля.

POST /api/database/:id/rescan_values

Включает ручное сканирование значений полей для заданной базы данных.

Параметры:

id целое число больше нуля.

POST /api/database/:id/sync_schema

Включает ручное обновление схемы метаданных для заданной базы данных.

Параметры:

  • id целое число больше нуля.

POST /api/database/:id/unpersist

Пытается выключить сохранение модели для базы данных. Если уже включено, возвращает общий код ошибки 204.

Параметры:

  • id целое число больше нуля.

POST /api/database/sample_database

Добавляет образец базы данных как новую базу данных Database.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

POST /api/database/validate

Проверить возможность подключения к базе данных на основе набора данных.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:

  • engine действительный тип базы данных.

  • details карта.

PUT /api/database/:id

Обновить заданную базу данных.

Параметры:

  • engine допустимый тип базы данных или null.

  • schedules null или значение должно быть валидной картой карт расписания для БД.

  • refingerprint логическое значение или null.

  • points_of_interest строка или null.

  • description строка или null.

  • auto_run_queries логическое значение или null.

  • name непустая строка или null.

  • settings карта или null.

  • caveats строка или null.

  • is_full_sync

  • cache_ttl целое число больше нуля или null.

  • details карта или null.

  • id целое число больше нуля.

  • is_on_demand

<< Назад к разделу API