Compartir a través de

Grupo de comandos postgres

Nota:

Esta información se aplica a las versiones 0.285 y posteriores de la CLI de Databricks. La CLI de Databricks está en versión preliminar pública.

El uso de la CLI de Databricks está sujeto a la licencia de Databricks y al aviso de privacidad de Databricks, incluidas las disposiciones de datos de uso.

El postgres grupo de comandos de la CLI de Databricks contiene comandos para administrar recursos de Lakebase Postgres, incluidos proyectos, ramas y puntos de conexión. La API de Postgres proporciona acceso a una base de datos de Postgres a través de la API REST o SQL directo.

databricks postgres create-branch

Cree una rama. Al crear una rama, debe especificar una directiva de expiración mediante no_expiry: true para ramas permanentes.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

databricks postgres create-branch PARENT BRANCH_ID [flags]

Arguments

PARENT

    Proyecto donde se crea esta rama. Formato: projects/{project_id}

BRANCH_ID

    Identificador que se va a usar para la rama, que se convierte en el componente final del nombre de recurso de la rama. Debe tener entre 1 y 63 caracteres, empezar con una letra minúscula y contener solo letras minúsculas, números y guiones (RFC 1123).

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--name string

    Nombre del recurso de la rama.

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se crea una rama en un proyecto:

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

En el ejemplo siguiente se crea una rama a partir de una rama 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 create-endpoint

Cree un punto de conexión. Una rama puede tener un punto de conexión de proceso de lectura y escritura y varios puntos de conexión de solo lectura (réplicas de lectura) para escalar las operaciones de lectura.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]

Arguments

PARENT

    Rama donde se crea este punto de conexión. Formato: projects/{project_id}/branches/{branch_id}

ENDPOINT_ID

    Identificador que se va a usar para el punto de conexión, que se convierte en el componente final del nombre de recurso del punto de conexión. Debe tener entre 1 y 63 caracteres, empezar con una letra minúscula y contener solo letras minúsculas, números y guiones (RFC 1123).

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--name string

    Nombre del recurso del punto de conexión.

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se crea un punto de conexión de lectura y escritura en una rama:

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
    }
  }'

En el ejemplo siguiente se crea un punto de conexión de solo lectura (réplica de lectura):

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

Cree un proyecto.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

Al crear un proyecto, incluye automáticamente una rama de producción predeterminada y un punto de conexión de proceso de lectura y escritura, ambos con identificadores generados automáticamente.

databricks postgres create-project PROJECT_ID [flags]

Arguments

PROJECT_ID

    Identificador que se va a usar para el proyecto, que se convierte en el componente final del nombre de recurso del proyecto. Debe tener entre 1 y 63 caracteres, empezar con una letra minúscula y contener solo letras minúsculas, números y guiones (RFC 1123).

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--name string

    Nombre del recurso del proyecto.

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se crea un proyecto:

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

En el ejemplo siguiente se crea un proyecto con una versión específica de PostgreSQL:

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

databricks postgres delete-branch

Eliminar una rama.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

No se pueden eliminar ramas protegidas. Use update-branch para establecer spec.is_protected en false antes de eliminar.

databricks postgres delete-branch NAME [flags]

Arguments

NAME

    Nombre de la rama que se va a eliminar. Formato: projects/{project_id}/branches/{branch_id}

Options

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se elimina una rama:

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

databricks postgres delete-endpoint

Elimine un punto de conexión.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

databricks postgres delete-endpoint NAME [flags]

Arguments

NAME

    Nombre del punto de conexión que se va a eliminar. Formato: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se elimina un punto de conexión:

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

databricks postgres delete-project

Eliminar un proyecto.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

databricks postgres delete-project NAME [flags]

Arguments

NAME

    Nombre del proyecto que se va a eliminar. Formato: projects/{project_id}

Options

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se elimina un proyecto:

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

databricks postgres generate-database-credential

Genere credenciales de OAuth para una base de datos de Postgres. El token de OAuth devuelto se usa para autenticar y conectarse a la base de datos con clientes de PostgreSQL como psql.

databricks postgres generate-database-credential ENDPOINT [flags]

Arguments

ENDPOINT

    Punto de conexión para el que se genera esta credencial. Formato: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

Marcas globales

Examples

En el ejemplo siguiente se generan credenciales de OAuth para un punto de conexión:

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

databricks postgres get-branch

Obtener una rama.

databricks postgres get-branch NAME [flags]

Arguments

NAME

    Nombre de la rama que se va a recuperar. Formato: projects/{project_id}/branches/{branch_id}

Options

Marcas globales

Examples

En el ejemplo siguiente se obtiene información sobre una rama:

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

databricks postgres get-endpoint

Obtener un punto de conexión.

databricks postgres get-endpoint NAME [flags]

Arguments

NAME

    Nombre del punto de conexión que se va a recuperar. Formato: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

Marcas globales

Examples

En el ejemplo siguiente se obtiene información sobre un punto de conexión:

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

databricks postgres get-operation

Obtener una operación.

databricks postgres get-operation NAME [flags]

Arguments

NAME

    Nombre del recurso de operación.

Options

Marcas globales

Examples

En el ejemplo siguiente se obtiene información sobre una operación:

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

databricks postgres get-project

Obtener un proyecto.

