Viktiga saker du behöver i ett SQL-formateringsverktyg

Innehållsförteckning

  • T SQL-formatalternativ
  • Förhandsgranskning av effekter
  • SQL-formateringsprofiler
  • Importera / exportera SQL-formateringsprofiler
  • Formatera objekt i en batch
  • Formatera T-SQL-skript i en batch
  • Värdintegration
  • Stöd för hög DPI och 4K-upplösning

Ingen gillar att kolla och läsa massor av rörigt, oformaterad text. När det gäller att läsa en komplex SQL-kod kan problemet bli ännu svårare, speciellt om du är den som måste lösa upp den.

SQL-kod kan formateras med en stil som gör det lättare att läsa det , särskilt om hela teamet använder detsamma. Ren, välformaterad (konsekvent) SQL-kod kan läsas mycket snabbare än inkonsekvent skriven SQL-kod, oavsett om inkonsekvensen är mellan lagmedlemmar och olika objekt eller till och med inom samma skript för själva objektet. Välorganiserad och formaterad SQL-kod kan granskas mer effektivt. Att överlämna ett projekt till ett annat team eller en klient med välformaterad SQL-kod kommer att bli mycket smidigare och mycket mer uppskattat.

Det största problemet med SQL-skriptformatering är att det inte finns någon stil eller standard för hur SQL kod ska formateras och allt är i allmänhet en fråga om preferenser. Den bästa lösningen här är att ställa in de standarder som du och ditt team i företaget kommer att hålla fast vid och sedan se till att de tillämpas konsekvent.

All SQL-kod kan formateras manuellt, vilket är mycket tidskrävande men verktyg från tredje part finns och kan användas för att formatera snabbt och effektivt.

Den här artikeln kommer att beskriva och introducera några grundläggande riktlinjer och förväntningar för vad ett perfekt SQL-formulärverktyg ska ha för att nå ditt mål att skapa en enhetlig och standardformatstil (standard) och hur man tillämpar den stilen på ett T-SQL-skript eller många T-SQL-skript eller objekt med ett enda klick.

Ett sådant formningsverktyg är ApexSQL Refactor, tillägg som kan integreras i SQL Server Management Studio (SSMS) eller Visual Studio (VS). ApexSQL Refactor har över 200 SQL-formuleringsalternativ och funktioner för att tillämpa en stil på ett eller flera T-SQL-skript samtidigt.

Alternativ

Det första målet är att ställa in grundläggande alternativ. Ett av de största bekymmerna när det gäller att upprätta standarder är vilka T-SQL-nyckelord som ska eller inte ska aktiveras i koden.

Under fliken Huvudstorlek i fönstret Alternativ kan regler för kapitalisering ställas in för följande:

För att ställa in lämplig regel för versaler, kan följande alternativ användas: ÖVERSTÄND, små bokstäver, lägreCamelCase, UpperCamelCase , Korrekt fall eller om du lämnar standardreglerna för SQL-fråga-layout genom att avmarkera alternativet:

Vissa utvecklare föredrar SQL-nyckelord, datatyper etc. för att vara i UPPER CASE och andra utvecklare, men som att SQL-nyckelorden ska vara i gemener.

Den bästa lösningen när du väljer ett verktyg är att välja ett som kan hantera alla dessa olika preferenser. / p>

I det första exemplet är nyckelord med versaler och datatyper gemener:

I andra exempel, nyckelord är gemener och da ta-typer är versaler:

Det tredje exemplet, nyckelord och datatyper är versaler:

SQL-formaterare Effektförhandsgranskning

En av de viktigaste sakerna som alla SQL-layoutverktyg bör ha är att kunna förhandsgranska visuellt hur SQL-koden ser ut efter att ha lagt till några alternativ.

ApexSQL Refactor har en förhandsgranskning av påverkan av SQL-kodformat som visar en tydlig insikt och syn på effekterna av eventuella ändringar av alternativ direkt när du gör dem. Om du inte gillar hur det ser ut kan det enkelt ändras och återställas utan att spara:

Ställa in regler för versaler SQL-nyckelord, datatyper, identifierare (objektnamn), systemfunktioner, variabler är bara ett objekt i uppsättningen av stilen.

SQL-kodlayoutregler för alias, kommentarer, komma, avstånd, justering, etc. måste också ställas in för att ha en bra, konsekvent, läsbar och välformaterad SQL-kod.

För alla ovan nämnda saker måste ett verktyg för formatverktyg ha alternativ för inställningar dessa SQL-frågestylningsregler.

