Azure Synapse

Azure Synapse 커넥터를 사용하면 Azure Synapse SQL 풀에 연결하고 SQL을 사용하여 Azure Synapse 데이터를 가져오고 업데이트할 수 있습니다.

시작하기 전에

Azure Synapse 커넥터를 사용하기 전에 다음 작업을 수행합니다.

  • Google Cloud 프로젝트에서:
    • 네트워크 연결이 설정되어 있는지 확인합니다. 네트워크 패턴에 대한 자세한 내용은 네트워크 연결을 참조하세요.
    • 커넥터를 구성하는 사용자에게 roles/connectors.admin IAM 역할을 부여합니다.
    • 커넥터에 사용할 서비스 계정에 다음 IAM 역할을 부여합니다.
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      서비스 계정은 인증을 거쳐야 하며 Google API의 데이터에 액세스할 수 있는 승인을 받은 사람이 아닌 사용자를 나타내는 특별한 유형의 Google 계정입니다. 서비스 계정이 없으면 서비스 계정을 만들어야 합니다. 자세한 내용은 서비스 계정 만들기를 참조하세요.

    • 다음 서비스를 사용 설정합니다.
      • secretmanager.googleapis.com(Secret Manager API)
      • connectors.googleapis.com(Connectors API)

      서비스 사용 설정 방법은 서비스 사용 설정을 참조하세요.

    이러한 서비스나 권한이 이전 프로젝트에서 사용 설정되지 않았으면 커넥터를 구성할 때 서비스나 권한을 사용 설정하라는 메시지가 표시됩니다.

커넥터 구성

커넥터를 구성하려면 데이터 소스(백엔드 시스템)에 대한 연결을 만들어야 합니다. 연결은 데이터 소스와 관련이 있습니다. 즉, 데이터 소스가 많으면 데이터 소스마다 별도의 연결을 만들어야 합니다. 연결을 만들려면 다음 단계를 따르세요.

  1. Cloud 콘솔에서 Integration Connectors > 연결 페이지로 이동한 다음 Google Cloud 프로젝트를 선택하거나 만듭니다.

    연결 페이지로 이동

  2. + 새로 만들기를 클릭하여 연결 만들기 페이지를 엽니다.
  3. 위치 섹션에서 연결 위치를 선택합니다.
    1. 리전: 드롭다운 목록에서 위치를 선택합니다.

      커넥터가 지원되는 리전은 다음과 같습니다.

      지원되는 모든 리전 목록은 위치를 참조하세요.

    2. 다음을 클릭합니다.
  4. 연결 세부정보 섹션에서 다음을 완료합니다.
    1. 커넥터: 사용 가능한 커넥터의 드롭다운 목록에서 Azure Synapse를 선택합니다.
    2. 커넥터 버전: 사용 가능한 버전의 드롭다운 목록에서 커넥터 버전을 선택합니다.
    3. 연결 이름 필드에서 연결 인스턴스의 이름을 입력합니다.

      연결 이름은 다음 기준을 충족해야 합니다.

      • 연결 이름에 문자, 숫자, 하이픈을 사용할 수 있습니다.
      • 문자는 소문자여야 합니다.
      • 연결 이름은 문자로 시작하고 문자 또는 숫자로 끝나야 합니다.
      • 연결 이름은 49자(영문 기준)를 초과할 수 없습니다.
    4. 선택적으로 연결 인스턴스에 대한 설명을 입력합니다.
    5. 서비스 계정: 필수 역할이 있는 서비스 계정을 선택합니다.
    6. 필요한 경우 연결 노드 설정을 구성합니다.

      • 최소 노드 수: 최소 연결 노드 수를 입력합니다.
      • 최대 노드 수: 최대 연결 노드 수를 입력합니다.

      노드는 트랜잭션을 처리하는 연결의 단위(또는 복제본)입니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하기 위해서는 더 적은 노드가 필요합니다. 노드가 커넥터 가격 책정에 미치는 영향을 파악하려면 연결 노드 가격 책정을 참조하세요. 값을 입력하지 않으면 기본적으로 최소 노드가 (높은 가용성을 위해) 2로 설정되고 최대 노드는 50으로 설정됩니다.

    7. Azure 테넌트: 이 속성은 데이터에 액세스하는 데 사용되는 Microsoft Azure 테넌트를 지정합니다.
    8. 데이터베이스: 이 속성은 서버리스 SQL 풀 또는 전용 SQL 풀의 Synapse 데이터베이스 이름을 지정합니다 .
    9. 대상 아래에서 다음 속성을 입력합니다.
      • 대상 유형: 드롭다운에서 호스트 주소 선택
      • 호스트 1: SQL 풀 엔드포인트 입력
      • 포트 1: SQL 엔드포인트의 포트 입력
      .
    10. 원하는 경우 SSL에 대해 다음 속성을 입력합니다.
      • SSL 사용 설정: 이 체크박스 속성은 SSL 사용 여부를 지정합니다.
      • 트러스트 저장소: 이 속성은 트러스트 저장소를 지정합니다. 라디오 버튼을 선택하여 공개, 비공개 또는 비보안 연결 중에서 트러스트 저장소를 선택할 수 있습니다.
      • 커스텀 트러스트 저장소: 이 속성은 PEM 형식의 커스텀 트러스트 저장소가 포함된 보안 비밀을 선택하는 데 사용됩니다.
      • SSL 클라이언트 인증서: 이 속성은 SSL 클라이언트 인증서를 지정합니다.
      • SSL 클라이언트 비공개 키: 이 속성은 PEM 형식의 SSL 클라이언트 비공개 키를 지정합니다.
      • SSL 클라이언트 인증서 키 암호: 이 속성은 SSL 클라이언트 비공개 키 암호를 지정합니다.
    11. 선택적으로 + 라벨 추가를 클릭하여 키/값 쌍의 형식으로 연결에 라벨을 추가합니다.
    12. 다음을 클릭합니다.
  5. 인증 섹션에서 인증 세부정보를 입력합니다.
    1. 인증 유형을 선택하고 관련 세부정보를 입력합니다.

      Azure Synapse 연결에서는 다음 인증 유형이 지원됩니다.

      • 사용자 비밀번호
      • Azure AD

      2. 이러한 인증 유형을 구성하는 방법은 인증 구성을 참조하세요.

    2. 다음을 클릭합니다.
  6. 검토: 연결 및 인증 세부정보를 검토합니다.
  7. 만들기를 클릭합니다.

