Udostępnij przez

postgres grupa poleceń

Uwaga / Notatka

Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.285 lub nowszej. Interfejs CLI Databricks jest w publicznej wersji testowej.

Korzystanie z interfejsu wiersza polecenia usługi Databricks podlega licencjom usługi Databricks i powiadomieniom o ochronie prywatności usługi Databricks, w tym wszelkim przepisom dotyczącym danych użycia.

Grupa postgres poleceń w interfejsie wiersza polecenia usługi Databricks zawiera polecenia do zarządzania zasobami bazy danych Lakebase Postgres, w tym projektami, gałęziami i punktami końcowymi. Interfejs API postgres zapewnia dostęp do bazy danych Postgres za pośrednictwem interfejsu API REST lub bezpośredniego języka SQL.

databricks postgres create-branch

Utwórz gałąź. Podczas tworzenia gałęzi należy określić zasady wygasania używane no_expiry: true dla gałęzi stałych.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

databricks postgres create-branch PARENT BRANCH_ID [flags]

Arguments

PARENT

    Projekt, w którym jest tworzona ta gałąź. Formatowanie: projects/{project_id}

BRANCH_ID

    Identyfikator używany dla gałęzi, który staje się ostatnim składnikiem nazwy zasobu gałęzi. Musi mieć długość od 1 do 63 znaków, zaczynać się od małej litery i zawierać tylko małe litery, cyfry i łączniki (RFC 1123).

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path, wskazujący na plik JSON zawierający treść żądania.

--name string

    Nazwa zasobu gałęzi.

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

Poniższy przykład tworzy gałąź w projekcie:

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

Poniższy przykład tworzy gałąź z istniejącej gałęzi:

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

Utwórz punkt końcowy. Gałąź może mieć jeden punkt końcowy obliczeniowy odczytu i zapisu oraz wiele punktów końcowych tylko do odczytu (repliki do odczytu) na potrzeby skalowania operacji odczytu.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]

Arguments

PARENT

    Gałąź, w której jest tworzony ten punkt końcowy. Formatowanie: projects/{project_id}/branches/{branch_id}

ENDPOINT_ID

    Identyfikator używany dla punktu końcowego, który staje się ostatnim składnikiem nazwy zasobu punktu końcowego. Musi mieć długość od 1 do 63 znaków, zaczynać się od małej litery i zawierać tylko małe litery, cyfry i łączniki (RFC 1123).

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path, wskazujący na plik JSON zawierający treść żądania.

--name string

    Nazwa zasobu punktu końcowego.

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

Poniższy przykład tworzy punkt końcowy odczytu i zapisu w gałęzi:

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

Poniższy przykład tworzy punkt końcowy tylko do odczytu (replika do odczytu):

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

Utwórz projekt.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

Podczas tworzenia projektu automatycznie zawiera on domyślną gałąź produkcyjną i punkt końcowy obliczeniowy odczytu i zapisu, zarówno z automatycznie wygenerowanymi identyfikatorami.

databricks postgres create-project PROJECT_ID [flags]

Arguments

PROJECT_ID

    Identyfikator używany dla projektu, który staje się ostatnim składnikiem nazwy zasobu projektu. Musi mieć długość od 1 do 63 znaków, zaczynać się od małej litery i zawierać tylko małe litery, cyfry i łączniki (RFC 1123).

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path, wskazujący na plik JSON zawierający treść żądania.

--name string

    Nazwa zasobu projektu.

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

Poniższy przykład tworzy projekt:

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

Poniższy przykład tworzy projekt z określoną wersją bazy danych PostgreSQL:

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

databricks postgres delete-branch

Usuń gałąź.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

Nie można usunąć chronionych gałęzi. Użyj update-branch polecenia , aby ustawić wartość spec.is_protected na przed false usunięciem.

databricks postgres delete-branch NAME [flags]

Arguments

NAME

    Nazwa gałęzi do usunięcia. Formatowanie: projects/{project_id}/branches/{branch_id}

Opcje

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

Poniższy przykład usuwa gałąź:

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

databricks postgres delete-endpoint

Usuń punkt końcowy.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

databricks postgres delete-endpoint NAME [flags]

