Condividi tramite

postgres gruppo di comandi

Annotazioni

Queste informazioni si applicano all'interfaccia della riga di comando di Databricks 0.285 e versioni successive. L'interfaccia della riga di comando di Databricks è disponibile in anteprima pubblica.

L'uso della CLI di Databricks è soggetto alla Licenza di Databricks e all'Informativa sulla privacy di Databricks, incluse eventuali disposizioni sui dati di utilizzo.

Il postgres gruppo di comandi all'interno dell'interfaccia della riga di comando di Databricks contiene i comandi per gestire le risorse di Lakebase Postgres, inclusi progetti, rami ed endpoint. L'API Postgres consente l'accesso a un database Postgres tramite l'API REST o SQL diretto.

databricks postgres create-branch

Creare un ramo. Quando si crea un ramo, è necessario specificare un criterio di scadenza usando no_expiry: true per i rami permanenti.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

databricks postgres create-branch PARENT BRANCH_ID [flags]

Arguments

PARENT

    Progetto in cui viene creato questo ramo. Formato: projects/{project_id}

BRANCH_ID

    ID da usare per branch, che diventa il componente finale del nome della risorsa del ramo. Deve avere una lunghezza di 1-63 caratteri, iniziare con una lettera minuscola e contenere solo lettere minuscole, numeri e trattini (RFC 1123).

Options

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

--name string

    Nome della risorsa del ramo.

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

L'esempio seguente crea un ramo in un progetto:

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

Nell'esempio seguente viene creato un ramo da un ramo esistente:

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

Creare un endpoint. Un ramo può avere un endpoint di calcolo di lettura/scrittura e più endpoint di sola lettura (repliche in lettura) per il ridimensionamento delle operazioni di lettura.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]

Arguments

PARENT

    Ramo in cui viene creato questo endpoint. Formato: projects/{project_id}/branches/{branch_id}

ENDPOINT_ID

    ID da usare per l'endpoint, che diventa il componente finale del nome della risorsa dell'endpoint. Deve avere una lunghezza di 1-63 caratteri, iniziare con una lettera minuscola e contenere solo lettere minuscole, numeri e trattini (RFC 1123).

Options

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

--name string

    Nome della risorsa dell'endpoint.

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

L'esempio seguente crea un endpoint di lettura/scrittura in un ramo:

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

L'esempio seguente crea un endpoint di sola lettura (replica di lettura):

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

Creare un progetto.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

Quando si crea un progetto, include automaticamente un ramo di produzione predefinito e un endpoint di calcolo di lettura/scrittura, entrambi con ID generati automaticamente.

databricks postgres create-project PROJECT_ID [flags]

Arguments

PROJECT_ID

    ID da usare per Project, che diventa il componente finale del nome della risorsa del progetto. Deve avere una lunghezza di 1-63 caratteri, iniziare con una lettera minuscola e contenere solo lettere minuscole, numeri e trattini (RFC 1123).

Options

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

--name string

    Nome della risorsa del progetto.

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

L'esempio seguente crea un progetto:

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

L'esempio seguente crea un progetto con una versione specifica di PostgreSQL:

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

databricks postgres delete-branch

Eliminare un ramo.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

I rami protetti non possono essere eliminati. Utilizzare update-branch per impostare su falsespec.is_protected prima dell'eliminazione.

databricks postgres delete-branch NAME [flags]

Arguments

NAME

    Nome del ramo da eliminare. Formato: projects/{project_id}/branches/{branch_id}

Options

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

Nell'esempio seguente viene eliminato un ramo:

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

databricks postgres delete-endpoint

Eliminare un endpoint.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

databricks postgres delete-endpoint NAME [flags]

Arguments

NAME

    Nome dell'endpoint da eliminare. Formato: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

Nell'esempio seguente viene eliminato un endpoint:

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

databricks postgres delete-project

Eliminare un progetto.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

databricks postgres delete-project NAME [flags]

Arguments

NAME

    Nome del progetto da eliminare. Formato: projects/{project_id}

Options

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

Nell'esempio seguente viene eliminato un progetto:

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

databricks postgres generate-database-credential

Generare le credenziali OAuth per un database Postgres. Il token OAuth restituito viene usato per autenticare e connettersi al database con client PostgreSQL come psql.

databricks postgres generate-database-credential ENDPOINT [flags]

Arguments

ENDPOINT

    Endpoint per il quale vengono generate queste credenziali. Formato: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

Flag globali

Esempi

L'esempio seguente genera le credenziali OAuth per un endpoint:

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

databricks postgres get-branch

Ottenere un ramo.

databricks postgres get-branch NAME [flags]

Arguments

NAME

    Nome del ramo da recuperare. Formato: projects/{project_id}/branches/{branch_id}

Options

Flag globali

Esempi

Nell'esempio seguente vengono recuperate informazioni su un ramo:

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

databricks postgres get-endpoint

Ottenere un endpoint.

databricks postgres get-endpoint NAME [flags]

Arguments

NAME

    Nome dell'endpoint da recuperare. Formato: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

Flag globali

Esempi

L'esempio seguente ottiene informazioni su un endpoint:

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

operazione get-operation di databricks postgres

Ottenere un'operazione.

databricks postgres get-operation NAME [flags]

Arguments

