Утилита командной строки#

Для работы с каталогом вы можете использовать утилиту командной строки catalog. Утилита позволяет управлять пользователями, файловыми системам и Iceberg каталогами, а также просматривать информацию о зарегистрированных Iceberg таблицах и представлениях.

Начало работы#

Если вы используете распакованный архив CedrusData Catalog, утилиту можно найти в директории bin/catalog:

bin/catalog --help

Если вы используете Docker-контейнер CedrusData Catalog, утилита доступна изнутри контейнера по имени catalog. Пример команды для вызова утилиты из запущенного контейнера с именем example-catalog:

docker exec -it example-catalog catalog --help

Подключение к каталогу#

При вызове команды утилита связывается с экземпляром CedrusData Catalog по протоколу HTTP или HTTPS, отправляет команду, и отображает полученный ответ.

Вы можете передать опции подключения в явном виде или настроить профиль с помощью команды configure. Мы рекомендуем настроить профили для большего удобства.

Пример вызова команды сервера с явным указанием опций подключения:

catalog --endpoint http://localhost:9080 --access-token-file data/admin-access-token info

+---------+-------------+
| version | initialized |
+---------+-------------+
| 458-1   | true        |
+---------+-------------+

Опции подключения#

--endpoint Адрес каталога в формате http[s]://host[:port]. Значение по умолчанию: http://127.0.0.1:9080.

--access-token-file Путь к файлу с постоянным токеном доступа.

--access-token Постоянный токен доступа, переданный в явном виде. Небезопасно, рекомендуем использовать –access-token-file`.

--keystore-path Путь к keystore в формате PEM или JKS (только для HTTPS).

--keystore-password-file Путь к файлу с паролем keystore (только для HTTPS).

--keystore-password Пароль keystore в явном виде (только для HTTPS). Небезопасно, рекомендуем использовать --keystore-password-file.

--truststore-path Путь к truststore в формате PEM или JKS (только для HTTPS).

--truststore-password-file Путь к файлу с паролем truststore (только для HTTPS).

--truststore-password Пароль truststore в явном виде (только для HTTPS). Небезопасно, рекомендуем использовать --truststore-password-file

--ssl-verification Способ валидации сертификата сервера (только для HTTPS). Допустимые значения: full - проверять сертификат и hostname сервера, ca - проверять только сертификат сервера, none - не проверять сертификат сервера. Используйте режим none только для тестирования (например, с самоподписанными сертификатами). Значение по умолчанию: full

Отображение результатов#

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

Вы также можете отображать результаты работы команд в формате JSON с помощью флага --json. Это может быть удобно для передачи результата другим скриптам.

Пример успешной работы команды:

catalog --json \
  --endpoint http://localhost:9080 \
  --access-token-file data/admin-access-token info

{
  "version" : "458-1",
  "initialized" : true
}

Пример завершения работы команды с ошибкой (указано недопустимое имя пользователя):

catalog --json \
  --endpoint http://localhost:9080 \
  --access-token-file data/admin-access-token \
  catalog --json  principal create --principal-name Ja?ne

{
  "error" : {
    "code" : 1003,
    "message" : "Principal name \"Ja?ne\" must contain only alphanumeric characters, \"_\", \"-\", \".\", or \"@\"",
    "details" : {
      "correlation-id" : "1583ce81-7890-4ca2-a5da-a5eca28214ab"
    }
  }
}

Доступные команды#