인증 구성

사용할 인증을 기반으로 세부정보를 입력합니다.

  • 사용자 비밀번호
    • 사용자 이름: 데이터베이스 사용자 아이디를 입력합니다.
    • 비밀번호: 사용자 아이디와 연결된 비밀번호가 포함된 Secret Manager 보안 비밀입니다.
  • Azure AD
    • 클라이언트 ID: 액세스 토큰을 요청하는 데 사용되는 클라이언트 ID입니다. 이 ID는 Azure 포털에서 만든 연결된 앱의 개요에서 확인할 수 있습니다.
    • 범위: 쉼표로 구분된 원하는 범위 목록입니다.
    • 클라이언트 보안 비밀번호: 계정 액세스 키가 포함된 Secret Manager 보안 비밀입니다.
    • 승인 URL: 클라이언트를 만들 때 생성된 승인 URL입니다.

연결 생성 후 추가 단계

인증에 OAuth 2.0 - Authorization code를 선택한 경우 연결을 만든 후 다음 추가 단계를 수행해야 합니다.

  1. 연결 페이지에서 새로 만든 연결을 찾습니다.

    새 커넥터의 상태는 승인 필요입니다.

  2. 승인 필요를 클릭합니다.

    그러면 승인 수정 창이 표시됩니다.

  3. 리디렉션 URI 값을 외부 애플리케이션에 복사합니다.
  4. 승인 세부정보를 확인합니다.
  5. 승인을 클릭합니다.

    승인이 성공하면 연결 페이지에서 연결 상태가 활성으로 설정됩니다.

승인 코드 재승인

Authorization code 인증 유형을 사용하고 있고 Azure Synapse 애플리케이션에서 구성을 변경한 경우에는 Azure Synapse 연결을 다시 승인해야 합니다. 연결을 다시 승인하려면 다음 단계를 수행하세요.

  1. 연결 페이지에서 필요한 연결을 클릭합니다.

    그러면 연결 세부정보 페이지가 열립니다.

  2. 수정을 클릭하여 연결 세부정보를 수정합니다.
  3. 인증 섹션에서 OAuth 2.0 - 승인 코드 세부정보를 확인합니다.

    필요한 경우 변경합니다.

  4. 저장을 클릭합니다. 그러면 연결 세부정보 페이지로 이동합니다.
  5. 인증 섹션에서 승인 수정을 클릭합니다. 그러면 승인 창이 표시됩니다.
  6. 승인을 클릭합니다.

    승인이 성공하면 연결 페이지에서 연결 상태가 활성으로 설정됩니다.

항목, 작업, 조치

