Obsah
- Možnosti formátu T SQL
- Náhled nárazu
- Profily formátovacího modulu SQL
- Import / Export profilů formátovacího nástroje SQL
- Formátování objektu v dávce
- Formátování skriptů T-SQL v dávce
- Integrace hostitele
- Podpora vysokého DPI a rozlišení 4K
Nikdo nemá rád kontrolu a čtení spousty chaotického, neformátovaného textu. Pokud jde o čtení složitého kódu SQL, může být tento problém ještě obtížnější, zejména pokud jste ten, kdo jej musí rozmotat.
Kód SQL lze formátovat stylem, který usnadňuje jeho čtení , zvláště pokud celý tým používá totéž. Čistý, dobře formátovaný (konzistentní) kód SQL lze číst mnohem rychleji než nekonzistentně napsaný kód SQL, ať už je nekonzistence napříč členy týmu a různými objekty, nebo dokonce ve stejném skriptu samotného objektu. Dobře organizovaný a formátovaný kód SQL lze kontrolovat efektivněji. Předání projektu jinému týmu nebo klientovi s dobře naformátovaným kódem SQL bude mnohem plynulejší a mnohem oceňovanější.
Hlavním problémem při formátování skriptů SQL je, že neexistuje žádný styl ani standardy toho, jak se má SQL kód by měl být formátován a vše je obecně otázkou preference. Nejlepším řešením je nastavit standardy, kterých se vy a váš tým ve společnosti budete držet, a poté zajistit jejich důsledné používání.
Celý kód SQL lze formátovat ručně, což je časově velmi náročné ale nástroje třetích stran existují a lze je použít k rychlému a efektivnímu formátování.
Tento článek popíše a představí několik základních pokynů a očekávání, co by měl mít dokonalý nástroj pro formátování dotazů SQL, aby splnil váš cíl vytvořit konzistentní a standardní styl formátu (standard) a jak tento styl použít na jeden skript T-SQL nebo na mnoho skriptů nebo objektů T-SQL jedním kliknutím.
Jedním z takových formovacích nástrojů je ApexSQL Refactor, doplněk, který lze integrovat do SQL Server Management Studio (SSMS) nebo Visual Studio (VS). ApexSQL Refactor má více než 200 možností vytváření dotazů SQL a funkcí pro použití stylu na jeden nebo hromadné skripty T-SQL najednou.
Možnosti
Prvním cílem je nastavení základních možností. Jednou z hlavních obav při stanovení standardů je, která klíčová slova T-SQL mají nebo nemají být v kódu velká.
Na kartě Velká písmena v okně Možnosti lze nastavit pravidla pro velká písmena pro následující:
K nastavení vhodného pravidla pro velká písmena lze použít následující možnosti: VELKÝ PŘÍPAD, malá písmena, lowerCamelCase, UpperCamelCase , Správná velikost písmen nebo ponechání výchozích pravidel rozložení dotazů SQL zrušením výběru možnosti:
Někteří vývojáři preferují klíčová slova SQL, datové typy atd., aby byly v HORNÍM PŘÍPADU a dalším vývojářům, ale mají ráda, že klíčová slova SQL jsou malá.
Nejlepším řešením při výběru nástroje je výběr nástroje, který zvládne všechny tyto různé preference.
V prvním příkladu jsou klíčová slova velká a datové typy malá:
V druhý příklad, klíčová slova jsou malá a da Typy jsou velká písmena:
Třetí příklad, klíčová slova a datové typy jsou velká písmena:
Náhled dopadu formátovacího modulu SQL
Jednou z důležitých věcí, kterou by měl mít každý nástroj pro rozložení SQL, je možnost vizuálního náhledu jak vypadá SQL kód po přidání některých možností.
ApexSQL Refactor má náhled dopadu na formát kódu SQL, který ukazuje jasný náhled a pohled na dopad všech změn možností okamžitě, jakmile je provedete. Pokud se vám nelíbí, jak to vypadá, lze to snadno změnit a vrátit zpět bez uložení:
Nastavení pravidel pro velká písmena klíčových slov SQL, datových typů, identifikátorů (názvy objektů), systémových funkcí, proměnných je pouze jedna položka v sadě stylu.
Pravidla rozložení kódu SQL pro aliasy, komentáře, čárky, mezery, zarovnání, atd., je třeba také nastavit, aby měl dobrý, konzistentní, čitelný a dobře formátovaný kód SQL.
U všech výše uvedených věcí musí nástroj formátovacího nástroje mít možnosti pro nastavení těchto Pravidla pro styling dotazů SQL.
ApexSQL Refactor má všechny tyto možnosti, aby vyhovoval vašim požadavkům.Další informace o možnostech formátování SQL naleznete v odkazech níže:
- Pravidla formátování SQL – Čárky a mezery v T-SQL
- Pravidla formátování SQL – Pravidelné a oddělené Identifikátory T-SQL
- Pravidla formátování SQL – komentování kódu SQL
- Pravidla formátování SQL – konvence pojmenování SQL a pravidla pro velká písmena
- Pravidla formátování SQL – ukončení Příkazy SQL se středníky
Profily formátovacího modulu dotazů SQL
Možnost nastavit požadovaný styl, uložit tento styl a sdílet tento styl s kolegy je další věc, kterou každý SQL Server nástroj pro formátování musí mít. Také s přednastaveným výběrem předkonfigurovaných profilů je out-of-the-box velmi užitečný.
S ApexSQL Refactor mohou uživatelé:
- uložit preferované Možnosti formátovače dotazů SQL na opakovaně použitelný profil
- seskupujte a kategorizujte styly formátování
- rychle upravte stávající profily
- vyhněte se konfliktům s ostatními uživateli
ApexSQL Refactor navíc přichází se čtyřmi integrovanými profily.
- ApexSQL – obsahuje to, co jsme určili jako dobrý standard formátovacího nástroje SQL
- Compact – nastaví možnost odsazení na 0 (nula) mezery, všechny další mezery nejsou zaškrtnuty a prázdné řádky jsou odstraněny pro dotaz, kde kód SQL vypadá hustě
- Rozšířený – je naproti profilu Compact. Tento profil přidává prázdné řádky před / po každém prohlášení, komentáři. Přidejte prostor kolem aritmetických logických operátorů
- MSDN SQL BOL – napodobuje styl použitý na webu prostředků MSDN
Tyto čtyři integrované profily nelze žádným způsobem změnit , ale kopii těchto předdefinovaných profilů formátoru dotazů SQL lze vytvořit kliknutím na tlačítko Kopírovat a poté je lze změnit preferovaným způsobem:
Kliknutím na tlačítko Nový lze také vytvořit nový profil formátoru SQL:
Import / export profilů ve formátu SQL
Jakmile vytvoříte dokonalý profil, je důležité mít možnost jej exportovat, aby byl přístupný ostatním; a také pro příjemce profilu, aby jej mohli snadno importovat. ApexSQL Refactor poskytuje právě tuto funkci.
Chcete-li exportovat profily a sdílet je s kolegy, stiskněte tlačítko Exportovat v okně Možnosti:
Chcete-li importovat profily v okně Možnosti, stiskněte tlačítko Importovat.
Více o profilech ApexSQL Refactor najdete na stránce Jak přizpůsobit profily formátování SQL.
Zpracování objektů v dávce
Jakmile je vytvořen profil formátu a jsou nastaveny možnosti, může formátování kódu SQL začít vážně, vždy s jedním objektem nebo skriptem. Ale co zpracování všeho v databázi najednou?
Zpracování mnoha objektů SQL, jako jsou uložené procedury jednotlivě, může být samozřejmě velmi obtížná a časově náročná práce.
Takže , další věc, kterou můžeme přidat, je, že každý formátovací nástroj by měl mít funkci, která může formátovat více objektů SQL pomocí jediného požadovaného profilu SQL najednou.
ApexSQL Refactor má funkci Formátovat objekty SQL, která umožňuje přesně že. V Průzkumníku objektů vyberte databázi, ve které jsou umístěny objekty, které chcete formátovat, klikněte pravým tlačítkem a v místní nabídce vyberte příkaz Formátovat objekty SQL:
Všechny objekty založené na skriptu, např zobrazení, uložené procedury budou uvedeny v okně Formátovat objekty SQL:
V rozbalovacím seznamu Profil vyberte požadovaný SQL profil formátovače (např. ApexSQL) a ze seznamu vyberte objekty SQL, které chcete formátovat, klikněte na tlačítko Vytvořit skript, čímž se otevře skript v editoru dotazů, poté klikněte na tlačítko Spustit (F5):
Chcete-li potvrdit, že objekty SQL jsou formátovány s požadovaným profilem, vraťte se do okna Formátovat objekty SQL v rozevíracím seznamu Profil vyberte profil a v seznamu objektů SQL ve sloupci OK se zelenou ikonou zaškrtnutí budou označeny objekty SQL, které jsou naformátovány, všechny ostatní objekty SQL budou označeny červenou ikonou x, což znamená, že nejsou naformátovány vybraným profilem :
Před formátováním skriptu objektu SQL s požadovaným profilem lze navíc zobrazit stejné skripty SQL, aby uživatel může se Jak to bude vypadat po zpracování. Tímto způsobem jej lze porovnat výběrem požadovaného objektu SQL ze seznamu, kliknutím pravým tlačítkem a výběrem tlačítka Porovnat:
Dávkové skripty ve formátu T-SQL
Při výběru správného nástroje pro rozložení SQL je třeba vzít v úvahu ještě jednu věc, je možnost formátovat skripty a skripty SQL ve složkách v dávkách.
V situacích, kdy na počítači existuje spousta skriptů SQL, které je třeba zkontrolovat, a tento kód je v docela velkém nepořádku, jako na obrázku níže:
Kontrola kódu v těchto skriptech SQL může být náročná.
Jedním z řešení je otevření skriptu SQL v SSMS a naformátujte jej podle svého preferovaného profilu kliknutím na tlačítko Formátovat SQL:
Tím se vyřeší problém pro jeden skript SQL, ale pro více z těchto skriptů SQL je třeba poskytnout rychlejší řešení.
ApexSQL Refactor nabízí funkci Format SQL scripts jako řešení tohoto druhu problému. V nabídce ApexSQL Refactor vyberte v podnabídce Jiné formátování příkaz Formátovat skripty SQL:
Formátovat SQL Otevře se okno skriptů, v seznamu přejděte a vyberte skripty SQL, vyberte požadovaný profil formátovacího modulu SQL v rozbalovacím seznamu Profil a stiskněte tlačítko OK:
Veškerý kód ve vybraných skriptech SQL bude naformátován požadovaným stylem formátovače SQL, což umožňuje kontrolu skriptů SQL mnohem jednodušší.
Integrace hostitele
Další důležitý při výběru správného nástroje pro styling SQL je jeho přímá integrace do hostitelských aplikací, které běžně používáte pro kódování SQL, jako je SSMS nebo Visual Studio.
Naštěstí ApexSQL Refactor podporuje integraci od SSMS 2012 a vyšší a podporuje integraci do Visual Studio od verze VS 2010 a vyšší.
To znamená, že můžete přidat výkonné možnosti formátování SQL a zlepšit produktivitu kódování bez jakéhokoli úniku domov vašeho oblíbeného editora
Bezproblémová integrace hostitele a konzistentní uživatelské prostředí
Integrace do hostitelské aplikace je jedna věc. Bezproblémová integrace s konzistentní zkušeností koncového uživatele je další. Mnoho doplňků je špatných hostů, kteří se trápí prostorem nabídky, nabízejí nesouvislé barvy a ikony a jsou obecně vizuálně „hlasité“ a dotěrné. ApexSQL Refactor je zdvořilý host, který bezproblémově zapadá do hostitelského prostředí, téměř jako by byl součástí samotného IDE. Tato konzistentní uživatelská zkušenost zahrnuje ikonografii, vizuální styl a motivy.
Barevné motivy umožňují uživateli upravit vizuální vzhled tak, aby vyhovoval vašim preferencím, a tento nástroj by měl odpovídat dobrý nástroj třetí strany. ApexSQL Refactor podporuje SSMS a vizuální barvu motivy, ale ještě lépe se automaticky změní, aby se přizpůsobily nastavení motivů hostitele.
Další informace najdete v tomto článku.
Temné barvy Visual Studio:
Modré barevné motivy SSMS:
Jedna poznámka , ApexSQL Refactor podporuje motiv SSMS dark color:
Přestože barevný motiv ještě není oficiální; pro ty, kteří chtějí vědět, jak nastavit d ark color theme in SSMS 17 can be found on the Setting up the dark theme in SQL Server management studio page.
Dále jsou zděděny všechny ikony, které se objevují v příkazech, dialozích, šablonách atd. v ApexSQL Refactor z knihovny obrázků Visual Studio. Některé ikony z knihovny jsou přepracovány tak, aby byly intuitivnější, jednodušší a snadno rozpoznatelné symboly.
Další informace najdete ve Visual Language Dictionary for Visual Studio pro ikonografii, barvy a další vizuální koncepty použité v Stránka nástrojů / doplňků ApexSQL.
Podpora vysokého DPI a rozlišení 4K
ApexSQL Refactor podporuje vysoké DPI a rozlišení 4K, což znamená, když je spuštěn ApexSQL Refactor, okna (např. Okno Možnosti ) ve kterém nastavíte všechny možnosti formátovače SQL a obrazovka nebude na vašem monitoru 4K rozmazaná:
Poznámka: VS zpracovává 4K a high-DPI velmi dobře, ale SSMS na monitorech 4K nefunguje tak dobře. Pro problém 4K a high-DPI v SSMS 2016 a vyšších existuje řešení, které lze vidět na stránce Jak povolit High-DPI v SSMS (SQL Server Management Studio) – Tipy, triky a problémy.
