Samouczek: przechowywanie schematu bazy danych w usłudze Git

• SDK .NET 8
• Visual Studio 2022 – Community, Professional lub Enterprise
• Zainstaluj Narzędzia danych SQL Server (SSDT) dla Visual Studio

• SDK .NET 8
• Visual Studio Code
• Rozszerzenie dla SQL Database Projects

• .NET SDK
• SQL Server Management Studio (SSMS)
• Zainstalowane obciążenie Database DevOps w programie SSMS

• SDK .NET 8
• Interfejs wiersza polecenia SqlPackage
• Microsoft.Build.Sql.Templates .NET szablony

# install SqlPackage CLI
dotnet tool install -g Microsoft.SqlPackage

# install Microsoft.Build.Sql.Templates
dotnet new install Microsoft.Build.Sql.Templates

W Visual Studio SQL Server Eksplorator obiektów kliknij prawym przyciskiem myszy bazę danych, z której chcesz utworzyć project, a następnie wybierz pozycję Utwórz nową Project... .

W oknie dialogowym Utwórz nowy projekt wprowadź nazwę projektu. Nazwa projektu nie musi być zgodna z nazwą bazy danych. Zweryfikuj i zmodyfikuj lokalizację projektu zgodnie z potrzebami. Domyślne ustawienia importu importują obiekty do folderów najpierw według schematu, a następnie według typu obiektu. Możesz zmodyfikować ustawienia importu, aby zmienić strukturę folderów lub uwzględnić uprawnienia do importowanych obiektów. Rozpocznij import.

W oknie dialogowym Importowanie bazy danych wyświetlany jest postęp importowania jako komunikaty. Po zakończeniu importowania można zobaczyć zaimportowane obiekty w Eksplorator rozwiązań. Proces przechowuje logi w pliku w katalogu projektu pod Import Schema Logs. Wybierz Zakończ

W widoku eksploratora obiektów bazy danych w programie Visual Studio Code wybierz bazę danych, z której chcesz utworzyć projekt. Kliknij prawym przyciskiem myszy bazę danych i wybierz pozycję Utwórz projekt z bazy danych.

W Visual Studio Code okno dialogowe Utwórz projekt z bazy danych wymaga nazwy i lokalizacji projektu. Domyślne ustawienia importu importują obiekty do folderów najpierw według schematu, a następnie według typu obiektu. Możesz wybrać inną strukturę folderów lub wybrać opcję dołączenia uprawnień do importowanych obiektów przed wybraniem pozycji Utwórz.

Otwórz widok Database Projects, aby wyświetlić nowy projekt i zaimportowane definicje obiektów.

W Eksplorator obiektów w SQL Server Management Studio kliknij prawym przyciskiem myszy bazę danych, z której chcesz utworzyć project, a następnie wybierz polecenie Utwórz Project z bazy danych... w menu Zadania.

W oknie dialogowym Tworzenie projektu SQL z bazy danych sprawdź wybraną bazę danych i w razie potrzeby zmień nazwę projektu oraz jego lokalizację. Nowy projekt jest tworzony z obiektami z wybranej bazy danych i rozmieszczony w folderach według schematu, a następnie typu obiektu.

Plik rozwiązania zostanie automatycznie utworzony w folderze powyżej folderu projektu i zostanie otwarty w Eksplorator rozwiązań po utworzeniu. Jeśli chcesz dodać nowy projekt do istniejącego rozwiązania, wybierz pozycję Dodaj do rozwiązania i przejdź do pliku rozwiązania. Wybierz polecenie Create (Utwórz), aby utworzyć projekt.

Użyj interfejsu wiersza polecenia sqlPackage, aby wyodrębnić schemat istniejącej bazy danych do projektu SQL. Następujące polecenie SqlPackage wyodrębnia schemat bazy danych do kompletnego projektu SQL. Pliki .sql są zorganizowane w zagnieżdżonych folderach według schematu i typu obiektu, a plik .sqlproj jest tworzony do zarządzania projektem z właściwościami ustawionymi zgodnie z opcjami bazy danych.

sqlpackage /a:Extract /ssn:localhost /sdn:MyDatabase /tf:MyDatabaseProject /p:ExtractTarget=SqlProject

Po otwarciu projektu SQL w Visual Studio utwórz lokalne repozytorium Git i wypchnij go do zdalnego.

1. Wybierz z paska menu pozycję Git>Utwórz repozytorium Git.

