Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Poznámka:
Tyto informace platí pro Databricks CLI verze 0.285 a vyšší. Rozhraní příkazového řádku Databricks je ve veřejné ukázce.
Použití rozhraní příkazového řádku Databricks podléhá licenci Databricks a oznámení o ochraně osobních údajů Databricks, včetně všech ustanovení o využití.
Skupina postgres příkazů v rozhraní příkazového řádku Databricks obsahuje příkazy pro správu prostředků Lakebase Postgres, včetně projektů, větví a koncových bodů. Rozhraní Postgres API poskytuje přístup k databázi Postgres prostřednictvím rozhraní REST API nebo přímého SQL.
databricks postgres create-branch
Vytvořte větev. Při vytváření větve musíte zadat zásadu vypršení platnosti, která se používá no_expiry: true pro trvalé větve.
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
databricks postgres create-branch PARENT BRANCH_ID [flags]
Arguments
PARENT
Projekt, ve kterém je tato větev vytvořena. Formát: projects/{project_id}
BRANCH_ID
ID, které se má použít pro větev, se stane konečnou součástí názvu prostředku větve. Musí mít délku 1 až 63 znaků, musí začínat malým písmenem a obsahovat pouze malá písmena, číslice a pomlčky (RFC 1123).
Možnosti
--json JSON
Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.
--name string
Název prostředku větve.
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad vytvoří větev v projektu:
databricks postgres create-branch projects/my-project-id my-branch \
--json '{
"spec": {
"no_expiry": true
}
}'
Následující příklad vytvoří větev z existující větve:
databricks postgres create-branch projects/my-project-id dev-branch \
--json '{
"spec": {
"source_branch": "projects/my-project-id/branches/main",
"no_expiry": true
}
}'
vytvoření koncového bodu databricks postgres
Vytvořte koncový bod. Větev může mít jeden výpočetní koncový bod pro čtení a několik koncových bodů jen pro čtení (replik pro čtení) pro škálování operací čtení.
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]
Arguments
PARENT
Větev, ve které je tento koncový bod vytvořen. Formát: projects/{project_id}/branches/{branch_id}
ENDPOINT_ID
ID, které se má použít pro koncový bod, se stane konečnou součástí názvu prostředku koncového bodu. Musí mít délku 1 až 63 znaků, musí začínat malým písmenem a obsahovat pouze malá písmena, číslice a pomlčky (RFC 1123).
Možnosti
--json JSON
Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.
--name string
Název prostředku koncového bodu.
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad vytvoří koncový bod pro čtení i zápis ve větvi:
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
}
}'
Následující příklad vytvoří koncový bod jen pro čtení (replika pro čtení):
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
}
}'
Vytvoření projektu databricks postgres
Vytvořte projekt.
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
Když vytvoříte projekt, automaticky zahrnuje výchozí produkční větev a výpočetní koncový bod pro čtení i zápis, a to jak s automaticky generovanými ID, tak i s automaticky generovanými ID.
databricks postgres create-project PROJECT_ID [flags]
Arguments
PROJECT_ID
ID, které se má použít pro projekt, se stane konečnou součástí názvu zdroje projektu. Musí mít délku 1 až 63 znaků, musí začínat malým písmenem a obsahovat pouze malá písmena, číslice a pomlčky (RFC 1123).
Možnosti
--json JSON
Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.
--name string
Název zdroje projektu.
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad vytvoří projekt:
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project"
}
}'
Následující příklad vytvoří projekt s konkrétní verzí PostgreSQL:
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project",
"pg_version": "17"
}
}'
databricks postgres delete-branch
Odstranění větve
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
Chráněné větve nelze odstranit. Slouží update-branch k nastavení spec.is_protected před false odstraněním.
databricks postgres delete-branch NAME [flags]
Arguments
NAME
Název větve, která se má odstranit. Formát: projects/{project_id}/branches/{branch_id}
Možnosti
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad odstraní větev:
databricks postgres delete-branch projects/my-project-id/branches/my-branch-id
koncový bod odstranění databricks postgres
Odstranění koncového bodu
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
databricks postgres delete-endpoint NAME [flags]
Arguments
NAME
Název koncového bodu, který chcete odstranit. Formát: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Možnosti
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad odstraní koncový bod:
databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres delete-project
Odstraňte projekt.
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
databricks postgres delete-project NAME [flags]
Arguments
NAME
Název projektu, který chcete odstranit. Formát: projects/{project_id}
Možnosti
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad odstraní projekt:
databricks postgres delete-project projects/my-project-id
databricks postgres generate-database-credential
Vygenerujte přihlašovací údaje OAuth pro databázi Postgres. Vrácený token OAuth se používá k ověření a připojení k databázi pomocí klientů PostgreSQL, jako je psql.
databricks postgres generate-database-credential ENDPOINT [flags]
Arguments
ENDPOINT
Koncový bod, pro který se vygenerují tyto přihlašovací údaje. Formát: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Možnosti
--json JSON
Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.
Examples
Následující příklad vygeneruje přihlašovací údaje OAuth pro koncový bod:
databricks postgres generate-database-credential projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres get-branch
Získejte větev.
databricks postgres get-branch NAME [flags]
Arguments
NAME
Název větve, která se má načíst. Formát: projects/{project_id}/branches/{branch_id}
Možnosti
Examples
Následující příklad získá informace o větvi:
databricks postgres get-branch projects/my-project-id/branches/my-branch-id
koncový bod get-endpoint databricks postgres
Získání koncového bodu
databricks postgres get-endpoint NAME [flags]
Arguments
NAME
Název koncového bodu, který se má načíst. Formát: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Možnosti
Examples
Následující příklad získá informace o koncovém bodu:
databricks postgres get-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
operace get-operation databricks postgres
Získání operace.
databricks postgres get-operation NAME [flags]
Arguments
NAME
Název prostředku operace.
Možnosti
Examples
Následující příklad získá informace o operaci:
databricks postgres get-operation projects/my-project-id/operations/my-operation-id
databricks postgres get-project
Získejte projekt.
databricks postgres get-project NAME [flags]
Arguments
NAME
Název projektu, který se má načíst. Formát: projects/{project_id}
Možnosti
Examples
Následující příklad získá informace o projektu:
databricks postgres get-project projects/my-project-id
větve seznamu postgres databricks
Vypsat větve Tento příkaz použijte k vyhledání ID větví, včetně výchozí větve vytvořené s vaším projektem (označených stavem "default": true ).
databricks postgres list-branches PARENT [flags]
Arguments
PARENT
Projekt, který vlastní tuto kolekci větví. Formát: projects/{project_id}
Možnosti
--page-size int
Horní mez vrácených položek
--page-token string
Token stránky z předchozí odpovědi
Examples
V následujícím příkladu jsou uvedeny všechny větve v projektu:
databricks postgres list-branches projects/my-project-id
Následující příklad uvádí větve se stránkováním:
databricks postgres list-branches projects/my-project-id --page-size 10
koncové body seznamu datových bodů databricks postgres
Výpis koncových bodů Tento příkaz použijte k vyhledání ID koncových bodů, včetně výchozího koncového bodu pro čtení i zápisu automaticky vytvořeného s vaším projektem.
databricks postgres list-endpoints PARENT [flags]
Arguments
PARENT
Větev, která vlastní tuto kolekci koncových bodů. Formát: projects/{project_id}/branches/{branch_id}
Možnosti
--page-size int
Horní mez vrácených položek
--page-token string
Token stránky z předchozí odpovědi
Examples
Následující příklad uvádí všechny koncové body ve větvi:
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id
Následující příklad uvádí koncové body se stránkováním:
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id --page-size 10
databricks postgres list-projects
Zobrazit seznam projektů
databricks postgres list-projects [flags]
Možnosti
--page-size int
Horní mez vrácených položek
--page-token string
Token stránky z předchozí odpovědi
Examples
V následujícím příkladu jsou uvedeny všechny projekty:
databricks postgres list-projects
Následující příklad uvádí projekty se stránkováním:
databricks postgres list-projects --page-size 10
databricks postgres update-branch
Aktualizujte větev.
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
databricks postgres update-branch NAME UPDATE_MASK [flags]
Arguments
NAME
Název prostředku větve. Formát: projects/{project_id}/branches/{branch_id}
UPDATE_MASK
Seznam polí, která chcete aktualizovat. Pokud není zadáno, aktualizují se všechna pole, pokud je to možné.
Možnosti
--json JSON
Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.
--name string
Název prostředku větve.
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad aktualizuje větev, aby byla chráněná:
databricks postgres update-branch projects/my-project-id/branches/my-branch-id spec.is_protected \
--json '{
"spec": {
"is_protected": true
}
}'
koncový bod aktualizace databricks postgres
Aktualizace koncového bodu
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
databricks postgres update-endpoint NAME UPDATE_MASK [flags]
Arguments
NAME
Název prostředku koncového bodu. Formát: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
UPDATE_MASK
Seznam polí, která chcete aktualizovat. Pokud není zadáno, aktualizují se všechna pole, pokud je to možné.
Možnosti
--json JSON
Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.
--name string
Název prostředku koncového bodu.
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad aktualizuje maximální výpočetní jednotky koncového bodu:
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
}
}'
Následující příklad aktualizuje několik polí (minimální a maximální výpočetní jednotky):
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
Aktualizace projektu
Poznámka:
Jedná se o dlouhotrvající operaci. Ve výchozím nastavení příkaz čeká na dokončení operace. Slouží --no-wait k okamžitému vrácení s podrobnostmi o nezpracované operaci. Pole operace name se pak dá použít k dotazování na dokončení pomocí get-operation příkazu.
databricks postgres update-project NAME UPDATE_MASK [flags]
Arguments
NAME
Název zdroje projektu. Formát: projects/{project_id}
UPDATE_MASK
Seznam polí, která chcete aktualizovat. Pokud není zadáno, aktualizují se všechna pole, pokud je to možné.
Možnosti
--json JSON
Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.
--name string
Název zdroje projektu.
--no-wait
Nečekejte na dosažení stavu HOTOVO.
--timeout duration
Maximální doba dosažení stavu DONE
Examples
Následující příklad aktualizuje zobrazovaný název projektu:
databricks postgres update-project projects/my-project-id spec.display_name \
--json '{
"spec": {
"display_name": "Updated Project Name"
}
}'
Globální příznaky
--debug
Zda povolit protokolování ladění.
-h nebo --help
Zobrazení nápovědy k rozhraní příkazového řádku Databricks nebo související skupině příkazů nebo souvisejícímu příkazu
--log-file řetězec
Řetězec představující soubor, do kterého se zapisují výstupní protokoly. Pokud tento příznak není zadaný, výchozí hodnota je zápis výstupních protokolů do stderru.
--log-format formát
Typ formátu protokolu, text nebo json. Výchozí hodnota je text.
--log-level řetězec
Řetězec představující úroveň formátu protokolu. Pokud není zadána, je úroveň formátu protokolu zakázaná.
-o, --output typ
Typ výstupu příkazu, text nebo json. Výchozí hodnota je text.
-p, --profile řetězec
Název profilu v ~/.databrickscfg souboru, který se má použít ke spuštění příkazu. Pokud tento příznak není zadán, použije se profil s názvem DEFAULT, pokud existuje.
--progress-format formát
Formát pro zobrazení protokolů průběhu: default, append, inplacenebo json
-t, --target řetězec
Pokud je to relevantní, cílový balíček, který se má použít