SqlPackage

  • 아티클

SqlPackage는 공용 데이터 계층 애플리케이션 프레임워크(DacFx) API 중 일부를 노출하여 데이터베이스 개발 작업을 자동화하는 명령줄 유틸리티입니다. SqlPackage의 기본 사용 사례는 데이터베이스의 SQL Server, Azure SQL 및 Azure Synapse Analytics 제품군에 대한 데이터베이스 이식성 및 배포에 초점을 맞춥니다. Azure Pipelines 및 GitHub 작업 또는 기타 CI/CD 도구를 사용하여 SqlPackage를 자동화할 수 있습니다.

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

참고 항목

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

이식성

데이터베이스 이식성은 SQL Server, Azure SQL 및 Azure Synapse Analytics의 여러 인스턴스 간에 데이터베이스 스키마와 데이터를 이동하는 기능입니다. 데이터베이스를 Azure SQL Database에서 온-프레미스 SQL Server 인스턴스로 내보내거나 SQL Server에서 Azure SQL Database로 내보내는 것이 데이터베이스 이식성의 예입니다. SqlPackage는 BACPAC 파일을 만들고 사용하는 Export 및 Import 작업을 통해 데이터베이스 이식성을 지원합니다. SqlPackage는 또한 데이터를 직접 포함하거나 Azure Blob Storage에 저장된 데이터를 참조할 수 있는 DACPAC 파일을 만들고 사용하는 Extract 및 Publish 작업을 통해 데이터베이스 이식성을 지원합니다.

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

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

배포

데이터베이스 배포는 테이블에 열을 추가하거나 저장 프로시저의 콘텐츠를 변경하는 등 원하는 상태와 일치하도록 데이터베이스 스키마를 업데이트하는 프로세스입니다. SqlPackage는 Publish 및 Extract 작업을 통해 데이터베이스 배포를 지원합니다. Publish 작업은 원본 .dacpac 파일의 콘텐츠와 일치하도록 데이터베이스 스키마를 업데이트하고 Extract 작업은 연결된 SQL 데이터베이스의 스키마 또는 스키마 및 사용자 데이터를 포함하는 데이터 계층 애플리케이션(.dacpac) 파일을 만듭니다. SqlPackage를 사용하면 대상 데이터베이스에 필요한 변경 내용을 적용하는 배포 계획을 자동으로 만들어 동일한 아티팩트(.dacpac)의 새 데이터베이스 또는 기존 데이터베이스에 대해 배포할 수 있습니다. Script 또는 DeployReport 작업을 사용하여 대상 데이터베이스에 변경 내용을 적용하기 전에 배포 계획을 검토할 수 있습니다.

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

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

  • DeployReport: 게시 작업으로 변경된 사항을 나타내는 XML 보고서를 만듭니다.

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

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

명령줄 구문

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

SqlPackage {parameters} {properties} {SQLCMD variables}

SqlPackage 명령줄 구문에 대한 자세한 내용은 SqlPackage CLI 참조 및 개별 작업 페이지에 자세히 설명되어 있습니다.

유틸리티 명령

버전

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는 관리 ID를 사용하여 Microsoft Entra 인증을 지원하는 데이터베이스에 연결하고 자격 증명 관리 없이 Microsoft Entra 토큰을 가져오기 때문에 이 메서드는 런타임에 SqlPackage에 자격 증명을 전달할 필요가 없습니다. 관리 ID가 SqlPackage 작업이 실행되는 환경에 대해 구성되면 SqlPackage 작업은 해당 ID를 사용하여 Azure SQL에 인증할 수 있습니다. 사용자 환경에 대한 관리 ID 구성에 대한 자세한 내용은 관리 ID 설명서를 참조하세요.

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

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

관리 ID는 Azure DevOps 및 GitHub 작업 CI/CD 파이프라인 모두에서 지원됩니다.

서비스 사용자

참고 항목

Microsoft Entra ID는 이전의 Azure AD(Azure Active Directory)입니다.

Microsoft Entra 애플리케이션 서비스 주체는 지정된 테넌트에서 애플리케이션이 수행할 수 있는 작업을 정의하는 Microsoft Entra 애플리케이션 내의 보안 개체입니다. 애플리케이션 등록 프로세스 중에 Azure Portal에서 설정되고 Azure SQL과 같은 Azure 리소스에 액세스하도록 구성됩니다. 사용자 환경에 대한 서비스 주체 구성에 대한 자세한 내용은 서비스 주체 설명서를 참조하세요.

서비스 주체와 함께 SqlPackage를 사용하는 경우 액세스 토큰을 검색하여 SqlPackage에 전달해야 할 수 있습니다. 액세스 토큰은 Azure PowerShell 모듈 또는 Azure CLI를 사용하여 검색할 수 있습니다. 액세스 토큰은 /at 매개 변수를 사용하여 SqlPackage에 전달할 수 있습니다.

# example export connecting using an access token associated with a service principal
$Account = Connect-AzAccount -ServicePrincipal -Tenant $Tenant -Credential $Credential
$AccessToken_Object = (Get-AzAccessToken -Account $Account -ResourceUrl "https://database.windows.net/")
$AccessToken = $AccessToken_Object.Token

SqlPackage /at:$AccessToken /Action:Export /TargetFile:"C:\AdventureWorksLT.bacpac" \
    /SourceConnectionString:"Server=tcp:{yourserver}.database.windows.net,1433;Initial Catalog=AdventureWorksLT;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;"
# OR
SqlPackage /at:$($AccessToken_Object.Token) /Action:Export /TargetFile:"C:\AdventureWorksLT.bacpac" \
    /SourceConnectionString:"Server=tcp:{yourserver}.database.windows.net,1433;Initial Catalog=AdventureWorksLT;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;"

서비스 주체는 Azure DevOps 및 GitHub 작업 CI/CD 파이프라인 모두에서 지원됩니다.

환경 변수

연결 풀링

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에서 임의로 생성된 문자열로 설정되며 기존 값은 전송되지 않습니다. 새 사용자의 암호는 .bacpac 가져오기 또는 .dacpac 배포 후 보안 값으로 다시 설정하는 것이 좋습니다. 자동화된 환경에서는 암호 값을 SqlPackage 다음 단계에서 Azure Key Vault와 같은 보안 키 저장소에서 검색할 수 있습니다.

사용량 현황 데이터 수집

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

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

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

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

원격 분석 보고 사용 안 함

원격 분석 수집 및 보고를 사용하지 않도록 설정하려면 환경 변수 DACFX_TELEMETRY_OPTOUT을 true 또는 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 지원 정책을 참조하세요.

SQL Server 외에도 SqlPackage 및 DacFx는 Microsoft Fabric에서 Azure SQL Managed Instance, Azure SQL Database, Azure Synapse Analytics 및 Synapse Data Warehouse를 지원합니다.

다음 단계