SqlPackage

SqlPackage는 공용 데이터 계층 애플리케이션 프레임워크(DacFx) API 중 일부를 노출하여 다음 데이터베이스 개발 작업을 자동화하는 명령줄 유틸리티입니다.

  • 버전: SqlPackage 애플리케이션의 빌드 번호를 반환합니다.

  • 추출: 연결된 SQL 데이터베이스의 스키마 또는 스키마와 사용자 데이터를 포함하는 데이터 계층 애플리케이션(.dacpac) 파일을 만듭니다.

  • 게시: 원본 .dacpac 파일의 스키마와 일치하도록 데이터베이스 스키마를 증분식으로 업데이트합니다. 서버에 데이터베이스가 없으면 게시 작업에서 데이터베이스를 만듭니다. 존재하는 경우 기존 데이터베이스가 업데이트됩니다.

  • Export: 데이터베이스 스키마 및 사용자 데이터를 포함하여 연결된 SQL 데이터베이스를 BACPAC 파일(.bacpac)로 내보냅니다.

  • Import: BACPAC 파일의 스키마 및 테이블 데이터를 새 사용자 데이터베이스로 가져옵니다.

  • DeployReport: 게시 작업에서 수행할 변경 내용을 나타내는 XML 보고서를 만듭니다.

  • DriftReport: 마지막으로 등록된 이후 등록된 데이터베이스에 적용된 변경 내용을 나타내는 XML 보고서를 만듭니다.

  • 스크립트: 대상의 스키마가 원본의 스키마와 일치하도록 업데이트하는 Transact-SQL 증분 업데이트 스크립트를 만듭니다.

SqlPackage 명령줄 도구를 사용하면 작업별 매개 변수 및 속성과 함께 이러한 작업을 지정할 수 있습니다.

최신 버전 다운로드 . 최신 릴리스에 대한 자세한 내용은 릴리스 정보를 참조하세요.

참고 항목

Microsoft Entra ID는 Azure AD(Azure Active Directory)의 새 이름이지만 기존 환경의 중단을 방지하기 위해 Azure AD는 UI 필드, 연결 공급자, 오류 코드 및 cmdlet과 같은 일부 하드 코드된 요소에서 여전히 다시 기본. 이 문서에서는 두 이름을 서로 교환할 수 있습니다.

명령줄 구문

SqlPackage는 명령줄에 지정된 매개 변수, 속성 및 SQLCMD 변수를 사용하여 지정된 작업을 시작합니다.

SqlPackage {parameters} {properties} {SQLCMD variables}

종료 코드

SqlPackage 명령은 다음 종료 코드를 반환합니다.

  • 0 = 성공
  • 0이 아닌 값 = 실패

사용 예제

추가 예제는 개별 작업 페이지에서 사용할 수 있습니다.

현재 데이터베이스 스키마의 .dacpac 파일 만들기:

SqlPackage /TargetFile:"C:\sqlpackageoutput\output_current_version.dacpac" /Action:Extract /SourceServerName:"." /SourceDatabaseName:"Contoso.Database"

매개 변수

일부 매개 변수는 SqlPackage 작업 간에 공유됩니다. 다음은 매개 변수를 요약한 표입니다. 자세한 내용은 특정 작업 페이지를 클릭합니다.

매개 변수 약식 추출 게시 내보내기 가져오기 DeployReport DriftReport 스크립트
/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
/MaxParallelism: /mp x x x x x x x
/OutputPath: /op x x x
/OverwriteFiles: /of x x x x x x
/Profile: /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: /sec 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

속성

SqlPackage 작업은 작업의 기본 동작을 수정할 수 있는 다양한 속성을 지원합니다. 자세한 내용을 알고 싶다면 구체적인 작업 페이지를 클릭하세요.

유틸리티 명령

버전

sqlpackage 버전을 빌드 번호로 표시합니다. 대화형 프롬프트 및 자동화된 파이프라인에서 사용할 수 있습니다.

SqlPackage /Version

도움말

/? 또는 /help:True를 사용하여 SqlPackage 사용 정보를 표시할 수 있습니다.

SqlPackage /?

특정 작업에 대한 특정한 매개 변수 및 속성 정보의 경우 해당 작업의 매개 변수 외에 도움말 매개 변수도 사용합니다.

SqlPackage /Action:Publish /?

인증

SqlPackage는 SqlClient에서 사용할 수 있는 메서드를 사용하여 인증합니다. 인증 유형 구성은 각 SqlPackage 작업(/SourceConnectionString/TargetConnectionString)에 대한 연결 문자열 매개 변수를 통해 또는 연결 속성에 대한 개별 매개 변수를 통해 수행할 수 있습니다. 연결 문자열에서 지원되는 인증 방법은 다음과 같습니다.

  • SQL Server 인증
  • Active Directory(Windows) 인증
  • Microsoft Entra 인증
    • 사용자 이름/암호
    • 통합 인증
    • 유니버설 인증
    • 관리 ID
    • 서비스 주체

관리 ID

참고 항목

Microsoft Entra ID 는 이전에 Azure AD(Azure Active Directory)라고 했습니다.