2. W oknie dialogowym Tworzenie repozytorium Git, w sekcji Wypchnij do nowego repozytorium zdalnego, wybierz opcję GitHub lub Azure DevOps. Jeśli zdecydujesz się wypchnąć zmiany do serwisu GitHub, po wyświetleniu monitu zaloguj się do swojego konta GitHub. Jeśli wybierzesz Azure DevOps, zaloguj się do konta Azure DevOps i wybierz lub utwórz projekt.

3. Wprowadź nazwę i opis repozytorium. Upewnij się, że szablon .gitignore jest ustawiony na VisualStudio, a następnie wybierz pozycję Utwórz i wypchnij.

Visual Studio tworzy lokalne repozytorium Git, tworzy pierwszy commit obejmujący pliki projektu SQL i wypycha je do zdalnego repozytorium.

Aby sprawdzić, czy kod został wypchnięty pomyślnie, otwórz przeglądarkę i przejdź do repozytorium w GitHub (https://github.com) lub Azure DevOps (https://dev.azure.com). Powinny zostać wyświetlone pliki projektu SQL, w tym .sqlproj plik i .sql definicje obiektów.

Aby uzyskać więcej informacji, zobacz About Git in Visual Studio (Informacje o usłudze Git w Visual Studio).

Po otwarciu folderu projektu SQL w Visual Studio Code zainicjuj lokalne repozytorium Git i wypchnij je do zdalnego.

1. Otwórz widok Kontrola źródła , wybierając ikonę Kontrola źródła na pasku działań lub naciśnij klawisz Ctrl+Shift+G.

2. Wybierz pozycję Zainicjuj repozytorium , aby utworzyć nowe repozytorium Git w bieżącym folderze.

3. Wszystkie pliki projektu są wyświetlane jako niezaśledzone zmiany. Wybierz ikonę + obok pozycji Zmiany , aby przygotować wszystkie pliki.

4. Wprowadź komunikat zatwierdzenia, taki jak Initial commit of SQL project w polu wprowadzania komunikatu, a następnie wybierz przycisk Zatwierdź (ikona znacznika wyboru).

5. W widoku kontroli źródła wybierz Publikuj gałąź, aby wypchnąć lokalne repozytorium do repozytorium zdalnego. Wybierz, czy chcesz opublikować do GitHub czy do Azure DevOps, i postępuj zgodnie z monitami dotyczącymi logowania. Wybierz widoczność repozytorium (publiczną lub prywatną) i potwierdź.

Aby sprawdzić, czy kod został wypchnięty pomyślnie, otwórz przeglądarkę i przejdź do repozytorium w GitHub (https://github.com) lub Azure DevOps (https://dev.azure.com). Powinny zostać wyświetlone pliki projektu SQL, w tym .sqlproj plik i .sql definicje obiektów.

Aby uzyskać więcej informacji, zobacz Kontrola źródła w Visual Studio Code.

Po otwarciu projektu SQL w SQL Server Management Studio utwórz lokalne repozytorium Git i wypchnij go do zdalnego.

1. Wybierz z paska menu pozycję Git>Utwórz repozytorium Git.

2. W oknie dialogowym Tworzenie repozytorium Git, w sekcji Wypychanie do nowego repozytorium zdalnego, wybierz GitHub lub Azure DevOps. Jeśli zdecydujesz się wypchnąć zmiany do serwisu GitHub, gdy zostanie wyświetlony monit, zaloguj się na swoje konto GitHub. Jeśli wybierzesz Azure DevOps, zaloguj się do konta Azure DevOps i wybierz lub utwórz projekt.

3. Wprowadź nazwę i opis repozytorium. Upewnij się , że szablon .gitignore ma ustawioną wartość VisualStudio , a następnie wybierz pozycję Utwórz i wypchnij.

SSMS tworzy lokalne repozytorium Git, tworzy początkowy commit obejmujący pliki projektu SQL i przesyła je do repozytorium zdalnego.

Aby sprawdzić, czy kod został wypchnięty pomyślnie, otwórz przeglądarkę i przejdź do repozytorium w GitHub (https://github.com) lub Azure DevOps (https://dev.azure.com). Powinny zostać wyświetlone pliki projektu SQL, w tym .sqlproj plik i .sql definicje obiektów.

Aby uzyskać więcej informacji, zobacz About Git in Visual Studio (Informacje o usłudze Git w Visual Studio).

W katalogu projektu SQL zainicjuj lokalne repozytorium Git, zatwierdź wszystkie pliki i wypchnij je do repozytorium zdalnego.

1. Zainicjuj nowe repozytorium Git, dodaj .gitignore plik i utwórz wstępne zatwierdzenie:

   cd MyDatabaseProject
   git init
   dotnet new gitignore
   git add .
   git commit -m "Initial commit of SQL project"
   

2. Utwórz nowe repozytorium zdalne w GitHub lub Azure DevOps:

   • GitHub: przejdź do https://github.com/new witryny i utwórz nowe repozytorium. Nie inicjuj go za pomocą pliku README, .gitignorelub licencji.
   • Azure DevOps: przejdź do projektu Azure DevOps, wybierz pozycję Repos i utwórz nowe repozytorium. Usuń zaznaczenie pola wyboru Dodaj plik README.

3. Dodaj zdalne i wypchnij wstępne zatwierdzenie:

   git remote add origin <your-repository-url>
   git push -u origin main
   

   Zastąp <your-repository-url> ciąg adresem URL podanym przez GitHub lub Azure DevOps podczas tworzenia repozytorium.

Aby sprawdzić, czy kod został wypchnięty pomyślnie, otwórz przeglądarkę i przejdź do repozytorium. Powinny zostać wyświetlone pliki projektu SQL, w tym .sqlproj plik i .sql definicje obiektów.

Użyj funkcji porównywania schematów, aby zaktualizować projekt SQL na podstawie bazy danych.

1. W SQL Server Eksplorator obiektów kliknij prawym przyciskiem myszy bazę danych i wybierz pozycję Porównaj schemat.

2. W oknie Porównanie schematów baza danych jest ustawiana jako źródło. Wybierz listę rozwijaną Wybierz element docelowy , a następnie wybierz pozycję Wybierz element docelowy.

3. W oknie dialogowym Wybieranie schematu docelowego wybierz pozycję Project i wybierz project bazy danych SQL. Kliknij przycisk OK.

4. Wybierz pozycję Porównaj , aby uruchomić porównanie. Wyniki przedstawiają różnice między bazą danych (źródłem) a projektem (elementem docelowym).

5. Przejrzyj różnice. Usuń zaznaczenie wszelkich zmian, których nie chcesz stosować do projektu.

6. Wybierz pozycję Aktualizuj, aby zastosować wybrane zmiany do projektu SQL.

Pliki projektu są aktualizowane tak, aby były zgodne ze schematem bazy danych. Przejrzyj zmiany w oknie Zmiany usługi Git , wprowadź komunikat zatwierdzenia i wybierz pozycję Zatwierdź wszystko. Wybierz Push, aby wypchnąć zmiany do zdalnego repozytorium.

Użyj polecenia Update Project from Database, aby zaktualizować project SQL z bazy danych.

1. W Eksploratorze obiektów bazy danych kliknij prawym przyciskiem myszy bazę danych, a następnie wybierz pozycję Projekty baz danych SQL>Aktualizuj projekt z bazy danych.

2. Wybierz projekt bazy danych SQL, aby zaktualizować i potwierdzić.

3. Uruchamiane jest porównanie i zmiany z bazy danych są stosowane w projekcie. Zaktualizowane .sql pliki są wyświetlane w widoku Kontroli źródła jako zmodyfikowane pliki.

Przejrzyj zmiany w widoku Kontroli źródła , przygotuj zmodyfikowane pliki, wprowadź komunikat zatwierdzenia i wybierz pozycję Zatwierdź. Wybierz pozycję Synchronizuj zmiany, aby przesłać commit do repozytorium zdalnego.

Użyj porównywania schematów, aby zaktualizować projekt SQL na podstawie bazy danych.

1. W Eksplorator obiektów kliknij prawym przyciskiem myszy na bazie danych i wybierz pozycję Zadania>Porównanie schematów (wersja zapoznawcza).

2. W oknie Porównanie schematów baza danych jest ustawiana jako źródło. Wybierz przycisk wielokropka docelowego i wybierz projekt bazy danych SQL jako element docelowy.

3. Wybierz pozycję Porównaj , aby uruchomić porównanie. Wyniki przedstawiają różnice między bazą danych (źródłem) a projektem (elementem docelowym).

4. Przejrzyj różnice. Usuń zaznaczenie wszelkich zmian, których nie chcesz stosować do projektu.

5. Wybierz pozycję Zastosuj , aby zastosować wybrane zmiany do projektu SQL.

Pliki projektu są aktualizowane tak, aby były zgodne ze schematem bazy danych. Przejrzyj zmiany w oknie Zmiany usługi Git , wprowadź komunikat zatwierdzenia i wybierz pozycję Zatwierdź wszystko. Wybierz Push, aby przesłać zmiany do zdalnego repozytorium.

Użyj pakietu SqlPackage, aby ponownie wygenerować projekt SQL z bazy danych, zastępując istniejące pliki projektu bieżącym schematem bazy danych. Chociaż inne narzędzia projektu SQL udostępniają interfejs graficzny, pakiet SqlPackage oferuje podejście wiersza polecenia do automatyzacji, które nie zapewnia możliwości przejrzenia zmian plików przed ich zastosowaniem.

1. Usuń istniejące pliki obiektów SQL i ponownie wygeneruj projekt:

   rm -rf MyDatabaseProject
   sqlpackage /a:Extract /ssn:localhost /sdn:MyDatabase /tf:MyDatabaseProject /p:ExtractTarget=SqlProject
   

2. Przejrzyj zmiany za pomocą narzędzia Git i zatwierdź:

   cd MyDatabaseProject
   dotnet new gitignore
   git add .
   git status
   git commit -m "Update project from database changes"
   git push
   

1. Wybierz z paska menu pozycje Git>Pull, aby pobrać najnowsze zmiany ze zdalnego repozytorium.

2. W Eksplorator rozwiązań kliknij prawym przyciskiem myszy węzeł projektu bazy danych SQL i wybierz pozycję Porównaj schemat.

3. W oknie Porównanie schematów projekt jest ustawiony jako źródło. Wybierz listę rozwijaną Wybierz element docelowy , a następnie wybierz pozycję Wybierz element docelowy.

4. W oknie dialogowym Wybieranie schematu docelowego wybierz pozycję Baza danych i wybierz lokalne połączenie z bazą danych deweloperskich. Kliknij przycisk OK.

5. Wybierz pozycję Porównaj , aby uruchomić porównanie. Wyniki przedstawiają różnice między projektem (źródłem) a bazą danych (elementem docelowym).

6. Przejrzyj różnice, aby sprawdzić, czy zmiany są oczekiwane.

7. Wybierz pozycję Aktualizuj, aby zastosować zmiany do bazy danych.

1. Otwórz widok Kontrola źródła i wybierz pozycję Ściągaj z menu ... (lub użyj przycisku synchronizacji na pasku stanu), aby ściągnąć najnowsze zmiany ze zdalnego repozytorium.

2. W widoku Projekty bazy danych kliknij prawym przyciskiem myszy projekt bazy danych SQL i wybierz pozycję Porównaj schemat.

3. W oknie Porównanie schematów projekt jest ustawiony jako źródło. Wybierz przycisk wielokropka docelowego i wybierz lokalne połączenie bazy danych deweloperskich jako obiekt docelowy.

4. Wybierz pozycję Porównaj , aby uruchomić porównanie. Wyniki przedstawiają różnice między projektem (źródłem) a bazą danych (elementem docelowym).

5. Przejrzyj różnice, aby sprawdzić, czy zmiany są oczekiwane.

6. Wybierz pozycję Zastosuj , aby zastosować zmiany do bazy danych.

1. Otwórz terminal i uruchom git pull polecenie w katalogu projektu, aby ściągnąć najnowsze zmiany z repozytorium zdalnego.

2. W Eksplorator rozwiązań kliknij prawym przyciskiem myszy węzeł projektu bazy danych SQL i wybierz pozycję Porównaj schemat (wersja zapoznawcza).

3. W oknie Porównanie schematów projekt jest ustawiony jako źródło. Wybierz obiekt docelowy i wybierz połączenie z lokalną bazą danych środowiska programistycznego.

4. Wybierz pozycję Porównaj , aby uruchomić porównanie. Wyniki przedstawiają różnice między projektem (źródłem) a bazą danych (elementem docelowym).

5. Przejrzyj różnice, aby sprawdzić, czy zmiany są oczekiwane.

6. Wybierz pozycję Zastosuj , aby zastosować zmiany do bazy danych.

1. Pobierz najnowsze zmiany z repozytorium zdalnego:

   cd MyDatabaseProject
   git pull
   

2. Skompiluj projekt, aby zweryfikować poprawną kompilację zmian:

   dotnet build
   

3. Wdróż zmiany w lokalnej bazie danych deweloperskich przy użyciu pakietu SqlPackage:

   sqlpackage /a:Publish /sf:bin/Debug/MyDatabaseProject.dacpac /tsn:localhost /tdn:MyDatabase
   

   Zastąp MyDatabaseProject.dacpac nazwą Twojego pliku wyjściowego .dacpac i w razie potrzeby zaktualizuj wartości serwera docelowego (/tsn) oraz bazy danych (/tdn).