База данных¶
/api/database методы.
DELETE /api/database/:id¶
Удалить Database.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
Параметры:¶
idцелое число больше нуля.include_editable_data_modelлогическое значение, может быть пустым.include_hiddenлогическое значение, может быть пустым.
GET /api/database/:id/syncable_schemas¶
Возвращает список всех синхронизируемых схем, найденных для базы данных id.
PARAMS:¶
idцелое число больше нуля.
GET /api/database/:id/usage_info¶
Возвращает информацию об использовании базы данных. Возвращает карту с ключами, в которых хранятся модели и значениями, в которых хранится количество сущностей, которые используются эту базу данных.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
Параметры:¶
idцелое число больше нуля.
GET /api/database/¶
Получить все базы данных Databases.
include_tablesозначает, что мы должны заполнить таблицы, принадлежащие каждой БД. По умолчанию:false.savedозначает, что мы должны включить виртуальную базу данных сохраненных вопросов. По умолчанию:false.include_editable_data_modelвключает только БД, для которых у текущего пользователя есть разрешения на редактирование модели данных. (Еслиinclude=tables, это также применяется к списку таблиц в каждой базе данных). Должен использоваться только в том случае, если доступен код версии Enterprise и включена функция расширенных разрешений.exclude_uneditable_detailsвключает только БД, для которых текущий пользователь имеет право на редактирование. Работает только в случае Enterprise версии и с включенной функцией расширенных разрешений.include_only_uploadableВключает только те БД, в которые GlarusBI может вставлять новые данные.
Параметры:¶
includeтаблица, может быть пустой.savedлогическое значение, может быть пустым.include_editable_data_modelлогическое значение, может быть пустым.exclude_uneditable_detailsлогическое значение, может быть пустым.include_only_uploadableлогическое значение, может быть пустым.include_analyticsлогическое значение, может быть пустым.
GET /api/database/:id¶
Получить одну базу данных по ее id. Опционально, при добавлении параметров ?include=tables или ?include=tables.fields возвращает таблицы или, соответственно, таблицы и поля этой базы данных. Если пользователь имеет разрешения на запись в БД (т.е. является администратором или имеет разрешения на модель данных), то определенные выводимые секретные значения также будут включены в возвращаемые данные.
Передача параметра include_editable_data_model вернет только таблицы, для которых у текущего пользователя есть разрешения на редактирование модели данных (в случае Enterprise версии и с включенной функцией расширенных разрешений). Кроме того, если у пользователя нет доступа к данным для БД (т.н. блокированные разрешения), он вернет только имя БД, ID и таблицы, без дополнительных метаданных.
Параметры:¶
idincludeзначение должно быть пустым или одним изtables,tables.fields.include_editable_data_modelexclude_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целое число.prefixnull или непустая строка.substringnull или непустая строка.
GET /api/database/:id/card_autocomplete_suggestions¶
Возвращает список Card предложений автозаполнения для заданного query в данной Database.
Предназначено для использованию с редактором ACE когда пользователь использует для Card синтаксис метки, например {{#…}}.
Параметры:¶
idцелое число.queryнепустая строка.
GET /api/database/:id/fields¶
Получить список всех Fields в Database.
Параметры:¶
id
GET /api/database/:id/idfields¶
Получить список всех первичных ключей Fields для Database.
Параметры:¶
idinclude_editable_data_model
GET /api/database/:id/metadata¶
Получить метаданные о Database, включая все ее Tables и Fields. Возвращает базу данных, поля и значения полей.
По умолчанию возвращаются только нескрытые поля и таблицы. Передача include_hidden=true включает так же показ и скрытых полей.
Передача include_editable_data_model вернет только таблицы для которых текущий пользователь имеет разрешения на редактирование модели данных (в случае Enterprise версии и с включенной функцией расширенных разрешений). В дополнение, если пользователь не имеет доступа к данным БД (т.е. есть блокировка разрешений), то вернется только название базы данных, ID и таблицы, без дополнительных метаданных.
Параметры:¶
idinclude_hiddenлогическое значение, может быть пустым.include_editable_data_modelлогическое значение, может быть пустым.
GET /api/database/:id/schema/¶
Возвращает список таблиц базы данных, чья schema является nil или пустой строкой.
Параметры:¶
idцелое число больше нуля.include_hiddenлогическое значение, может быть пустым.include_editable_data_modelлогическое значение, может быть пустым.
GET /api/database/:id/schema/:schema¶
Возращает список таблиц для заданной базы данных id и schema.
Параметры:¶
idцелое число больше нуля.include_hiddenлогическое значение, может быть пустым.include_editable_data_modelлогическое значение, может быть пустым.schema
GET /api/database/:id/schemas¶
Возвращает список всех схем с таблицами, найденных в базе данных id. Исключает из выборки те схемы, в которых нет таблиц.
Параметры:¶
idцелое число больше нуля.include_editable_data_modelлогическое значение, может быть пустым.include_hiddenлогическое значение, может быть пустым.
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¶
Возвращает список всех схем, найденных для виртуальной базы данных сохраненных вопросов.
GET /api/database/db-ids-with-deprecated-drivers¶
Возвращает список ID баз данных, использующих устаревшие драйверы.
POST /api/database/¶
Добавляет новую Database.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
Параметры:¶
nameнепустая строка.engineзначение должно быть действительным двигателем базы данных.detailsзначение должной быть картой.is_full_syncзначение должно быть пустым, или если не пустое, значение должно быть булевым.is_on_demandзначение должно быть пустым, или если не пустое, значение должно быть булевым.schedulesзначение должно быть пустым, или если не пустое, значение должно быть действительной картой расписаний для базы данных.auto_run_queriesзначение должно быть пустым, или если не пустое, значение должно быть булевым.cache_ttlзначение должно быть пустым, или если не пустое, значение должно быть целым больше нуля.
POST /api/database/:id/discard_values¶
Скрывает все сохранненые значения полей для данной Database.
Параметры:¶
id
POST /api/database/:id/dismiss_spinner¶
В ручном режиме устанавливает первоначальный статус синхронизацииDatabase и соответствующих таблиц в значение complete (см. #20863).
Параметры:¶
id
POST /api/database/:id/persist¶
Пытается включить сохранение модели для базы данных. Если уже включено, возвращает общий код ошибки 204.
Параметры:¶
id
POST /api/database/:id/rescan_values¶
Включает ручное сканирование значений полей для заданной Database.
Параметры:¶
id целое число больше нуля.
POST /api/database/:id/sync_schema¶
Включает ручное обновление схемы метаданных для данной Database.
Параметры:¶
idцелое число больше нуля.
POST /api/database/:id/unpersist¶
Пытается выключить сохранение модели для базы данных. Если уже включено, возвращает общий код ошибки 204.
Параметры:¶
id
POST /api/database/sample_database¶
Добавляет образец базы данных как новую базу данных Database.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
POST /api/database/validate¶
Проверить возможность подключения к базе данных на основе набора данных.
Вы должны обладать правами суперпользователя, чтобы использовать этот метод.
Параметры:¶
engineзначение должно быть действительным типом базы данных.detailsзначение должно быть картой.
PUT /api/database/:id¶
Обновить базу данных Database.
Параметры:¶
engineзначение должно быть пустым, или если не пустое, значение должно быть допустимым типом базы данных.schedulesзначение должно быть пустым, или если не пустое, значение должно быть допустимой картой расписаний для БД.refingerprintзначение должно быть пустым, или если не пустое, значение должно быть булевым.points_of_interestзначение должно быть пустым, или если не пустое, значение должно быть строкой.descriptionзначение должно быть пустым, или если не пустое, значение должно быть строкой.auto_run_queriesзначение должно быть пустым, или если не пустое, значение должно быть булевым.nameзначение должно быть пустым, или если не пустое, значение должно быть не пустой строкой.settingsзначение должно быть пустым, или если не пустое, value must be a map.caveatsзначение должно быть пустым, или если не пустое, значение должно быть строкой.is_full_synccache_ttlзначение должно быть пустым, или если не пустое, значение должно быть целым больше нуля.detailsзначение должно быть пустым, или если не пустое, значение должно быть картой.idis_on_demand