postgres kommandogrupp

Anmärkning

Den här informationen gäller för Databricks CLI-versionerna 0.285 och senare. Databricks CLI finns i offentlig förhandsversion.

Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.

Kommandogruppen postgres i Databricks CLI innehåller kommandon för att hantera Lakebase Postgres-resurser, inklusive projekt, grenar och slutpunkter. Postgres-API:et ger åtkomst till en Postgres-databas via REST API eller direkt SQL.

databricks postgres create-branch

Skapa en gren. När du skapar en gren måste du ange en förfalloprincip som använder no_expiry: true för permanenta grenar.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres create-branch PARENT BRANCH_ID [flags]

Arguments

PARENT

    Projektet där den här grenen skapas. Format: projects/{project_id}

BRANCH_ID

    Det ID som ska användas för grenen, som blir den sista komponenten i grenens resursnamn. Måste vara 1–63 tecken långt, börja med en gemen bokstav och endast innehålla gemener, siffror och bindestreck (RFC 1123).

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--name string

    Resursnamnet för grenen.

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel skapas en gren i ett projekt:

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

I följande exempel skapas en gren från en befintlig gren:

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

Skapa en slutpunkt. En gren kan ha en slutpunkt för skrivskyddad beräkning och flera skrivskyddade slutpunkter (skrivskyddade repliker) för skalning av läsåtgärder.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]

Arguments

PARENT

    Grenen där den här slutpunkten skapas. Format: projects/{project_id}/branches/{branch_id}

ENDPOINT_ID

    Det ID som ska användas för slutpunkten, som blir den sista komponenten i slutpunktens resursnamn. Måste vara 1–63 tecken långt, börja med en gemen bokstav och endast innehålla gemener, siffror och bindestreck (RFC 1123).

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--name string

    Slutpunktens resursnamn.

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel skapas en skrivskyddad slutpunkt i en gren:

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

I följande exempel skapas en skrivskyddad slutpunkt (skrivskyddad replik):

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

Skapa ett projekt.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

När du skapar ett projekt innehåller det automatiskt en standardproduktionsgren och en slutpunkt för skrivskyddad beräkning, båda med automatiskt genererade ID:t.

databricks postgres create-project PROJECT_ID [flags]

Arguments

PROJECT_ID

    Det ID som ska användas för projektet, som blir den sista komponenten i projektets resursnamn. Måste vara 1–63 tecken långt, börja med en gemen bokstav och endast innehålla gemener, siffror och bindestreck (RFC 1123).

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--name string

    Projektets resursnamn.

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel skapas ett projekt:

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

I följande exempel skapas ett projekt med en specifik PostgreSQL-version:

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

databricks postgres create-role

Skapa en Postgres-roll för en gren.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres create-role PARENT [flags]

Arguments

PARENT

    Grenen där den här rollen skapas. Format: projects/{project_id}/branches/{branch_id}.

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--name string

    Resursnamnet för rollen (endast utdata).

--no-wait

    Vänta inte med att nå DONE-tillståndet.

--role-id string

    Det ID som ska användas för rollen, som blir den sista komponenten i rollens resursnamn.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel skapas en lösenordsbaserad roll i en gren:

databricks postgres create-role projects/my-project-id/branches/my-branch-id \
  --role-id my-role \
  --json '{"spec": {"postgres_role": "my-role"}}'

I följande exempel skapas en OAuth-roll för en Databricks-användare:

databricks postgres create-role projects/my-project-id/branches/my-branch-id \
  --role-id my-user-role \
  --json '{"spec": {"identity_type": "USER", "postgres_role": "user@example.com"}}'

databricks postgres delete-branch

Ta bort en gren.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

Det går inte att ta bort skyddade grenar. Använd update-branch för att ange spec.is_protected till false innan du tar bort.

databricks postgres delete-branch NAME [flags]

Arguments

NAME

    Namnet på den gren som ska tas bort. Format: projects/{project_id}/branches/{branch_id}

Options

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel tas en gren bort:

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

databricks postgres delete-endpoint

Ta bort en slutpunkt.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres delete-endpoint NAME [flags]

Arguments

NAME

    Namnet på den slutpunkt som ska tas bort. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel tas en slutpunkt bort:

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

databricks postgres delete-project

