Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
El formato coherente facilita la lectura, revisión y mantenimiento de Transact-SQL (T-SQL), especialmente cuando varias personas contribuyen al mismo código base. La extensión MSSQL para Visual Studio Code incluye un formateador SQL integrado (versión preliminar) que puedes ejecutar a demanda, configurar para aplicar formato automáticamente al guardar y personalizar a través de la configuración de Visual Studio Code.
La funcionalidad de formateo T-SQL en la extensión MSSQL está construida sobre ScriptDOM, una biblioteca .NET de código abierto que analiza T-SQL y genera scripts basados en árboles de sintaxis abstracta.
Formato a petición
Puedes formatear T-SQL en cualquier ventana del editor. El formador funciona sobre todo el documento o solo sobre el texto que seleccionas.
Para formatear T-SQL bajo demanda, utiliza uno de los siguientes métodos:
Menú contextual: Haz clic derecho en una ventana del editor T-SQL y selecciona Formatear documento o Selección de formato.
Paleta de comandos: Ejecutar documento de formato o selección de formato.
Acceso directo de teclado: Para Formatear documento, pulsa Shift+Alt+F en Windows y Linux, o Shift+Option+F en macOS. Para la selección de formato, pulsa Ctrl+K, Ctrl+F en Windows y Linux, o Cmd+K, Cmd+F en macOS.
Formatear al guardar
En Visual Studio Code, la configuración estándar del editor controla el formato al guardar, en lugar de una configuración dedicada de formateador MSSQL.
Utiliza las siguientes configuraciones en tu archivo Visual Studio Code settings.json para formatear T-SQL automáticamente cada vez que guardes un archivo:
{
"[sql]": {
"editor.formatOnSave": true
}
}
Configuración de las opciones de formato
Configura el formato en la interfaz de configuración de Visual Studio Code o en usuario o espacio de trabajosettings.json.
En el editor de Configuración, buscaFormatoMssql> para ver las opciones disponibles. En settings.json, utiliza los ajustes correspondientes de mssql.format.*.
El formador de vista previa está activado por defecto. Sus opciones usan el espacio de nombres
mssql.format.options.*.Los cinco ajustes existentes del formatador permanecen disponibles cuando el formatador de vista previa está activado. El formateador de vista previa añade la configuración
mssql.format.options.*.
Configuraciones admitidas
Las tablas muestran los ajustes existentes del formatador seguidos de los ajustes de previsualización del formatador.
Configuraciones existentes del formatador
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.alignColumnDefinitionsInColumns |
bool | false |
Alinear las definiciones de columnas en columnas. |
mssql.format.datatypeCasing |
enumeración | none |
Formatea los tipos de datos como uppercase, lowercase, o none (no formateado). |
mssql.format.keywordCasing |
enumeración | none |
Formatea palabras clave como uppercase, lowercase, o none (no formateado). |
mssql.format.placeCommasBeforeNextStatement |
bool | false |
Coloca comas al principio de cada elemento de una lista, por ejemplo , mycolumn2, en lugar de al final, por ejemplo mycolumn1,. |
mssql.format.placeSelectStatementReferencesOnNewLine |
bool | false |
Coloca referencias en una SELECT declaración en líneas separadas. Para SELECT C1, C2 FROM T1, tanto C1 como C2 están en líneas separadas. |
Configuración de vista previa del formateador
Estos mssql.format.options.* ajustes se suman a los ajustes existentes del formateador cuando activas el formateador de vista previa.
General
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.enablePreviewFormatter |
bool | true |
Usa el formador SQL (Vista previa). |
mssql.format.showParseErrorNotification |
bool | true |
Muestra una notificación cuando el formatador no pueda analizar completamente el T-SQL. |
mssql.format.options.sqlVersion |
enumeración | sql170 |
Versión de T-SQL utilizada para analizar y generar scripts formateados. |
mssql.format.options.sqlEngineType |
enumeración | all |
Tipo Motor de base de datos usado para analizar y generar scripts formateados. Los valores válidos son all, standaloney sqlAzure. |
Alineación
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.options.alignClauseBodies |
bool | true |
Alinee los cuerpos de FROM, WHERE, GROUP BY y cláusulas similares. |
mssql.format.options.alignColumnDefinitionFields |
bool | true |
Alinee los campos de definición de columna, como el nombre, el tipo y las restricciones. |
mssql.format.options.alignSetClauseItem |
bool | true |
Alinear SET los elementos de las cláusulas en las UPDATE sentencias. |
Paths
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.options.allowExternalLanguagePaths |
bool | true |
Permite que el contenido de idiomas externos use rutas de archivo. |
mssql.format.options.allowExternalLibraryPaths |
bool | true |
Permite que el contenido externo de la biblioteca use rutas de archivo. |
Formatting
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.options.asKeywordOnOwnLine |
bool | true |
Coloque AS en su propia línea. |
mssql.format.options.keywordCasing |
enumeración | uppercase |
Estilo de uso de mayúsculas y minúsculas en palabras clave. Los valores válidos son uppercase, lowercasey pascalCase. |
mssql.format.options.preserveComments |
bool | true |
Mantener los comentarios durante el formateo. |
mssql.format.options.numNewlinesAfterStatement |
int | 1 |
Número de saltos de línea tras cada afirmación, desde 0 hasta 5. |
Sangría
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.options.indentSetClause |
bool | false |
Cláusula Indent en SETUPDATE instrucciones. |
mssql.format.options.indentViewBody |
bool | false |
Aplicar sangría al cuerpo VIEW. |
Multilínea
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.options.multilineInsertSourcesList |
bool | true |
INSERT orígenes como multilínea. |
mssql.format.options.multilineInsertTargetsList |
bool | true |
INSERT columnas como multilínea. |
mssql.format.options.multilineSelectElementsList |
bool | true |
SELECT columnas como multilínea. |
mssql.format.options.multilineSetClauseItems |
bool | true |
SET elementos en varias líneas. |
mssql.format.options.multilineViewColumnsList |
bool | true |
VIEW columnas como multilínea. |
mssql.format.options.multilineWherePredicatesList |
bool | true |
WHERE predicados como multilínea. |
Nueva línea
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.options.newLineBeforeCloseParenthesisInMultilineList |
bool | true |
Nueva línea antes del paréntesis de cierre en una lista multilínea. |
mssql.format.options.newLineBeforeFromClause |
bool | true |
Nueva línea antes de la cláusula FROM. |
mssql.format.options.newLineBeforeGroupByClause |
bool | true |
Salto de línea antes de la cláusula GROUP BY. |
mssql.format.options.newLineBeforeHavingClause |
bool | true |
Nueva línea antes de la cláusula HAVING. |
mssql.format.options.newLineBeforeJoinClause |
bool | true |
Nueva línea antes de la cláusula JOIN. |
mssql.format.options.newLineBeforeOffsetClause |
bool | true |
Nueva cláusula de línea antes OFFSET . |
mssql.format.options.newLineBeforeOpenParenthesisInMultilineList |
bool | false |
Nueva línea antes de la apertura entre paréntesis en la lista multilínea. |
mssql.format.options.newLineBeforeOrderByClause |
bool | true |
Nueva línea antes de ORDER BY. |
mssql.format.options.newLineBeforeOutputClause |
bool | true |
Nueva línea antes de la cláusula OUTPUT. |
mssql.format.options.newLineBeforeWhereClause |
bool | true |
Nueva línea antes de la cláusula WHERE. |
mssql.format.options.newLineBeforeWindowClause |
bool | true |
Nueva línea antes de la cláusula WINDOW. |
mssql.format.options.newlineFormattedCheckConstraint |
bool | false |
Restricción con formato de CHECK nueva línea. |
mssql.format.options.newLineFormattedIndexDefinition |
bool | false |
Definición de índice con formato de salto de línea. |
Spacing
| Configuración | Tipo | Predeterminado | Description |
|---|---|---|---|
mssql.format.options.spaceBetweenDataTypeAndParameters |
bool | true |
Espacio entre el tipo de dato y los paréntesis, por ejemplo VARCHAR (255). |
mssql.format.options.spaceBetweenParametersInDataType |
bool | true |
Espacio entre parámetros en los tipos de datos. |
Ejemplo de archivo de configuración
{
"mssql.format.options.keywordCasing": "lowercase",
"mssql.format.options.alignClauseBodies": false,
"mssql.format.options.numNewlinesAfterStatement": 2,
"[sql]": {
"editor.formatOnSave": true
}
}
Establecer el formador por defecto
Para establecer la extensión MSSQL como predeterminada, selecciona Configurar Formateador por defecto...>SQL Server (mssql), o añadir la siguiente configuración asettings.json:
{
"[sql]": {
"editor.defaultFormatter": "ms-mssql.mssql"
}
}