Condividi tramite


Informazioni di riferimento per l'interfaccia della riga di comando di SqlPackage

SqlPackage è un'utilità della riga di comando per la portabilità e le distribuzioni del database in ambienti Windows, Linux e macOS. L'interfaccia della riga di comando di SqlPackage analizza ogni chiamata per parametri, proprietà e variabili SQLCMD.

SqlPackage {parameters} {properties} {SQLCMD variables}
  • I parametri specificano l'azione da eseguire, i database di origine e di destinazione e altre impostazioni generali.
  • Le proprietà modificano il comportamento predefinito di un'azione.
  • Le variabili SQLCMD passano valori alle variabili SQLCMD nel file di origine.

Per creare un comando SqlPackage, specificare un'azione e i relativi parametri aggiuntivi. Facoltativamente, aggiungere proprietà e variabili SQLCMD per personalizzare ulteriormente il comando.

Nell'esempio seguente viene usato SqlPackage per creare un .dacpac file dello schema del database corrente:

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

Questi sono i parametri di questo esempio:

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

Queste sono le proprietà di questo esempio:

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

Azioni di SqlPackage

Action Description
Versione Restituisce il numero di build dell'applicazione SqlPackage.
estrarre Crea un file dell'applicazione livello dati (.dacpac) contenente lo schema o lo schema e i dati utente da un database SQL connesso.
Pubblica Aggiorna in modo incrementale uno schema del database in modo che corrisponda allo schema di un file di origine .dacpac . Se il database non esiste nel server, l'operazione di pubblicazione lo crea. In caso contrario, viene aggiornato un database esistente.
Esportazione Esporta un database SQL connesso, inclusi lo schema del database e i dati utente, in un file BACPAC (.bacpac).
Importa Importa i dati dello schema e della tabella da un file BACPAC in un nuovo database utente.
DeployReport Crea un report XML che rappresenta le modifiche che verrà eseguita da un'azione di pubblicazione.
DriftReport Crea un report XML che rappresenta le modifiche applicate a un database registrato dall'ultima registrazione.
script crea uno script di aggiornamento incrementale Transact-SQL che aggiorna lo schema di una destinazione affinché corrisponda allo schema di un'origine.

Nota

Anche se Microsoft Entra ID è il nuovo nome per Azure Active Directory (Azure AD), per evitare l'interruzione degli ambienti esistenti, Azure AD rimane ancora in alcuni elementi hardcoded, ad esempio campi dell'interfaccia utente, provider di connessione, codici di errore e cmdlet. In questo articolo i due nomi sono intercambiabili.

Parametri

Alcuni parametri vengono condivisi tra le azioni SqlPackage. Nella tabella seguente vengono riepilogati i parametri. Per altre informazioni, usare i collegamenti nell'intestazione della tabella per visitare le pagine di azione specifiche.

Parametro Forma breve estrarre Pubblica Esportazione Importa DeployReport DriftReport script
/AccessToken: /at Yes Yes Yes Yes Yes Yes Yes
/ClientId: /cid NO Yes NO NO NO NO NO
/DeployScriptPath: /dsp NO Yes NO NO NO NO Yes
/DeployReportPath: /drp NO Yes NO NO NO NO Yes
/Diagnostics: /d Yes Yes Yes Yes Yes Yes Yes
/DiagnosticsFile: /df Yes Yes Yes Yes Yes Yes Yes
/DiagnosticsPackageFile: /dpf NO Yes NO Yes NO NO NO
/MaxParallelism: /mp Yes Yes Yes Yes Yes Yes Yes
/OutputPath: /op NO NO NO NO Yes Yes Yes
/OverwriteFiles: /of Yes Yes Yes NO Yes Yes Yes
/Profile: /pr NO Yes NO NO Yes NO Yes
/Properties: /p Yes Yes Yes Yes Yes NO Yes
/Quiet: /q Yes Yes Yes Yes Yes Yes Yes
/Secret: /secr NO Yes NO NO NO NO NO
/SourceConnectionString: /scs Yes Yes Yes NO Yes NO Yes
/SourceDatabaseName: /sdn Yes Yes Yes NO Yes NO Yes
/SourceEncryptConnection: /sec Yes Yes Yes NO Yes NO Yes
/SourceFile: /sf NO Yes NO Yes Yes NO Yes
/SourcePassword: /sp Yes Yes Yes NO Yes NO Yes
/SourceServerName: /ssn Yes Yes Yes NO Yes NO Yes
/SourceTimeout: /st Yes Yes Yes NO Yes NO Yes
/SourceTrustServerCertificate: /stsc Yes Yes Yes NO Yes NO Yes
/SourceUser: /su Yes Yes Yes NO Yes NO Yes
/TargetConnectionString: /tcs NO NO NO Yes Yes Yes Yes
/TargetDatabaseName: /tdn NO Yes NO Yes Yes Yes Yes
/TargetEncryptConnection: /tec NO Yes NO Yes Yes Yes Yes
/TargetFile: /tf Yes NO Yes NO Yes NO Yes
/TargetPassword: /tp NO Yes NO Yes Yes Yes Yes
/TargetServerName: /tsn NO Yes NO Yes Yes Yes Yes
/TargetTimeout: /tt NO Yes NO Yes Yes Yes Yes
/TargetTrustServerCertificate: /ttsc NO Yes NO Yes Yes Yes Yes
/TargetUser: /tu NO Yes NO Yes Yes Yes Yes
/TenantId: /tid Yes Yes Yes Yes Yes Yes Yes
/UniversalAuthentication: /ua Yes Yes Yes Yes Yes Yes Yes
/Variables: /v NO NO NO NO Yes NO Yes

Proprietà

Le azioni SqlPackage supportano molte proprietà per modificare il comportamento predefinito di un'azione. Aggiungere /p:PropertyName=Value alla riga di comando per usare facoltativamente le proprietà. È possibile specificare più proprietà e specificare più proprietà più volte. Ad esempio, è possibile usare /p:TableData=Product /p:TableData=ProductCategory. Per altre informazioni sulle proprietà, vedere le pagine di azione specifiche.

Variabili SQLCMD

È possibile compilare variabili SQLCMD in un .dacpac file da un progetto SQL. Impostare queste variabili durante la distribuzione usando SqlPackage Publish o Script. Per altre informazioni sull'aggiunta di variabili SQLCMD a un progetto SQL, vedere Estensione progetti di database SQL.

Comandi di utilità

Versione

Visualizza la versione di sqlpackage come numero di build. Usarlo nei prompt interattivi e nelle pipeline automatizzate.

SqlPackage /Version

Guida

Usare /? o /help:True per visualizzare le informazioni sull'utilizzo di SqlPackage.

SqlPackage /?

Per informazioni sui parametri e sulle proprietà specifiche di una determinata azione, usare il parametro della Guida oltre al parametro dell'azione.

SqlPackage /Action:Publish /?

Codici di uscita

I comandi SqlPackage restituiscono i codici di uscita seguenti:

  • 0 = esito positivo
  • diverso da zero = errore