모든 Integration Connectors는 연결된 애플리케이션의 객체에 대한 추상화 레이어를 제공합니다. 이 추상화를 통해서만 애플리케이션의 객체에 액세스할 수 있습니다. 추상화는 항목, 작업, 조치로 노출됩니다.

  • 항목: 연결된 애플리케이션 또는 서비스에서 항목은 객체 또는 속성 모음으로 간주될 수 있습니다. 항목의 정의는 커넥터마다 다릅니다. 예를 들어 데이터베이스 커넥터에서는 테이블이 항목이고, 파일 서버 커넥터에서는 폴더가 항목이며 메시징 시스템 커넥터에서는 큐가 항목입니다.

    그러나 커넥터가 항목을 지원하지 않거나 항목을 포함하지 않을 수 있으며, 이 경우 Entities 목록이 비어 있습니다.

  • 작업: 작업은 항목에 대해 수행할 수 있는 활동입니다. 항목에서 다음 작업을 수행할 수 있습니다.

    사용 가능한 목록에서 항목을 선택하면 항목에 사용 가능한 작업 목록이 생성됩니다. 작업에 대한 자세한 설명은 커넥터 태스크의 항목 작업을 참조하세요. 그러나 커넥터가 항목 작업을 지원하지 않으면 이렇게 지원되지 않는 작업은 Operations 목록에 나열되지 않습니다.

  • 조치: 커넥터 인터페이스를 통해 통합에 제공되는 첫 번째 클래스 함수입니다. 조치를 사용하면 항목을 변경할 수 있습니다. 조치는 커넥터마다 다릅니다. 일반적으로 조치에는 입력 매개변수와 출력 매개변수가 있습니다. 하지만 커넥터가 조치를 지원하지 않을 수 있으며 이 경우 Actions 목록이 비어 있습니다.

시스템 제한사항

Azure Synapse 커넥터는 노드별로 초당 최대 4개의 트랜잭션을 처리할 수 있으며 이 한도를 초과하는 모든 트랜잭션은 제한됩니다. 기본적으로 Integration Connectors는 가용성을 높이기 위해 연결에 2개의 노드를 할당합니다.

Integration Connectors에 적용되는 한도에 대한 자세한 내용은 한도를 참조하세요.

지원되는 데이터 유형

이 커넥터에 지원되는 데이터 유형은 다음과 같습니다.

  • BIGINT
  • 바이너리
  • BIT
  • CHAR
  • DATE
  • DATETIME
  • DATETIME2
  • DATETIMEOFFSET
  • DECIMAL
  • FLOAT
  • DECIMAL
  • FLOAT
  • INT
  • MONEY
  • NCHAR
  • NVARCHAR
  • REAL
  • LSEG
  • SMALLDATETIME
  • SMALLINT
  • SMALLMONEY
  • TINYINT
  • UNIQUEIDENTIFIER
  • VARBINARY
  • VARCHAR

작업

Azure Synapse 커넥터를 사용하면 Azure Synapse에서 지원되는 형식으로 저장 프로시저와 커스텀 SQL 쿼리를 실행할 수 있습니다. 커스텀 SQL 쿼리가 실행되도록 커넥터에서 커스텀 쿼리 실행 작업을 제공합니다.

커스텀 쿼리를 만들려면 다음 단계를 수행합니다.

  1. 자세한 안내에 따라 커넥터 태스크를 추가합니다.
  2. 커넥터 태스크를 구성할 때 수행할 작업 유형에서 작업을 선택합니다.
  3. 작업 목록에서 커스텀 쿼리 실행을 선택한 후 완료를 클릭합니다.

    execute-custom-query-action을 보여주는 이미지 execute-custom-query-action을 보여주는 이미지

  4. 태스크 입력 섹션을 펼친 후 다음을 수행합니다.
    1. 다음 이후 시간 초과 필드에 쿼리가 실행될 때까지 대기할 시간(초)을 입력합니다.

      기본값: 180초

    2. 최대 행 수 필드에 데이터베이스에서 반환될 최대 행 수를 입력합니다.

      기본값은 25입니다.

    3. 커스텀 쿼리를 업데이트하려면 커스텀 스크립트 수정을 클릭합니다. 스크립트 편집기 대화상자가 열립니다.

      custom-sql-query를 보여주는 이미지 custom-sql-query를 보여주는 이미지

    4. 스크립트 편집기 대화상자에서 SQL 쿼리를 입력하고 저장을 클릭합니다.

      SQL 문에서 물음표(?)를 사용하여 쿼리 매개변수 목록에 지정해야 하는 단일 매개변수를 나타낼 수 있습니다. 예를 들어 다음 SQL 쿼리는 Employees 테이블에서 LastName 열에 지정된 값과 일치하는 모든 행을 선택합니다. 

      SELECT * FROM Employees where LastName=?

    5. SQL 쿼리에 물음표를 사용한 경우에는 물음표마다 + 매개변수 이름 추가를 클릭하여 매개변수를 추가해야 합니다. 통합을 실행하는 동안 이 매개변수는 SQL 쿼리의 물음표(?)를 순차적으로 대체합니다. 예를 들어 물음표(?) 3개를 추가한 경우 매개변수 3개를 순서대로 추가해야 합니다.

      add-query-param을 보여주는 이미지 add-query-param을 보여주는 이미지

      쿼리 매개변수를 추가하려면 다음을 수행합니다.

      1. 유형 목록에서 매개변수 데이터 유형을 선택합니다.
      2. 값 필드에 매개변수 값을 입력합니다.
      3. 여러 매개변수를 추가하려면 + 쿼리 매개변수 추가를 클릭합니다.