자동화된 환경에서 Microsoft Entra 관리 ID 는 권장 인증 방법입니다. 이 메서드는 런타임에 SqlPackage에 자격 증명을 전달할 필요가 없습니다. SqlPackage 작업이 실행되는 환경에 대해 관리 ID가 구성된 경우 SqlPackage 작업은 해당 ID를 사용하여 Azure SQL에 인증할 수 있습니다. 사용자 환경에 대한 관리 ID를 구성하는 방법에 대한 자세한 내용은 관리 ID 설명서를 참조하세요.

시스템 할당 관리 ID를 사용하는 연결 문자열의 예는 다음과 같습니다.

Server=sampleserver.database.windows.net; Authentication=Active Directory Managed Identity; Database=sampledatabase;

환경 변수

연결 풀링

CONNECTION_POOLING_ENABLED 환경 변수를 True로 설정하여 SqlPackage에서 만든 모든 연결에 대해 연결 풀링을 사용하도록 설정할 수 있습니다. 이 설정은 MSAL(Microsoft 인증 라이브러리)의 제한을 방지하기 위해 Microsoft Entra 사용자 이름 및 암호 연결을 사용하는 작업에 권장됩니다.

임시 파일

SqlPackage 작업 중에 테이블 데이터는 압축 전이나 압축 해제 후 임시 파일에 기록됩니다. 대용량 데이터베이스의 경우 이러한 임시 파일은 상당한 양의 디스크 공간을 차지할 수 있지만 임시 파일의 위치를 지정할 수 있습니다. 내보내기 및 추출 작업에는 SqlPackage의 기본값을 재정의하도록 /p:TempDirectoryForTableData를 지정하는 선택적 속성이 포함되어 있습니다.

.NET API GetTempPath 는 SqlPackage 내에서 기본값을 결정하는 데 사용됩니다.

Windows의 경우 다음 환경 변수가 다음 순서에 따라 확인되고 존재하는 첫 번째 경로가 사용됩니다.

  1. 환경 변수에 지정된 경로입니다 TMP .
  2. 환경 변수에 지정된 경로입니다 TEMP .
  3. 환경 변수에 지정된 경로입니다 USERPROFILE .
  4. Windows 디렉터리입니다.

Linux 및 macOS의 경우 경로가 환경 변수에 TMPDIR 지정되지 않은 경우 기본 경로 /tmp/ 가 사용됩니다.

SqlPackage 및 데이터베이스 사용자

포함된 데이터베이스 사용자는 SqlPackage 작업에 포함됩니다. 그러나 정의의 암호 부분은 SqlPackage에서 임의로 생성된 문자열로 설정되며 기존 값은 전송되지 않습니다. 새 사용자의 암호는 가져오기 또는 배포 .dacpac후 보안 값으로 .bacpac 다시 설정하는 것이 좋습니다. 자동화된 환경에서는 암호 값을 SqlPackage 다음 단계에서 Azure Key Vault와 같은 보안 키 저장소에서 검색할 수 있습니다.

사용량 현황 데이터 수집

SqlPackage에는 익명 기능 사용량 및 진단 데이터를 수집하고 Microsoft에 보낼 수 있는 인터넷 지원 기능이 포함되어 있습니다.

SqlPackage는 Microsoft로 전송되고 SqlPackage의 품질, 보안 및 안정성을 개선하기 위해 분석될 수 있는 표준 컴퓨터, 사용 및 성능 정보를 수집할 수 있습니다.

SqlPackage는 사용자별 또는 개인 정보를 수집하지 않습니다. 진단 목적으로 단일 사용자를 근사화하기 위해 SqlPackage는 실행되는 각 컴퓨터에 대해 임의 GUID를 생성하고 전송하는 모든 이벤트에 해당 값을 사용합니다.

자세한 내용은 Microsoft 개인정보처리방침SQL Server 개인 정보 제공을 참조하세요.

원격 분석 보고 사용 안 함

원격 분석 수집 및 보고를 사용하지 않도록 설정하려면 환경 변수 DACFX_TELEMETRY_OPTOUTtrue 를 업데이트하거나 1

지원

DacFx 라이브러리 및 SqlPackage CLI 도구는 Microsoft 최신 수명 주기 정책을 채택했습니다. 모든 보안 업데이트, 수정 및 새 기능은 주 버전의 최신 포인트 버전에서만 릴리스됩니다. DacFx 또는 SqlPackage 설치를 현재 버전으로 유지 관리하면 적용 가능한 모든 버그 수정을 적시에 받을 수 있습니다.

SqlPackage에 대한 도움말을 보고하고, 기능 요청을 제출하고, DacFx GitHub 리포지토리에서 문제를 보고합니다.

지원되는 SQL 서비스

SqlPackage 및 DacFx는 SqlPackage/DacFx 릴리스 시 지원되는 모든 SQL 버전을 지원합니다. 예를 들어 2022년 1월 14일의 SqlPackage 릴리스는 2022년 1월 14일에 지원되는 모든 SQL 버전을 지원합니다. SQL 지원 정책에 대한 자세한 내용은 SQL 지원 정책을 참조하세요.

다음 단계