비고
이 정보는 Databricks CLI 버전 0.285 이상에 적용됩니다. Databricks CLI는 공개 미리 보기로 제공됩니다.
Databricks CLI 사용은 Databricks 라이선스 및 Databricks 개인 정보 보호 고지, 그리고 모든 사용 데이터 관련 조항의 적용을 받습니다.
Databricks CLI 내의 명령 그룹에는 postgres 프로젝트, 분기 및 엔드포인트를 포함한 Lakebase Postgres 리소스를 관리하는 명령이 포함되어 있습니다. Postgres API는 REST API 또는 직접 SQL을 통해 Postgres 데이터베이스에 대한 액세스를 제공합니다.
databricks postgres create-branch
분기를 만듭니다. 분기를 만들 때 영구 분기를 사용하여 no_expiry: true 만료 정책을 지정해야 합니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
databricks postgres create-branch PARENT BRANCH_ID [flags]
Arguments
PARENT
이 분기가 만들어지는 프로젝트입니다. 형식: projects/{project_id}
BRANCH_ID
분기의 리소스 이름의 최종 구성 요소가 되는 분기에 사용할 ID입니다. 길이는 1~63자여야 하며 소문자로 시작하고 소문자, 숫자 및 하이픈만 포함해야 합니다(RFC 1123).
Options
--json JSON
요청 본문은 인라인 JSON 문자열이거나 JSON 파일에 @path을 포함한 것입니다.
--name string
분기의 리소스 이름입니다.
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 프로젝트에서 분기를 만듭니다.
databricks postgres create-branch projects/my-project-id my-branch \
--json '{
"spec": {
"no_expiry": true
}
}'
다음 예제에서는 기존 분기에서 분기를 만듭니다.
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
엔드포인트를 만듭니다. 분기에는 읽기-쓰기 컴퓨팅 엔드포인트가 하나 있고 읽기 전용 엔드포인트(읽기 복제본)가 여러 개 있을 수 있습니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]
Arguments
PARENT
이 엔드포인트가 만들어지는 분기입니다. 형식: projects/{project_id}/branches/{branch_id}
ENDPOINT_ID
엔드포인트에 사용할 ID로, 엔드포인트 리소스 이름의 최종 구성 요소가 됩니다. 길이는 1~63자여야 하며 소문자로 시작하고 소문자, 숫자 및 하이픈만 포함해야 합니다(RFC 1123).
Options
--json JSON
요청 본문은 인라인 JSON 문자열이거나 JSON 파일에 @path을 포함한 것입니다.
--name string
엔드포인트의 리소스 이름입니다.
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 분기에 읽기-쓰기 엔드포인트를 만듭니다.
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
}
}'
다음 예제에서는 읽기 전용 엔드포인트(읽기 복제본)를 만듭니다.
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
프로젝트를 만듭니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
프로젝트를 만들 때 자동으로 기본 프로덕션 분기와 읽기-쓰기 컴퓨팅 엔드포인트가 모두 자동 생성된 ID를 포함합니다.
databricks postgres create-project PROJECT_ID [flags]
Arguments
PROJECT_ID
프로젝트에 사용할 ID로, 프로젝트의 자원 이름의 최종 구성 요소가 됩니다. 길이는 1~63자여야 하며 소문자로 시작하고 소문자, 숫자 및 하이픈만 포함해야 합니다(RFC 1123).
Options
--json JSON
요청 본문은 인라인 JSON 문자열이거나 JSON 파일에 @path을 포함한 것입니다.
--name string
프로젝트의 리소스 이름입니다.
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 프로젝트를 만듭니다.
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project"
}
}'
다음 예제에서는 특정 PostgreSQL 버전을 사용하여 프로젝트를 만듭니다.
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project",
"pg_version": "17"
}
}'
databricks postgres delete-branch
분기를 삭제합니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
보호된 분기는 삭제할 수 없습니다. 삭제하기 전에 설정하는 falsespec.is_protected 데 사용합니다update-branch.
databricks postgres delete-branch NAME [flags]
Arguments
NAME
삭제할 분기의 이름입니다. 형식: projects/{project_id}/branches/{branch_id}
Options
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 분기를 삭제합니다.
databricks postgres delete-branch projects/my-project-id/branches/my-branch-id
databricks postgres delete-endpoint
엔드포인트를 삭제합니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
databricks postgres delete-endpoint NAME [flags]
Arguments
NAME
삭제할 엔드포인트의 이름입니다. 형식: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 엔드포인트를 삭제합니다.
databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres delete-project
프로젝트를 삭제합니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
databricks postgres delete-project NAME [flags]
Arguments
NAME
삭제할 프로젝트의 이름입니다. 형식: projects/{project_id}
Options
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 프로젝트를 삭제합니다.
databricks postgres delete-project projects/my-project-id
databricks postgres generate-database-credential
Postgres 데이터베이스에 대한 OAuth 자격 증명을 생성합니다. 반환된 OAuth 토큰은 PostgreSQL 클라이언트(예 psql: PostgreSQL 클라이언트)를 사용하여 데이터베이스를 인증하고 연결하는 데 사용됩니다.
databricks postgres generate-database-credential ENDPOINT [flags]
Arguments
ENDPOINT
이 자격 증명이 생성되는 엔드포인트입니다. 형식: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
--json JSON
요청 본문은 인라인 JSON 문자열이거나 JSON 파일에 @path을 포함한 것입니다.
예시
다음 예제에서는 엔드포인트에 대한 OAuth 자격 증명을 생성합니다.
databricks postgres generate-database-credential projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres get-branch
분기를 가져옵니다.
databricks postgres get-branch NAME [flags]
Arguments
NAME
검색할 분기의 이름입니다. 형식: projects/{project_id}/branches/{branch_id}
Options
예시
다음 예제에서는 분기에 대한 정보를 가져옵니다.
databricks postgres get-branch projects/my-project-id/branches/my-branch-id
databricks postgres get-endpoint
엔드포인트를 가져옵니다.
databricks postgres get-endpoint NAME [flags]
Arguments
NAME
검색할 엔드포인트의 이름입니다. 형식: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
예시
다음 예제에서는 엔드포인트에 대한 정보를 가져옵니다.
databricks postgres get-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres get-operation
작업을 가져옵니다.
databricks postgres get-operation NAME [flags]
Arguments
NAME
작업 리소스의 이름입니다.
Options
예시
다음 예제에서는 작업에 대한 정보를 가져옵니다.
databricks postgres get-operation projects/my-project-id/operations/my-operation-id
databricks postgres get-project
프로젝트를 가져옵니다.
databricks postgres get-project NAME [flags]
Arguments
NAME
검색할 프로젝트의 이름입니다. 형식: projects/{project_id}
Options
예시
다음 예제에서는 프로젝트에 대한 정보를 가져옵니다.
databricks postgres get-project projects/my-project-id
databricks postgres list-branches
분기를 나열합니다. 이 명령을 사용하여 프로젝트로 만든 기본 분기(상태에 표시됨 "default": true )를 포함하여 분기 ID를 찾습니다.
databricks postgres list-branches PARENT [flags]
Arguments
PARENT
이 분기 컬렉션을 소유하는 프로젝트입니다. 형식: projects/{project_id}
Options
--page-size int
반환된 항목의 상한입니다.
--page-token string
이전 응답의 페이지 토큰입니다.
예시
다음 예제에서는 프로젝트의 모든 분기를 나열합니다.
databricks postgres list-branches projects/my-project-id
다음 예제에서는 페이지 매김이 있는 분기를 나열합니다.
databricks postgres list-branches projects/my-project-id --page-size 10
databricks postgres list-endpoints
엔드포인트를 나열합니다. 이 명령을 사용하여 프로젝트에서 자동으로 생성된 기본 읽기/쓰기 엔드포인트를 포함하여 엔드포인트 ID를 찾습니다.
databricks postgres list-endpoints PARENT [flags]
Arguments
PARENT
이 엔드포인트 컬렉션을 소유하는 분기입니다. 형식: projects/{project_id}/branches/{branch_id}
Options
--page-size int
반환된 항목의 상한입니다.
--page-token string
이전 응답의 페이지 토큰입니다.
예시
다음 예제에서는 분기의 모든 엔드포인트를 나열합니다.
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id
다음 예제에서는 페이지 매김이 있는 엔드포인트를 나열합니다.
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id --page-size 10
databricks postgres list-projects
프로젝트를 나열합니다.
databricks postgres list-projects [flags]
Options
--page-size int
반환된 항목의 상한입니다.
--page-token string
이전 응답의 페이지 토큰입니다.
예시
다음 예제에서는 모든 프로젝트를 나열합니다.
databricks postgres list-projects
다음 예제에서는 페이지 매김이 있는 프로젝트를 나열합니다.
databricks postgres list-projects --page-size 10
databricks postgres update-branch
분기를 업데이트합니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
databricks postgres update-branch NAME UPDATE_MASK [flags]
Arguments
NAME
분기의 리소스 이름입니다. 형식: projects/{project_id}/branches/{branch_id}
UPDATE_MASK
업데이트할 필드 목록입니다. 지정되지 않은 경우 가능한 경우 모든 필드가 업데이트됩니다.
Options
--json JSON
요청 본문은 인라인 JSON 문자열이거나 JSON 파일에 @path을 포함한 것입니다.
--name string
분기의 리소스 이름입니다.
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 분기를 보호하도록 업데이트합니다.
databricks postgres update-branch projects/my-project-id/branches/my-branch-id spec.is_protected \
--json '{
"spec": {
"is_protected": true
}
}'
databricks postgres update-endpoint
엔드포인트를 업데이트합니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
databricks postgres update-endpoint NAME UPDATE_MASK [flags]
Arguments
NAME
엔드포인트의 리소스 이름입니다. 형식: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
UPDATE_MASK
업데이트할 필드 목록입니다. 지정되지 않은 경우 가능한 경우 모든 필드가 업데이트됩니다.
Options
--json JSON
요청 본문은 인라인 JSON 문자열이거나 JSON 파일에 @path을 포함한 것입니다.
--name string
엔드포인트의 리소스 이름입니다.
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 엔드포인트의 최대 컴퓨팅 단위를 업데이트합니다.
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
}
}'
다음 예제에서는 여러 필드(최소 및 최대 컴퓨팅 단위)를 업데이트합니다.
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
프로젝트를 업데이트합니다.
비고
장기 실행 작업입니다. 기본적으로 명령은 작업이 완료되기를 기다립니다. 원시 작업 세부 정보와 함께 즉시 반환하는 데 사용합니다 --no-wait . 그런 다음 작업의 name 필드를 사용하여 명령을 사용하여 완료를 폴링할 get-operation 수 있습니다.
databricks postgres update-project NAME UPDATE_MASK [flags]
Arguments
NAME
프로젝트의 리소스 이름입니다. 형식: projects/{project_id}
UPDATE_MASK
업데이트할 필드 목록입니다. 지정되지 않은 경우 가능한 경우 모든 필드가 업데이트됩니다.
Options
--json JSON
요청 본문은 인라인 JSON 문자열이거나 JSON 파일에 @path을 포함한 것입니다.
--name string
프로젝트의 리소스 이름입니다.
--no-wait
DONE 상태에 도달할 때까지 기다리지 마세요.
--timeout duration
완료 상태에 도달하는 최대 시간입니다.
예시
다음 예제에서는 프로젝트의 표시 이름을 업데이트합니다.
databricks postgres update-project projects/my-project-id spec.display_name \
--json '{
"spec": {
"display_name": "Updated Project Name"
}
}'
전역 표시기
--debug
디버그 로깅을 사용할지 여부입니다.
-h 또는 --help
Databricks CLI 또는 관련 명령 그룹 또는 관련 명령에 대한 도움말을 표시합니다.
--log-file 문자열
출력 로그를 쓸 파일을 나타내는 문자열입니다. 이 플래그가 지정되지 않으면 출력 로그는 기본적으로 stderr에 기록됩니다.
--log-format 포맷
로그 형식 형식 text 또는 json. 기본값은 text입니다.
--log-level 문자열
로그 형식 수준을 나타내는 문자열입니다. 지정하지 않으면 로그 형식 수준을 사용할 수 없습니다.
-o, --output 유형
명령 출력 형식 text 또는 json. 기본값은 text입니다.
-p, --profile 문자열
명령을 실행하는 데 사용할 파일의 프로필 ~/.databrickscfg 이름입니다. 이 플래그를 지정하지 않으면, 존재하는 경우 DEFAULT로 명명된 프로필이 사용됩니다.
--progress-format 포맷
진행률 로그를 표시할 형식: default, append, inplace또는 json
-t, --target 문자열
해당하는 경우 사용할 번들 대상