ApexSQL Refactor har alla dessa alternativ för att uppfylla dina krav.Mer om SQL-formateringsalternativ hittar du från länkarna nedan:

  • Regler för SQL-formatering – Komma och avstånd i T-SQL
  • Regler för SQL-formatering – Regelbunden och avgränsad T-SQL-identifierare
  • SQL-formateringsregler – SQL-kodkommentarer
  • SQL-formateringsregler – Konventioner för namngivning av SQL och regler för versaler
  • SQL-formateringsregler – Avslutande SQL-uttalanden med semikolon

SQL-fråga-formateringsprofiler

Att kunna ställa in önskad stil, spara den stilen och dela stilen med kollegor är en annan sak som varje SQL Server formateringsverktyget måste ha. Att ha ett förinställt urval av förkonfigurerade profiler är också mycket hjälpsamt.

Med ApexSQL Refactor-användare kan:

  • spara önskat SQL-frågaformateringsalternativ till en återanvändbar profil
  • -grupp och kategorisera formateringsstilar
  • snabbt ändra befintliga profiler
  • undvik konflikter med andra användare

Dessutom kommer ApexSQL Refactor med fyra inbyggda profiler

  • ApexSQL – innehåller vad vi bestämde var en bra SQL-formateringsstandard
  • Kompakt – ställer in alternativ för fördjupningar till 0 (noll) utrymme, alla ytterligare utrymmen är avmarkerade och tomma rader tas bort för en fråga där SQL-koden ser tät ut
  • Utökad – är motsatt kompaktprofilen. Denna profil lägger till tomma rader före / efter varje uttalande, kommentarer. Lägg till utrymme runt aritmetiska, logiska operatorer
  • MSDN SQL BOL – härmar stilen som används på MSDN-resurswebbplatsen

Dessa fyra inbyggda profiler kan inte ändras på något sätt , men en kopia av dessa inbyggda SQL-frågeställningar kan göras genom att klicka på knappen Kopiera och sedan kan ändras på önskat sätt:

Dessutom kan en ny SQL-formateringsprofil skapas genom att klicka på knappen Ny:

Importera / exportera profiler i SQL-format

När du väl har skapat den perfekta profilen är det viktigt att kunna exportera den för att göra den tillgänglig för andra; såväl som för mottagarna av profilen för att enkelt kunna importera den. ApexSQL Refactor tillhandahåller just denna funktion

Om du vill exportera profiler och dela med kollegor trycker du på knappen Export i alternativfönstret:

För att importera profiler i fönstret Alternativ, tryck på Importera-knappen.

Mer om ApexSQL Refactor-profiler finns på sidan Hur man anpassar SQL-formateringsprofiler.

Bearbeta objekt i en sats

När formatprofilen har skapats och alternativen har ställts in kan formatering av SQL-kod börja på allvar, med ett objekt eller skript åt gången. Men hur är det med att bearbeta allt i en databas på en gång?

Att bearbeta många SQL-objekt som lagrade procedurer individuellt kan naturligtvis vara ett mycket svårt och tidskrävande jobb.

Så , en annan sak, vi kan lägga till är att varje formatverktyg ska ha en funktion som kan formatera flera SQL-objekt med en enda önskad SQL-profil samtidigt.

ApexSQL Refactor har Format SQL-objektfunktionen som tillåter exakt det där. I Object Explorer väljer du en databas i vilken objekten som ska formateras, högerklickar och väljer snabbkommandot Formatera SQL-objekt-kommandot:

Alla skriptbaserade objekt, t.ex. vy kommer lagrade procedurer att listas i fönstret Format SQL-objekt:

Under kombinationsrutan Profil väljer du önskad SQL formaterarprofil (t.ex. ApexSQL) och, i listan, välj de SQL-objekt som ska formateras, klicka på knappen Skapa skript som öppnar ett skript i frågeredigeraren och klicka sedan på Kör (F5) -knappen:

För att bekräfta att SQL-objekt är formaterade med önskad profil, gå tillbaka till fönstret Formatera SQL-objekt, under kombinationsrutan Profil, välj en profil, och i SQL-objektlistan, under kolumnen OK med den gröna bockikonen, kommer SQL-objekt som är formaterade att visas, alla andra SQL-objekt markeras med röd x-ikon som indikerar att de inte är formaterade med den valda profilen :