Arguments

NAME

    Nazwa punktu końcowego do usunięcia. Formatowanie: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Opcje

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

Poniższy przykład usuwa punkt końcowy:

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

databricks postgres delete-project

Usuwanie projektu.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

databricks postgres delete-project NAME [flags]

Arguments

NAME

    Nazwa projektu do usunięcia. Formatowanie: projects/{project_id}

Opcje

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

Poniższy przykład usuwa projekt:

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

databricks postgres generate-database-credential

Generowanie poświadczeń protokołu OAuth dla bazy danych Postgres. Zwrócony token OAuth jest używany do uwierzytelniania i nawiązywania połączenia z bazą danych przy użyciu klientów PostgreSQL, takich jak psql.

databricks postgres generate-database-credential ENDPOINT [flags]

Arguments

ENDPOINT

    Punkt końcowy, dla którego jest generowane to poświadczenie. Formatowanie: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path, wskazujący na plik JSON zawierający treść żądania.

Flagi globalne

Przykłady

Poniższy przykład generuje poświadczenia protokołu OAuth dla punktu końcowego:

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

databricks postgres get-branch

Pobierz gałąź.

databricks postgres get-branch NAME [flags]

Arguments

NAME

    Nazwa gałęzi do pobrania. Formatowanie: projects/{project_id}/branches/{branch_id}

Opcje

Flagi globalne

Przykłady

Poniższy przykład pobiera informacje o gałęzi:

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

databricks postgres get-endpoint

Uzyskiwanie punktu końcowego.

databricks postgres get-endpoint NAME [flags]

Arguments

NAME

    Nazwa punktu końcowego do pobrania. Formatowanie: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Opcje

Flagi globalne

Przykłady

Poniższy przykład pobiera informacje o punkcie końcowym:

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

databricks postgres get-operation

Pobierz operację.

databricks postgres get-operation NAME [flags]

Arguments

NAME

    Nazwa zasobu operacji.

Opcje

Flagi globalne

Przykłady

Poniższy przykład pobiera informacje o operacji:

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

databricks postgres get-project

Pobierz projekt.

databricks postgres get-project NAME [flags]

Arguments

NAME

    Nazwa projektu do pobrania. Formatowanie: projects/{project_id}

Opcje

Flagi globalne

Przykłady

Poniższy przykład pobiera informacje o projekcie:

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

databricks postgres list-branches

Wyświetl gałęzie. Użyj tego polecenia, aby znaleźć identyfikatory gałęzi, w tym domyślną gałąź utworzoną z projektem (wskazywaną przez "default": true w stanie).

databricks postgres list-branches PARENT [flags]

Arguments

PARENT

    Projekt, który jest właścicielem tej kolekcji gałęzi. Formatowanie: projects/{project_id}

Opcje

--page-size int

    Górna granica dla zwracanych elementów.

--page-token string

    Token strony z poprzedniej odpowiedzi.

Flagi globalne

Przykłady

Poniższy przykład zawiera listę wszystkich gałęzi w projekcie:

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

W poniższym przykładzie wymieniono gałęzie z podziałem na strony:

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

databricks postgres list-endpoints

Wyświetlanie listy punktów końcowych. Użyj tego polecenia, aby znaleźć identyfikatory punktów końcowych, w tym domyślny punkt końcowy odczytu i zapisu automatycznie utworzony w projekcie.

databricks postgres list-endpoints PARENT [flags]

Arguments

PARENT

    Gałąź będąca właścicielem tej kolekcji punktów końcowych. Formatowanie: projects/{project_id}/branches/{branch_id}

Opcje

--page-size int

    Górna granica dla zwracanych elementów.

--page-token string

    Token strony z poprzedniej odpowiedzi.

Flagi globalne

Przykłady

Poniższy przykład zawiera listę wszystkich punktów końcowych w gałęzi:

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

W poniższym przykładzie wymieniono punkty końcowe z podziałem na strony:

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

databricks postgres list-projects

Lista projektów.

databricks postgres list-projects [flags]

Opcje

--page-size int

    Górna granica dla zwracanych elementów.

--page-token string

    Token strony z poprzedniej odpowiedzi.

