Indholdsfortegnelse
- T SQL-formatindstillinger
- Eksempel på effekt
- SQL-formateringsprofiler
- Import / eksport af SQL-formateringsprofiler
- Formatér objekt i en batch
- Formatér T-SQL-scripts i et batch
- Hostintegration
- Understøttelse af høj DPI og 4K-opløsning
Ingen kan lide at kontrollere og læse masser af rodet, uformateret tekst. Når det kommer til at læse en kompleks SQL-kode, kan problemet blive endnu vanskeligere, især hvis du er den, der skal fjerne det.
SQL-kode kan formateres med en stil, der gør læsningen af det lettere , især hvis hele teamet bruger det samme. Ren, velformateret (konsistent) SQL-kode kan læses meget hurtigere end inkonsekvent skrevet SQL-kode, uanset om inkonsekvensen er på tværs af teammedlemmer og forskellige objekter eller endda inden for det samme script af selve objektet. Velorganiseret og formateret SQL-kode kan gennemgås mere effektivt. At aflevere et projekt til et andet team eller en klient med velformateret SQL-kode vil være meget glattere og meget mere værdsat.
Hovedproblemet med SQL-scriptformatering er, at der ikke er nogen stil eller standarder for, hvordan SQL kode skal formateres, og alt er generelt et spørgsmål om præference. Den bedste løsning her er at indstille de standarder, som du og dit team i virksomheden vil holde sig til, og derefter sørge for at de anvendes konsekvent.
Al SQL-kode kan formateres manuelt, hvilket er meget tidskrævende men der findes tredjepartsværktøjer og kan bruges til at formatere hurtigt og effektivt.
Denne artikel beskriver og introducerer nogle grundlæggende retningslinjer og forventninger til, hvad et perfekt SQL-forespørgselsformateringsværktøj skal have for at opfylde dit mål at etablere en ensartet og standardformatformat (standard), og hvordan man anvender denne stil på et T-SQL-script eller mange T-SQL-scripts eller objekter med et enkelt klik.
Et sådant formeringsværktøj er ApexSQL Refactor, tilføjelsesprogram, der kan integreres i SQL Server Management Studio (SSMS) eller Visual Studio (VS). ApexSQL Refactor har over 200 SQL-forespørgselsformeringsindstillinger og funktioner til anvendelse af en typografi på et eller T-SQL-scripts på én gang.
Valgmuligheder
Det første mål er at indstille grundlæggende indstillinger. En af de største bekymringer, når det gælder etablering af standarder, er, hvilke T-SQL-nøgleord der skal eller ikke skal være store i koden.
Under fanen Store bogstaver i vinduet Indstillinger kan der indstilles store bogstaver for følgende:
For at indstille en passende regel for brug af store bogstaver, kan følgende indstillinger bruges: OPPER CASE, små, småCamelCase, UpperCamelCase , Korrekt sag eller ved at forlade standardreglerne for SQL-forespørgselslayout ved at fravælge indstillingen:
Nogle udviklere foretrækker SQL-nøgleord, datatyper osv. for at være i UPPER CASE og andre udviklere, men ligesom SQL-nøgleordene skal være med små bogstaver.
Den bedste løsning, når du vælger et værktøj, er at vælge et, der kan håndtere alle disse forskellige præferencer.
I det første eksempel er nøgleord små og store bogstaver:
I andet eksempel, nøgleord er små og da ta-typer er store bogstaver:
Det tredje eksempel, søgeord og datatyper er store bogstaver:
SQL-formatering Impact preview
En af de kritiske ting, som ethvert SQL-layoutværktøj burde have, er at kunne visuelt forhåndsvise hvordan SQL-koden ser ud efter at have tilføjet nogle indstillinger.
ApexSQL Refactor har et eksempel på en indvirkning på SQL-formatformat, der viser en klar indsigt og et overblik over virkningen af eventuelle valgændringer med det samme, når du foretager dem. Hvis du ikke kan lide, hvordan det ser ud, kan det let ændres og gendannes uden at gemme:
Indstilling af regler for brug af store bogstaver af SQL-nøgleord, datatyper, identifikatorer (Objektnavne), systemfunktioner, variabler er kun et element i sæt af stilen.
SQL-kodelayoutregler for aliaser, kommentarer, kommaer, afstand, justering, osv. skal også indstilles for at have en god, konsistent, læselig og velformateret SQL-kode.
For alle de ovennævnte ting skal et værktøj til formatværktøj have muligheder for indstillinger disse SQL-forespørgsels stylingregler.
ApexSQL Refactor har alle disse muligheder for at imødekomme dine krav.Mere om SQL-formateringsmuligheder kan findes fra nedenstående links:
- SQL-formateringsregler – kommaer og afstand i T-SQL
- SQL-formateringsregler – Regelmæssig og afgrænset T-SQL-identifikatorer
- Regler for SQL-formatering – SQL-kodekommentering
- Regler for SQL-formatering – SQL-navngivningskonventioner og kapitaliseringsregler
- SQL-formateringsregler – Afslutning SQL-sætninger med semikoloner
SQL-forespørgselsformateringsprofiler
At være i stand til at indstille en ønsket stil, gemme den stil og dele stilen med kolleger er en anden ting, som hver SQL Server formateringsværktøjet skal have. At have et forudindstillet udvalg af forudkonfigurerede profiler er også meget nyttigt uden for kassen.
Med ApexSQL Refactor-brugere kan brugere:
- gemme foretrukket SQL-forespørgsel formateringsmuligheder til en genanvendelig profil
- gruppe og kategoriser formateringsstile
- hurtigt ændre eksisterende profiler
- undgå konflikter med andre brugere
Derudover kommer ApexSQL Refactor med fire indbyggede profiler
- ApexSQL – indeholder det, som vi fastslog, var en god SQL-formateringsstandard
- Kompakt – indstiller indrykningsindstilling til 0 (nul) plads, alle yderligere mellemrum er ikke markeret, og tomme linjer fjernes for en forespørgsel, hvor SQL-koden ser tæt ud
- Udvidet – er modsat af den kompakte profil. Denne profil tilføjer tomme linjer før / efter hver erklæring, kommentarer. Tilføj plads omkring aritmetiske, logiske operatorer
- MSDN SQL BOL – efterligner den stil, der bruges på MSDN-ressourcewebstedet
Disse fire indbyggede profiler kan ikke ændres på nogen måde , men en kopi af disse indbyggede SQL-forespørgselsformateringsprofiler kan laves ved at klikke på knappen Kopier og derefter kan ændres på den foretrukne måde:
Der kan også oprettes en ny SQL-formateringsprofil ved at klikke på knappen Ny:
Import / eksport af SQL-profilprofiler
Når du har oprettet den perfekte profil, er det vigtigt at kunne eksportere den for at gøre den tilgængelig for andre; såvel som for modtagerne af profilen for let at kunne importere den. ApexSQL Refactor giver netop denne funktionalitet
For at eksportere profiler og dele med kolleger skal du trykke på knappen Eksporter i vinduet Indstillinger:
For at importere profiler i vinduet Indstillinger skal du trykke på knappen Importer.
Mere om ApexSQL Refactor-profiler kan findes på siden Sådan tilpasser du SQL-formateringsprofiler.
Behandling af objekter i en batch
Når formatprofilen er oprettet, og indstillinger er indstillet, kan formatering af SQL-kode begynde for alvor med et objekt eller script ad gangen. Men hvad med at behandle alt i en database på én gang?
Behandling af mange SQL-objekter som lagrede procedurer individuelt kan naturligvis være et meget vanskeligt og tidskrævende job.
Så , en anden ting, vi kan tilføje, er at hvert formatværktøj skal have en funktion, der kan formatere flere SQL-objekter med en enkelt ønsket SQL-profil på én gang.
ApexSQL Refactor har Format SQL-objekter-funktionen, der tillader nøjagtigt at. I Object Explorer skal du vælge en database, hvori de objekter, der skal formateres, findes. Højreklik og vælg kommandoen Formatér SQL-objekter i genvejsmenuen:
Alle scriptbaserede objekter, f.eks visning vises lagrede procedurer i vinduet Format SQL-objekter:
Under kombinationsboksen Profil skal du vælge den ønskede SQL formateringsprofil (f.eks. ApexSQL) og vælg på listen de SQL-objekter, der skal formateres, klik på knappen Opret script, som åbner et script i Query-editoren, og klik derefter på Udfør (F5) -knappen:
For at bekræfte, at SQL-objekter er formateret med den ønskede profil, skal du gå tilbage til vinduet Format SQL-objekter under kombinationsboksen Profil, vælg en profil, og i listen SQL-objekter under kolonnen OK med grønt afkrydsningsikon vises SQL-objekter, der er formateret, alle andre SQL-objekter markeres med et rødt x-ikon, der indikerer, at de ikke er formateret med den valgte profil :
Derudover kan de samme SQL-scripts vises, så brugeren før formatering af et SQL-objektscript med den ønskede profil kan se hvordan det ser ud, når det er behandlet. På denne måde kan det sammenlignes ved at vælge et ønsket SQL-objekt på listen, højreklik og vælge knappen Sammenlign:
Batch-scripts T-SQL-format
En ting, der skal tages i betragtning, når du vælger det rigtige SQL-layoutværktøj, er muligheden for at formatere SQL-scripts og scripts i mapper i batches.
I situationer, hvor der på maskinen er mange SQL-scripts, hvilken kode der skal kontrolleres, og den koden er i et ret stort rod som i billedet nedenfor:
Kontrollering af kode i disse SQL-scripts kan være udfordrende.
En løsning på dette er at åbne SQL-scriptet i SSMS og formater det med din foretrukne profil ved at klikke på Format SQL-knappen:
Dette løser et problem for et SQL-script, men for flere af disse SQL-scripts skal der leveres en hurtigere løsning.
ApexSQL Refactor tilbyder Format SQL-scripts-funktionen som en løsning på denne slags problemer. Fra menuen ApexSQL Refactor under undermenuen Anden formatering skal du vælge kommandoen Format SQL scripts:
Format SQL scripts-vindue åbnes, naviger og vælg SQL-scripts på listen, vælg den ønskede SQL-formateringsprofil under kombinationsboksen Profil og tryk på OK-knappen:
Al kode i de valgte SQL-scripts vil blive formateret med den ønskede SQL-formateringsstil, hvilket gennemgang af SQL-scripts gør det meget nemmere.
Hostintegration
En anden vigtig element, når du vælger det rigtige SQL-stylingværktøj, er dets direkte integration i værtsapplikationer, som du normalt bruger til SQL-kodning som SSMS eller Visual Studio.
Heldigvis understøtter ApexSQL Refactor integration fra SSMS 2012 og derover og understøtter integration i Visual Studio fra VS 2010-version og nyere.
Dette betyder, at du kan tilføje kraftfulde SQL-formateringsfunktioner og forbedre din kodningsproduktivitet uden nogensinde at fjerne ng hjemmet til din yndlingseditor
Problemfri værtintegration og ensartet brugeroplevelse
Integrering i en værtsapplikation er en ting. Integrering problemfrit med en ensartet slutbrugeroplevelse er en anden. Mange tilføjelsesprogrammer er dårlige gæster, der spiser menupunkt, tilbyder uadskilte farver og ikoner og er generelt visuelt “højt” og påtrængende. ApexSQL Refactor er en høflig gæst, der problemfrit blandes ind i værtsmiljøer, næsten som om det var en del af IDE selv. Denne ensartede brugeroplevelse inkluderer ikonografi, visuel stil og temaer.
Farvetemaer gør det muligt for brugeren at ændre det visuelle udseende, så det passer til dine præferencer, og et godt tredjepartsværktøj skal matche denne mulighed. ApexSQL Refactor understøtter SSMS og visuel farve temaer, men bedre endnu, ændres automatisk for at tilpasse sig til værts temaindstillinger.
Se denne artikel for at lære mere.
Dark Studio-tema i Visual Studio:
SSMS blå farvetema:
En note , ApexSQL Refactor understøtter SSMS mørkt farvetema:
Selv om farvetemaet ikke er officielt endnu; for dem der vil vide hvordan man opsætter d arkfarvetema i SSMS 17 findes på siden Opsætning af det mørke tema i SQL Server-administrationsstudie-siden.
Desuden arves alle ikoner, der vises i kommandoer, dialoger, skabeloner osv. i ApexSQL Refactor, arv. fra Visual Studio Image Library. Nogle af ikonerne fra biblioteket er redesignet til at være mere intuitive, enkle og er let genkendelige symboler.
Mere kan findes i Visual Language Dictionary for Visual Studio til ikonografi, farver og andre visuelle koncepter anvendt i ApexSQL-værktøj / tilføjelsesside.
Understøttelse af høj DPI og 4K-opløsning
ApexSQL Refactor understøtter høj DPI og 4K-opløsning, hvilket betyder, når ApexSQL Refactor køres, windows (f.eks. Vinduet Indstillinger ) hvor du indstiller alle SQL-formateringsindstillinger, og skærmen ikke bliver sløret på din 4K-skærm:
Bemærk: VS håndterer 4K og high-DPI meget godt, men SSMS fungerer ikke så godt på 4K-skærme. For 4K- og high-DPI-problemet i SSMS 2016 og højere er der en løsning, der kan ses på siden Sådan aktiveres High-DPI i SSMS (SQL Server Management Studio) – siden Tips, tricks og problemer.