Innan du formaterar ett SQL-objektskript med önskad profil kan samma SQL-skript visas så att användaren kan se hur det kommer att se ut efter att det har bearbetats. På detta sätt kan det jämföras genom att välja ett önskat SQL-objekt från listan, högerklicka och välja Jämför-knappen:

Batchskript T-SQL-format

En sak till som måste tas med i beräkningen, när man väljer rätt SQL-layoutverktyg, är möjligheten att formatera SQL-skript och skript i mappar i satser.

I situationer där det finns många SQL-skript på maskinen vilken kod måste kontrolleras och den koden är i en ganska stor röra som i bilden nedan:

Kontroll av kod i dessa SQL-skript kan vara utmanande.

En lösning för detta är att öppna SQL-skriptet i SSMS och formatera den med din önskade profil genom att klicka på Format SQL-knappen:

Detta löser ett problem för ett SQL-skript, men för fler av dessa SQL-skript måste en snabbare lösning tillhandahållas.

ApexSQL Refactor erbjuder Format SQL-skriptsfunktionen som en lösning för denna typ av problem. Från ApexSQL Refactor-menyn, under undermenyn Annan formatering, välj kommandot Format SQL scripts:

Format SQL skriptfönster öppnas, i listan navigerar du och väljer SQL-skript, väljer önskad SQL-formaterarprofil under kombinationsrutan Profil och trycker på OK-knappen:

All kod i valda SQL-skript formateras med önskad SQL-formateringsstil vilket granskning av SQL-skript gör det mycket enklare.

Värdintegration

En annan viktig objekt när du väljer rätt SQL-stylingverktyg är dess direkta integration i värdapplikationer som du normalt använder för SQL-kodning som SSMS eller Visual Studio.

Lyckligtvis stöder ApexSQL Refactor integration från SSMS 2012 och senare och stöder integration i Visual Studio från VS 2010-versionen och senare.

Detta innebär att du kan lägga till kraftfulla SQL-formateringsfunktioner och förbättra kodningsproduktiviteten utan att någonsin lämna ng hem för din favoritredigerare

Sömlös värdintegration och konsekvent användarupplevelse

Integrering i en värdapplikation är en sak. Att integrera sömlöst med en konsekvent slutanvändarupplevelse är en annan. Många tillägg är dåliga gäster, menar med menyutrymme, erbjuder oskiljaktiga färger och ikoner och är i allmänhet visuellt ”högljudda” och påträngande. ApexSQL Refactor är en artig gäst som smidigt smälter in i värdmiljöer, nästan som om det var en del av IDE själv. Denna konsekventa användarupplevelse inkluderar ikonografi, visuell stil och teman.

Färgteman gör det möjligt för användaren att ändra det visuella utseendet för att passa dina preferenser och ett bra verktyg från tredje part bör matcha denna förmåga. ApexSQL Refactor stöder SSMS och Visual color teman men ännu bättre ändras automatiskt för att anpassas till värdtemainställningarna.

Se den här artikeln för att lära dig mer.

Mörkt färgtema för Visual Studio:

SSMS blått färgtema:

En anteckning , ApexSQL Refactor stöder SSMS mörkt färgtema:

Även om färgtemat inte är officiellt än; för dem som vill vet hur man ställer in d arkfärgtema i SSMS 17 finns på sidan Ställa in det mörka temat på SQL Server-hanteringsstudiosidan.

Dessutom ärvs alla ikoner som visas i kommandon, dialogrutor, mallar etc. i ApexSQL Refactor ärvda. från Visual Studio Image Library. Några av ikonerna från biblioteket är omdesignade för att vara mer intuitiva, enkla och är lätt att känna igen symboler.

Mer finns i Visual Language Dictionary för Visual Studio för ikonografi, färger och andra visuella koncept som används i ApexSQL-verktyg / tilläggssida.

Stöd för hög DPI och 4K-upplösning

ApexSQL Refactor stöder hög DPI- och 4K-upplösning vilket innebär att ApexSQL Refactor körs, windows (t.ex. Alternativfönster ) där du ställer in alla alternativ för SQL-formaterare och skärmen inte blir suddig på din 4K-skärm:

Obs: VS hanterar 4K och hög-DPI mycket bra, men SSMS fungerar inte så bra på 4K-skärmar. För 4K- och high-DPI-problemet i SSMS 2016 och högre finns en lösning som kan ses på sidan Så här aktiverar du High-DPI i SSMS (SQL Server Management Studio) – Tips, tricks och problem.

Se även:

Write a Comment

Din e-postadress kommer inte publiceras. Obligatoriska fält är märkta *