Bagikan melalui

Referensi SqlPackage CLI

  • Artikel

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 digunakan untuk menentukan tindakan yang akan dilakukan, database sumber dan target, dan pengaturan umum lainnya.
  • Properti digunakan untuk mengubah perilaku default tindakan.
  • Variabel SQLCMD digunakan untuk meneruskan nilai ke variabel SQLCMD dalam file sumber.

Untuk membuat perintah SqlPackage, Anda harus menentukan tindakan dan parameter tambahannya. Secara opsional Anda dapat menambahkan properti dan variabel SQLCMD untuk menyesuaikan perintah lebih lanjut.

Dalam contoh berikut, SqlPackage digunakan untuk membuat file .dacpac dari skema database saat ini:

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

Dalam contoh itu, parameternya adalah:

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

Dalam contoh tersebut, propertinya adalah:

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

Tindakan SqlPackage

  • 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 .dacpac sumber. Jika database tidak ada di server, operasi penerbitan membuatnya. Jika tidak, database yang ada diperbarui.

  • Ekspor: Mengekspor database SQL yang tersambung - termasuk struktur 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 pada database terdaftar sejak terakhir didaftarkan.

  • Skrip: Membuat skrip pembaruan bertahap Transact-SQL yang memperbarui skema target agar sesuai dengan skema sumber.

Catatan

Meskipun MICROSOFT Entra ID 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. Di bawah ini adalah tabel yang meringkas parameter, untuk informasi selengkapnya, klik halaman tindakan tertentu.

Parameter Formulir Pendek Ekstrak Mempublikasikan Ekspor Impor DeployReport DriftReport Skrip
/AccessToken: /Di x x x x x x x
/ClientId: /Cid x
/DeployScriptPath: /Dsp x x
/DeployReportPath: /drp x x
/Diagnostik: /D x x x x x x x
/DiagnosticsFile: /Df x x x x x x x
/MaxParallelism: /Mp x x x x x x x
/OutputPath: /Op x x x
/OverwriteFiles: /of x x x x x x
/Profil: /Pr x x x
/Properti: /p x x x x x x
/Tenang: /q x x x x x x x
/Rahasia: /secr x
/Source Koneksi ionString: /Scs x x x x x
/SourceDatabaseName: /Sdn x x x x x
/SourceEncrypt Koneksi ion: /Sec x x x x x
/SourceFile: /Sf x x x x
/SourcePassword: /Sp x x x x x
/SourceServerName: /Ssn x x x x x
/SourceTimeout: /St x x x x x
/SourceTrustServerCertificate: /stsc x x x x x
/SourceUser: /Su x x x x x
/Target Koneksi ionString: /Tcs x x x x
/TargetDatabaseName: /tdn x x x x x
/TargetEncrypt Koneksi ion: /Tec x x x x x
/TargetFile: /Tf x x x x
/TargetPassword: /Tp x x x x x
/TargetServerName: /Tsn x x x x x
/TargetTimeout: /Tt x x x x x
/TargetTrustServerCertificate: /ttsc x x x x x
/TargetUser: /Tu x x x x x
/TenantId: /tid x x x x x x x
/UniversalAuthentication: /Ua x x x x x x x
/Variabel: /v x x

Properti

Tindakan SqlPackage mendukung sejumlah besar properti untuk mengubah perilaku default tindakan. Penggunaan properti opsional dilakukan dengan menambahkan /p:PropertyName=Value ke baris perintah. Beberapa properti dapat ditentukan dan beberapa properti dapat ditentukan lebih dari sekali (misalnya /p:TableData=Product /p:TableData=ProductCategory). Untuk informasi selengkapnya tentang properti, lihat halaman tindakan tertentu.

Variabel SQLCMD

Variabel SQLCMD dapat dibangun ke dalam file .dacpac dari proyek SQL, lalu diatur selama penyebaran dengan SqlPackage Publish atau Script. Untuk informasi selengkapnya tentang menambahkan variabel SQLCMD ke proyek SQL, lihat dokumentasi proyek SQL.

Perintah utilitas

Versi

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

SqlPackage /Version

Bantuan

Anda dapat menampilkan informasi penggunaan SqlPackage dengan menggunakan /? atau /help:True.

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

Langkah berikutnya