postgres grupo de comandos
Esta informação se aplica às versões 0.285 e acima CLI Databricks . A CLI do Databricks está em versão prévia pública.
O uso CLI Databricks está sujeito à LicençaDatabricks e ao Aviso de PrivacidadeDatabricks, incluindo qualquer fornecimento de Dados de Uso.
O grupo de comandos postgres dentro da CLIDatabricks contém comandos para gerenciar recursos do Lakebase Postgres, incluindo projetos, branches e endpoints. A API do Postgres fornece acesso a um banco de dados Postgres via API REST ou SQL direto.
databricks postgres criar-ramificação
Criar uma ramificação.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres create-branch PARENT BRANCH_ID [flags]
Argumentos
PARENT
O projeto no qual esta ramificação foi criada. Formatar: projects/{project_id}
BRANCH_ID
O ID a ser usado para a ramificação, que se torna o componente final do nome do recurso da ramificação. Deve ter entre 1 e 63 caracteres, começar com uma letra minúscula e conter apenas letras minúsculas, números e hífenes (RFC 1123).
Opções
--json JSON
As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.
--name string
O nome do recurso da ramificação.
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir cria uma ramificação em um projeto:
databricks postgres create-branch projects/my-project-id my-branch \
--json '{
"spec": {
"no_expiry": true
}
}'
O exemplo a seguir cria uma ramificação a partir de uma ramificação existente:
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 criar-endpoint
Criar um ponto de extremidade.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]
Argumentos
PARENT
A ramificação onde este endpoint foi criado. Formatar: projects/{project_id}/branches/{branch_id}
ENDPOINT_ID
O ID a ser usado para o endpoint, que se torna o componente final do nome do recurso do endpoint. Deve ter entre 1 e 63 caracteres, começar com uma letra minúscula e conter apenas letras minúsculas, números e hífenes (RFC 1123).
Opções
--json JSON
As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.
--name string
O nome do recurso do endpoint.
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir cria um endpoint de leitura e gravação em uma ramificação:
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
}
}'
O exemplo a seguir cria um endpoint somente leitura (réplica de leitura):
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 criar-projeto
Criar um projeto.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres create-project PROJECT_ID [flags]
Argumentos
PROJECT_ID
O ID a ser usado para o projeto, que se torna o componente final do nome do recurso do projeto. Deve ter entre 1 e 63 caracteres, começar com uma letra minúscula e conter apenas letras minúsculas, números e hífenes (RFC 1123).
Opções
--json JSON
As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.
--name string
O nome do recurso do projeto.
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir cria um projeto:
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project"
}
}'
O exemplo a seguir cria um projeto com uma versão específica do PostgreSQL:
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project",
"pg_version": "17"
}
}'
databricks postgres excluir-ramo
Excluir uma ramificação.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres delete-branch NAME [flags]
Argumentos
NAME
Nome da filial a ser excluída. Formatar: projects/{project_id}/branches/{branch_id}
Opções
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir exclui um ramo:
databricks postgres delete-branch projects/my-project-id/branches/my-branch-id
endpoint de exclusão do PostgreSQL do Databricks
Excluir um ponto de extremidade.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres delete-endpoint NAME [flags]
Argumentos
NAME
O nome do endpoint a ser excluído. Formatar: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Opções
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir exclui um endpoint:
databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres excluir-projeto
Excluir um projeto.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres delete-project NAME [flags]
Argumentos
NAME
Nome do projeto a ser excluído. Formatar: projects/{project_id}
Opções
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir exclui um projeto:
databricks postgres delete-project projects/my-project-id
databricks postgres gerar-credencial-de-banco-de-dados
Gere credenciais OAuth para um banco de dados Postgres.
databricks postgres generate-database-credential ENDPOINT [flags]
Argumentos
ENDPOINT
O endpoint para o qual esta credencial foi gerada. Formatar: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Opções
--json JSON
As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.
Exemplos
O exemplo a seguir gera credenciais OAuth para um endpoint:
databricks postgres generate-database-credential projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres obter-ramificação
Consiga uma filial.
databricks postgres get-branch NAME [flags]
Argumentos
NAME
O nome da filial a ser recuperada. Formatar: projects/{project_id}/branches/{branch_id}
Opções
Exemplos
O exemplo a seguir obtém informações sobre uma filial:
databricks postgres get-branch projects/my-project-id/branches/my-branch-id
databricks postgres obter-endpoint
Obtenha um ponto final.
databricks postgres get-endpoint NAME [flags]
Argumentos
NAME
O nome do endpoint a ser recuperado. Formatar: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Opções
Exemplos
O exemplo a seguir obtém informações sobre um endpoint:
databricks postgres get-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres get-operações
Faça uma cirurgia.
databricks postgres get-operation NAME [flags]
Argumentos
NAME
O nome do recurso de operações.
Opções
Exemplos
O exemplo a seguir obtém informações sobre uma operação:
databricks postgres get-operation projects/my-project-id/operations/my-operation-id
databricks postgres obter-projeto
Obtenha um projeto.
databricks postgres get-project NAME [flags]
Argumentos
NAME
O nome do projeto a ser recuperado. Formatar: projects/{project_id}
Opções
Exemplos
O exemplo a seguir obtém informações sobre um projeto:
databricks postgres get-project projects/my-project-id
listar ramificações do PostgreSQL
Listar filiais.
databricks postgres list-branches PARENT [flags]
Argumentos
PARENT
O projeto que detém essa coleção de filiais. Formatar: projects/{project_id}
Opções
--page-size int
Limite máximo para itens devolvidos.
--page-token string
Tokens da página de uma resposta anterior.
Exemplos
O exemplo a seguir lista todas as ramificações de um projeto:
databricks postgres list-branches projects/my-project-id
O exemplo a seguir lista filiais com paginação:
databricks postgres list-branches projects/my-project-id --page-size 10
endpoint de lista do PostgreSQL do Databricks
Listar endpoints.
databricks postgres list-endpoints PARENT [flags]
Argumentos
PARENT
A filial que detém essa coleção de endpoints. Formatar: projects/{project_id}/branches/{branch_id}
Opções
--page-size int
Limite máximo para itens devolvidos.
--page-token string
Tokens da página de uma resposta anterior.
Exemplos
O exemplo a seguir lista todos os endpoints em uma ramificação:
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id
O exemplo a seguir lista os endpoints com paginação:
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id --page-size 10
listar projetos do databricks postgres
Lista de projetos.
databricks postgres list-projects [flags]
Opções
--page-size int
Limite máximo para itens devolvidos.
--page-token string
Tokens da página de uma resposta anterior.
Exemplos
O exemplo a seguir lista todos os projetos:
databricks postgres list-projects
O exemplo a seguir lista projetos com paginação:
databricks postgres list-projects --page-size 10
databricks postgres atualização-branch
Atualizar uma ramificação.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres update-branch NAME UPDATE_MASK [flags]
Argumentos
NAME
O nome do recurso da ramificação. Formatar: projects/{project_id}/branches/{branch_id}
UPDATE_MASK
Lista de campos a serem atualizados. Caso não seja especificado, todos os campos serão atualizados assim que possível.
Opções
--json JSON
As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.
--name string
O nome do recurso da ramificação.
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir atualiza uma ramificação para torná-la protegida:
databricks postgres update-branch projects/my-project-id/branches/my-branch-id spec.is_protected \
--json '{
"spec": {
"is_protected": true
}
}'
endpoint de atualização do PostgreSQL do Databricks
Atualizar um endpoint.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres update-endpoint NAME UPDATE_MASK [flags]
Argumentos
NAME
O nome do recurso do endpoint. Formatar: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
UPDATE_MASK
Lista de campos a serem atualizados. Caso não seja especificado, todos os campos serão atualizados assim que possível.
Opções
--json JSON
As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.
--name string
O nome do recurso do endpoint.
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir atualiza as unidades compute máximas de um endpoint:
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
}
}'
O exemplo a seguir atualiza vários campos (unidades compute mínimas e máximas):
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
}
}'
projeto de atualização do PostgreSQL do Databricks
Atualizar um projeto.
Esta é uma operação de longa duração. Por default, o comando aguarda a conclusão das operações. Use --no-wait para retornar imediatamente com os detalhes brutos das operações. O campo name das operações pode então ser usado para verificar a conclusão usando o comando get-operation .
databricks postgres update-project NAME UPDATE_MASK [flags]
Argumentos
NAME
O nome do recurso do projeto. Formatar: projects/{project_id}
UPDATE_MASK
Lista de campos a serem atualizados. Caso não seja especificado, todos os campos serão atualizados assim que possível.
Opções
--json JSON
As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.
--name string
O nome do recurso do projeto.
--no-wait
Não espere até atingir o estado CONCLUÍDO.
--timeout duration
Tempo máximo necessário para atingir o estado CONCLUÍDO.
Exemplos
O exemplo a seguir atualiza o nome de exibição de um projeto:
databricks postgres update-project projects/my-project-id spec.display_name \
--json '{
"spec": {
"display_name": "Updated Project Name"
}
}'
Bandeiras globais
--debug
Ativar ou não o registro de depuração.
-h ou --help
Exibir ajuda para a CLI Databricks , o grupo de comandos relacionado ou o comando específico.
--log-file string
Uma sequência de caracteres representando o arquivo no qual logs de saída serão gravados. Se essa opção não for especificada, o default é gravar logs de saída em stderr.
--log-format Formato
O tipo de formato de log, text ou json. O valor default é text.
--log-level string
Uma sequência de caracteres representando o nível de formato log . Caso não seja especificado, o nível de formato log será desativado.
-o, --output Tipo
O tipo de saída do comando, text ou json. O valor default é text.
-p, --profile string
O nome do perfil no arquivo ~/.databrickscfg a ser usado para executar o comando. Se este sinalizador não for especificado, então, se existir, o perfil denominado DEFAULT será usado.
--progress-format Formato
O formato para exibir logs de progresso é: default, append, inplace ou json
-t, --target string
Se aplicável, o pacote de destino a ser usado.