Udostępnij za pośrednictwem

Dokumentacja interfejsu wiersza polecenia sqlPackage

  • Artykuł

SqlPackage to narzędzie wiersza polecenia umożliwiające przenoszenie i wdrażanie bazy danych w środowiskach systemów Windows, Linux i macOS. Interfejs wiersza polecenia sqlPackage analizuje każde wywołanie parametrów, właściwości i zmiennych SQLCMD.

SqlPackage {parameters} {properties} {SQLCMD variables}
  • parametry służą do określania akcji do wykonania, źródłowych i docelowych baz danych oraz innych ustawień ogólnych.
  • właściwości są używane do modyfikowania domyślnego zachowania akcji.
  • zmiennych SQLCMD są używane do przekazywania wartości do zmiennych SQLCMD w pliku źródłowym.

Aby utworzyć polecenie SqlPackage, należy określić akcję i jego dodatkowe parametry. Opcjonalnie możesz dodać właściwości i zmienne SQLCMD, aby jeszcze bardziej dostosować polecenie.

W poniższym przykładzie pakiet SqlPackage służy do tworzenia pliku dacpac bieżącego schematu bazy danych:

SqlPackage /Action:Extract /TargetFile:"C:\sqlpackageoutput\output_current_version.dacpac" \
 /SourceServerName:"localhost" /SourceDatabaseName:"Contoso" \
 /p:IgnoreUserLoginMappings=True /p:Storage=Memory

W tym przykładzie parametry to:

  • /Action:Extract
  • /TargetFile:"C:\sqlpackageoutput\output_current_version.dacpac"
  • /SourceServerName:"localhost"
  • /SourceDatabaseName:"Contoso"

W tym przykładzie właściwości były następujące:

  • /p:IgnoreUserLoginMappings=True
  • /p:Storage=Memory

Akcje sqlPackage

  • wersja: zwraca numer kompilacji aplikacji SqlPackage.

  • Wyodrębnij: tworzy plik aplikacji warstwy danych (dacpac) zawierający schemat lub schemat i dane użytkownika z połączonej bazy danych SQL.

  • Publikuj: przyrostowo aktualizuje schemat bazy danych, aby był zgodny ze schematem źródłowego pliku dacpac. Jeśli baza danych nie istnieje na serwerze, operacja publikowania go tworzy. W przeciwnym razie istniejąca baza danych zostanie zaktualizowana.

  • Export: eksportuje połączoną bazę danych SQL Database — w tym schemat bazy danych i dane użytkownika — do pliku BACPAC (bacpac).

  • Import: importuje dane schematu i tabeli z pliku BACPAC do nowej bazy danych użytkownika.

  • DeployReport: tworzy raport XML reprezentujący zmiany, które zostaną wprowadzone przez akcję publikowania.

  • DriftReport: tworzy raport XML reprezentujący zmiany zastosowane do zarejestrowanej bazy danych od czasu ostatniego zarejestrowania.

  • skryptu: tworzy skrypt aktualizacji przyrostowej Transact-SQL, który aktualizuje schemat obiektu docelowego w celu dopasowania do schematu źródła.

Nuta

Chociaż identyfikator Entra firmy Microsoft to nowa nazwa usługi Azure Active Directory (Azure AD), aby zapobiec zakłócaniu działania istniejących środowisk, usługa Azure AD nadal pozostaje w niektórych zakodowanych na stałe elementach, takich jak pola interfejsu użytkownika, dostawcy połączeń, kody błędów i polecenia cmdlet. W tym artykule dwie nazwy są wymienne.

Parametry

Niektóre parametry są współużytkowane między akcjami SqlPackage. Poniżej znajduje się tabela podsumowująca parametry, aby uzyskać więcej informacji, kliknij konkretne strony akcji.

Parametr Krótki formularz wyodrębnianie publikowanie Eksportuj Importowanie DeployReport DriftReport skryptu
/AccessToken: /at x x x x x x x
/ClientId: /cid x
/DeployScriptPath: /dsp x x
/DeployReportPath: /drp x x
/Diagnostics: /d x x x x x x x
/DiagnosticsFile: /df x x x x x x x
/DiagnosticsPackageFile: /dpf x x
/MaxParallelism: /mp x x x x x x x
/OutputPath: /op x x x
/OverwriteFiles: /z x x x x x x
/Profil: /pr x x x
/Properties: /p x x x x x x
/Quiet: /q x x x x x x x
/Secret: /secr x
/SourceConnectionString: /scs x x x x x
/SourceDatabaseName: /sdn x x x x x
/SourceEncryptConnection: /s x x x x x
/SourceFile: /sf x x x x
/SourcePassword: /sp x x x x x
/SourceServerName: /ssn x x x x x
/SourceTimeout: /st x x x x x
/SourceTrustServerCertificate: /stsc x x x x x
/SourceUser: /su x x x x x
/TargetConnectionString: /tcs x x x x
/TargetDatabaseName: /tdn x x x x x
/TargetEncryptConnection: /tec x x x x x
/TargetFile: /tf x x x x
/TargetPassword: /tp x x x x x
/TargetServerName: /tsn x x x x x
/TargetTimeout: /tt x x x x x
/TargetTrustServerCertificate: /ttsc x x x x x
/TargetUser: /tu x x x x x
/TenantId: /tid x x x x x x x
/UniversalAuthentication: /ua x x x x x x x
/Variables: /v x x

Właściwości

Akcje SqlPackage obsługują dużą liczbę właściwości, aby zmodyfikować domyślne zachowanie akcji. Opcjonalne użycie właściwości jest realizowane przez dodanie /p:PropertyName=Value do wiersza polecenia. Można określić wiele właściwości, a niektóre właściwości można określić więcej niż raz (np. /p:TableData=Product /p:TableData=ProductCategory). Aby uzyskać więcej informacji na temat właściwości, zapoznaj się z określonymi stronami akcji.

Zmienne SQLCMD

Zmienne SQLCMD można wbudowane w plik dacpac z projektu SQL, a następnie ustawić podczas wdrażania za pomocą narzędzia SqlPackage publikowania lub skryptu . Aby uzyskać więcej informacji na temat dodawania zmiennych SQLCMD do projektu SQL, zobacz dokumentację projektów SQL.

Polecenia narzędzia

Wersja

Wyświetla wersję sqlpackage jako numer kompilacji. Może być używany w monitach interakcyjnych i w zautomatyzowanych potoków.

SqlPackage /Version

Pomoc

Informacje o użyciu pakietu SqlPackage można wyświetlić przy użyciu /? lub /help:True.

SqlPackage /?

Aby uzyskać informacje o parametrach i właściwościach specyficznych dla konkretnej akcji, użyj parametru pomocy oprócz parametru tej akcji.

SqlPackage /Action:Publish /?

Kody zakończenia

Polecenia SqlPackage zwracają następujące kody zakończenia:

  • 0 = powodzenie
  • nonzero = failure

Następne kroki