Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Hinweis
Diese Informationen gelten für Databricks CLI-Versionen 0.285 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.
Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.
Die postgres Befehlsgruppe innerhalb der Databricks CLI enthält Befehle zum Verwalten von Lakebase Postgres-Ressourcen, einschließlich Projekten, Verzweigungen und Endpunkten. Die Postgres-API bietet Zugriff auf eine Postgres-Datenbank über REST-API oder direkte SQL.
databricks postgres create-branch
Erstellen Sie eine Verzweigung. Beim Erstellen einer Verzweigung müssen Sie eine Ablaufrichtlinie angeben, die für permanente Verzweigungen verwendet no_expiry: true wird.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
databricks postgres create-branch PARENT BRANCH_ID [flags]
Arguments
PARENT
Das Projekt, in dem diese Verzweigung erstellt wird. Formatierung: projects/{project_id}
BRANCH_ID
Die ID, die für den Branch verwendet werden soll, was zur endgültigen Komponente des Ressourcennamens der Verzweigung wird. Muss 1 bis 63 Zeichen lang sein, mit einem Kleinbuchstaben beginnen und nur Kleinbuchstaben, Zahlen und Bindestriche (RFC 1123) enthalten.
Options
--json JSON
Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.
--name string
Der Ressourcenname der Verzweigung.
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel wird eine Verzweigung in einem Projekt erstellt:
databricks postgres create-branch projects/my-project-id my-branch \
--json '{
"spec": {
"no_expiry": true
}
}'
Im folgenden Beispiel wird eine Verzweigung aus einer vorhandenen Verzweigung erstellt:
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
Erstellen Sie einen Endpunkt. Eine Verzweigung kann einen Computeendpunkt mit Lese-/Schreibzugriff und mehrere schreibgeschützte Endpunkte (Lesereplikate) für die Skalierung von Lesevorgängen aufweisen.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]
Arguments
PARENT
Der Branch, in dem dieser Endpunkt erstellt wird. Formatierung: projects/{project_id}/branches/{branch_id}
ENDPOINT_ID
Die FÜR den Endpunkt zu verwendende ID, die zur endgültigen Komponente des Ressourcennamens des Endpunkts wird. Muss 1 bis 63 Zeichen lang sein, mit einem Kleinbuchstaben beginnen und nur Kleinbuchstaben, Zahlen und Bindestriche (RFC 1123) enthalten.
Options
--json JSON
Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.
--name string
Der Ressourcenname des Endpunkts.
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel wird ein Lese-/Schreibzugriffsendpunkt in einer Verzweigung erstellt:
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
}
}'
Im folgenden Beispiel wird ein schreibgeschützter Endpunkt (Lesereplikat) erstellt:
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
Erstellen Sie ein Projekt.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
Wenn Sie ein Projekt erstellen, enthält es automatisch einen Standardproduktionszweig und einen Lese-/Schreib-Computeendpunkt, sowohl mit automatisch generierten IDs.
databricks postgres create-project PROJECT_ID [flags]
Arguments
PROJECT_ID
Die FÜR das Projekt zu verwendende ID, die zur endgültigen Komponente des Ressourcennamens des Projekts wird. Muss 1 bis 63 Zeichen lang sein, mit einem Kleinbuchstaben beginnen und nur Kleinbuchstaben, Zahlen und Bindestriche (RFC 1123) enthalten.
Options
--json JSON
Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.
--name string
Der Ressourcenname des Projekts.
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel wird ein Projekt erstellt:
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project"
}
}'
Im folgenden Beispiel wird ein Projekt mit einer bestimmten PostgreSQL-Version erstellt:
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project",
"pg_version": "17"
}
}'
databricks postgres delete-branch
Löschen sie eine Verzweigung.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
Geschützte Verzweigungen können nicht gelöscht werden. Dient update-branch zum Festlegen spec.is_protected vor false dem Löschen.
databricks postgres delete-branch NAME [flags]
Arguments
NAME
Der Name des zu löschenden Zweigs. Formatierung: projects/{project_id}/branches/{branch_id}
Options
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel wird eine Verzweigung gelöscht:
databricks postgres delete-branch projects/my-project-id/branches/my-branch-id
databricks postgres delete-endpoint
Löschen eines Endpunkts.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
databricks postgres delete-endpoint NAME [flags]
Arguments
NAME
Der Name des zu löschenden Endpunkts. Formatierung: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel wird ein Endpunkt gelöscht:
databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres delete-project
Löschen eines Projekts.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
databricks postgres delete-project NAME [flags]
Arguments
NAME
Der Name des zu löschenden Projekts. Formatierung: projects/{project_id}
Options
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel wird ein Projekt gelöscht:
databricks postgres delete-project projects/my-project-id
databricks postgres generate-database-credential
Generieren Sie OAuth-Anmeldeinformationen für eine Postgres-Datenbank. Das zurückgegebene OAuth-Token wird zum Authentifizieren und Herstellen einer Verbindung mit Ihrer Datenbank mit PostgreSQL-Clients verwendet, z psql. B. .
databricks postgres generate-database-credential ENDPOINT [flags]
Arguments
ENDPOINT
Der Endpunkt, für den diese Anmeldeinformationen generiert werden. Formatierung: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
--json JSON
Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.
Examples
Im folgenden Beispiel werden OAuth-Anmeldeinformationen für einen Endpunkt generiert:
databricks postgres generate-database-credential projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres get-branch
Rufen Sie eine Verzweigung ab.
databricks postgres get-branch NAME [flags]
Arguments
NAME
Der Name des abzurufenden Zweigs. Formatierung: projects/{project_id}/branches/{branch_id}
Options
Examples
Das folgende Beispiel ruft Informationen zu einer Verzweigung ab:
databricks postgres get-branch projects/my-project-id/branches/my-branch-id
databricks postgres get-endpoint
Rufen Sie einen Endpunkt ab.
databricks postgres get-endpoint NAME [flags]
Arguments
NAME
Der Name des abzurufenden Endpunkts. Formatierung: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
Examples
Das folgende Beispiel ruft Informationen zu einem Endpunkt ab:
databricks postgres get-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres get-operation
Rufen Sie einen Vorgang ab.
databricks postgres get-operation NAME [flags]
Arguments
NAME
Der Name der Vorgangsressource.
Options
Examples
Das folgende Beispiel ruft Informationen zu einem Vorgang ab:
databricks postgres get-operation projects/my-project-id/operations/my-operation-id
databricks postgres get-project
Rufen Sie ein Projekt ab.
databricks postgres get-project NAME [flags]
Arguments
NAME
Der Name des abzurufenden Projekts. Formatierung: projects/{project_id}
Options
Examples
Das folgende Beispiel ruft Informationen zu einem Projekt ab:
databricks postgres get-project projects/my-project-id
databricks postgres list-branches
Verzweigungen auflisten. Verwenden Sie diesen Befehl, um Verzweigungs-IDs zu finden, einschließlich der mit Ihrem Projekt erstellten Standardverzweigung (im Status angegeben "default": true ).
databricks postgres list-branches PARENT [flags]
Arguments
PARENT
Das Projekt, das diese Sammlung von Verzweigungen besitzt. Formatierung: projects/{project_id}
Options
--page-size int
Obere Grenze für zurückgegebene Elemente.
--page-token string
Seitentoken aus einer vorherigen Antwort.
Examples
Im folgenden Beispiel werden alle Verzweigungen in einem Projekt aufgelistet:
databricks postgres list-branches projects/my-project-id
Im folgenden Beispiel werden Verzweigungen mit Paginierung aufgelistet:
databricks postgres list-branches projects/my-project-id --page-size 10
databricks postgres list-endpoints
Endpunkte auflisten. Verwenden Sie diesen Befehl, um Endpunkt-IDs zu finden, einschließlich des standardmäßigen Lese-/Schreibzugriffsendpunkts, der automatisch mit Ihrem Projekt erstellt wurde.
databricks postgres list-endpoints PARENT [flags]
Arguments
PARENT
The Branch that owns this collection of endpoints. Formatierung: projects/{project_id}/branches/{branch_id}
Options
--page-size int
Obere Grenze für zurückgegebene Elemente.
--page-token string
Seitentoken aus einer vorherigen Antwort.
Examples
Im folgenden Beispiel werden alle Endpunkte in einer Verzweigung aufgelistet:
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id
Im folgenden Beispiel werden Endpunkte mit Paginierung aufgelistet:
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id --page-size 10
databricks postgres list-projects
Listet Projekte auf.
databricks postgres list-projects [flags]
Options
--page-size int
Obere Grenze für zurückgegebene Elemente.
--page-token string
Seitentoken aus einer vorherigen Antwort.
Examples
Im folgenden Beispiel werden alle Projekte aufgelistet:
databricks postgres list-projects
Im folgenden Beispiel werden Projekte mit Paginierung aufgelistet:
databricks postgres list-projects --page-size 10
databricks postgres update-branch
Aktualisieren sie eine Verzweigung.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
databricks postgres update-branch NAME UPDATE_MASK [flags]
Arguments
NAME
Der Ressourcenname der Verzweigung. Formatierung: projects/{project_id}/branches/{branch_id}
UPDATE_MASK
Die Liste der zu aktualisierenden Felder. Wenn nicht angegeben, werden alle Felder nach Möglichkeit aktualisiert.
Options
--json JSON
Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.
--name string
Der Ressourcenname der Verzweigung.
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel wird eine Verzweigung aktualisiert, um sie zu schützen:
databricks postgres update-branch projects/my-project-id/branches/my-branch-id spec.is_protected \
--json '{
"spec": {
"is_protected": true
}
}'
databricks postgres update-endpoint
Aktualisieren eines Endpunkts.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
databricks postgres update-endpoint NAME UPDATE_MASK [flags]
Arguments
NAME
Der Ressourcenname des Endpunkts. Formatierung: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
UPDATE_MASK
Die Liste der zu aktualisierenden Felder. Wenn nicht angegeben, werden alle Felder nach Möglichkeit aktualisiert.
Options
--json JSON
Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.
--name string
Der Ressourcenname des Endpunkts.
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel werden die maximalen Computeeinheiten eines Endpunkts aktualisiert:
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
}
}'
Im folgenden Beispiel werden mehrere Felder aktualisiert (min. und max. Computeeinheiten):
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
Aktualisieren eines Projekts.
Hinweis
Dies ist ein lang ausgeführter Vorgang. Standardmäßig wartet der Befehl auf den Abschluss des Vorgangs. Wird verwendet --no-wait , um sofort mit den Unformatierten Vorgangsdetails zurückzugeben. Das Feld des Vorgangs name kann dann zum Abrufen des Abschlusses mithilfe des get-operation Befehls verwendet werden.
databricks postgres update-project NAME UPDATE_MASK [flags]
Arguments
NAME
Der Ressourcenname des Projekts. Formatierung: projects/{project_id}
UPDATE_MASK
Die Liste der zu aktualisierenden Felder. Wenn nicht angegeben, werden alle Felder nach Möglichkeit aktualisiert.
Options
--json JSON
Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.
--name string
Der Ressourcenname des Projekts.
--no-wait
Warten Sie nicht, bis der Status "FERTIG" erreicht ist.
--timeout duration
Maximale Zeitdauer, um den Zustand "FERTIG" zu erreichen.
Examples
Im folgenden Beispiel wird der Anzeigename eines Projekts aktualisiert:
databricks postgres update-project projects/my-project-id spec.display_name \
--json '{
"spec": {
"display_name": "Updated Project Name"
}
}'
Globale Kennzeichnungen
--debug
Gibt an, ob die Debugprotokollierung aktiviert werden soll.
-h oder --help
Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.
--log-file Schnur
Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.
--log-format Format
Der Protokollformattyp text oder json. Der Standardwert ist text.
--log-level Schnur
Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.
-o, --output Typ
Der Befehlsausgabetyp text oder json. Der Standardwert ist text.
-p, --profile Schnur
Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben wird, wird, falls vorhanden, das Profil mit dem Namen DEFAULT verwendet.
--progress-format Format
Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json
-t, --target Schnur
Falls zutreffend, das zu verwendende Bündelziel