Bagikan melalui


grup perintah postgres

Nota

Informasi ini berlaku untuk Databricks CLI versi 0.285 ke atas. Databricks CLI ada di Pratinjau Publik.

Penggunaan Databricks CLI tunduk pada Lisensi Databricks dan Pemberitahuan Privasi Databricks, termasuk ketentuan Data Penggunaan apa pun.

postgres Grup perintah dalam Databricks CLI berisi perintah untuk mengelola sumber daya Lakebase Postgres termasuk proyek, cabang, dan titik akhir. API Postgres menyediakan akses ke database Postgres melalui REST API atau SQL langsung.

databricks postgres create-branch

Buat Cabang. Saat membuat cabang, Anda harus menentukan kebijakan kedaluwarsa menggunakan no_expiry: true untuk cabang permanen.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

databricks postgres create-branch PARENT BRANCH_ID [flags]

Arguments

PARENT

    Proyek tempat Cabang ini dibuat. Format: projects/{project_id}

BRANCH_ID

    ID yang digunakan untuk Cabang, yang menjadi komponen akhir dari nama sumber daya cabang. Panjangnya harus 1-63 karakter, dimulai dengan huruf kecil, dan hanya berisi huruf kecil, angka, dan tanda hubung (RFC 1123).

Opsi

--json JSON

    String JSON inline atau @path ditambahkan ke file JSON dengan isi permintaan.

--name string

    Nama sumber daya cabang.

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut membuat cabang dalam proyek:

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

Contoh berikut membuat cabang dari cabang yang ada:

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

Membuat Titik Akhir. Cabang dapat memiliki satu titik akhir komputasi baca-tulis dan beberapa titik akhir baca-saja (replika baca) untuk penskalaan operasi baca.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]

Arguments

PARENT

    Cabang tempat Titik Akhir ini dibuat. Format: projects/{project_id}/branches/{branch_id}

ENDPOINT_ID

    ID yang digunakan untuk Titik Akhir, yang menjadi komponen akhir dari nama sumber daya titik akhir. Panjangnya harus 1-63 karakter, dimulai dengan huruf kecil, dan hanya berisi huruf kecil, angka, dan tanda hubung (RFC 1123).

Opsi

--json JSON

    String JSON inline atau @path ditambahkan ke file JSON dengan isi permintaan.

--name string

    Nama sumber daya titik akhir.

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut membuat titik akhir baca-tulis di cabang:

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

Contoh berikut membuat titik akhir baca-saja (replika baca):

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

Buat Proyek.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

Saat Anda membuat proyek, proyek secara otomatis menyertakan cabang produksi default dan titik akhir komputasi baca-tulis, keduanya dengan ID yang dihasilkan secara otomatis.

databricks postgres create-project PROJECT_ID [flags]

Arguments

PROJECT_ID

    ID yang digunakan untuk Proyek, yang menjadi komponen akhir dari nama sumber daya proyek. Panjangnya harus 1-63 karakter, dimulai dengan huruf kecil, dan hanya berisi huruf kecil, angka, dan tanda hubung (RFC 1123).

Opsi

--json JSON

    String JSON inline atau @path ditambahkan ke file JSON dengan isi permintaan.

--name string

    Nama sumber daya proyek.

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut membuat proyek:

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

Contoh berikut membuat proyek dengan versi PostgreSQL tertentu:

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

databricks postgres delete-branch

Menghapus Cabang.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

Cabang yang dilindungi tidak dapat dihapus. Gunakan update-branch untuk mengatur spec.is_protected ke false sebelum menghapus.

databricks postgres delete-branch NAME [flags]

Arguments

NAME

    Nama Cabang yang akan dihapus. Format: projects/{project_id}/branches/{branch_id}

Opsi

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut menghapus cabang:

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

databricks postgres delete-endpoint

Menghapus Titik Akhir.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

databricks postgres delete-endpoint NAME [flags]

Arguments

NAME

    Nama Titik Akhir yang akan dihapus. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Opsi

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut menghapus titik akhir:

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

databricks postgres delete-project

Menghapus Proyek.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

databricks postgres delete-project NAME [flags]

Arguments

NAME

    Nama Proyek yang akan dihapus. Format: projects/{project_id}

Opsi

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut menghapus proyek:

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

databricks postgres generate-database-credential

Hasilkan kredensial OAuth untuk database Postgres. Token OAuth yang dikembalikan digunakan untuk mengautentikasi dan menyambungkan ke database Anda dengan klien PostgreSQL seperti psql.

databricks postgres generate-database-credential ENDPOINT [flags]

Arguments

ENDPOINT

    Titik akhir tempat kredensial ini dihasilkan. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Opsi

--json JSON

    String JSON inline atau @path ditambahkan ke file JSON dengan isi permintaan.

Bendera global

Examples

Contoh berikut menghasilkan kredensial OAuth untuk titik akhir:

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

databricks postgres get-branch

Dapatkan Cabang.

databricks postgres get-branch NAME [flags]

Arguments

NAME

    Nama Cabang yang akan diambil. Format: projects/{project_id}/branches/{branch_id}

Opsi

Bendera global

Examples

Contoh berikut mendapatkan informasi tentang cabang:

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

titik akhir postgres databricks

Dapatkan Titik Akhir.

databricks postgres get-endpoint NAME [flags]

Arguments

NAME

    Nama Titik Akhir yang akan diambil. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Opsi

Bendera global

Examples

Contoh berikut mendapatkan informasi tentang titik akhir:

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

databricks postgres get-operation

Dapatkan Operasi.

databricks postgres get-operation NAME [flags]

Arguments

NAME

    Nama sumber daya operasi.

Opsi

