Udostępnij przez


Dokumentacja interfejsu wiersza polecenia sqlPackage

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 określają akcję do wykonania, źródłowe i docelowe bazy danych oraz inne ustawienia ogólne.
  • Właściwości modyfikują domyślne zachowanie akcji.
  • Zmienne SQLCMD przekazują wartości do zmiennych SQLCMD w pliku źródłowym.

Aby utworzyć polecenie SqlPackage, określ akcję i jego dodatkowe parametry. Opcjonalnie dodaj właściwości i zmienne SQLCMD, aby jeszcze bardziej dostosować polecenie.

W poniższym przykładzie użyto pakietu SqlPackage do utworzenia .dacpac pliku 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

Są to parametry z tego przykładu:

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

Są to właściwości z tego przykładu:

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

Akcje sqlPackage

Akcja Description
wersja Zwraca numer kompilacji aplikacji SqlPackage.
wyodrębnianie Tworzy plik aplikacji warstwy danych (.dacpac) zawierający schemat lub schemat i dane użytkownika z połączonej bazy danych SQL.
publikowanie Przyrostowo aktualizuje schemat bazy danych, aby był zgodny ze schematem pliku źródłowego .dacpac . Jeśli baza danych nie istnieje na serwerze, operacja publikowania go tworzy. W przeciwnym razie istniejąca baza danych zostanie zaktualizowana.
Eksportuj Eksportuje połączoną bazę danych SQL — w tym schemat bazy danych i dane użytkownika — do pliku BACPAC (.bacpac).
Importowanie 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 języka 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ższa tabela zawiera podsumowanie parametrów. Aby uzyskać więcej informacji, użyj linków w nagłówku tabeli, aby odwiedzić określone strony akcji.

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

Właściwości

Akcje SqlPackage obsługują wiele właściwości, aby zmodyfikować domyślne zachowanie akcji. Dodaj /p:PropertyName=Value do wiersza polecenia, aby opcjonalnie używać właściwości. Można określić wiele właściwości i określić niektóre właściwości więcej niż raz. Możesz na przykład użyć /p:TableData=Product /p:TableData=ProductCategory. Aby uzyskać więcej informacji na temat właściwości, zobacz konkretne strony akcji.

Zmienne SQLCMD

Zmienne SQLCMD można utworzyć w .dacpac pliku z projektu SQL. Ustaw te zmienne podczas wdrażania przy użyciu polecenia SqlPackage Publish lub Script. Aby uzyskać więcej informacji na temat dodawania zmiennych SQLCMD do projektu SQL, zobacz Rozszerzenie SQL Database Projects.

Polecenia narzędzia

Wersja

Wyświetla wersję sqlpackage jako numer kompilacji. Używaj go w interakcyjnych monitach i w zautomatyzowanych potokach.

SqlPackage /Version

Pomoc

Użyj /? polecenia lub /help:True , aby wyświetlić informacje o użyciu pakietu SqlPackage.

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