Bagikan melalui

Referensi SqlPackage CLI

SqlPackage adalah utilitas baris perintah untuk portabilitas dan penyebaran database di lingkungan Windows, Linux, dan macOS. Antarmuka baris perintah (CLI) SqlPackage mengurai setiap pemanggilan untuk parameter, properti, dan variabel SQLCMD.

SqlPackage {parameters} {properties} {SQLCMD variables}
  • Parameter menentukan tindakan yang akan dilakukan, database sumber dan target, dan pengaturan umum lainnya.
  • Properti mengubah perilaku default tindakan.
  • Variabel SQLCMD meneruskan nilai ke variabel SQLCMD dalam file sumber.

Untuk membuat perintah SqlPackage, tentukan tindakan dan parameter tambahannya. Secara opsional, tambahkan properti dan variabel SQLCMD untuk menyesuaikan perintah lebih lanjut.

Contoh berikut menggunakan SqlPackage untuk membuat .dacpac file skema database saat ini:

SqlPackage /Action:Extract /TargetFile:"C:\sqlpackageoutput\output_current_version.dacpac" \
 /SourceServerName:"localhost" /SourceDatabaseName:"Contoso" \
 /p:IgnoreUserLoginMappings=True /p:Storage=Memory

Ini adalah parameter dari contoh ini:

  • /Action:Extract
  • /TargetFile:"C:\sqlpackageoutput\output_current_version.dacpac"
  • /SourceServerName:"localhost"
  • /SourceDatabaseName:"Contoso"

Ini adalah properti dari contoh ini:

  • /p:IgnoreUserLoginMappings=True
  • /p:Storage=Memory

Tindakan SqlPackage

Tindakan Description
Versi Mengembalikan nomor build aplikasi SqlPackage.
Ekstrak Membuat file aplikasi tingkat data (.dacpac) yang berisi skema atau skema dan data pengguna dari database SQL yang tersambung.
Terbitkan Memperbarui skema database secara bertahap agar sesuai dengan skema file sumber .dacpac . Jika database tidak ada di server, operasi penerbitan membuatnya. Jika tidak, database yang ada diperbarui.
Ekspor Mengekspor database SQL yang tersambung - termasuk skema database dan data pengguna - ke file BACPAC (.bacpac).
Impor Mengimpor data skema dan tabel dari file BACPAC ke database pengguna baru.
DeployReport Membuat laporan XML yang mewakili perubahan yang akan dilakukan tindakan penerbitan.
DriftReport Membuat laporan XML yang mewakili perubahan yang diterapkan ke database terdaftar sejak terakhir didaftarkan.
Skrip Membuat skrip pembaruan inkremental Transact-SQL yang memperbarui skema target agar sesuai dengan skema sumber.

Nota

Meskipun ID Microsoft Entra adalah nama baru untuk Azure Active Directory (Azure AD), untuk mencegah mengganggu lingkungan yang ada, Azure AD masih tetap berada di beberapa elemen yang dikodekan secara permanen seperti bidang UI, penyedia koneksi, kode kesalahan, dan cmdlet. Dalam artikel ini, dua nama tersebut dapat dipertukarkan.

Parameter

Beberapa parameter dibagikan antara tindakan SqlPackage. Tabel berikut ini meringkas parameter. Untuk informasi selengkapnya, gunakan tautan dalam judul tabel untuk mengunjungi halaman tindakan tertentu.

