Compartir a través de

Referencia de la CLI de SqlPackage

SqlPackage es una utilidad de línea de comandos para la portabilidad y las implementaciones de bases de datos en entornos windows, Linux y macOS. La interfaz de la línea de comandos (CLI) de SqlPackage analiza cada invocación de parámetros, propiedades y variables SQLCMD.

SqlPackage {parameters} {properties} {SQLCMD variables}
  • Los parámetros especifican la acción que se va a realizar, las bases de datos de origen y de destino y otras configuraciones generales.
  • Las propiedades modifican el comportamiento predeterminado de una acción.
  • Las variables SQLCMD pasan valores a las variables SQLCMD del archivo de origen.

Para crear un comando SqlPackage, especifique una acción y sus parámetros adicionales. Opcionalmente, agregue propiedades y variables SQLCMD para personalizar aún más el comando.

En el ejemplo siguiente se usa SqlPackage para crear un .dacpac archivo del esquema de base de datos actual:

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

Estos son los parámetros de este ejemplo:

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

Estas son las propiedades de este ejemplo:

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

Acciones de SqlPackage

Acción Description
Versión Devuelve el número de compilación de la aplicación SqlPackage.
extraer Crea un archivo de aplicación de capa de datos (.dacpac) que contiene el esquema o esquema y los datos de usuario de una base de datos SQL conectada.
publicar Actualiza incrementalmente un esquema de base de datos para que coincida con el esquema de un archivo de origen .dacpac . Si la base de datos no existe en el servidor, la operación de publicación la crea. De lo contrario, se actualiza una base de datos existente.
exportar Exporta una base de datos SQL conectada ( incluido el esquema de base de datos y los datos de usuario) a un archivo BACPAC (.bacpac).
importar Importa los datos de esquema y tabla de un archivo BACPAC en una nueva base de datos de usuario.
DeployReport Crea un informe XML que representa los cambios que realizaría una acción de publicación.
driftReport Crea un informe XML que representa los cambios aplicados a una base de datos registrada desde que se registró por última vez.
script de crea un script de actualización incremental de Transact-SQL que actualiza el esquema de un destino para que coincida con el esquema de un origen.

Nota

Aunque Microsoft Entra ID es el nuevo nombre para Azure Active Directory (Azure AD), para evitar interrupciones de los entornos existentes, Azure AD sigue estando en algunos elementos codificados de forma dura, como campos de interfaz de usuario, proveedores de conexiones, códigos de error y cmdlets. En este artículo, los dos nombres son intercambiables.

Parámetros

Algunos parámetros se comparten entre las acciones SqlPackage. En la tabla siguiente se resumen los parámetros. Para obtener más información, use los vínculos del encabezado de tabla para visitar las páginas de acciones específicas.

Parámetro Formulario corto extraer publicar exportar importar DeployReport driftReport script de
/AccessToken: /at Sí Sí Sí Sí Sí Sí Sí
/ClientId: /cid No Sí No No No No No
/DeployScriptPath: /dsp No Sí No No No No Sí
/DeployReportPath: /drp No Sí No No No No Sí
/Diagnostics: /d Sí Sí Sí Sí Sí Sí Sí
/DiagnosticsFile: /df Sí Sí Sí Sí Sí Sí Sí
/DiagnosticsPackageFile: /dpf No Sí No Sí No No No
/MaxParallelism: /mp Sí Sí Sí Sí Sí Sí Sí
/OutputPath: /op No No No No Sí Sí Sí
/OverwriteFiles: /of Sí Sí Sí No Sí Sí Sí
/Profile: /pr No Sí No No Sí No Sí
/Properties: /p Sí Sí Sí Sí Sí No Sí
/Quiet: /q Sí Sí Sí Sí Sí Sí Sí
/Secret: /secr No Sí No No No No No
/SourceConnectionString: /scs Sí Sí Sí No Sí No Sí
/SourceDatabaseName: /sdn Sí Sí Sí No Sí No Sí
/SourceEncryptConnection: /sec Sí Sí Sí No Sí No Sí
/SourceFile: /sf No Sí No Sí Sí No Sí
/SourcePassword: /sp Sí Sí Sí No Sí No Sí
/SourceServerName: /ssn Sí Sí Sí No Sí No Sí
/SourceTimeout: /st Sí Sí Sí No Sí No Sí
/SourceTrustServerCertificate: /stsc Sí Sí Sí No Sí No Sí
/SourceUser: /su Sí Sí Sí No Sí No Sí
/TargetConnectionString: /tcs No No No Sí Sí Sí Sí
/TargetDatabaseName: /tdn No Sí No Sí Sí Sí Sí
/TargetEncryptConnection: /tec No Sí No Sí Sí Sí Sí
/TargetFile: /tf Sí No Sí No Sí No Sí
/TargetPassword: /tp No Sí No Sí Sí Sí Sí
/TargetServerName: /tsn No Sí No Sí Sí Sí Sí
/TargetTimeout: /tt No Sí No Sí Sí Sí Sí
/TargetTrustServerCertificate: /ttsc No Sí No Sí Sí Sí Sí
/TargetUser: /tu No Sí No Sí Sí Sí Sí
/TenantId: /tid Sí Sí Sí Sí Sí Sí Sí
/UniversalAuthentication: /ua Sí Sí Sí Sí Sí Sí Sí
/Variables: /v No No No No Sí No Sí

Propiedades

Las acciones sqlPackage admiten muchas propiedades para modificar el comportamiento predeterminado de una acción. Agregue /p:PropertyName=Value a la línea de comandos para usar propiedades opcionalmente. Puede especificar varias propiedades y especificar algunas propiedades más de una vez. Por ejemplo, puede usar /p:TableData=Product /p:TableData=ProductCategory. Para obtener más información sobre las propiedades, consulte las páginas de acciones específicas.

Variables SQLCMD

Puede compilar variables SQLCMD en un .dacpac archivo desde un proyecto de SQL. Establezca estas variables durante la implementación con SqlPackage Publish o Script. Para obtener más información sobre cómo agregar variables SQLCMD a un proyecto de SQL, vea Extensión proyectos de SQL Database.

Comandos de utilidad

Versión

Muestra la versión de sqlpackage como un número de compilación. Úselo en avisos interactivos y en canalizaciones automatizadas.

SqlPackage /Version

Ayuda

Use /? o /help:True para mostrar información de uso de SqlPackage.

SqlPackage /?

Para obtener información de parámetros y propiedades específica de una acción determinada, use el parámetro help además del parámetro de esa acción.

SqlPackage /Action:Publish /?

Códigos de salida

Los comandos SqlPackage devuelven los siguientes códigos de salida:

  • 0 = correcto
  • nonzero = failure

Contenido relacionado

  • Last updated on