Ta bort ett projekt.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres delete-project NAME [flags]

Arguments

NAME

    Namnet på projektet som ska tas bort. Format: projects/{project_id}

Options

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel tas ett projekt bort:

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

databricks postgres delete-role

Ta bort en Postgres-roll från en gren.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres delete-role NAME [flags]

Arguments

NAME

    Den fullständiga resurssökvägen för rollen som ska tas bort. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}.

Options

--no-wait

    Vänta inte med att nå DONE-tillståndet.

--reassign-owned-to string

    Tilldela om objekt som ägs av den borttagna rollen till den här rollen.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel tas en roll bort från en gren:

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

databricks postgres generate-database-credential

Generera OAuth-autentiseringsuppgifter för en Postgres-databas. Den returnerade OAuth-token används för att autentisera och ansluta till databasen med PostgreSQL-klienter som psql.

databricks postgres generate-database-credential ENDPOINT [flags]

Arguments

ENDPOINT

    Slutpunkten som den här autentiseringsuppgiften genereras för. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

Globala flaggor

Examples

I följande exempel genereras OAuth-autentiseringsuppgifter för en slutpunkt:

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

databricks postgres get-branch

Hämta en gren.

databricks postgres get-branch NAME [flags]

Arguments

NAME

    Namnet på den gren som ska hämtas. Format: projects/{project_id}/branches/{branch_id}

Options

Globala flaggor

Examples

I följande exempel hämtas information om en gren:

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

databricks postgres get-endpoint

Hämta en slutpunkt.

databricks postgres get-endpoint NAME [flags]

Arguments

NAME

    Namnet på den slutpunkt som ska hämtas. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

Globala flaggor

Examples

I följande exempel hämtas information om en slutpunkt:

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

databricks postgres get-operation

Hämta en åtgärd.

databricks postgres get-operation NAME [flags]

Arguments

NAME

    Namnet på åtgärdsresursen.

Options

Globala flaggor

Examples

I följande exempel hämtas information om en åtgärd:

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

databricks postgres get-project

Hämta ett projekt.

databricks postgres get-project NAME [flags]

Arguments

NAME

    Namnet på projektet som ska hämtas. Format: projects/{project_id}

Options

Globala flaggor

Examples

I följande exempel hämtas information om ett projekt:

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

databricks postgres get-role

Hämta en Postgres-roll för en gren. Hämtar information om den angivna rollen, inklusive dess autentiseringsmetod och behörigheter.

databricks postgres get-role NAME [flags]

Arguments

NAME

    Den fullständiga resurssökvägen för rollen som ska hämtas. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}.

Options

Globala flaggor

Examples

Följande exempel hämtar en roll:

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

databricks postgres list-branchs

Visa en lista över grenar. Använd det här kommandot för att hitta gren-ID:er, inklusive standardgrenen som skapats med projektet (anges med "default": true status).

databricks postgres list-branches PARENT [flags]

Arguments

PARENT

    Projektet som äger den här samlingen med grenar. Format: projects/{project_id}

Options

--page-size int

    Övre gräns för returnerade objekt.

--page-token string

    Sidtoken från ett tidigare svar.

Globala flaggor

Examples

I följande exempel visas alla grenar i ett projekt:

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

I följande exempel visas grenar med sidnumrering:

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

databricks postgres list-endpoints

Lista slutpunkter. Använd det här kommandot för att hitta slutpunkts-ID:t, inklusive standardslutpunkten för läs-och-skriv som skapas automatiskt med projektet.

databricks postgres list-endpoints PARENT [flags]

Arguments

PARENT

    Grenen som äger den här samlingen med slutpunkter. Format: projects/{project_id}/branches/{branch_id}

Options

--page-size int

    Övre gräns för returnerade objekt.

--page-token string

    Sidtoken från ett tidigare svar.

Globala flaggor

Examples

I följande exempel visas alla slutpunkter i en gren:

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

I följande exempel visas slutpunkter med sidnumrering:

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

databricks postgres list-projects

Lista projekt.

databricks postgres list-projects [flags]

Options

--page-size int

    Övre gräns för returnerade objekt.

--page-token string

    Sidtoken från ett tidigare svar.

Globala flaggor

Examples

I följande exempel visas alla projekt:

databricks postgres list-projects

I följande exempel visas projekt med sidnumrering:

databricks postgres list-projects --page-size 10

databricks postgres list-roles

Lista Postgres-roller för en gren.

databricks postgres list-roles PARENT [flags]

Arguments

PARENT

    Den gren som äger den här samlingen roller. Format: projects/{project_id}/branches/{branch_id}.

Options

--page-size int

    Övre gräns för returnerade objekt.

--page-token string

    Sidtoken från ett tidigare svar.

Globala flaggor

Examples

I följande exempel visas alla roller i en gren:

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

databricks postgres update-branch

Uppdatera en gren.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres update-branch NAME UPDATE_MASK [flags]

Arguments

NAME

    Resursnamnet för grenen. Format: projects/{project_id}/branches/{branch_id}

UPDATE_MASK

    Listan över fält som ska uppdateras. Om det är ospecificerat uppdateras alla fält när det är möjligt.

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--name string

    Resursnamnet för grenen.

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel uppdateras en gren för att skydda den:

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

databricks postgres update-endpoint

Uppdatera en slutpunkt.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres update-endpoint NAME UPDATE_MASK [flags]

Arguments

NAME

    Slutpunktens resursnamn. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

UPDATE_MASK

    Listan över fält som ska uppdateras. Om det är ospecificerat uppdateras alla fält när det är möjligt.

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--name string

    Slutpunktens resursnamn.

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel uppdateras en slutpunkts maximala beräkningsenheter:

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

I följande exempel uppdateras flera fält (min och max beräkningsenheter):

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

Uppdatera ett projekt.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres update-project NAME UPDATE_MASK [flags]

Arguments

NAME

    Projektets resursnamn. Format: projects/{project_id}

UPDATE_MASK

    Listan över fält som ska uppdateras. Om det är ospecificerat uppdateras alla fält när det är möjligt.

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--name string

    Projektets resursnamn.

--no-wait

    Vänta inte med att nå TILLSTÅNDET KLAR.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

I följande exempel uppdateras ett projekts visningsnamn:

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

databricks postgres update-role

Uppdatera en Postgres-roll för en gren.

Anmärkning

Det här är en tidskrävande åtgärd. Som standard väntar kommandot på att åtgärden ska slutföras. Använd --no-wait för att returnera omedelbart med information om rååtgärden. Åtgärdens name fält kan sedan användas för att avsöka efter slutförande med hjälp av get-operation kommandot .

databricks postgres update-role NAME UPDATE_MASK [flags]

Arguments

NAME

    Rollens fullständiga resurssökväg. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}.

UPDATE_MASK

    Listan över fält som ska uppdateras. Om det är ospecificerat uppdateras alla fält när det är möjligt.

Options

--json JSON

    Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.

--name string

    Resursnamnet för rollen (endast utdata).

--no-wait

    Vänta inte med att nå DONE-tillståndet.

--timeout duration

    Maximal tid för att nå DONE-tillstånd.

Globala flaggor

Examples

Följande exempel beviljar CREATEDB till en roll. När du uppdaterar spec.attributesmåste alla tre attributfälten anges:

databricks postgres update-role projects/my-project-id/branches/my-branch-id/roles/my-role \
  spec.attributes \
  --json '{"spec": {"attributes": {"createdb": true, "createrole": false, "bypassrls": false}}}'

I följande exempel läggs en roll till i medlemskapet databricks_superuser :

databricks postgres update-role projects/my-project-id/branches/my-branch-id/roles/my-role \
  spec.membership_roles \
  --json '{"spec": {"membership_roles": ["DATABRICKS_SUPERUSER"]}}'

Globala flaggor

--debug

  Om felsökningsloggning ska aktiveras.

-h eller --help

    Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.

--log-file sträng

    En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.

--log-format Format

    Loggformattypen, text eller json. Standardvärdet är text.

--log-level sträng

    En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.

-o, --output typ

    Kommandots utdatatyp, text eller json. Standardvärdet är text.

-p, --profile sträng

    Namnet på profilen i ~/.databrickscfg-filen som ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.

--progress-format Format

    Formatet för att visa förloppsloggar: default, append, inplaceeller json

-t, --target sträng

    Om tillämpligt, paketmålet som ska användas

  • Last updated on