NAME

    Nome della risorsa dell'operazione.

Options

Flag globali

Esempi

Nell'esempio seguente vengono recuperate informazioni su un'operazione:

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

databricks postgres get-project

Ottenere un progetto.

databricks postgres get-project NAME [flags]

Arguments

NAME

    Nome del progetto da recuperare. Formato: projects/{project_id}

Options

Flag globali

Esempi

L'esempio seguente ottiene informazioni su un progetto:

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

databricks postgres list-branch

Elencare i rami. Usare questo comando per trovare gli ID dei rami, incluso il ramo predefinito creato con il progetto (indicato dallo "default": true stato).

databricks postgres list-branches PARENT [flags]

Arguments

PARENT

    Oggetto Project proprietario di questa raccolta di rami. Formato: projects/{project_id}

Options

--page-size int

    Limite superiore per gli elementi restituiti.

--page-token string

    Token di pagina da una risposta precedente.

Flag globali

Esempi

Nell'esempio seguente sono elencati tutti i rami di un progetto:

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

L'esempio seguente elenca i rami con paginazione:

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

databricks postgres list-endpoints

Elencare gli endpoint. Usare questo comando per trovare gli ID endpoint, incluso l'endpoint di lettura/scrittura predefinito creato automaticamente con il progetto.

databricks postgres list-endpoints PARENT [flags]

Arguments

PARENT

    Branch proprietario di questa raccolta di endpoint. Formato: projects/{project_id}/branches/{branch_id}

Options

--page-size int

    Limite superiore per gli elementi restituiti.

--page-token string

    Token di pagina da una risposta precedente.

Flag globali

Esempi

L'esempio seguente elenca tutti gli endpoint in un ramo:

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

L'esempio seguente elenca gli endpoint con paginazione:

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

databricks postgres list-projects

Elenca progetti.

databricks postgres list-projects [flags]

Options

--page-size int

    Limite superiore per gli elementi restituiti.

--page-token string

    Token di pagina da una risposta precedente.

Flag globali

Esempi

L'esempio seguente elenca tutti i progetti:

databricks postgres list-projects

L'esempio seguente elenca i progetti con paginazione:

databricks postgres list-projects --page-size 10

databricks postgres update-branch

Aggiornare un ramo.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

databricks postgres update-branch NAME UPDATE_MASK [flags]

Arguments

NAME

    Nome della risorsa del ramo. Formato: projects/{project_id}/branches/{branch_id}

UPDATE_MASK

    Elenco di campi da aggiornare. Se non specificato, tutti i campi vengono aggiornati quando possibile.

Options

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

--name string

    Nome della risorsa del ramo.

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

L'esempio seguente aggiorna un ramo per renderlo protetto:

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

databricks postgres update-endpoint

Aggiornare un endpoint.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

databricks postgres update-endpoint NAME UPDATE_MASK [flags]

Arguments

NAME

    Nome della risorsa dell'endpoint. Formato: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

UPDATE_MASK

    Elenco di campi da aggiornare. Se non specificato, tutti i campi vengono aggiornati quando possibile.

Options

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

--name string

    Nome della risorsa dell'endpoint.

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

L'esempio seguente aggiorna le unità di calcolo massime di un 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
    }
  }'

L'esempio seguente aggiorna più campi (min e max compute units):

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

Aggiornare un progetto.

Annotazioni

Si tratta di un'operazione a esecuzione prolungata. Per impostazione predefinita, il comando attende il completamento dell'operazione. Usare --no-wait per restituire immediatamente con i dettagli dell'operazione non elaborata. Il campo dell'operazione name può quindi essere usato per eseguire il polling per il completamento usando il get-operation comando .

databricks postgres update-project NAME UPDATE_MASK [flags]

Arguments

NAME

    Nome della risorsa del progetto. Formato: projects/{project_id}

UPDATE_MASK

    Elenco di campi da aggiornare. Se non specificato, tutti i campi vengono aggiornati quando possibile.

Options

--json JSON

    La stringa JSON inline o il @path nel file JSON che contiene il corpo della richiesta.

--name string

    Nome della risorsa del progetto.

--no-wait

    Non aspettare di raggiungere lo stato DONE.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato DONE.

Flag globali

Esempi

Nell'esempio seguente viene aggiornato il nome visualizzato di un progetto:

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

Bandiere globali

--debug

  Indica se abilitare la registrazione di debug.

-h oppure --help

    Mostra la guida per il Databricks CLI, il gruppo di comandi correlato o il comando correlato.

--log-file stringa

    Stringa che rappresenta il file in cui scrivere i log di output. Se questo flag non viene specificato, l'impostazione predefinita prevede la scrittura dei log di output su stderr.

--log-format formato

    Tipo di formato del log, text o json. Il valore predefinito è text.

--log-level stringa

    Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.

tipo

    Tipo di output del comando, text o json. Il valore predefinito è text.

-p, --profile stringa

    Nome del profilo nel ~/.databrickscfg file da usare per eseguire il comando . Se questo flag non viene specificato, se esiste, viene usato il profilo denominato DEFAULT .

--progress-format formato

    Formato per visualizzare i log di stato: default, append, inplaceo json

-t, --target stringa

    Se applicabile, la destinazione del bundle da utilizzare

  • Last updated on