Sommario
- Opzioni formato T SQL
- Anteprima impatto
- Profili del formattatore SQL
- Importazione / esportazione di profili del formattatore SQL
- Formatta oggetto in un batch
- Formatta script T-SQL in un batch
- Integrazione host
- DPI elevato e supporto della risoluzione 4K
A nessuno piace controllare e leggere un sacco di testo disordinato e non formattato. Quando si tratta di leggere un codice SQL complesso quel problema può diventare ancora più difficile, soprattutto se sei tu a doverlo districare.
Il codice SQL può essere formattato con uno stile che ne faciliti la lettura , soprattutto se l’intero team utilizza lo stesso. Il codice SQL pulito, ben formattato (coerente) può essere letto molto più velocemente del codice SQL scritto in modo incoerente, indipendentemente dal fatto che l’incoerenza sia tra membri del team e oggetti diversi o anche all’interno dello stesso script dell’oggetto stesso. Il codice SQL ben organizzato e formattato può essere rivisto in modo più efficiente. Consegnare un progetto a un altro team oa un cliente con un codice SQL ben formattato sarà molto più agevole e molto più apprezzato.
Il problema principale con la formattazione degli script SQL è che non esiste uno stile o standard di come l’SQL il codice dovrebbe essere formattato e tutto è generalmente una questione di preferenza. La soluzione migliore in questo caso è impostare gli standard a cui tu e il tuo team in azienda vi atteniate e quindi assicurarvi che siano applicati in modo coerente.
Tutto il codice SQL può essere formattato manualmente, il che richiede molto tempo ma esistono strumenti di terze parti e possono essere utilizzati per formattare in modo rapido ed efficiente.
Questo articolo descriverà e introdurrà alcune linee guida e aspettative di base su ciò che un perfetto strumento di formattazione di query SQL dovrebbe avere per raggiungere il tuo obiettivo per stabilire uno stile di formato coerente e standard (standard) e come applicare quello stile a uno script T-SQL o a molti script o oggetti T-SQL con un clic.
Uno di questi strumenti di formattazione è ApexSQL Refactor, componente aggiuntivo che può essere integrato in SQL Server Management Studio (SSMS) o Visual Studio (VS). ApexSQL Refactor ha oltre 200 opzioni di formattazione di query SQL e funzionalità per applicare uno stile su uno o più script T-SQL contemporaneamente.
Opzioni
Il primo obiettivo è impostare le opzioni di base. Una delle principali preoccupazioni quando si tratta di stabilire standard è quali parole chiave T-SQL devono o non devono essere inserite in maiuscolo nel codice.
Nella scheda Maiuscole della finestra Opzioni, è possibile impostare le regole per le maiuscole per seguente:
Per impostare la regola appropriata per le maiuscole, è possibile utilizzare le seguenti opzioni: MAIUSCOLO, minuscolo, minuscolo, camelCase, maiuscolo , Case corrette o lasciando le regole di layout della query SQL predefinite deselezionando l’opzione:
Alcuni sviluppatori preferiscono le parole chiave SQL, i tipi di dati , ecc. in MAIUSCOLO e altri sviluppatori, tuttavia, come le parole chiave SQL in minuscolo.
La soluzione migliore quando si sceglie uno strumento è selezionarne uno in grado di gestire tutte quelle diverse preferenze.
Nel primo esempio, le parole chiave sono maiuscole e i tipi di dati sono minuscoli:
Nella secondo esempio, le parole chiave sono minuscole e da i tipi ta sono maiuscoli:
Il terzo esempio, le parole chiave e i tipi di dati sono maiuscoli:
Anteprima dell’impatto del formattatore SQL
Una delle cose fondamentali che dovrebbe avere ogni strumento di layout SQL è la possibilità di visualizzare l’anteprima visiva come appare il codice SQL dopo aver aggiunto alcune opzioni.
ApexSQL Refactor ha un’anteprima dell’impatto del formato del codice SQL che mostra una chiara visione e una visione dell’impatto di qualsiasi opzione cambia immediatamente quando le fai. Se non ti piace come appare, può essere facilmente modificato e ripristinato senza salvare:
Impostazione delle regole per l’uso delle maiuscole di parole chiave SQL, tipi di dati, identificatori (nomi di oggetti), funzioni di sistema, variabili è solo un elemento dell’insieme dello stile.
Regole di layout del codice SQL per alias, commenti, virgole, spaziatura, allineamento, ecc., deve essere impostato anche per avere un codice SQL valido, coerente, leggibile e ben formattato.
Per tutte le cose sopra menzionate uno strumento di formattazione deve avere opzioni per le impostazioni queste Regole per lo stile delle query SQL.
ApexSQL Refactor ha tutte queste opzioni per soddisfare le tue esigenze.Ulteriori informazioni sulle opzioni del formattatore SQL possono essere trovate dai collegamenti seguenti:
- Regole di formattazione SQL – Virgole e spaziatura in T-SQL
- Regole di formattazione SQL – Regolari e delimitate Identificatori T-SQL
- Regole di formattazione SQL – Commenti sul codice SQL
- Regole di formattazione SQL – Convenzioni di denominazione SQL e regole di maiuscola
- Regole di formattazione SQL – Terminazione Istruzioni SQL con punto e virgola
Profili del formattatore di query SQL
Essere in grado di impostare uno stile desiderato, salvare quello stile e condividere lo stile con i colleghi è un’altra cosa che ogni SQL Server lo strumento formattatore deve avere. Inoltre, avendo una selezione preimpostata di profili preconfigurati, out-of-the-box è molto utile.
Con ApexSQL Refactor gli utenti possono:
- salvare preferito Opzioni del formattatore di query SQL in un profilo riutilizzabile
- raggruppa e classifica gli stili di formattazione
- modifica rapidamente i profili esistenti
- evita conflitti con altri utenti
Inoltre, ApexSQL Refactor viene fornito con quattro profili incorporati
- ApexSQL – contiene quello che abbiamo determinato essere un buon standard di formattazione SQL
- Compatto – imposta l’opzione per i rientri a 0 (zero) spazio, tutti gli spazi aggiuntivi vengono deselezionati e le righe vuote vengono rimosse per una query in cui il codice SQL sembra denso
- Esteso – è l’opposto del profilo Compatto. Questo profilo aggiunge righe vuote prima / dopo ogni affermazione, commenti. Aggiungi spazio intorno agli operatori logici e aritmetici
- MSDN SQL BOL: imita lo stile utilizzato nel sito delle risorse MSDN
Questi quattro profili incorporati non possono essere modificati in alcun modo , ma è possibile creare una copia di questi profili di formattazione delle query SQL incorporati facendo clic sul pulsante Copia e quindi modificarli nel modo preferito:
Inoltre, è possibile creare un nuovo profilo di formattatore SQL facendo clic sul pulsante Nuovo:
Importazione / esportazione di profili in formato SQL
Una volta creato il profilo perfetto, è importante poterlo esportare per renderlo accessibile ad altri; così come per i destinatari del profilo per poterlo importare facilmente. ApexSQL Refactor fornisce proprio questa funzionalità
Per esportare i profili e condividerli con i colleghi, premere il pulsante Esporta nella finestra Opzioni:
Per importare i profili nella finestra Opzioni, premere il pulsante Importa.
Ulteriori informazioni sui profili di ApexSQL Refactor sono disponibili nella pagina Come personalizzare i profili di formattazione SQL.
Elaborazione di oggetti in un batch
Una volta creato il profilo di formato e impostate le opzioni, la formattazione del codice SQL può iniziare sul serio, con un oggetto o uno script alla volta. Ma che dire dell’elaborazione di tutto in un database in una volta?
L’elaborazione di molti oggetti SQL come le procedure memorizzate individualmente può essere un lavoro molto difficile e che richiede tempo, ovviamente.
Quindi , un’altra cosa che possiamo aggiungere è che ogni strumento di formattazione dovrebbe avere una funzionalità in grado di formattare più oggetti SQL con un singolo profilo SQL desiderato contemporaneamente.
ApexSQL Refactor ha la funzione Formatta oggetti SQL che consente esattamente quello. In Esplora oggetti, selezionare un database in cui si trovano gli oggetti che si desidera formattare, fare clic con il tasto destro e, dal menu contestuale, scegliere il comando Formato oggetti SQL:
Tutti gli oggetti basati su script, ad es visualizzazione, le procedure memorizzate verranno elencate nella finestra Formato oggetti SQL:
Nella casella combinata Profilo, selezionare l’SQL desiderato profilo del formattatore (ad esempio ApexSQL) e, dall’elenco, scegliere gli oggetti SQL che si desidera formattare, fare clic sul pulsante Crea script, che aprirà uno script nell’editor di query, quindi fare clic sul pulsante Esegui (F5):
Per confermare che gli oggetti SQL sono formattati con il profilo desiderato, torna alla finestra Formatta oggetti SQL, sotto la casella combinata Profilo, scegli un profilo e, nell’elenco degli oggetti SQL, sotto la colonna OK con l’icona del segno di spunta verde, verranno indicati gli oggetti SQL formattati, tutti gli altri oggetti SQL saranno contrassegnati con l’icona x rossa che indica che non sono formattati con il profilo selezionato :
Inoltre, prima di formattare uno script oggetto SQL con il profilo desiderato, è possibile mostrare gli stessi script SQL in modo che l’utente può vedere e come apparirà dopo l’elaborazione. In questo modo, può essere confrontato selezionando un oggetto SQL desiderato dall’elenco, fare clic con il tasto destro e selezionare il pulsante Confronta:
Batch scripts Formato T-SQL
Un’altra cosa che deve essere presa in considerazione, quando si sceglie il giusto strumento di layout SQL, è la possibilità di formattare script SQL e script in cartelle in batch.
In situazioni in cui, sulla macchina, ci sono molti script SQL il cui codice deve essere controllato e quel codice è in un pasticcio piuttosto grande come nell’immagine seguente:
Controllare il codice in questi script SQL può essere impegnativo.
Una soluzione per questo è aprire lo script SQL in SSMS e formattalo con il tuo profilo preferito facendo clic sul pulsante Formato SQL:
Questo risolve un problema per uno script SQL, ma per più di questi script SQL, è necessario fornire una soluzione più rapida.
ApexSQL Refactor offre la funzione Format SQL scripts come soluzione per questo tipo di problema. Dal menu ApexSQL Refactor, sotto il sottomenu Other formatting, seleziona il comando Format SQL scripts:
The Format SQL si aprirà la finestra degli script, nell’elenco navigare e selezionare gli script SQL, scegliere il profilo del formattatore SQL desiderato sotto la casella combinata Profilo e premere il pulsante OK:
Tutto il codice negli script SQL selezionati verrà formattato con lo stile di formattazione SQL desiderato che la revisione degli script SQL rende molto più semplice.
Integrazione host
Un altro importante elemento quando si sceglie il giusto strumento di styling SQL è la sua integrazione diretta nelle applicazioni host che normalmente si utilizza per la codifica SQL come SSMS o Visual Studio.
Fortunatamente, ApexSQL Refactor supporta l’integrazione da SSMS 2012 e versioni successive e supporta l’integrazione in Visual Studio dalla versione VS 2010 e successive.
Ciò significa che puoi aggiungere potenti funzionalità di formattazione SQL e migliorare la produttività della codifica senza mai lasciare ng la casa del tuo editor preferito
Integrazione host senza soluzione di continuità ed esperienza utente coerente
L’integrazione in un’applicazione host è una cosa. L’integrazione perfetta con un’esperienza utente finale coerente è un’altra. Molti componenti aggiuntivi sono cattivi ospiti, occupano spazio nel menu, offrono colori e icone disgiunti e generalmente sono visivamente “rumorosi” e invadenti. ApexSQL Refactor è un ospite educato che si integra perfettamente negli ambienti host, quasi come se fosse parte dell’IDE stesso. Questa esperienza utente coerente include iconografia, stile visivo e temi.
I temi colore consentono all’utente di modificare l’aspetto visivo in base alle proprie preferenze e un buon strumento di terze parti dovrebbe corrispondere a questa capacità. ApexSQL Refactor supporta SSMS e colore visivo temi, ma meglio ancora cambieranno automaticamente per adattarsi alle impostazioni del tema host.
Consulta questo articolo per saperne di più.
Tema di colore scuro di Visual Studio:
Tema di colore blu SSMS:
Una nota , ApexSQL Refactor supporta il tema di colore scuro SSMS:
Anche se il tema del colore non è ancora ufficiale; per coloro che lo desiderano sapere come impostare il d Il tema colore ark in SSMS 17 può essere trovato nella pagina Configurazione del tema scuro nella pagina Studio di gestione di SQL Server.
Inoltre, tutte le icone che compaiono nei comandi, nelle finestre di dialogo, nei modelli, ecc. in ApexSQL Refactor vengono ereditate dalla libreria di immagini di Visual Studio. Alcune delle icone della libreria sono state ridisegnate per essere più intuitive, semplici e sono simboli facilmente riconoscibili.
Ulteriori informazioni possono essere trovate sul dizionario del linguaggio visivo per Visual Studio per iconografia, colori e altri concetti visivi applicati in Pagina degli strumenti / componenti aggiuntivi di ApexSQL.
Supporto per alta risoluzione DPI e 4K
ApexSQL Refactor supporta DPI elevato e risoluzione 4K, il che significa che quando viene eseguito ApexSQL Refactor, windows (ad es. ) in cui imposti tutte le opzioni del formattatore SQL e lo schermo non sarà sfocato sul tuo monitor 4K:
Nota: VS gestisce molto bene 4K e DPI elevato, ma SSMS non funziona così bene sui monitor 4K. Per il problema 4K e DPI elevato in SSMS 2016 e versioni successive, è disponibile una soluzione che può essere visualizzata nella pagina Come abilitare DPI elevato in SSMS (SQL Server Management Studio) – Suggerimenti, trucchi e problemi.
