Table des matières
- Options de format T SQL
- Aperçu de l’impact
- Profils de formateur SQL
- Importation / exportation de profils de formateur SQL
- Formater un objet dans un lot
- Mettre en forme des scripts T-SQL dans un lot
- Intégration de l’hôte
- Prise en charge de haute résolution DPI et 4K
Personne n’aime vérifier et lire une tonne de texte désordonné et non formaté. Lorsqu’il s’agit de lire un code SQL complexe, ce problème peut devenir encore plus difficile, surtout si vous êtes celui qui doit le démêler.
Le code SQL peut être formaté avec un style facilitant sa lecture , surtout si toute l’équipe utilise le même. Un code SQL propre et bien formaté (cohérent) peut être lu beaucoup plus rapidement qu’un code SQL écrit de manière incohérente, que l’incohérence se situe entre les membres de l’équipe et différents objets ou même dans le même script de l’objet lui-même. Un code SQL bien organisé et formaté peut être revu plus efficacement. Confier un projet à une autre équipe ou à un client avec un code SQL bien formaté sera beaucoup plus fluide et beaucoup plus apprécié.
Le principal problème avec le formatage des scripts SQL est qu’il n’y a pas de style ou de normes sur la façon dont le SQL le code doit être formaté et tout est généralement une question de préférence. La meilleure solution ici est de définir les normes auxquelles vous et votre équipe dans l’entreprise vous tiendrez, puis de vous assurer qu’elles sont appliquées de manière cohérente.
Tout le code SQL peut être formaté manuellement, ce qui prend beaucoup de temps mais des outils tiers existent et peuvent être utilisés pour formater rapidement et efficacement.
Cet article décrira et présentera quelques directives et attentes de base sur ce qu’un outil de formatage de requête SQL parfait devrait avoir pour atteindre votre objectif pour établir un style de format cohérent et standard (standard) et comment appliquer ce style à un script T-SQL ou à plusieurs scripts ou objets T-SQL en un seul clic.
Un de ces outils de formatage est ApexSQL Refactor, complément qui peut être intégré dans SQL Server Management Studio (SSMS) ou Visual Studio (VS). ApexSQL Refactor a plus de 200 options de formatage de requêtes SQL et des fonctionnalités pour appliquer un style sur un ou plusieurs scripts T-SQL à la fois.
Options
Le premier objectif est de définir les options de base. L’une des principales préoccupations lors de l’établissement de normes est de savoir quels mots-clés T-SQL doivent ou non être mis en majuscules dans le code.
Sous l’onglet Capitalisation de la fenêtre Options, des règles de capitalisation peuvent être définies pour le suivant:
Pour définir la règle appropriée pour la capitalisation, les options suivantes peuvent être utilisées: UPPER CASE, minuscule, lowerCamelCase, UpperCamelCase , Bon cas, ou en laissant les règles de mise en page de requête SQL par défaut en désélectionnant l’option:
Certains développeurs préfèrent les mots-clés SQL, les types de données , etc. pour être dans UPPER CASE et d’autres développeurs, cependant, comme les mots clés SQL pour être en minuscules.
La meilleure solution lors du choix d’un outil est de sélectionner celui qui peut gérer toutes ces différentes préférences.
Dans le premier exemple, les mots clés sont en majuscules et les types de données sont en minuscules:
Dans le deuxième exemple, les mots clés sont en minuscules et da les types ta sont en majuscules:
Le troisième exemple, les mots-clés et les types de données sont en majuscules:
Aperçu de l’impact du formateur SQL
L’une des choses essentielles que tout outil de mise en page SQL devrait avoir est de pouvoir prévisualiser visuellement à quoi ressemble le code SQL après l’ajout de certaines options.
ApexSQL Refactor a un aperçu de l’impact du format de code SQL qui montre un aperçu clair et une vue de l’impact de toute option change immédiatement lorsque vous les faites. Si vous n’aimez pas son apparence, il peut être facilement modifié et inversé sans enregistrer:
Définition des règles de capitalisation des mots-clés SQL, des types de données, des identifiants (noms d’objets), des fonctions système, des variables n’est qu’un élément de l’ensemble du style.
Règles de disposition du code SQL pour les alias, commentaires, virgules, espacement, alignement, etc., doit également être défini afin d’avoir un bon code SQL cohérent, lisible et bien formaté.
Pour toutes les choses mentionnées ci-dessus, un outil de mise en forme doit avoir des options pour les paramètres Règles de style des requêtes SQL.
ApexSQL Refactor dispose de toutes ces options pour répondre à vos besoins.Pour en savoir plus sur les options du formateur SQL, consultez les liens ci-dessous:
- Règles de formatage SQL – Virgules et espacement en T-SQL
- Règles de formatage SQL – Régulier et délimité Identificateurs T-SQL
- Règles de mise en forme SQL – Commentaire de code SQL
- Règles de mise en forme SQL – Conventions de dénomination SQL et règles de capitalisation
- Règles de mise en forme SQL – Fin Instructions SQL avec des points-virgules
Profils de formateur de requêtes SQL
Pouvoir définir un style souhaité, enregistrer ce style et partager le style avec des collègues est une autre chose que chaque serveur SQL outil de formateur doit avoir. De plus, avoir une sélection prédéfinie de profils pré-configurés, prêts à l’emploi, est très utile.
Avec ApexSQL Refactor, les utilisateurs peuvent:
- enregistrer leurs préférences Options du formateur de requêtes SQL vers un profil réutilisable
- regrouper et catégoriser les styles de formatage
- modifier rapidement les profils existants
- éviter les conflits avec d’autres utilisateurs
De plus, ApexSQL Refactor est livré avec quatre profils intégrés
- ApexSQL – contient ce que nous avons déterminé être un bon standard de formateur SQL
- Compact – définit l’option d’indentations à 0 (zéro) espace, tous les espaces supplémentaires sont décochés et les lignes vides sont supprimées pour une requête où le code SQL semble dense
- Extended – est l’opposé du profil Compact. Ce profil ajoute des lignes vides avant / après chaque déclaration, commentaires. Ajoutez de l’espace autour des opérateurs arithmétiques et logiques
- MSDN SQL BOL – imite le style utilisé dans le site de ressources MSDN
Ces quatre profils intégrés ne peuvent en aucun cas être modifiés , mais une copie de ces profils de formateur de requêtes SQL intégrés peut être faite en cliquant sur le bouton Copier et peut ensuite être modifiée de la manière préférée:
De plus, un nouveau profil de formateur SQL peut être créé en cliquant sur le bouton Nouveau:
Importation / exportation de profils au format SQL
Une fois que vous avez créé le profil parfait, il est important de pouvoir l’exporter pour le rendre accessible aux autres; ainsi que pour les destinataires du profil pour pouvoir l’importer facilement. ApexSQL Refactor fournit précisément cette fonctionnalité
Pour exporter des profils et les partager avec des collègues, appuyez sur le bouton Exporter dans la fenêtre Options:
Pour importer des profils dans la fenêtre Options, appuyez sur le bouton Importer.
Pour en savoir plus sur les profils ApexSQL Refactor, consultez la page Comment personnaliser les profils de formatage SQL.
Traitement des objets dans un lot
Une fois le profil de format créé et les options définies, le formatage du code SQL peut commencer sérieusement, avec un objet ou un script à la fois. Mais qu’en est-il du traitement de tout ce qui se trouve dans une base de données en même temps?
Le traitement d’un grand nombre d’objets SQL tels que les procédures stockées individuellement peut être un travail très difficile et chronophage, bien sûr.
Donc , une autre chose que nous pouvons ajouter est que chaque outil de mise en forme devrait avoir une fonctionnalité qui peut formater plusieurs objets SQL avec un seul profil SQL souhaité à la fois.
ApexSQL Refactor a la fonctionnalité de mise en forme des objets SQL qui permet exactement cette. Dans l’Explorateur d’objets, sélectionnez une base de données dans laquelle se trouvent les objets à mettre en forme, faites un clic droit et, dans le menu contextuel, choisissez la commande Formater les objets SQL:
Tous les objets basés sur des scripts, par exemple vue, les procédures stockées seront répertoriées dans la fenêtre Formater les objets SQL:
Dans la zone de liste déroulante Profil, sélectionnez le SQL souhaité profil du formateur (par exemple ApexSQL) et, dans la liste, choisissez les objets SQL à mettre en forme, cliquez sur le bouton Créer un script, qui ouvrira un script dans l’éditeur de requête, puis cliquez sur le bouton Exécuter (F5):
Pour confirmer que les objets SQL sont formatés avec le profil souhaité, revenez à la fenêtre Formater les objets SQL, sous la liste déroulante Profil, choisissez un profil et, dans la liste des objets SQL, sous la colonne OK avec l’icône de coche verte, les objets SQL qui sont formatés seront indiqués, tous les autres objets SQL seront marqués d’une icône x rouge qui indique qu’ils ne sont pas formatés avec le profil sélectionné :
De plus, avant de formater un script objet SQL avec le profil souhaité, les mêmes scripts SQL peuvent être affichés pour l’utilisateur peut se e à quoi il ressemblera après son traitement. De cette façon, il peut être comparé en sélectionnant un objet SQL souhaité dans la liste, cliquez avec le bouton droit et sélectionnez le bouton Comparer:
Format T-SQL des scripts Batch
Une autre chose qui doit être prise en compte, lors du choix du bon outil de mise en page SQL, est la possibilité de formater les scripts SQL et les scripts dans des dossiers par lots.
Dans les situations où, sur la machine, il y a beaucoup de scripts SQL dont le code doit être vérifié et que ce code est dans un assez gros désordre comme dans l’image ci-dessous:
Vérifier le code dans ces scripts SQL peut être difficile.
Une solution pour cela consiste à ouvrir le script SQL dans SSMS et formatez-le avec votre profil préféré en cliquant sur le bouton Formater SQL:
Cela résout un problème pour un script SQL, mais pour plus de ces scripts SQL, une solution plus rapide doit être fournie.
ApexSQL Refactor offre la fonctionnalité de scripts SQL en tant que solution à ce genre de problème. Dans le menu ApexSQL Refactor, sous le sous-menu Other formatting, sélectionnez la commande Formater les scripts SQL:
Le format SQL la fenêtre des scripts s’ouvre, dans la liste, naviguez et sélectionnez les scripts SQL, choisissez le profil de formateur SQL souhaité dans la zone de liste déroulante Profil et appuyez sur le bouton OK:
Tout le code dans les scripts SQL sélectionnés sera formaté avec le style de formateur SQL souhaité, ce qui facilite grandement la révision des scripts SQL.
Intégration hôte
Un autre élément important élément lors du choix du bon outil de style SQL est son intégration directe dans les applications hôtes que vous utilisez normalement pour le codage SQL comme SSMS ou Visual Studio.
Heureusement, ApexSQL Refactor prend en charge l’intégration de SSMS 2012 et supérieur et prend en charge l’intégration dans Visual Studio à partir de la version VS 2010 et supérieure.
Cela signifie que vous pouvez ajouter de puissantes capacités de formateur SQL et améliorer votre productivité de codage sans jamais quitter ng la maison de votre éditeur préféré
Intégration transparente de l’hôte et expérience utilisateur cohérente
L’intégration dans une application hôte est une chose. L’intégration transparente avec une expérience utilisateur finale cohérente en est une autre. De nombreux compléments sont de mauvais invités, monopolisant l’espace du menu, offrant des couleurs et des icônes disjointes et étant généralement visuellement «bruyants» et intrusifs. ApexSQL Refactor est un invité poli qui se fond parfaitement dans les environnements hôtes, presque comme s’il faisait partie de l’EDI lui-même. Cette expérience utilisateur cohérente comprend l’iconographie, le style visuel et les thèmes.
Les thèmes de couleur permettent à l’utilisateur de modifier l’apparence visuelle en fonction de vos préférences et un bon outil tiers doit correspondre à cette fonctionnalité. ApexSQL Refactor prend en charge SSMS et la couleur visuelle thèmes mais mieux encore changeront automatiquement pour s’adapter aux paramètres du thème de l’hôte.
Consultez cet article pour en savoir plus.
Thème de couleurs sombres de Visual Studio:
Thème de couleur bleu SSMS:
Une note , ApexSQL Refactor prend en charge le thème de couleur sombre SSMS:
Même si le thème de couleur n’est pas encore officiel; pour ceux qui le souhaitent savoir comment configurer le d Le thème de couleur ark dans SSMS 17 peut être trouvé sur la page Configuration du thème sombre dans le studio de gestion SQL Server.
De plus, toutes les icônes qui apparaissent dans les commandes, boîtes de dialogue, modèles, etc. dans ApexSQL Refactor sont héritées à partir de la bibliothèque d’images de Visual Studio. Certaines des icônes de la bibliothèque ont été repensées pour être plus intuitives, simples et sont des symboles facilement reconnaissables.
Vous pouvez en trouver plus sur le dictionnaire du langage visuel pour Visual Studio pour l’iconographie, les couleurs et d’autres concepts visuels appliqués dans Page des outils / compléments ApexSQL.
Prise en charge de haute résolution DPI et 4K
ApexSQL Refactor prend en charge une résolution élevée DPI et 4K, ce qui signifie lorsque ApexSQL Refactor est exécuté, fenêtres (par exemple, fenêtre Options ) dans lequel vous définissez toutes les options du formateur SQL et l’écran ne sera pas flou sur votre moniteur 4K:
Remarque: VS gère très bien le 4K et le DPI élevé, mais SSMS ne fonctionne pas aussi bien sur les moniteurs 4K. Pour le problème 4K et haute résolution dans SSMS 2016 et supérieur, il existe une solution qui peut être vue sur la page Comment activer High-DPI dans SSMS (SQL Server Management Studio) – Trucs, astuces et problèmes.