Flagi globalne

Przykłady

Poniższy przykład zawiera listę wszystkich projektów:

databricks postgres list-projects

W poniższym przykładzie wymieniono projekty z podziałem na strony:

databricks postgres list-projects --page-size 10

databricks postgres update-branch

Aktualizowanie gałęzi.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

databricks postgres update-branch NAME UPDATE_MASK [flags]

Arguments

NAME

    Nazwa zasobu gałęzi. Formatowanie: projects/{project_id}/branches/{branch_id}

UPDATE_MASK

    Lista pól do zaktualizowania. Jeśli nie zostanie określony, wszystkie pola zostaną zaktualizowane, gdy jest to możliwe.

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path, wskazujący na plik JSON zawierający treść żądania.

--name string

    Nazwa zasobu gałęzi.

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

Poniższy przykład aktualizuje gałąź, aby była chroniona:

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

databricks postgres update-endpoint

Aktualizowanie punktu końcowego.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

databricks postgres update-endpoint NAME UPDATE_MASK [flags]

Arguments

NAME

    Nazwa zasobu punktu końcowego. Formatowanie: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

UPDATE_MASK

    Lista pól do zaktualizowania. Jeśli nie zostanie określony, wszystkie pola zostaną zaktualizowane, gdy jest to możliwe.

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path, wskazujący na plik JSON zawierający treść żądania.

--name string

    Nazwa zasobu punktu końcowego.

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

W poniższym przykładzie zaktualizowano maksymalną liczbę jednostek obliczeniowych punktu końcowego:

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

Poniższy przykład aktualizuje wiele pól (minimalna i maksymalna liczba jednostek obliczeniowych):

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

Aktualizowanie projektu.

Uwaga / Notatka

Jest to długotrwała operacja. Domyślnie polecenie czeka na ukończenie operacji. Użyj polecenia --no-wait , aby natychmiast wrócić z nieprzetworzonymi szczegółami operacji. Pole operacji name może następnie służyć do sondowania pod kątem get-operation ukończenia przy użyciu polecenia .

databricks postgres update-project NAME UPDATE_MASK [flags]

Arguments

NAME

    Nazwa zasobu projektu. Formatowanie: projects/{project_id}

UPDATE_MASK

    Lista pól do zaktualizowania. Jeśli nie zostanie określony, wszystkie pola zostaną zaktualizowane, gdy jest to możliwe.

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path, wskazujący na plik JSON zawierający treść żądania.

--name string

    Nazwa zasobu projektu.

--no-wait

    Nie czekaj na osiągnięcie stanu GOTOWE.

--timeout duration

    Maksymalny czas osiągnięcia stanu GOTOWE.

Flagi globalne

Przykłady

Poniższy przykład aktualizuje nazwę wyświetlaną projektu:

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

Flagi globalne

--debug

  Czy włączyć logowanie debugowe.

-h lub --help

    Wyświetl pomoc dla Databricks CLI lub dla powiązanej grupy poleceń czy pojedynczego polecenia.

--log-file łańcuch znaków

    Ciąg tekstowy reprezentujący plik do zapisywania logów wyjściowych. Jeśli ta flaga nie zostanie określona, wartością domyślną jest zapisywanie dzienników wyjściowych w programie stderr.

--log-format formatowanie

    Format typu logu text lub json. Domyślna wartość to text.

--log-level łańcuch znaków

    Ciąg reprezentujący poziom formatu zapisu dziennika. Jeśli nie zostanie określony, poziom formatu dziennika jest wyłączony.

-o, --output typ

    Typ danych wyjściowych polecenia: text lub json. Domyślna wartość to text.

-p, --profile łańcuch znaków

    Nazwa profilu w pliku ~/.databrickscfg, który ma być użyty do uruchomienia polecenia. Jeśli ta flaga nie zostanie określona, to jeśli istnieje, zostanie użyty profil o nazwie DEFAULT.

--progress-format formatowanie

    Format wyświetlania dzienników postępu: default, , appendinplacelubjson

-t, --target łańcuch znaków

    Jeśli ma to zastosowanie, docelowy obiekt pakietu do użycia

  • Last updated on