databricks postgres get-project NAME [flags]

Arguments

NAME

    Nombre del proyecto que se va a recuperar. Formato: projects/{project_id}

Options

Marcas globales

Examples

En el ejemplo siguiente se obtiene información sobre un proyecto:

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

databricks postgres list-branches

Enumerar ramas. Use este comando para buscar identificadores de rama, incluida la rama predeterminada creada con el proyecto (indicado por "default": true en el estado).

databricks postgres list-branches PARENT [flags]

Arguments

PARENT

    Project que posee esta colección de ramas. Formato: projects/{project_id}

Options

--page-size int

    Límite superior para los elementos devueltos.

--page-token string

    Token de página de una respuesta anterior.

Marcas globales

Examples

En el ejemplo siguiente se enumeran todas las ramas de un proyecto:

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

En el ejemplo siguiente se enumeran las ramas con paginación:

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

databricks postgres list-endpoints

Enumerar puntos de conexión. Use este comando para buscar identificadores de punto de conexión, incluido el punto de conexión de lectura y escritura predeterminado creado automáticamente con el proyecto.

databricks postgres list-endpoints PARENT [flags]

Arguments

PARENT

    Rama propietaria de esta colección de puntos de conexión. Formato: projects/{project_id}/branches/{branch_id}

Options

--page-size int

    Límite superior para los elementos devueltos.

--page-token string

    Token de página de una respuesta anterior.

Marcas globales

Examples

En el ejemplo siguiente se enumeran todos los puntos de conexión de una rama:

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

En el ejemplo siguiente se enumeran los puntos de conexión con paginación:

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

databricks postgres list-projects

Enumera los proyectos.

databricks postgres list-projects [flags]

Options

--page-size int

    Límite superior para los elementos devueltos.

--page-token string

    Token de página de una respuesta anterior.

Marcas globales

Examples

En el ejemplo siguiente se enumeran todos los proyectos:

databricks postgres list-projects

En el ejemplo siguiente se enumeran los proyectos con paginación:

databricks postgres list-projects --page-size 10

databricks postgres update-branch

Actualizar una rama.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

databricks postgres update-branch NAME UPDATE_MASK [flags]

Arguments

NAME

    Nombre del recurso de la rama. Formato: projects/{project_id}/branches/{branch_id}

UPDATE_MASK

    Lista de campos que se van a actualizar. Si no se especifica, todos los campos se actualizan siempre que sea posible.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--name string

    Nombre del recurso de la rama.

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se actualiza una rama para que esté protegida:

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

databricks postgres update-endpoint

Actualice un punto de conexión.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

databricks postgres update-endpoint NAME UPDATE_MASK [flags]

Arguments

NAME

    Nombre del recurso del punto de conexión. Formato: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

UPDATE_MASK

    Lista de campos que se van a actualizar. Si no se especifica, todos los campos se actualizan siempre que sea posible.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--name string

    Nombre del recurso del punto de conexión.

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se actualizan las unidades de proceso máximas de un punto de conexión:

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
    }
  }'

En el ejemplo siguiente se actualizan varios campos (unidades de proceso mínimas y 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
    }
  }'

databricks postgres update-project

Actualizar un proyecto.

Nota:

Se trata de una operación de larga duración. De forma predeterminada, el comando espera a que se complete la operación. Use --no-wait para devolver inmediatamente con los detalles de la operación sin procesar. Después, el campo de la name operación se puede usar para sondear la finalización mediante el get-operation comando .

databricks postgres update-project NAME UPDATE_MASK [flags]

Arguments

NAME

    Nombre del recurso del proyecto. Formato: projects/{project_id}

UPDATE_MASK

    Lista de campos que se van a actualizar. Si no se especifica, todos los campos se actualizan siempre que sea posible.

Options

--json JSON

    La cadena JSON en línea o el archivo JSON @path con el cuerpo de la solicitud.

--name string

    Nombre del recurso del proyecto.

--no-wait

    No esperes a alcanzar el estado DONE.

--timeout duration

    Cantidad máxima de tiempo para alcanzar el estado DONE.

Marcas globales

Examples

En el ejemplo siguiente se actualiza el nombre para mostrar de un proyecto:

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

Marcas globales

--debug

  Indica si se va a habilitar el registro de depuración.

-h o --help

    Mostrar ayuda para la CLI de Databricks o el grupo de comandos relacionado o el comando relacionado.

--log-file cadena

    Cadena que representa el archivo en el que se van a escribir registros de salida. Si no se especifica esta marca, el valor predeterminado es escribir registros de salida en stderr.

--log-format formato

    Tipo de formato de registro: text o json. El valor predeterminado es text.

--log-level cadena

    Cadena que representa el nivel de formato de registro. Si no se especifica, el nivel de formato de registro está deshabilitado.

-o, --output tipo

    Tipo de salida del comando, text o json. El valor predeterminado es text.

-p, --profile cadena

    Nombre del perfil en el archivo ~/.databrickscfg que se usará para ejecutar el comando. Si no se especifica esta marca, si existe, se usa el perfil denominado DEFAULT .

--progress-format formato

    Formato para mostrar los registros de progreso: default, append, inplaceo json

-t, --target cadena

    Si procede, el destino del paquete que se va a usar

  • Last updated on