Bendera global

Examples

Contoh berikut mendapatkan informasi tentang operasi:

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

databricks postgres get-project

Dapatkan Proyek.

databricks postgres get-project NAME [flags]

Arguments

NAME

    Nama Proyek yang akan diambil. Format: projects/{project_id}

Opsi

Bendera global

Examples

Contoh berikut mendapatkan informasi tentang proyek:

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

databricks postgres list-branches

Mencantumkan Cabang. Gunakan perintah ini untuk menemukan ID cabang, termasuk cabang default yang dibuat dengan proyek Anda (ditunjukkan oleh "default": true dalam status).

databricks postgres list-branches PARENT [flags]

Arguments

PARENT

    Proyek yang memiliki koleksi cabang ini. Format: projects/{project_id}

Opsi

--page-size int

    Batas atas untuk item yang dikembalikan.

--page-token string

    Token halaman dari respons sebelumnya.

Bendera global

Examples

Contoh berikut mencantumkan semua cabang dalam proyek:

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

Contoh berikut mencantumkan cabang dengan penomoran halaman:

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

titik akhir daftar postgres databricks

Mencantumkan Titik Akhir. Gunakan perintah ini untuk menemukan ID titik akhir, termasuk titik akhir baca-tulis default yang dibuat secara otomatis dengan proyek Anda.

databricks postgres list-endpoints PARENT [flags]

Arguments

PARENT

    Cabang yang memiliki kumpulan titik akhir ini. Format: projects/{project_id}/branches/{branch_id}

Opsi

--page-size int

    Batas atas untuk item yang dikembalikan.

--page-token string

    Token halaman dari respons sebelumnya.

Bendera global

Examples

Contoh berikut mencantumkan semua titik akhir dalam cabang:

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

Contoh berikut mencantumkan titik akhir dengan penomoran halaman:

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

proyek daftar postgres databricks

Mencantumkan Proyek.

databricks postgres list-projects [flags]

Opsi

--page-size int

    Batas atas untuk item yang dikembalikan.

--page-token string

    Token halaman dari respons sebelumnya.

Bendera global

Examples

Contoh berikut mencantumkan semua proyek:

databricks postgres list-projects

Contoh berikut mencantumkan proyek dengan penomoran halaman:

databricks postgres list-projects --page-size 10

databricks postgres update-branch

Perbarui Cabang.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

databricks postgres update-branch NAME UPDATE_MASK [flags]

Arguments

NAME

    Nama sumber daya cabang. Format: projects/{project_id}/branches/{branch_id}

UPDATE_MASK

    Daftar bidang yang akan diperbarui. Jika tidak ditentukan, semua bidang diperbarui jika memungkinkan.

Opsi

--json JSON

    String JSON inline atau @path ditambahkan ke file JSON dengan isi permintaan.

--name string

    Nama sumber daya cabang.

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut memperbarui cabang untuk membuatnya terlindungi:

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

databricks postgres update-endpoint

Memperbarui Titik Akhir.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

databricks postgres update-endpoint NAME UPDATE_MASK [flags]

Arguments

NAME

    Nama sumber daya titik akhir. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

UPDATE_MASK

    Daftar bidang yang akan diperbarui. Jika tidak ditentukan, semua bidang diperbarui jika memungkinkan.

Opsi

--json JSON

    String JSON inline atau @path ditambahkan ke file JSON dengan isi permintaan.

--name string

    Nama sumber daya titik akhir.

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut memperbarui unit komputasi maksimum titik akhir:

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

Contoh berikut memperbarui beberapa bidang (unit komputasi min dan maks):

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

proyek pembaruan postgres databricks

Perbarui Proyek.

Nota

Ini adalah operasi jangka panjang. Secara default, perintah menunggu operasi selesai. Gunakan --no-wait untuk segera kembali dengan detail operasi mentah. Bidang operasi name kemudian dapat digunakan untuk polling untuk penyelesaian menggunakan get-operation perintah .

databricks postgres update-project NAME UPDATE_MASK [flags]

Arguments

NAME

    Nama sumber daya proyek. Format: projects/{project_id}

UPDATE_MASK

    Daftar bidang yang akan diperbarui. Jika tidak ditentukan, semua bidang diperbarui jika memungkinkan.

Opsi

--json JSON

    String JSON inline atau @path ditambahkan ke file JSON dengan isi permintaan.

--name string

    Nama sumber daya proyek.

--no-wait

    Jangan menunggu untuk mencapai status SELESAI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status SELESAI.

Bendera global

Examples

Contoh berikut memperbarui nama tampilan proyek:

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

Bendera dunia

--debug

  Apakah debug logging ingin diaktifkan?

-h atau --help

    Tampilkan bantuan untuk Databricks CLI atau grup perintah terkait atau perintah terkait.

--log-file tali

    String yang mewakili file yang akan digunakan untuk menulis log output. Jika bendera ini tidak ditentukan, maka defaultnya adalah menulis log output ke stderr.

--log-format Format

    Jenis format log, text atau json. Nilai defaultnya adalah text.

--log-level tali

    Untaian yang menggambarkan tingkat format log. Jika tidak ditentukan, maka tingkat format log akan dinonaktifkan.

-o, --output jenis

    Jenis output perintah, text atau json. Nilai defaultnya adalah text.

-p, --profile tali

    Nama profil dalam file ~/.databrickscfg yang digunakan untuk menjalankan perintah. Jika bendera ini tidak ditentukan maka jika ada, profil bernama DEFAULT digunakan.

--progress-format Format

    Format untuk menampilkan log kemajuan: default, , append, inplaceatau json

-t, --target tali

    Jika berlaku, target bundel yang akan digunakan