Sdílet prostřednictvím

Referenční informace k rozhraní příkazového řádku SqlPackage

  • Článek

SqlPackage je nástroj příkazového řádku pro přenositelnost a nasazení databáze v prostředích s Windows, Linuxem a macOS. Rozhraní příkazového řádku SqlPackage (CLI) analyzuje každé vyvolání parametrů, vlastností a proměnných SQLCMD.

SqlPackage {parameters} {properties} {SQLCMD variables}
  • parametry slouží k určení akce, která se má provést, zdrojové a cílové databáze a další obecná nastavení.
  • Vlastnosti slouží k úpravě výchozího chování akce.
  • proměnné SQLCMD slouží k předávání hodnot proměnným SQLCMD ve zdrojovém souboru.

Chcete-li vytvořit příkaz SqlPackage, musíte zadat akci a její další parametry. Volitelně můžete přidat vlastnosti a proměnné SQLCMD pro další přizpůsobení příkazu.

V následujícím příkladu se SqlPackage používá k vytvoření souboru .dacpac aktuálního schématu databáze:

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

V tomto příkladu byly parametry:

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

V tomto příkladu byly vlastnosti:

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

Akce SqlPackage

  • verze: Vrátí číslo sestavení aplikace SqlPackage.

  • Extrahovat: Vytvoří soubor aplikace datové vrstvy (.dacpac) obsahující schéma nebo schéma a uživatelská data z připojené databáze SQL.

  • Publikovat: Přírůstkově aktualizuje schéma databáze tak, aby odpovídalo schématu zdrojového souboru .dacpac. Pokud databáze na serveru neexistuje, operace publikování ji vytvoří. V opačném případě se aktualizuje existující databáze.

  • Export: Exportuje připojenou databázi SQL , včetně schématu databáze a uživatelských dat, do souboru BACPAC (.bacpac).

  • Import: Importuje data schématu a tabulky ze souboru BACPAC do nové uživatelské databáze.

  • DeployReport: Vytvoří sestavu XML představující změny, které provede akce publikování.

  • DriftReport: Vytvoří sestavu XML představující změny použité u registrované databáze od poslední registrace.

  • skript: Vytvoří Transact-SQL skript přírůstkové aktualizace, který aktualizuje schéma cíle tak, aby odpovídalo schématu zdroje.

Poznámka

I když je ID Microsoft Entra novým názvem proAzure Active Directory (Azure AD), aby se zabránilo narušení existujících prostředí, Azure AD stále zůstává v některých pevně zakódovaných prvcích, jako jsou pole uživatelského rozhraní, zprostředkovatelé připojení, kódy chyb a rutiny. V tomto článku jsou tyto dva názvy zaměnitelné.

Parametry

Některé parametry jsou sdíleny mezi akcemi SqlPackage. Níže je tabulka se souhrnem parametrů, kde najdete další informace, kliknutím na konkrétní stránky akcí.

Parametr Krátký formulář extrahování publikovat exportu importu DeployReport DriftReport skriptů
/AccessToken: /at x x x x x x x
/ClientId: /cid x
/DeployScriptPath: /dsp x x
/DeployReportPath: /drp x x
/Diagnostics: /d x x x x x x x
/DiagnosticsFile: /df x x x x x x x
/DiagnosticsPackageFile: /dpf x x
/MaxParallelism: /mp x x x x x x x
/OutputPath: /op x x x
/OverwriteFiles: /of x x x x x x
/Profile: /pr x x x
/Vlastnosti: /p x x x x x x
/Quiet: /q x x x x x x x
/Secret: /secr x
/SourceConnectionString: /scs x x x x x
/SourceDatabaseName: /sdn x x x x x
/SourceEncryptConnection: /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
/TargetConnectionString: /tcs x x x x
/TargetDatabaseName: /tdn x x x x x
/TargetEncryptConnection: /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
/Variables: /v x x

Vlastnosti

Akce SqlPackage podporují velký počet vlastností pro úpravu výchozího chování akce. Volitelné použití vlastností se provádí přidáním /p:PropertyName=Value do příkazového řádku. Lze zadat více vlastností a některé vlastnosti lze zadat více než jednou (např. /p:TableData=Product /p:TableData=ProductCategory). Další informace ovlastnostech

Proměnné SQLCMD

Proměnné SQLCMD lze integrovat do souboru .dacpac z projektu SQL a pak nastavit během nasazování pomocí nástroje SqlPackage Publikovat nebo Skript. Další informace o přidávání proměnných SQLCMD do projektu SQL najdete v dokumentaci k projektům SQL .

Příkazy nástroje

Verze

Zobrazí verzi sqlpackage jako číslo buildu. Lze použít v interaktivních výzev a v automatizovaných kanálech.

SqlPackage /Version

Pomoc

Informace o využití SqlPackage můžete zobrazit pomocí /? nebo /help:True.

SqlPackage /?

Informace o parametrech a vlastnostech specifické pro konkrétní akci použijte kromě parametru této akce také parametr nápovědy.

SqlPackage /Action:Publish /?

Ukončovací kódy

Příkazy SqlPackage vrátí následující ukončovací kódy:

  • 0 = úspěch
  • nonzero = selhání

Další kroky

  • Další informace o extrakci SqlPackage
  • Další informace o publikování SqlPackage
  • Další informace o exportu SqlPackage
  • Další informace o importu SqlPackage
  • Další informace o řešení potíží s sqlPackage
  • Podělte se o zpětnou vazbu k SqlPackage v úložišti DacFx na GitHubu