Spis treści
- Opcje formatu T SQL
- Podgląd wpływu
- Profile programu formatującego SQL
- Importowanie / eksportowanie profili programu formatującego SQL
- Sformatuj obiekt zbiorczo
- Sformatuj skrypty T-SQL zbiorczo
- Integracja hosta
- Obsługa wysokiej rozdzielczości DPI i 4K
Nikt nie lubi sprawdzać i czytać mnóstwa niechlujnego, niesformatowanego tekstu. Jeśli chodzi o czytanie złożonego kodu SQL, problem może stać się jeszcze trudniejszy, zwłaszcza jeśli to Ty musisz go rozplątać.
Kod SQL można sformatować za pomocą stylu ułatwiającego jego czytanie , zwłaszcza jeśli cały zespół używa tego samego. Czysty, dobrze sformatowany (spójny) kod SQL można odczytać znacznie szybciej niż niekonsekwentnie napisany kod SQL, niezależnie od tego, czy niespójność dotyczy członków zespołu i różnych obiektów, czy nawet w ramach tego samego skryptu samego obiektu. Dobrze zorganizowany i sformatowany kod SQL można przeglądać wydajniej. Przekazanie projektu innemu zespołowi lub klientowi z dobrze sformatowanym kodem SQL będzie znacznie płynniejsze i znacznie bardziej doceniane.
Główny problem z formatowaniem skryptów SQL polega na tym, że nie ma stylu ani standardów tego, jak SQL kod powinien być sformatowany i wszystko jest ogólnie kwestią preferencji. Najlepszym rozwiązaniem jest ustalenie standardów, których Ty i Twój zespół w firmie będziecie przestrzegać, a następnie upewnienie się, że są one konsekwentnie stosowane.
Cały kod SQL można formatować ręcznie, co jest bardzo czasochłonne ale istnieją narzędzia innych firm i można ich używać do szybkiego i wydajnego formatowania.
W tym artykule opisano i przedstawiono kilka podstawowych wskazówek i oczekiwań dotyczących tego, jakie powinno mieć doskonałe narzędzie do formatowania zapytań SQL, aby osiągnąć cel aby ustalić spójny i standardowy styl formatu (standard) oraz jak zastosować ten styl do jednego skryptu T-SQL lub wielu skryptów T-SQL lub obiektów jednym kliknięciem.
Jednym z takich narzędzi do formatowania jest ApexSQL Refactor, dodatek, który można zintegrować z programem SQL Server Management Studio (SSMS) lub Visual Studio (VS). ApexSQL Refactor ma ponad 200 opcji formatowania zapytań SQL i funkcji do jednoczesnego stosowania stylu w jednym lub zbiorczym skrypcie T-SQL.
Opcje
Pierwszym celem jest ustawienie podstawowych opcji. Jednym z głównych problemów przy ustalaniu standardów jest to, które słowa kluczowe T-SQL powinny lub nie powinny być pisane wielkimi literami w kodzie.
Na karcie Kapitalizacja w oknie Opcje można ustawić zasady dotyczące wielkich liter dla następujące:
Aby ustawić odpowiednią regułę dla wielkich liter, można użyć następujących opcji: WIELKIE LITERY, małe litery, lowerCamelCase, UpperCamelCase , Właściwa wielkość liter lub pozostawienie domyślnych reguł układu zapytania SQL poprzez odznaczenie opcji:
Niektórzy programiści wolą słowa kluczowe SQL, typy danych itp. pisane WIELKIMI LITERAMI, a inni programiści lubią, aby słowa kluczowe SQL były pisane małymi literami.
Najlepszym rozwiązaniem przy wyborze narzędzia jest wybranie takiego, które obsługuje wszystkie te różne preferencje.
W pierwszym przykładzie słowa kluczowe są pisane dużymi literami, a typy danych małymi:
W Drugi przykład, słowa kluczowe to małe litery i da typy ta są pisane dużymi literami:
Trzeci przykład, słowa kluczowe i typy danych są pisane dużymi literami:
Program formatujący SQL Podgląd wpływu
Jedną z najważniejszych rzeczy, które powinno mieć każde narzędzie do tworzenia układu SQL, jest możliwość wizualnego podglądu jak wygląda kod SQL po dodaniu niektórych opcji.
ApexSQL Refactor ma podgląd wpływu formatu kodu SQL, który pokazuje jasny wgląd i obraz wpływu wszelkich zmian opcji natychmiast po ich wprowadzeniu. Jeśli nie podoba ci się wygląd, możesz go łatwo zmienić i cofnąć bez zapisywania:
Ustawianie zasad używania wielkich liter słów kluczowych SQL, typów danych, identyfikatorów (nazw obiektów), funkcji systemowych, zmiennych to tylko jedna pozycja w zestawie stylu.
Zasady układu kodu SQL dla aliasów, komentarzy, przecinków, odstępów, wyrównania, itp., należy również ustawić, aby uzyskać dobry, spójny, czytelny i dobrze sformatowany kod SQL.
W przypadku wszystkich wyżej wymienionych rzeczy narzędzie Format musi mieć opcje ustawień tych Reguły stylów zapytań SQL.
ApexSQL Refactor ma wszystkie te opcje, aby spełnić Twoje wymagania.Więcej o opcjach programu formatującego SQL można znaleźć w poniższych linkach:
- Reguły formatowania SQL – Przecinki i odstępy w T-SQL
- Reguły formatowania SQL – Zwykłe i rozdzielane Identyfikatory T-SQL
- Reguły formatowania SQL – komentowanie kodu SQL
- Reguły formatowania SQL – Konwencje nazewnictwa SQL i zasady dotyczące wielkich liter
- Reguły formatowania SQL – kończenie Instrukcje SQL ze średnikami
Profile programu formatującego zapytania SQL
Możliwość ustawienia żądanego stylu, zapisanie tego stylu i udostępnienie stylu współpracownikom to kolejna rzecz, którą każdy SQL Server narzędzie formatujące musi mieć. Ponadto posiadanie wstępnie ustawionego wyboru wstępnie skonfigurowanych profili, gotowe do użycia jest bardzo pomocne.
Dzięki ApexSQL Refactor użytkownicy mogą:
- zapisać preferowane Opcje programu formatującego zapytania SQL do profilu wielokrotnego użytku
- grupuj i kategoryzuj style formatowania
- szybko modyfikuj istniejące profile
- unikaj konfliktów z innymi użytkownikami
Ponadto ApexSQL Refactor zawiera cztery wbudowane profile
- ApexSQL – zawiera to, co uznaliśmy za dobry standard programu formatującego SQL
- Kompaktowe – ustawia opcję wcięć do 0 (zero) miejsca, wszystkie dodatkowe spacje są odznaczane, a puste wiersze są usuwane z zapytania, w którym kod SQL wygląda na gęsty.
- Rozszerzony – jest przeciwieństwem profilu Compact. Ten profil dodaje puste linie przed / po każdym oświadczeniu, komentarzach. Dodaj spację wokół operatorów arytmetycznych i logicznych
- MSDN SQL BOL – naśladuje styl używany w witrynie zasobów MSDN
Tych czterech wbudowanych profili nie można w żaden sposób zmienić , ale kopię tych wbudowanych profili programu formatującego zapytania SQL można utworzyć, klikając przycisk Kopiuj, a następnie można je zmienić w preferowany sposób:
Ponadto można utworzyć nowy profil programu formatującego SQL, klikając przycisk Nowy:
Importowanie / eksportowanie profili w formacie SQL
Po utworzeniu idealnego profilu ważne jest, aby móc go wyeksportować, aby był dostępny dla innych; a także aby odbiorcy profilu mogli go łatwo zaimportować. ApexSQL Refactor zapewnia tylko tę funkcjonalność
Aby wyeksportować profile i udostępnić je współpracownikom, naciśnij przycisk Eksportuj w oknie Opcje:
Aby zaimportować profile w oknie Opcje, naciśnij przycisk Importuj.
Więcej o profilach ApexSQL Refactor można znaleźć na stronie Jak dostosować profile formatowania SQL.
Przetwarzanie obiektów zbiorczo
Po utworzeniu profilu formatu i ustawieniu opcji formatowanie kodu SQL można rozpocząć na dobre, od jednego obiektu lub skryptu na raz. Ale co z przetwarzaniem wszystkiego w bazie danych naraz?
Przetwarzanie wielu obiektów SQL, takich jak procedury składowane, może być oczywiście bardzo trudne i czasochłonne.
Zatem Kolejną rzeczą, którą możemy dodać, jest to, że każde narzędzie formatujące powinno mieć funkcję, która może formatować wiele obiektów SQL za pomocą jednego, pożądanego profilu SQL naraz.
ApexSQL Refactor ma funkcję Formatuj obiekty SQL, która pozwala dokładnie że. W Eksploratorze obiektów wybierz bazę danych, w której znajdują się obiekty do sformatowania, kliknij prawym przyciskiem myszy iz menu kontekstowego wybierz polecenie Formatuj obiekty SQL:
Wszystkie obiekty oparte na skryptach, np widoku, procedury składowane zostaną wyświetlone w oknie Formatowanie obiektów SQL:
W polu kombi Profile wybierz żądany SQL profil programu formatującego (np. ApexSQL) i wybierz z listy obiekty SQL, które chcesz sformatować, kliknij przycisk Utwórz skrypt, co spowoduje otwarcie skryptu w edytorze zapytań, a następnie kliknij przycisk Wykonaj (F5):
Aby potwierdzić, że obiekty SQL są sformatowane przy użyciu żądanego profilu, wróć do okna Formatuj obiekty SQL, w polu kombi Profil wybierz profile i na liście obiektów SQL pod kolumną OK z zieloną ikoną znacznika wyboru zostaną wskazane sformatowane obiekty SQL, wszystkie inne obiekty SQL zostaną oznaczone czerwoną ikoną x, co oznacza, że nie są sformatowane z wybranym profilem :
Ponadto przed sformatowaniem skryptu obiektu SQL z żądanym profilem można wyświetlić te same skrypty SQL, aby użytkownik można zobaczyć e jak będzie wyglądać po przetworzeniu. W ten sposób można go porównać, wybierając żądany obiekt SQL z listy, klikając prawym przyciskiem myszy i wybierając przycisk Porównaj:
Skrypty wsadowe w formacie T-SQL
Kolejną rzeczą, którą należy wziąć pod uwagę przy wyborze odpowiedniego narzędzia do tworzenia układu SQL, jest możliwość formatowania skryptów SQL i skryptów w folderach w partiach.
W sytuacjach, gdy na komputerze jest dużo skryptów SQL, których kod należy sprawdzić, a kod jest w dość dużym bałaganie, jak na poniższym obrazku:
Sprawdzanie kodu w tych skryptach SQL może być trudne.
Jednym z rozwiązań jest otwarcie skryptu SQL w SSMS i sformatuj go za pomocą preferowanego profilu, klikając przycisk Formatuj SQL:
To rozwiązuje problem z jednym skryptem SQL, ale więcej takich skryptów SQL, należy zapewnić szybsze rozwiązanie.
ApexSQL Refactor oferuje funkcję formatowania skryptów SQL jako rozwiązanie tego rodzaju problemu. Z menu ApexSQL Refactor, w podmenu Inne formatowanie wybierz polecenie Formatuj skrypty SQL:
Formatuj SQL otworzy się okno skryptów, na liście przejdź do i wybierz skrypty SQL, wybierz żądany profil programu formatującego SQL w polu kombi Profil i naciśnij przycisk OK:
Cały kod w wybranych skryptach SQL zostanie sformatowany przy użyciu żądanego stylu programu formatującego SQL, co znacznie ułatwia przeglądanie skryptów SQL.
Integracja hosta
Kolejna ważna przy wyborze odpowiedniego narzędzia do stylizacji SQL jest jego bezpośrednia integracja z aplikacjami hosta, których zwykle używasz do kodowania SQL, takich jak SSMS lub Visual Studio.
Na szczęście ApexSQL Refactor obsługuje integrację z SSMS 2012 i nowszymi oraz obsługuje integrację z Visual Studio od wersji VS 2010 i nowszych.
Oznacza to, że możesz dodać potężne możliwości programu formatującego SQL i poprawić produktywność kodowania bez konieczności opuszczania w domu swojego ulubionego edytora
Bezproblemowa integracja z hostem i spójne wrażenia użytkownika
Integracja z aplikacją hosta to jedno. Bezproblemowa integracja z spójnym doświadczeniem użytkownika końcowego to inna sprawa. Wiele dodatków to złych gości, zajmujących miejsce w menu, oferujących rozłączne kolory i ikony oraz generalnie wizualnie „głośny” i natrętny. ApexSQL Refactor to uprzejmy gość, który płynnie wtapia się w środowisko hosta, prawie tak, jakby był częścią samego IDE. To spójne doświadczenie użytkownika obejmuje ikonografię, styl wizualny i motywy.
Motywy kolorów pozwalają użytkownikowi modyfikować wygląd wizualny zgodnie z własnymi preferencjami, a dobre narzędzie innej firmy powinno pasować do tej możliwości. ApexSQL Refactor obsługuje SSMS i kolory wizualne motywy, ale jeszcze lepiej zmieni się automatycznie, aby dostosować się do ustawień motywu hosta.
Zobacz ten artykuł, aby dowiedzieć się więcej.
Motyw ciemnego koloru programu Visual Studio:
Motyw w kolorze niebieskim SSMS:
Jedna uwaga , ApexSQL Refactor obsługuje motyw ciemnych kolorów SSMS:
Nawet jeśli motyw kolorów nie jest jeszcze oficjalny; dla tych, którzy chcą wiedzieć, jak skonfigurować d Arkusz kolorów w SSMS 17 można znaleźć na stronie Setting up the dark theme in SQL Server Management Studio.
Ponadto wszystkie ikony pojawiające się w poleceniach, oknach dialogowych, szablonach itp. w ApexSQL Refactor są dziedziczone z biblioteki obrazów programu Visual Studio. Niektóre ikony z biblioteki zostały przeprojektowane, aby były bardziej intuicyjne, proste i łatwo rozpoznawalne.
Więcej można znaleźć w Słowniku języka wizualnego dla programu Visual Studio w zakresie ikonografii, kolorów i innych koncepcji wizualnych stosowanych w Strona narzędzi / dodatków ApexSQL.
Obsługa wysokiej rozdzielczości DPI i 4K
ApexSQL Refactor obsługuje wysoką rozdzielczość DPI i 4K, co oznacza, że po uruchomieniu ApexSQL Refactor okna (np. Okno opcji ), w którym ustawisz wszystkie opcje programu formatującego SQL, a ekran nie będzie rozmazany na monitorze 4K:
Uwaga: VS bardzo dobrze radzi sobie z 4K i wysokim DPI, ale SSMS nie działa tak dobrze na monitorach 4K. W przypadku problemu 4K i wysokiej rozdzielczości DPI w SSMS 2016 i nowszych istnieje rozwiązanie, które można zobaczyć na stronie Jak włączyć wysoką rozdzielczość w SSMS (SQL Server Management Studio) – porady, wskazówki i problemy.
