`postgres` группа команд

Замечание

Эта информация относится к Databricks CLI версии 0.285 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

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

Группа postgres команд в интерфейсе командной строки Databricks содержит команды для управления ресурсами Lakebase Postgres, включая проекты, ветви и конечные точки. API Postgres предоставляет доступ к базе данных Postgres через REST API или прямой SQL.

databricks postgres create-branch

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

Замечание

Это длительная операция. По умолчанию команда ожидает завершения операции. Используется --no-wait для немедленного возврата сведений о необработанной операции. Затем поле операции name можно использовать для опроса завершения с помощью get-operation команды.

databricks postgres create-branch PARENT BRANCH_ID [flags]

Arguments

PARENT

Проект, в котором создается эта ветвь. Формат: projects/{project_id}

BRANCH_ID

Идентификатор, используемый для ветви, который становится окончательным компонентом имени ресурса ветви. Должно иметь длину 1–63 символов, начинаться с строчной буквы и содержать только строчные буквы, цифры и дефисы (RFC 1123).

Options

--json JSON

Строка JSON inline или @path к JSON-файлу с телом запроса.

--name string

Имя ресурса ветви.

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

В следующем примере создается ветвь в проекте:

databricks postgres create-branch projects/my-project-id my-branch \
  --json '{
    "spec": {
      "no_expiry": true
    }
  }'

В следующем примере создается ветвь из существующей ветви:

databricks postgres create-branch projects/my-project-id dev-branch \
  --json '{
    "spec": {
      "source_branch": "projects/my-project-id/branches/main",
      "no_expiry": true
    }
  }'

databricks postgres create-endpoint

Создайте конечную точку. Ветвь может иметь одну конечную точку вычислений для чтения и записи и несколько конечных точек только для чтения (реплик чтения) для масштабирования операций чтения.

Замечание

databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]

Arguments

PARENT

Ветвь, в которой создается эта конечная точка. Формат: projects/{project_id}/branches/{branch_id}

ENDPOINT_ID

Идентификатор, используемый для конечной точки, которая становится конечным компонентом имени ресурса конечной точки. Должно иметь длину 1–63 символов, начинаться с строчной буквы и содержать только строчные буквы, цифры и дефисы (RFC 1123).

Options

--json JSON

Строка JSON inline или @path к JSON-файлу с телом запроса.

--name string

Имя ресурса конечной точки.

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

В следующем примере создается конечная точка чтения и записи в ветви:

databricks postgres create-endpoint projects/my-project-id/branches/my-branch-id my-endpoint \
  --json '{
    "spec": {
      "endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
      "autoscaling_limit_min_cu": 0.5,
      "autoscaling_limit_max_cu": 4.0
    }
  }'

В следующем примере создается конечная точка только для чтения (реплика чтения):

databricks postgres create-endpoint projects/my-project-id/branches/my-branch-id read-replica-1 \
  --json '{
    "spec": {
      "endpoint_type": "ENDPOINT_TYPE_READ_ONLY",
      "autoscaling_limit_min_cu": 0.5,
      "autoscaling_limit_max_cu": 4.0
    }
  }'

databricks postgres create-project

Создание проекта.

Замечание

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

databricks postgres create-project PROJECT_ID [flags]

Arguments

PROJECT_ID

Идентификатор, используемый для проекта, который становится окончательным компонентом имени ресурса проекта. Должно иметь длину 1–63 символов, начинаться с строчной буквы и содержать только строчные буквы, цифры и дефисы (RFC 1123).

Options

--json JSON

Строка JSON inline или @path к JSON-файлу с телом запроса.

--name string

Имя ресурса проекта.

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

В следующем примере создается проект:

databricks postgres create-project my-project \
  --json '{
    "spec": {
      "display_name": "My Project"
    }
  }'

В следующем примере создается проект с определенной версией PostgreSQL:

databricks postgres create-project my-project \
  --json '{
    "spec": {
      "display_name": "My Project",
      "pg_version": "17"
    }
  }'

databricks postgres delete-branch

Удаление ветви.

Замечание

Защищенные ветви не могут быть удалены. Используйте update-branch для установки значение spec.is_protectedfalse перед удалением.

databricks postgres delete-branch NAME [flags]

Arguments

NAME

Имя удаленной ветви. Формат: projects/{project_id}/branches/{branch_id}

Options

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

В следующем примере удаляется ветвь:

databricks postgres delete-branch projects/my-project-id/branches/my-branch-id

databricks postgres delete-endpoint

Удаление конечной точки.

Замечание

databricks postgres delete-endpoint NAME [flags]

Arguments

NAME

Имя удаленной конечной точки. Формат: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

В следующем примере удаляется конечная точка:

databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id

databricks postgres delete-project

Удаление проекта.

Замечание

databricks postgres delete-project NAME [flags]

Arguments

NAME

Имя удаленного проекта. Формат: projects/{project_id}

Options

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

В следующем примере удаляется проект:

databricks postgres delete-project projects/my-project-id

databricks postgres generate-database-credential

Создайте учетные данные OAuth для базы данных Postgres. Возвращенный маркер OAuth используется для проверки подлинности и подключения к базе данных с помощью клиентов PostgreSQL, таких как psql.

databricks postgres generate-database-credential ENDPOINT [flags]

Arguments

ENDPOINT

Конечная точка, для которой создаются эти учетные данные. Формат: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--json JSON

Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

Примеры

В следующем примере создаются учетные данные OAuth для конечной точки:

databricks postgres generate-database-credential projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id

databricks postgres get-branch

Получите ветвь.

databricks postgres get-branch NAME [flags]

Arguments

NAME

Имя извлекаемой ветви. Формат: projects/{project_id}/branches/{branch_id}

Options

Глобальные флаги

Примеры

В следующем примере показано, как получить сведения о ветви:

databricks postgres get-branch projects/my-project-id/branches/my-branch-id

databricks postgres get-endpoint

Получение конечной точки.

databricks postgres get-endpoint NAME [flags]

Arguments

NAME

Имя извлекаемой конечной точки. Формат: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

Глобальные флаги

Примеры

В следующем примере показано, как получить сведения о конечной точке:

databricks postgres get-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id

databricks postgres get-operation

Получение операции.

databricks postgres get-operation NAME [flags]

Arguments

NAME

Имя ресурса операции.

Options

Глобальные флаги

Примеры

В следующем примере показано, как получить сведения об операции:

databricks postgres get-operation projects/my-project-id/operations/my-operation-id

databricks postgres get-project

Получение проекта.

databricks postgres get-project NAME [flags]

Arguments

NAME

Имя извлекаемого проекта. Формат: projects/{project_id}

Options

Глобальные флаги

Примеры

В следующем примере показано, как получить сведения о проекте:

databricks postgres get-project projects/my-project-id

databricks postgres list-branches

Вывод списка ветвей. Используйте эту команду, чтобы найти идентификаторы ветвей, включая ветвь по умолчанию, созданную в проекте (указано "default": true в состоянии).

databricks postgres list-branches PARENT [flags]

Arguments

PARENT

Проект, принадлежащий этой коллекции ветвей. Формат: projects/{project_id}

Options

--page-size int

Верхняя граница возвращаемых элементов.

--page-token string

Маркер страницы из предыдущего ответа.

Глобальные флаги

Примеры

В следующем примере перечислены все ветви проекта:

databricks postgres list-branches projects/my-project-id

В следующем примере перечислены ветви с разбивкой на страницы:

databricks postgres list-branches projects/my-project-id --page-size 10

databricks postgres list-endpoints

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

databricks postgres list-endpoints PARENT [flags]

Arguments

PARENT

Ветвь, которая владеет этой коллекцией конечных точек. Формат: projects/{project_id}/branches/{branch_id}

Options

--page-size int

Верхняя граница возвращаемых элементов.

--page-token string

Маркер страницы из предыдущего ответа.

Глобальные флаги

Примеры

В следующем примере перечислены все конечные точки в ветви:

databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id

В следующем примере перечислены конечные точки с разбивкой на страницы:

databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id --page-size 10

databricks postgres list-projects

Вывод списка проектов.

databricks postgres list-projects [flags]

Options

--page-size int

Верхняя граница возвращаемых элементов.

--page-token string

Маркер страницы из предыдущего ответа.

Глобальные флаги

Примеры

В следующем примере перечислены все проекты:

databricks postgres list-projects

В следующем примере перечислены проекты с разбивкой на страницы:

databricks postgres list-projects --page-size 10

databricks postgres update-branch

Обновление ветви.

Замечание

databricks postgres update-branch NAME UPDATE_MASK [flags]

Arguments

NAME

