Innholdsfortegnelse
- T SQL-formatalternativer
- Forhåndsvisning av virkning
- SQL-formateringsprofiler
- Importere / eksportere SQL-formateringsprofiler
- Formater objekt i en batch
- Format T-SQL-skript i en batch
- Vertintegrasjon
- Støtte for høy DPI og 4K-oppløsning
Ingen liker å sjekke og lese massevis av rotete, uformaterte tekst. Når det gjelder å lese en kompleks SQL-kode, kan problemet bli enda vanskeligere, spesielt hvis du er den som må løsne den.
SQL-kode kan formateres med en stil som gjør lesingen lettere , spesielt hvis hele teamet bruker det samme. Ren, godt formatert (konsistent) SQL-kode kan leses mye raskere enn inkonsekvent skrevet SQL-kode, enten inkonsekvensen er på tvers av teammedlemmer og forskjellige objekter eller til og med innenfor det samme skriptet til selve objektet. Godt organisert og formatert SQL-kode kan gjennomgås mer effektivt. Å overlevere et prosjekt til et annet team eller en klient med godt formatert SQL-kode vil være mye jevnere og mye mer verdsatt.
Hovedproblemet med SQL-skriptformatering er at det ikke er noen stil eller standarder for hvordan SQL koden skal formateres, og alt er generelt et spørsmål om preferanse. Den beste løsningen her er å sette standardene som du og teamet ditt i selskapet vil holde seg til, og deretter sørge for at de blir brukt konsekvent.
All SQL-kode kan formateres manuelt, noe som er veldig tidkrevende. men tredjepartsverktøy eksisterer og kan brukes til å formatere raskt og effektivt.
Denne artikkelen vil beskrive og introdusere noen grunnleggende retningslinjer og forventninger for hva et perfekt SQL-spørringsformateringsverktøy skal ha for å oppfylle målet ditt å etablere en konsistent og standard formatstil (standard) og hvordan du bruker den stilen på ett T-SQL-skript eller mange T-SQL-skript eller objekter med ett klikk.
Et slikt formeringsverktøy er ApexSQL Refactor, tillegg som kan integreres i SQL Server Management Studio (SSMS) eller Visual Studio (VS). ApexSQL Refactor har over 200 SQL-spørringsformeringsalternativer og funksjoner for å bruke en stil på ett eller store T-SQL-skript samtidig.
Alternativer
Det første målet er å sette grunnleggende alternativer. En av de største bekymringene når det gjelder å etablere standarder, er hvilke T-SQL-nøkkelord som skal eller ikke skal ha store bokstaver i koden.
Under store bokstaver i fanen Valg, kan det settes store bokstavregler for følgende:
For å angi passende regel for bruk av store og små bokstaver, kan følgende alternativer brukes: ØVERSTE TASKER, små bokstaver, små bokstaver, store bokstaver , Riktig sak, eller ved å forlate standard SQL-oppsettregler ved å fjerne merket for alternativet:
Noen utviklere foretrekker SQL-nøkkelord, datatyper osv. for å være i HOVEDTASKE og andre utviklere, men som om SQL-nøkkelordene skal være med små bokstaver.
Den beste løsningen når du velger et verktøy er å velge et som kan håndtere alle de forskjellige preferansene.
I det første eksemplet er nøkkelord store og små bokstaver:
I andre eksempel, nøkkelord er små og store bokstaver ta-typer er store bokstaver:
Det tredje eksemplet, nøkkelord og datatyper er med store bokstaver:
SQL-formatering Impact preview
En av de kritiske tingene som alle SQL-layoutverktøy bør ha er å kunne visuelt forhåndsvise hvordan SQL-koden ser ut etter å ha lagt til noen alternativer.
ApexSQL Refactor har en forhåndsvisning av innvirkning på SQL-formatformat som viser en klar innsikt og oversikt over virkningen av eventuelle alternativendringer umiddelbart når du lager dem. Hvis du ikke liker hvordan det ser ut, kan det enkelt endres og tilbakestilles uten å lagre:
Angi regler for bruk av store bokstaver av SQL-nøkkelord, datatyper, identifikatorer (Objektnavn), systemfunksjoner, variabler er bare ett element i settet med stilen.
SQL-kodelayoutregler for aliaser, kommentarer, kommaer, mellomrom, justering, osv., må også settes inn for å ha en god, konsistent, lesbar og godt formatert SQL-kode.
For alle de ovennevnte tingene må et verktøy for formatverktøy ha muligheter for innstillinger disse SQL-spørsmåls stylingregler.
ApexSQL Refactor har alle disse alternativene for å oppfylle dine krav.Mer om alternativene for SQL-formatering finner du fra lenkene nedenfor:
- SQL-formateringsregler – Komma og mellomrom i T-SQL
- SQL-formateringsregler – Vanlig og avgrenset T-SQL-identifikatorer
- Regler for SQL-formatering – SQL-kodekommentering
- Regler for SQL-formatering – SQL-navnekonvensjoner og store bokstavregler
- SQL-formateringsregler – Avslutning SQL-setninger med semikolon
SQL-spørringsformateringsprofiler
Å kunne sette en ønsket stil, lagre den stilen og dele stilen med kolleger er en annen ting som hver SQL Server formateringsverktøyet må ha. Å ha et forhåndsinnstilt utvalg av forhåndskonfigurerte profiler, er utenom boksen veldig nyttig.
Med ApexSQL Refactor-brukere kan:
- lagre foretrukket SQL-spørringsformateringsalternativer til en gjenbrukbar profil
- gruppe og kategorisere formateringsstiler
- endre raskt eksisterende profiler
- unngå konflikter med andre brukere
I tillegg kommer ApexSQL Refactor med fire innebygde profiler
- ApexSQL – inneholder det vi bestemte var en god SQL-formateringsstandard
- Kompakt – setter innrykkingsalternativ til 0 (null) plass, alle ekstra mellomrom er ukontrollert og tomme linjer fjernes for et spørsmål der SQL-koden ser tett ut
- Utvidet – er motsatt av Compact-profilen. Denne profilen legger til tomme linjer før / etter hver uttalelse, kommentarer. Legg til plass rundt aritmetiske, logiske operatorer
- MSDN SQL BOL – etterligner stilen som brukes på MSDN-ressurssiden
Disse fire innebygde profilene kan ikke endres på noen måte , men en kopi av disse innebygde SQL-spørringsformateringsprofilene kan lages ved å klikke på Kopier-knappen og deretter kan endres på den foretrukne måten:
Det kan også opprettes en ny SQL-formateringsprofil ved å klikke på Ny-knappen:
Importere / eksportere profiler i SQL-format
Når du har opprettet den perfekte profilen, er det viktig å kunne eksportere den for å gjøre den tilgjengelig for andre; samt at mottakerne av profilen enkelt kan importere den. ApexSQL Refactor tilbyr akkurat denne funksjonaliteten
For å eksportere profiler og dele med kolleger, trykk på Eksporter-knappen i vinduet Alternativer:
For å importere profiler i vinduet Alternativer, trykk på Importer-knappen.
Mer om ApexSQL Refactor-profiler finner du på siden Hvordan tilpasse SQL-formateringsprofiler.
Behandle objekter i en batch
Når formatprofilen er opprettet og alternativene er angitt, kan formatering av SQL-kode begynne for alvor, med ett objekt eller skript om gangen. Men hva med å behandle alt i en database på en gang?
Behandle mange SQL-objekter som lagrede prosedyrer hver for seg kan selvfølgelig være en veldig vanskelig og tidkrevende jobb.
Så , en annen ting, vi kan legge til, er at hvert formatverktøy skal ha en funksjon som kan formatere flere SQL-objekter med en enkelt ønsket SQL-profil samtidig.
ApexSQL Refactor har Format SQL-objekter-funksjonen som tillater nøyaktig at. I Object Explorer velger du en database der objektene som skal formateres, høyreklikker og velger hurtigkommandoen Formater SQL-objekter fra hurtigmenyen:
Alle skriptbaserte objekter, f.eks visning, vil lagrede prosedyrer bli oppført i vinduet Format SQL-objekter:
Under kombinasjonsboksen Profil velger du ønsket SQL formateringsprofil (f.eks. ApexSQL) og velg SQL-objektene som skal formateres fra listen, klikk på Opprett skript-knappen, som åpner et skript i Spørreredigereren, og klikk deretter på Utfør (F5) -knappen:
For å bekrefte at SQL-objekter er formatert med ønsket profil, går du tilbake til vinduet Format SQL-objekter, under kombinationsboksen Profil, velg en profil, og i SQL-objekter-listen, under OK-kolonnen med grønt avkrysningsikon, vil SQL-objekter som er formatert være indikert, alle andre SQL-objekter vil bli markert med rødt x-ikon som indikerer at de ikke er formatert med den valgte profilen :
I tillegg, før du formaterer et SQL-objektskript med ønsket profil, kan de samme SQL-skriptene vises slik at brukeren kan se hvordan det vil se ut etter at det er behandlet. På denne måten kan det sammenlignes ved å velge et ønsket SQL-objekt fra listen, høyreklikke og velge Sammenlign-knappen:
Batchskript T-SQL-format
En ting til som må tas i betraktning, når du velger riktig SQL-layoutverktøy, er muligheten for å formatere SQL-skript og skript i mapper i grupper.
I situasjoner der det på maskinen er mange SQL-skript hvilken kode som må sjekkes, og at koden er i et ganske stort rot som på bildet nedenfor:
Å sjekke kode i disse SQL-skriptene kan være utfordrende.
En løsning på dette er å åpne SQL-skriptet i SSMS og formatere den med din foretrukne profil ved å klikke Format SQL-knappen:
Dette løser et problem for ett SQL-skript, men for flere av disse SQL-skriptene, en raskere løsning må leveres.
ApexSQL Refactor tilbyr Format SQL-skriptsfunksjonen som en løsning på denne typen problemer. Fra ApexSQL Refactor-menyen, under undermenyen Annen formatering, velger du kommandoen Format SQL scripts:
Format SQL Skriptvinduet åpnes, naviger og velg SQL-skript i listen, velg ønsket SQL-formateringsprofil under Profil-kombinasjonsboksen og trykk på OK-knappen:
All kode i de valgte SQL-skriptene vil være formatert med ønsket SQL-formateringsstil som gjennomgang av SQL-skript gjør det mye enklere.
Vertintegrasjon
En annen viktig element når du velger riktig SQL-stylingsverktøy er dets direkte integrering i vertsapplikasjoner som du vanligvis bruker for SQL-koding som SSMS eller Visual Studio.
Heldigvis støtter ApexSQL Refactor integrering fra SSMS 2012 og nyere og støtter integrering i Visual Studio fra VS 2010-versjonen og nyere.
Dette betyr at du kan legge til kraftige SQL-formateringsegenskaper og forbedre kodingsproduktiviteten uten å måtte forlate ng hjemmet til favorittredigeringsprogrammet ditt
Sømløs vertintegrasjon og konsistent brukeropplevelse
Integrering i et vertsapplikasjon er en ting. Å integrere sømløst med en konsistent sluttbrukeropplevelse er en annen. Mange tilleggsprogrammer er dårlige gjester, som gir store menyplasser, og som tilbyr usammenhengende farger og ikoner, og generelt er visuelt «høylydte» og påtrengende. ApexSQL Refactor er en høflig gjest som sømløst blandes inn i vertsmiljøer, nesten som om det var en del av IDE selv. Denne konsistente brukeropplevelsen inkluderer ikonografi, visuell stil og temaer.
Fargetemaer lar brukeren endre det visuelle utseendet slik at det passer dine preferanser, og et godt tredjepartsverktøy bør matche denne muligheten. ApexSQL Refactor støtter SSMS og Visual color temaer, men bedre ennå, vil automatisk endres for å tilpasse seg innstillingene for verts-temaet.
Se denne artikkelen for å lære mer.
Visual Studio mørkt fargetema:
SSMS blått fargetema:
Ett notat , ApexSQL Refactor støtter SSMS mørkt fargetema:
Selv om fargetemaet ikke er offisielt ennå; for de som vil vet hvordan du setter opp d arkfargetema i SSMS 17 finner du på Sette opp det mørke temaet i SQL Server-administrasjonsstudiosiden.
Videre arves alle ikonene som vises i kommandoer, dialoger, maler osv. i ApexSQL Refactor. fra Visual Studio Image Library. Noen av ikonene fra biblioteket er redesignet for å være mer intuitive, enkle og er lett gjenkjennelige symboler.
Mer finner du på Visual Language Dictionary for Visual Studio for ikonografi, farger og andre visuelle konsepter som brukes i ApexSQL-verktøy / tilleggsside.
Støtte for høy DPI og 4K-oppløsning
ApexSQL Refactor støtter høy DPI og 4K-oppløsning, noe som betyr at når ApexSQL Refactor kjøres, windows (f.eks. Alternativvindu ) der du setter alle alternativene for SQL-formatering, og skjermen ikke blir uskarp på 4K-skjermen:
Merk: VS håndterer 4K og high-DPI veldig bra, men SSMS fungerer ikke så bra på 4K-skjermer. For 4K- og high-DPI-problemet i SSMS 2016 og høyere er det en løsning som kan sees på siden Slik aktiverer du High-DPI i SSMS (SQL Server Management Studio) – Tips, triks og problemer-siden.