Parameter Formulir Pendek Ekstrak Terbitkan Ekspor Impor DeployReport DriftReport Skrip
/AccessToken: /at Yes Yes Yes Yes Yes Yes Yes
/ClientId: /cid Tidak. Yes Tidak. Tidak. Tidak. Tidak. Tidak.
/DeployScriptPath: /dsp Tidak. Yes Tidak. Tidak. Tidak. Tidak. Yes
/DeployReportPath: /drp Tidak. Yes Tidak. Tidak. Tidak. Tidak. Yes
/Diagnostics: /d Yes Yes Yes Yes Yes Yes Yes
/DiagnosticsFile: /df Yes Yes Yes Yes Yes Yes Yes
/DiagnosticsPackageFile: /dpf Tidak. Yes Tidak. Yes Tidak. Tidak. Tidak.
/MaxParallelism: /mp Yes Yes Yes Yes Yes Yes Yes
/OutputPath: /op Tidak. Tidak. Tidak. Tidak. Yes Yes Yes
/OverwriteFiles: /of Yes Yes Yes Tidak. Yes Yes Yes
/Profile: /pr Tidak. Yes Tidak. Tidak. Yes Tidak. Yes
/Properties: /p Yes Yes Yes Yes Yes Tidak. Yes
/Quiet: /q Yes Yes Yes Yes Yes Yes Yes
/Secret: /secr Tidak. Yes Tidak. Tidak. Tidak. Tidak. Tidak.
/SourceConnectionString: /scs Yes Yes Yes Tidak. Yes Tidak. Yes
/SourceDatabaseName: /sdn Yes Yes Yes Tidak. Yes Tidak. Yes
/SourceEncryptConnection: /sec Yes Yes Yes Tidak. Yes Tidak. Yes
/SourceFile: /sf Tidak. Yes Tidak. Yes Yes Tidak. Yes
/SourcePassword: /sp Yes Yes Yes Tidak. Yes Tidak. Yes
/SourceServerName: /ssn Yes Yes Yes Tidak. Yes Tidak. Yes
/SourceTimeout: /st Yes Yes Yes Tidak. Yes Tidak. Yes
/SourceTrustServerCertificate: /stsc Yes Yes Yes Tidak. Yes Tidak. Yes
/SourceUser: /su Yes Yes Yes Tidak. Yes Tidak. Yes
/TargetConnectionString: /tcs Tidak. Tidak. Tidak. Yes Yes Yes Yes
/TargetDatabaseName: /tdn Tidak. Yes Tidak. Yes Yes Yes Yes
/TargetEncryptConnection: /tec Tidak. Yes Tidak. Yes Yes Yes Yes
/TargetFile: /tf Yes Tidak. Yes Tidak. Yes Tidak. Yes
/TargetPassword: /tp Tidak. Yes Tidak. Yes Yes Yes Yes
/TargetServerName: /tsn Tidak. Yes Tidak. Yes Yes Yes Yes
/TargetTimeout: /tt Tidak. Yes Tidak. Yes Yes Yes Yes
/TargetTrustServerCertificate: /ttsc Tidak. Yes Tidak. Yes Yes Yes Yes
/TargetUser: /tu Tidak. Yes Tidak. Yes Yes Yes Yes
/TenantId: /tid Yes Yes Yes Yes Yes Yes Yes
/UniversalAuthentication: /ua Yes Yes Yes Yes Yes Yes Yes
/Variables: /v Tidak. Tidak. Tidak. Tidak. Yes Tidak. Yes

Properti

Tindakan SqlPackage mendukung banyak properti untuk mengubah perilaku default tindakan. Tambahkan /p:PropertyName=Value ke baris perintah untuk menggunakan properti secara opsional. Anda dapat menentukan beberapa properti, dan menentukan beberapa properti lebih dari sekali. Misalnya, Anda dapat menggunakan /p:TableData=Product /p:TableData=ProductCategory. Untuk informasi selengkapnya tentang properti, lihat halaman tindakan tertentu.

Variabel SQLCMD

Anda dapat membangun variabel SQLCMD ke dalam .dacpac file dari proyek SQL. Atur variabel ini selama penyebaran menggunakan SqlPackage Publish atau Script. Untuk informasi selengkapnya tentang menambahkan variabel SQLCMD ke proyek SQL, lihat Ekstensi Proyek SQL Database.

Perintah utilitas

Versi

Menampilkan versi sqlpackage sebagai nomor build. Gunakan dalam perintah interaktif dan dalam alur otomatis.

SqlPackage /Version

Tolong

Gunakan /? atau /help:True untuk menampilkan informasi penggunaan SqlPackage.

SqlPackage /?

Untuk parameter dan informasi properti khusus untuk tindakan tertentu, gunakan parameter bantuan selain parameter tindakan tersebut.

SqlPackage /Action:Publish /?

Kode keluar

Perintah SqlPackage mengembalikan kode keluar berikut:

  • 0 = berhasil
  • nonzero = kegagalan

Konten terkait

  • Last updated on