Имя ресурса ветви. Формат: projects/{project_id}/branches/{branch_id}

UPDATE_MASK

Список полей для обновления. Если не указано, все поля обновляются по возможности.

Options

--json JSON

Строка JSON inline или @path к JSON-файлу с телом запроса.

--name string

Имя ресурса ветви.

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

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

databricks postgres update-branch projects/my-project-id/branches/my-branch-id spec.is_protected \
  --json '{
    "spec": {
      "is_protected": true
    }
  }'

databricks postgres update-endpoint

Обновление конечной точки.

Замечание

databricks postgres update-endpoint NAME UPDATE_MASK [flags]

Arguments

NAME

Имя ресурса конечной точки. Формат: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

UPDATE_MASK

Список полей для обновления. Если не указано, все поля обновляются по возможности.

Options

--json JSON

Строка JSON inline или @path к JSON-файлу с телом запроса.

--name string

Имя ресурса конечной точки.

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

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

databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id spec.autoscaling_limit_max_cu \
  --json '{
    "spec": {
      "autoscaling_limit_max_cu": 8.0
    }
  }'

В следующем примере обновляется несколько полей (минимальное и максимальное число вычислительных единиц):

databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id "spec.autoscaling_limit_min_cu,spec.autoscaling_limit_max_cu" \
  --json '{
    "spec": {
      "autoscaling_limit_min_cu": 1.0,
      "autoscaling_limit_max_cu": 8.0
    }
  }'

databricks postgres update-project

Обновление проекта.

Замечание

databricks postgres update-project NAME UPDATE_MASK [flags]

Arguments

NAME

Имя ресурса проекта. Формат: projects/{project_id}

UPDATE_MASK

Список полей для обновления. Если не указано, все поля обновляются по возможности.

Options

--json JSON

Строка JSON inline или @path к JSON-файлу с телом запроса.

--name string

Имя ресурса проекта.

--no-wait

Не дождитесь достижения состояния DONE.

--timeout duration

Максимальное время достижения состояния DONE.

Глобальные флаги

Примеры

В следующем примере обновляется отображаемое имя проекта:

databricks postgres update-project projects/my-project-id spec.display_name \
  --json '{
    "spec": {
      "display_name": "Updated Project Name"
    }
  }'

Глобальные флаги

--debug

Следует ли включить ведение журнала отладки.

-h или --help

Отобразить справку по интерфейсу командной строки Databricks, связанной группе команд или отдельной команде.

--log-file струна

Строка, представляющая файл для записи журналов выходных данных. Если этот флаг не указан, по умолчанию используется запись журналов выходных данных в stderr.

--log-format формат

Тип формата журнала: text или json. Значение по умолчанию — text.

--log-level струна

Строка, представляющая уровень формата журнала. Если не указано, уровень формата журнала отключен.

типа -o, --output

Тип выходных данных команды: text или json. Значение по умолчанию — text.

-p, --profile струна

Имя профиля в ~/.databrickscfg файле, используемого для выполнения команды. Если этот флаг не указан, при наличии используется профиль с именем DEFAULT.

--progress-format формат

Формат для отображения журналов хода выполнения: default, appendinplace, илиjson

-t, --target струна

Если применимо, целевой объект пакета для использования

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2026-02-07

Поделиться через

postgres группа команд

databricks postgres create-branch

Arguments

Options

Примеры

databricks postgres create-endpoint

Arguments

Options

Примеры

databricks postgres create-project

Arguments

Options

Примеры

databricks postgres delete-branch

Arguments

Options

Примеры

databricks postgres delete-endpoint

Arguments

Options

Примеры

databricks postgres delete-project

Arguments

Options

Примеры

databricks postgres generate-database-credential

Arguments

Options

Примеры

databricks postgres get-branch

Arguments

Options

Примеры

databricks postgres get-endpoint

Arguments

Options

Примеры

databricks postgres get-operation

Arguments

Options

Примеры

databricks postgres get-project

Arguments

Options

Примеры

databricks postgres list-branches

Arguments

Options

Примеры

databricks postgres list-endpoints

Arguments

Options

Примеры

databricks postgres list-projects

Options

Примеры

databricks postgres update-branch

Arguments

Options

Примеры

databricks postgres update-endpoint

Arguments

Options

Примеры

databricks postgres update-project

Arguments

Options

Примеры

Глобальные флаги

Обратная связь

Дополнительные ресурсы

`postgres` группа команд