항목 작업 예시

예시 - 항목 레코드 나열

이 예시에서는 Users 항목의 레코드를 나열합니다.

  1. Configure connector task 대화상자에서 Entities를 클릭합니다.
  2. Entity 목록에서 Users를 선택합니다.
  3. List 작업을 선택한 후 완료를 클릭합니다.
  4. 커넥터 태스크의 태스크 입력 섹션에서 요구사항에 따라 filterClause를 설정할 수 있습니다.

    예를 들어 필터 절을 employeeCode='5100' and startDate='2010-01-01 00:00:00'으로 설정하면 employeeCode가 5100이고 startDate가 2010-01-01 00:00:00인 레코드만 나열됩니다.

예시 - 항목에서 단일 레코드 가져오기

이 예시에서는 Users 항목에서 레코드를 가져옵니다.

  1. Configure connector task 대화상자에서 Entities를 클릭합니다.
  2. Entity 목록에서 User를 선택합니다.
  3. Get 작업을 선택한 후 완료를 클릭합니다.
  4. 커넥터 태스크의 태스크 입력 섹션에서 entityId를 클릭한 후 기본값 필드에 103032를 입력합니다.

    여기서 103032는 Users 항목의 기본 키 값입니다.

예시 - 항목에서 레코드 삭제

이 예시에서는 Users 항목에서 레코드를 삭제합니다.

  1. Configure connector task 대화상자에서 Entities를 클릭합니다.
  2. Entity 목록에서 Users를 선택합니다.
  3. Delete 작업을 선택한 후 완료를 클릭합니다.
  4. 커넥터 태스크의 태스크 입력 섹션에서 entityId를 클릭한 후 기본값 필드에 113132를 입력합니다.

    또는 항목에 entityId를 지정하는 대신 복합 기본 키가 있으면 filterClause를 설정할 수 있습니다. 예를 들면 employeeCode='5100' and startDate='2010-01-01 00:00:00'입니다.

예시 - 항목에 레코드 만들기

이 예시에서는 Users 항목에 레코드를 만듭니다.

  1. Configure connector task 대화상자에서 Entities를 클릭합니다.
  2. Entity 목록에서 Users를 선택합니다.
  3. Create 작업을 선택한 후 완료를 클릭합니다.
  4. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다. 
    {
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}

    5. 통합이 성공하면 커넥터 태스크의 connectorOutputPayload 필드에 만들기 작업 응답이 포함됩니다.

예시 - 항목의 레코드 업데이트

이 예시에서는 Users 항목의 레코드를 업데이트합니다.

  1. Configure connector task 대화상자에서 Entities를 클릭합니다.
  2. Entity 목록에서 Users를 선택합니다.
  3. Update 작업을 선택한 후 완료를 클릭합니다.
  4. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다. 
    {
"country": "IN"
}
  5. 커넥터 태스크의 태스크 입력 섹션에서 entityId를 클릭한 후 기본값 필드에 113132를 입력합니다.

    또는 항목에 entityId를 지정하는 대신 복합 기본 키가 있으면 filterClause를 설정할 수 있습니다. 예를 들면 employeeCode='5100' and startDate='2010-01-01 00:00:00'입니다.

    6. 통합이 성공하면 커넥터 태스크의 connectorOutputPayload 필드에 업데이트 작업 응답이 포함됩니다.

통합에서 Azure Synapse 연결 사용

연결을 만들면 Apigee Integration 및 Application Integration에서 사용할 수 있게 됩니다. 커넥터 태스크를 통해 통합에서 연결을 사용할 수 있습니다.

  • Apigee Integration에서 커넥터 태스크를 만들고 사용하는 방법을 알아보려면 커넥터 태스크를 참조하세요.
  • Application Integration에서 커넥터 태스크를 만들고 사용하는 방법을 이해하려면 커넥터 태스크를 참조하세요.

Google Cloud 커뮤니티에서 도움 받기

Google Cloud 커뮤니티에서 Cloud 포럼에 질문을 게시하고 이 커넥터에 대해 토론할 수 있습니다.

다음 단계