使用 Azure Data Factory 或 Azure Synapse Analytics,在 Azure SQL Database 中複製和轉換資料

適用於:Azure Data Factory Azure Synapse Analytics

本文概述如何使用 Azure Data Factory 或 Azure Synapse 管線中的複製活動,來回複製 Azure SQL Database 中的資料,以及如何使用資料流程在 Azure SQL Database 中轉換資料。 若要深入了解,請閱讀 Azure Data FactoryAzure Synapse Analytics 的介紹文章。

支援的功能

下列功能支援此Azure SQL資料庫連接器:

支援的功能 IR 受控私人端點
複製活動 (來源/接收) ① ②
( 來源/接收) 對應資料流程
查閱活動 ① ②
GetMetadata 活動 ① ②
指令碼活動 ① ②
預存程序活動 ① ②

[1] Azure 整合執行時間 #2. 自我裝載整合執行時間

針對複製活動,此 Azure SQL Database 連接器支援下列功能:

  • 搭配使用 SQL 驗證與 Azure Active Directory (Azure AD) 應用程式權杖驗證服務主體或 Azure 資源的受控身分識別來複製資料。
  • 作為來源時,使用 SQL 查詢或預存程序來擷取資料。 您也可以選擇從 Azure SQL Database 來源平行複製,如需詳細資料,請參閱從 SQL 資料庫平行複製一節。
  • 作為接收器,如果目的地資料表不存在,則會根據來源結構描述自動建立;在複製期間會將資料附加至資料表,或叫用具有自訂邏輯的預存程序。

如果您使用 Azure SQL Database 無伺服器層,則請注意,伺服器暫停時,活動執行會失敗,而不是等待自動繼續準備就緒。 您可以新增活動重試或鏈結其他活動,以確定伺服器在實際執行時為使用中。

重要

如果您使用 Azure 整合執行階段來複製資料,則請設定伺服器層級防火牆規則,讓 Azure 服務可以存取伺服器。 如果您使用自我裝載整合執行階段來複製資料,請將防火牆設定為允許適當的 IP 範圍。 此範圍包括用來連線至 Azure SQL Database 的機器 IP。

開始使用

若要透過管線執行複製活動,您可以使用下列其中一個工具或 SDK:

使用 UI 建立 Azure SQL Database 連結服務

使用下列步驟,在 Azure 入口網站 UI 中建立 Azure SQL Database 連結服務。

  1. 瀏覽至 Azure Data Factory 或 Synapse 工作區中的 [管理] 索引標籤,並選取 [連結服務],然後按一下 [新增]:

  2. 搜尋 [SQL],然後選取 [Azure SQL Database 連接器]。

    選取 [Azure SQL資料庫連接器]。

  3. 設定服務詳細資料、測試連線,然後建立新的連結服務。

    Azure SQL資料庫連結服務的設定螢幕擷取畫面。

連接器設定詳細資料

下列各節提供屬性的相關詳細資料,這些屬性是用來定義 Azure SQL Database 連接器專屬的 Azure Data Factory 或 Synapse 管線實體。

連結服務屬性

以下是支援 Azure SQL Database 已連結服務的屬性:

屬性 描述 必要
type type 屬性必須設為 AzureSqlDatabase
connectionString 針對 connectionString 屬性指定連線到 Azure SQL Database 執行個體所需的資訊。
您也可以在 Azure Key Vault 中放置密碼或服務主體金鑰。 如果這是 SQL 驗證,則會從連接字串中提取 password 組態。 如需詳細資訊,請參閱表格下方的 JSON 範例和在 Azure Key Vault 中儲存認證
servicePrincipalId 指定應用程式的用戶端識別碼。 當您搭配使用 Azure AD 驗證與服務主體時為是
servicePrincipalKey 指定應用程式的金鑰。 將此欄位標示為 SecureString 以將其安全地儲存,或參考 Azure Key Vault 中儲存的祕密 當您搭配使用 Azure AD 驗證與服務主體時為是
tenant 指定您的應用程式所在租用戶的資訊,例如網域名稱或租用戶識別碼。 將滑鼠游標暫留在 Azure 入口網站右上角,即可加以擷取。 當您搭配使用 Azure AD 驗證與服務主體時為是
azureCloudType 針對服務主體驗證,請指定 Azure AD 應用程式註冊的 Azure 雲端環境類型。
允許的值為 AzurePublicAzureChinaAzureUsGovernmentAzureGermany。 預設會使用 Data Factory 或 Synapse 管線的雲端環境。
No
alwaysEncryptedSettings 指定 alwaysencryptedsettings 資訊,讓 Always Encrypted 能夠使用受控身分識別或服務主體來保護儲存在 SQL Server 的敏感性資料。 如需詳細資訊,請參閱表格下方的 JSON 範例和使用 Always Encrypted 一節。 如果未指定,則會停用預設的一律加密設定。 No
認證 將使用者指派的受控身分識別指定為認證物件。 當您使用使用者指派的受控身分識別驗證時為是
connectVia 用來連線到資料存放區的整合執行階段。 您可以使用 Azure 整合執行階段 (IR) 或自我裝載整合執行階段 (如果您的資料存放區位於私人網路中)。 若未指定,則會使用預設 Azure Integration Runtime。

針對不同的驗證類型,請分別參閱下列有關先決條件和 JSON 範例的章節:

提示

如果您遇到錯誤,且其錯誤碼為 "UserErrorFailedToConnectToSqlServer",以及「資料庫的工作階段限制為 XXX 並已達到」訊息,則請將 Pooling=false 新增至您的連接字串並再試一次。 也建議使用 Pooling=false 來進行 SHIR (自我裝載整合執行階段) 類型連結服務設定。 在連結服務建立表單的 [其他連線屬性] 區段中,您可以新增共用和其他連線參數作為新的參數名稱和值。

SQL 驗證

範例:使用 SQL 驗證

{
    "name": "AzureSqlDbLinkedService",
    "properties": {
        "type": "AzureSqlDatabase",
        "typeProperties": {
            "connectionString": "Data Source=tcp:<servername>.database.windows.net,1433;Initial Catalog=<databasename>;User ID=<username>@<servername>;Password=<password>;Trusted_Connection=False;Encrypt=True;Connection Timeout=30"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

範例:Azure Key Vault 中的密碼

{
    "name": "AzureSqlDbLinkedService",
    "properties": {
        "type": "AzureSqlDatabase",
        "typeProperties": {
            "connectionString": "Data Source=tcp:<servername>.database.windows.net,1433;Initial Catalog=<databasename>;User ID=<username>@<servername>;Trusted_Connection=False;Encrypt=True;Connection Timeout=30",
            "password": {
                "type": "AzureKeyVaultSecret",
                "store": {
                    "referenceName": "<Azure Key Vault linked service name>",
                    "type": "LinkedServiceReference"
                },
                "secretName": "<secretName>"
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

範例:使用 Always Encrypted

{
    "name": "AzureSqlDbLinkedService",
    "properties": {
        "type": "AzureSqlDatabase",
        "typeProperties": {
            "connectionString": "Data Source=tcp:<servername>.database.windows.net,1433;Initial Catalog=<databasename>;User ID=<username>@<servername>;Password=<password>;Trusted_Connection=False;Encrypt=True;Connection Timeout=30"
        },
        "alwaysEncryptedSettings": {
            "alwaysEncryptedAkvAuthType": "ServicePrincipal",
            "servicePrincipalId": "<service principal id>",
            "servicePrincipalKey": {
                "type": "SecureString",
                "value": "<service principal key>"
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

服務主體驗證

若要使用以服務主體為基礎的 Azure AD 應用程式權杖驗證,請遵循下列步驟:

  1. 從 Azure 入口網站 建立 Azure Active Directory 應用程式 。 請記下應用程式名稱,以及下列可定義連結服務的值:

    • 應用程式識別碼
    • 應用程式金鑰
    • 租用戶識別碼
  2. 在 Azure 入口網站上為您的伺服器佈建 Azure Active Directory 系統管理員 (如果您尚未這麼做)。 Azure AD 系統管理員必須是 Azure AD 使用者或 Azure AD 群組,但不能是服務主體。 此步驟必須完成,如此您才可以在下一個步驟中使用 Azure AD 身分識別,為服務主體建立自主資料庫使用者。

  3. 為服務主體 建立自主資料庫使用者 。 使用至少具有 ALTER ANY USER 權限的 Azure AD 身分識別,使用 SQL Server Management Studio 這類工具連線至您想要來回複製資料的資料庫。 執行下列 T-SQL:

    CREATE USER [your application name] FROM EXTERNAL PROVIDER;
    
  4. 如同您一般對 SQL 使用者或其他人所做的一樣,將所需的權限授與服務主體。 執行下列程式碼。 如需更多選項,請參閱此文件

    ALTER ROLE [role name] ADD MEMBER [your application name];
    
  5. 在 Azure Data Factory 或 Synapse 工作區中,設定 Azure SQL Database 連結服務。

使用服務主體驗證的連結服務範例

{
    "name": "AzureSqlDbLinkedService",
    "properties": {
        "type": "AzureSqlDatabase",
        "typeProperties": {
            "connectionString": "Data Source=tcp:<servername>.database.windows.net,1433;Initial Catalog=<databasename>;Connection Timeout=30",
            "servicePrincipalId": "<service principal id>",
            "servicePrincipalKey": {
                "type": "SecureString",
                "value": "<service principal key>"
            },
            "tenant": "<tenant info, e.g. microsoft.onmicrosoft.com>"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

系統指派的受控身分識別驗證

資料處理站或 Synapse 工作區可以與 Azure 資源的系統指派受控身分識別相關聯,而此身分識別代表向 Azure 中的其他資源驗證時的服務。 您可以使用此受控識別來進行 Azure SQL Database 分析驗證。 指定的處理站或 Synapse 工作區可以使用此身分識別從您的資料庫存取資料,或來回複製您資料庫中的資料。

若要使用系統指派的受控身分識別驗證,請依照下列步驟操作。

  1. 在 Azure 入口網站上為您的伺服器佈建 Azure Active Directory 系統管理員 (如果您尚未這麼做)。 Azure AD 系統管理員可以是 Azure AD 使用者或 Azure AD 群組。 如果您授與受控識別系統管理員角色,請略過步驟 3 和 4。 系統管理員擁有資料庫的完整存取權。

  2. 為受控身分識別建立自主資料庫使用者。 使用至少具有 ALTER ANY USER 權限的 Azure AD 身分識別,使用 SQL Server Management Studio 這類工具連線至您想要來回複製資料的資料庫。 執行下列 T-SQL:

    CREATE USER [your_resource_name] FROM EXTERNAL PROVIDER;
    
  3. 依照您平常為 SQL 使用者和其他人所進行的作業一樣,授與受控身分識別所需的權限。 執行下列程式碼。 如需更多選項,請參閱此文件

    ALTER ROLE [role name] ADD MEMBER [your_resource_name];
    
  4. 設定 Azure SQL Database 連結服務。

範例

{
    "name": "AzureSqlDbLinkedService",
    "properties": {
        "type": "AzureSqlDatabase",
        "typeProperties": {
            "connectionString": "Data Source=tcp:<servername>.database.windows.net,1433;Initial Catalog=<databasename>;Connection Timeout=30"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

使用者指派的受控身分識別驗證

資料處理站或 Synapse 工作區可以與使用者指派的受控身分識別相關聯,而此身分識別代表向 Azure 中的其他資源驗證時的服務。 您可以使用此受控識別來進行 Azure SQL Database 分析驗證。 指定的處理站或 Synapse 工作區可以使用此身分識別從您的資料庫存取資料,或來回複製您資料庫中的資料。

若要使用使用者指派的受控身分識別驗證,請遵循下列步驟。

  1. 在 Azure 入口網站上為您的伺服器佈建 Azure Active Directory 系統管理員 (如果您尚未這麼做)。 Azure AD 系統管理員可以是 Azure AD 使用者或 Azure AD 群組。 如果您為具有使用者指派的受控身分識別的群組授與系統管理員角色,請略過步驟 3。 系統管理員擁有資料庫的完整存取權。

  2. 為使用者指派的受控身分識別建立自主資料庫使用者。 使用至少具有 ALTER ANY USER 權限的 Azure AD 身分識別,使用 SQL Server Management Studio 這類工具連線至您想要來回複製資料的資料庫。 執行下列 T-SQL:

    CREATE USER [your_resource_name] FROM EXTERNAL PROVIDER;
    
  3. 依照您平常為 SQL 使用者和其他人所進行的作業一樣,建立一或多個使用者指派的受控身分識別,並授與使用者指派的受控身分識別所需的權限。 執行下列程式碼。 如需更多選項,請參閱此文件

    ALTER ROLE [role name] ADD MEMBER [your_resource_name];
    
  4. 將一或多個使用者指派的受控身分識別指派給資料處理站,並為每個使用者指派的受控身分識別建立認證

  5. 設定 Azure SQL Database 連結服務。

範例︰

{
    "name": "AzureSqlDbLinkedService",
    "properties": {
        "type": "AzureSqlDatabase",
        "typeProperties": {
            "connectionString": "Data Source=tcp:<servername>.database.windows.net,1433;Initial Catalog=<databasename>;Connection Timeout=30",
            "credential": {
                "referenceName": "credential1",
                "type": "CredentialReference"
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

資料集屬性

如需可用來定義資料集的完整區段和屬性清單,請參閱資料集

下列是針對 Azure SQL Database 資料集所支援的屬性:

屬性 描述 必要
type 資料集的 type 屬性必須設定為 AzureSqlTable
結構描述 結構描述的名稱。 否 (來源);是 (接收)
資料表 資料表/檢視的名稱。 否 (來源);是 (接收)
tableName 具有結構描述的資料表/檢視名稱。 支援此屬性是基於回溯相容性。 對於新的工作負載,請使用 schematable 否 (來源);是 (接收)

資料集屬性範例

{
    "name": "AzureSQLDbDataset",
    "properties":
    {
        "type": "AzureSqlTable",
        "linkedServiceName": {
            "referenceName": "<Azure SQL Database linked service name>",
            "type": "LinkedServiceReference"
        },
        "schema": [ < physical schema, optional, retrievable during authoring > ],
        "typeProperties": {
            "schema": "<schema_name>",
            "table": "<table_name>"
        }
    }
}

複製活動屬性

如需可用來定義活動的區段和屬性完整清單,請參閱管線。 本節提供 Azure SQL Database 來源和接收所支援屬性的清單。

Azure SQL Database 作為來源

提示

若要使用資料分割有效率地從 Azure SQL Database 載入資料,請在從 SQL Server 資料庫平行複製一節深入了解。

若要從 Azure SQL Database 複製資料,複製活動 source 區段中支援下列屬性:

屬性 描述 必要
type 複製活動來源的 type 屬性必須設定為 AzureSqlSource。 回溯相容性仍然支援 "SqlSource" 類型。
sqlReaderQuery 此屬性使用自訂 SQL 查詢來讀取資料。 例如 select * from MyTable
sqlReaderStoredProcedureName 從來源資料表讀取資料的預存程序名稱。 最後一個 SQL 陳述式必須是預存程序中的 SELECT 陳述式。
storedProcedureParameters 預存程序的參數。
允許的值為名稱或值組。 參數的名稱和大小寫必須符合預存程序參數的名稱和大小寫。
isolationLevel 指定 SQL 來源的異動鎖定行為。 允許的值為:ReadCommittedReadUncommittedRepeatableReadSerializableSnapshot。 如果未指定,則會使用資料庫的預設隔離等級。 如需詳細資訊,請參閱這篇文件
partitionOptions 指定用來從 Azure SQL Database 載入資料的資料分割選項。
允許的值為:None (預設值)、PhysicalPartitionsOfTableDynamicRange
啟用分割區選項後 (即不是 None),從 Azure SQL Database 並行載入資料的平行處理程度,會由複製活動的 parallelCopies 設定所控制。
partitionSettings 指定資料分割的設定群組。
當分割選項不是 None 時套用。
No
partitionSettings 底下:
partitionColumnName 整數類型或日期/日期時間類型 (intsmallintbigintdatesmalldatetimedatetimedatetime2datetimeoffset) 指定來源資料行的名稱,供平行複製的範圍分割使用。 如果未指定,則會自動偵測資料表的索引或主索引鍵作為分割資料行。
當分割選項是 DynamicRange 時套用。 如果您使用查詢來取出來源資料,請在 WHERE 子句中加上 ?AdfDynamicRangePartitionCondition 。 如需範例,請參閱從 SQL 資料庫平行複製一節。
partitionUpperBound 分割區範圍分割的分割區資料行最大值。 這個值用於決定分割區的跨距,而不是用於篩選資料表中的資料列。 資料表或查詢結果中的所有資料列都會進行分割和複製。 如果未指定,複製活動會自動偵測該值。
當分割選項是 DynamicRange 時套用。 如需範例,請參閱從 SQL 資料庫平行複製一節。
partitionLowerBound 分割區範圍分割的分割區資料行最小值。 這個值用於決定分割區的跨距,而不是用於篩選資料表中的資料列。 資料表或查詢結果中的所有資料列都會進行分割和複製。 如果未指定,複製活動會自動偵測該值。
當分割選項是 DynamicRange 時套用。 如需範例,請參閱從 SQL 資料庫平行複製一節。
No

請注意下列幾點:

  • 如果已為 AzureSqlSource 指定 sqlReaderQuery,則複製活動會針對 Azure SQL Database 來源執行這項查詢以取得資料。 如果預存程序接受參數,您也可以藉由指定 sqlReaderStoredProcedureNamestoredProcedureParameters 來指定預存程序。
  • 在來源中使用預存程序來擷取資料時,請注意,如果您的預存程序設計為在傳入不同的參數值時傳回不同的結構描述,在從 UI 匯入結構描述,或使用自動資料表建立將資料複製到 SQL 資料庫時,您可能遇到失敗,或看到非預期的結果。

SQL 查詢範例

"activities":[
    {
        "name": "CopyFromAzureSQLDatabase",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Azure SQL Database input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "AzureSqlSource",
                "sqlReaderQuery": "SELECT * FROM MyTable"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

預存程序範例

"activities":[
    {
        "name": "CopyFromAzureSQLDatabase",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Azure SQL Database input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "AzureSqlSource",
                "sqlReaderStoredProcedureName": "CopyTestSrcStoredProcedureWithParameters",
                "storedProcedureParameters": {
                    "stringData": { "value": "str3" },
                    "identifier": { "value": "$$Text.Format('{0:yyyy}', <datetime parameter>)", "type": "Int"}
                }
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

預存程序定義

CREATE PROCEDURE CopyTestSrcStoredProcedureWithParameters
(
    @stringData varchar(20),
    @identifier int
)
AS
SET NOCOUNT ON;
BEGIN
     select *
     from dbo.UnitTestSrcTable
     where dbo.UnitTestSrcTable.stringData != stringData
    and dbo.UnitTestSrcTable.identifier != identifier
END
GO

Azure SQL Database 作為接收

提示

將資料載入 Azure SQL Database 的最佳做法中,深入了解支援的寫入行為、設定和最佳做法。

若要將資料複製至 Azure SQL Database,複製活動 sink 區段中支援下列屬性:

屬性 描述 必要
type 複製活動接收器的 type 屬性必須設定為 AzureSqlSink。 回溯相容性仍然支援 "SqlSink" 類型。 Yes
preCopyScript 指定 SQL 查詢,供複製活動在將資料寫入 Azure SQL Database 之前執行。 每一複製回合只會叫用此查詢一次。 使用此屬性來清除預先載入的資料。
tableOption 指定是否要根據來源結構描述,自動建立接收資料表 (如果不存在)。
當接收指定預存程序時,不支援自動建立資料表。
允許的值包為:none (預設) 或 autoCreate
sqlWriterStoredProcedureName 定義如何將來源資料套用到目標資料表的預存程序名稱。
此預存程序將會依批次叫用。 針對只執行一次且與來源資料無關的作業 (例如刪除或截斷),請使用 preCopyScript 屬性。
請參閱叫用 SQL 接收器中的預存程序的範例。
No
storedProcedureTableTypeParameterName 預存程序中指定資料表類型的參數名稱。 No
sqlWriterTableType 在預存程序中使用的資料表類型名稱。 複製活動可讓正在移動的資料可用於此資料表類型的暫存資料表。 然後,預存程序程式碼可以合併正在複製的資料與現有的資料。
storedProcedureParameters 預存程序的參數。
允許的值為:名稱和值組。 參數的名稱和大小寫必須符合預存程序參數的名稱和大小寫。
writeBatchSize 針對「每個批次」要插入 SQL 資料表中的資料列數。
允許的值為整數 (資料列數目)。 根據預設,服務會依據資料列大小動態決定適當的批次大小。
No
writeBatchTimeout 在逾時前等待批次插入作業完成的時間。
允許的值為時間範圍。 範例是 "00:30:00" (30 分鐘)。
disableMetricsCollection 該服務會收集 Azure SQL Database DTU 這類計量以獲得複製效能最佳化和建議,而這會導致額外的主要 DB 存取。 如果您擔心此行為,請指定 true 將其關閉。 否 (預設值為 false)
 maxConcurrentConnections 活動執行期間,建立與資料存放區的並行連線上限。 僅在想要限制並行連線時,才需要指定值。  No
WriteBehavior 指定複製活動將資料載入 Azure SQL Database 的寫入行為。
允許的值為 InsertUpsert。 根據預設,服務會使用 Insert 載入資料。
No
upsertSettings 指定寫入行為的設定群組。
當 WriteBehavior 選項為 Upsert 時套用。
No
upsertSettings 底下:
useTempDB 指定是否要使用全域暫存資料表或實體資料表作為 upsert 的過渡資料表。
根據預設,服務會使用全域暫存資料表作為過度資料表。 值為 true
No
interimSchemaName 如果使用實體資料表,請指定建立過渡資料表的過渡結構描述。 注意:使用者必須具有建立和刪除資料表的權限。 根據預設,過渡資料表會與接收資料表共用相同的結構描述。
當 useTempDB 選項為 False 套用。
No
金鑰 指定唯一資料列識別的資料行名稱。 您可以使用單一索引鍵或一系列索引鍵。 如果未指定,則會使用主索引鍵。 No

範例 1:附加資料

"activities":[
    {
        "name": "CopyToAzureSQLDatabase",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<Azure SQL Database output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "<source type>"
            },
            "sink": {
                "type": "AzureSqlSink",
                "tableOption": "autoCreate",
                "writeBatchSize": 100000
            }
        }
    }
]

範例 2:在複製期間叫用預存程序

若要了解更多詳細資料,請參閱叫用 SQL 接收中的預存程序

"activities":[
    {
        "name": "CopyToAzureSQLDatabase",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<Azure SQL Database output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "<source type>"
            },
            "sink": {
                "type": "AzureSqlSink",
                "sqlWriterStoredProcedureName": "CopyTestStoredProcedureWithParameters",
                "storedProcedureTableTypeParameterName": "MyTable",
                "sqlWriterTableType": "MyTableType",
                "storedProcedureParameters": {
                    "identifier": { "value": "1", "type": "Int" },
                    "stringData": { "value": "str1" }
                }
            }
        }
    }
]

範例 3:Upsert 資料

"activities":[
    {
        "name": "CopyToAzureSQLDatabase",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<Azure SQL Database output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "<source type>"
            },
            "sink": {
                "type": "AzureSqlSink",
                "tableOption": "autoCreate",
                "writeBehavior": "upsert",
                "upsertSettings": {
                    "useTempDB": true,
                    "keys": [
                        "<column name>"
                    ]
                },
            }
        }
    }
]

從 SQL 資料庫平行複製

複製活動中 Azure SQL Database 連接器提供內建的資料分割,以平行複製資料。 您可以在複製活動的 [來源] 索引標籤上找到資料分割選項。

分割選項的螢幕擷取畫面

當您啟用分割複本時,複製活動會平行查詢 Azure SQL Database 來源,以依分割區來載入資料。 平行程度由複製活動的 parallelCopies 設定所控制。 例如,如果您將 parallelCopies 設定為 4,則服務會根據您指定的分割區選項和設定,同時產生並執行四個查詢,而每個查詢都會從 Azure SQL Database 中擷取一部分的資料。

建議您啟用平行複製與資料分割,特別是從 Azure SQL Database 資料庫載入大量資料時。 以下針對各種情節的建議設定。 將資料複製到以檔案為基礎的資料存放區時,建議分成多個檔案來寫入資料夾 (僅指定資料夾名稱),這樣效能會比寫入單一檔案更好。

狀況 建議的設定
使用實體分割區從大型資料表完整載入。 分割選項:資料表的實體分割區。

在執行期間,服務會自動偵測實體分割區,並依分割區複製資料。

若要檢查您的資料表是否有實體分割區,您可以參考此查詢
從大型資料表完整載入,不含實體分割區,同時在資料分割時包含整數或日期時間資料行。 分割選項:動態範圍分割。
分割資料行 (選用):指定用來分割資料的資料行。 如果未指定,則會使用索引或主索引鍵資料行。
分割區上限分割區下限 (選用):指定是否要決定分割區跨距。 這不適用於篩選資料表中的資料列,資料表中的所有資料列都會分割並複製。 如果未指定,複製活動會自動偵測值。

例如,如果您的分割區資料行「識別碼」具有範圍 1 到 100 之間的值,而您將下限設定為 20、上限設定為 80,且平行複製為 4,則服務會分別依 4 個分割區擷取資料 - 範圍中的識別碼分別為 <=20、[21, 50]、[51, 80] 和 >=81。
使用自訂查詢載入大量資料,不使用實體分割區,同時包含整數或日期/日期時間資料行用於資料分割。 分割選項:動態範圍分割。
查詢SELECT * FROM <TableName> WHERE ?AdfDynamicRangePartitionCondition AND <your_additional_where_clause>
分割資料行:指定用來分割資料的資料行。
分割區上限分割區下限 (選用):指定是否要決定分割區跨距。 這不適用於篩選資料表中的資料列,查詢結果中的所有資料列都會分割並複製。 如果未指定,複製活動會自動偵測該值。

在執行期間,服務會將 ?AdfRangePartitionColumnName 取代為每個分割區的實際資料行名稱和值範圍,並傳送至 Azure SQL Database。
例如,如果您的分割區資料行「識別碼」具有範圍 1 到 100 之間的值,而您將下限設定為 20、上限設定為 80,且平行複製為 4,則服務會分別依 4 個分割區擷取資料 - 範圍中的識別碼分別為 <=20、[21, 50]、[51, 80] 和 >=81。

以下是不同案例的更多範例查詢:
1. 查詢整個資料表:
SELECT * FROM <TableName> WHERE ?AdfDynamicRangePartitionCondition
2. 來自具有資料行選取範圍和其他 where 子句篩選的資料表查詢:
SELECT <column_list> FROM <TableName> WHERE ?AdfDynamicRangePartitionCondition AND <your_additional_where_clause>
3. 使用子查詢的查詢:
SELECT <column_list> FROM (<your_sub_query>) AS T WHERE ?AdfDynamicRangePartitionCondition AND <your_additional_where_clause>
4. 在子查詢中使用分割區的查詢:
SELECT <column_list> FROM (SELECT <your_sub_query_column_list> FROM <TableName> WHERE ?AdfDynamicRangePartitionCondition) AS T

使用分割區選項載入資料的最佳做法:

  1. 選擇獨特的資料行作為分割資料行 (例如主索引鍵或唯一索引鍵) 以避免資料扭曲。
  2. 如果資料表有內建分割區,請使用分割選項「資料表的實體分割區」,以獲得更佳的效能。
  3. 如果您使用 Azure Integration Runtime 來複製資料,您可以設定較大的「資料整合單位 (DIU)」(>4) 來利用更多運算資源。 檢查該處適用的案例。
  4. 複製平行處理原則的程度」會控制分割區數目,將此數目設定過大有時會損害效能,建議將此數目設定為 (DIU 或自我裝載 IR 節點數目) * (2 到 4)。

範例:使用實體分割區從大型資料表完整載入

"source": {
    "type": "AzureSqlSource",
    "partitionOption": "PhysicalPartitionsOfTable"
}

範例:使用動態範圍分割進行查詢

"source": {
    "type": "AzureSqlSource",
    "query": "SELECT * FROM <TableName> WHERE ?AdfDynamicRangePartitionCondition AND <your_additional_where_clause>",
    "partitionOption": "DynamicRange",
    "partitionSettings": {
        "partitionColumnName": "<partition_column_name>",
        "partitionUpperBound": "<upper_value_of_partition_column (optional) to decide the partition stride, not as data filter>",
        "partitionLowerBound": "<lower_value_of_partition_column (optional) to decide the partition stride, not as data filter>"
    }
}

用來檢查實體分割區的範例查詢

SELECT DISTINCT s.name AS SchemaName, t.name AS TableName, pf.name AS PartitionFunctionName, c.name AS ColumnName, iif(pf.name is null, 'no', 'yes') AS HasPartition
FROM sys.tables AS t
LEFT JOIN sys.objects AS o ON t.object_id = o.object_id
LEFT JOIN sys.schemas AS s ON o.schema_id = s.schema_id
LEFT JOIN sys.indexes AS i ON t.object_id = i.object_id 
LEFT JOIN sys.index_columns AS ic ON ic.partition_ordinal > 0 AND ic.index_id = i.index_id AND ic.object_id = t.object_id 
LEFT JOIN sys.columns AS c ON c.object_id = ic.object_id AND c.column_id = ic.column_id 
LEFT JOIN sys.partition_schemes ps ON i.data_space_id = ps.data_space_id 
LEFT JOIN sys.partition_functions pf ON pf.function_id = ps.function_id 
WHERE s.name='[your schema]' AND t.name = '[your table name]'

如果資料表具有實體分割區,您會看到 “HasPartition” 顯示為 “yes”,如下所示。

Sql 查詢結果

將資料載入至 Azure SQL Database 的最佳做法

將資料複製至 Azure SQL Database 時,您可能需要不同的寫入行為:

  • 附加:我的來源資料只有新的記錄。
  • Upsert:我的來源資料同時有插入和更新。
  • 覆寫:我想要每次都重新載入整個維度資料表。
  • 使用自訂邏輯寫入:在最終插入目的地資料表之前,我還需要額外的處理。

請參閱如何在服務和最佳做法中設定的各節。

附加資料

附加資料是這個 Azure SQL Database 接收連接器的預設行為。 服務會執行大量插入,以有效率地寫入資料表。 您可以在複製活動中據以設定來源和接收。

更新插入資料

複製活動現在支援將資料原生載入資料庫暫存資料表,然後在索引鍵存在時更新接收資料表中的資料,若無則插入新的資料。 若要深入了解複製活動中的 upsert 設定,請參閱 Azure SQL Database 作為接收器

覆寫整個資料表

您可以在複製活動接收器中設定 preCopyScript 屬性。 在此情況下,針對執行的每個複製活動,服務會先執行指令碼。 然後服務會執行複本以插入資料。 例如,若要以最新的資料覆寫整個資料表,可以指定先刪除所有記錄,再從來源大量載入新資料的指令碼。

使用自訂邏輯寫入資料

使用自訂邏輯寫入資料的步驟類似於 Upsert 資料一節中所述的步驟。 當您需要在最終插入來源資料至目的地資料表之前套用額外的處理時,您可以載入暫存表格,然後叫用預存程序活動,或在複製活動接收器中叫用預存程序來套用資料,或使用對應資料流程。

從 SQL 接收叫用預存程序

當您將資料複製至 Azure SQL Database 時,也可以在來源資料表的每個批次上設定和叫用具有額外參數的使用者指定預存程序。 預存程序功能使用資料表值參數

當內建的複製機制無法滿足需求時,您可以使用預存程序。 例如,當您想要在最終插入來源資料至目的地資料表之前,套用額外的處理。 額外處理的一些範例包括:合併資料行、查閱其他的值,以及插入多個資料表中。

下列範例示範如何使用預存程序,對 Azure SQL Database 中的資料表執行 upsert。 假設輸入資料和接收 Marketing 資料表各有三個資料行:ProfileIDStateCategory。 根據 ProfileID 資料行執行更新插入,然後僅套用至名為 "ProductA" 的特定類別。

  1. 在資料庫中,使用與 sqlWriterTableType 相同的名稱來定義資料表類型。 資料表類型的結構描述會與輸入資料所傳回的結構描述相同。

    CREATE TYPE [dbo].[MarketingType] AS TABLE(
        [ProfileID] [varchar](256) NOT NULL,
        [State] [varchar](256) NOT NULL,
        [Category] [varchar](256) NOT NULL
    )
    
  2. 在資料庫中,使用與 SqlWriterStoredProcedureName 相同的名稱來定義預存程序。 它會處理來自指定來源的輸入資料,並合併至輸出資料表。 預存程序中資料表類型的參數名稱會與資料集中定義的 tableName 相同。

    CREATE PROCEDURE spOverwriteMarketing @Marketing [dbo].[MarketingType] READONLY, @category varchar(256)
    AS
    BEGIN
    MERGE [dbo].[Marketing] AS target
    USING @Marketing AS source
    ON (target.ProfileID = source.ProfileID and target.Category = @category)
    WHEN MATCHED THEN
        UPDATE SET State = source.State
    WHEN NOT MATCHED THEN
        INSERT (ProfileID, State, Category)
        VALUES (source.ProfileID, source.State, source.Category);
    END
    
  3. 在您的 Azure Data Factory 或 Synapse 管線中,定義複製活動中的「SQL 接收器」區段,如下所示:

    "sink": {
        "type": "AzureSqlSink",
        "sqlWriterStoredProcedureName": "spOverwriteMarketing",
        "storedProcedureTableTypeParameterName": "Marketing",
        "sqlWriterTableType": "MarketingType",
        "storedProcedureParameters": {
            "category": {
                "value": "ProductA"
            }
        }
    }
    

對應資料流程屬性

在對應資料流程中轉換資料時,您可以從 Azure SQL Database 讀取和寫入至資料表。 如需詳細資訊,請參閱對應資料流程中的來源轉換接收轉換

來源轉換

您可以在來源轉換的 [來源選項] 索引標籤中找到 Azure SQL Database 的專屬設定。

Input: 選取您是要將來源指向資料表 (相當於 Select * from <table-name>) 還是要輸入自訂的 SQL 查詢。

查詢:如果您在 [輸入] 欄位中選取 [查詢],請對於您的來源輸入 SQL 查詢。 此設定會覆寫您在資料集中選擇的任何資料表。 這裡不支援 Order By 子句,但您可以設定完整的 SELECT FROM 陳述式。 您也可使用使用者定義的資料表函數。 select * from udfGetData() 是 SQL 中傳回資料表的 UDF。 此查詢會產生您可以在資料流程中使用的來源資料表。 使用查詢也是縮減資料列以進行測試或查閱的絕佳方式。

提示

對應資料流程 [查詢] 模式不支援 SQL 的通用資料表運算式 (CTE),因為使用此模式的必要條件是查詢可用於 SQL 查詢 FROM 子句,但 CTE 不適用。 若要使用 CTE,您必須使用下列查詢來建立預存程序:

CREATE PROC CTESP @query nvarchar(max)
AS
BEGIN
EXECUTE sp_executesql @query;
END

然後在對應資料流程的來源轉換中使用 [預存程序] 模式,並依照範例 with CTE as (select 'test' as a) select * from CTE 設定 @query。 接著您便可以正常使用 CTE。

預存程序:如果您想要透過從來源資料庫執行的預存程序來產生投影和來源資料,則請選擇此選項。 您可以輸入結構描述、程序名稱和參數,或按一下 [重新整理] 以要求服務探索結構描述和程序名稱。 然後,您可以按一下 [匯入],以使用 @paraName 形式匯入所有程序參數。

預存程式

  • SQL 範例:Select * from MyTable where customerId > 1000 and customerId < 2000
  • 參數化 SQL 範例:"select * from {$tablename} where orderyear > {$year}"

批次大小:輸入批次大小,以將大量資料分成多次讀取。

隔離等級:對應資料流程中 SQL 來源的預設值為「未認可」。 您可以在這裡將隔離等級變更為下列其中一個值:

  • 讀取認可
  • 讀取未認可
  • 可重複讀取
  • 可序列化
  • None (忽略隔離等級)

隔離等級

啟用累加擷取:使用此選項可告訴 ADF 只處理自上次執行管線以來已變更的資料列。

累加日期資料行:使用累加擷取功能時,您必須選擇您想要用來作為來源資料表浮水印的日期/時間資料行。

從頭開始讀取:使用累加擷取設定此選項,會指示 ADF 在第一次執行管線時讀取所有資料列,並開啟累加擷取。

接收轉換

您可以在接收轉換的 [設定] 索引標籤中找到 Azure SQL Database 的專屬設定。

Update 方法: 決定您的資料庫目的地所允許的作業。 預設僅允許插入。 若要更新、upsert 或刪除資料列,必須使用 alter-row 轉換來標記這些動作的資料列。 對於更新、更新插入和刪除,必須設定索引鍵資料行,以決定要改變哪一個資料列。

索引鍵資料行

在後續更新、Upsert、刪除期間,服務將會使用您在這裡挑選作為索引鍵的資料行名稱。 因此,您必須挑選存在於接收器對應中的資料行。 如果您不想要將值寫入至此索引鍵資料行,則請按一下 [跳過寫入索引鍵資料行]。

您可以參數化此處用來更新目標 Azure SQL Database 資料表的索引鍵資料行。 如果您的複合索引鍵有多個資料行,則請按一下 [自訂運算式],您就可以使用資料流程運算式語言來新增動態內容,其中包括具有複合索引鍵資料行名稱的字串陣列。

資料表動作: 決定在寫入之前,是否要重新建立或移除目的地資料表中的所有資料列。

  • 無:資料表不會執行任何動作。
  • 重新建立:資料表會遭到捨棄並重新建立。 如果要動態建立新的資料表,則為必要。
  • Truncate:會移除目標資料表中的所有資料列。

批次大小:控制要在每個值區中寫入的資料列數目。 較大的批次大小會改善壓縮和記憶體優化,但會導致在快取資料時發生記憶體例外狀況的風險。

使用 TempDB:根據預設,在載入程序期間,服務將會使用全域暫存資料表來儲存資料。 或者,您可以取消核取 [使用 TempDB] 選項,並改為要求服務將暫存持有資料表儲存至使用者資料庫,而此使用者資料庫位於用於此接收器的資料庫中。

使用 Temp DB

前置和後置 SQL 指令碼:輸入將在寫入至您的接收資料庫之前 (前置處理) 和之後 (後置處理) 將執行的多行 SQL 指令碼

此螢幕擷取畫面顯示具有 SQL 前置和後置處理腳本的接收設定。

提示

  1. 建議將含有多個命令的單一批次指令碼分成多個批次。
  2. 只有傳回簡單更新計數的資料定義語言 (DDL) 和資料操作語言 (DML) 陳述式可以當作批次的一部份來執行。 若要深入了解,請參閱執行批次作業

處理資料列時發生錯誤

寫入至 Azure SQL DB 時,某些資料列可能會因為目的地設定的條件約束而失敗。 部分常見錯誤包括:

  • 資料表中的字串或二進位資料會遭到截斷
  • 無法將 NULL 值插入資料行
  • INSERT 陳述式與 CHECK 條件約束衝突

根據預設,資料流程執行會在它遇到的第一個錯誤時失敗。 您可以選擇 [發生錯誤時繼續],讓您的資料流程即使在個別資料列發生錯誤時也能夠完成。 該服務會提供不同的選項,讓您處理這些錯誤資料列。

交易認可:選擇您的資料是以單一交易或批次寫入。 單一交易將會提供較差的效能,但在交易完成之前,其他人看不到寫入的資料。

輸出拒絕的資料:如果啟用,則可以將錯誤資料列輸出至 Azure Blob 儲存體中的 csv 檔案或您選擇的 Azure Data Lake Storage Gen2 帳戶。 這會寫入含有三個額外資料行的錯誤資料列:INSERT 或 UPDATE 之類的 SQL 作業、資料流程錯誤碼,以及資料列上的錯誤訊息。

發生錯誤時回報成功:如果啟用,即使找到發生錯誤的資料列,資料流程也會標示為成功。

處理資料列時發生錯誤

Azure SQL Database 的資料類型對應

從 Azure SQL Database 複製資料或將資料複製至其中時,會使用下列從 Azure SQL Database 資料類型對應至 Azure Data Factory 過渡期資料類型的對應。 Synapse 管線功能會使用相同的對應,而這會直接實作 Azure Data Factory。 若要了解複製活動如何將來源結構描述和資料類型對應至接收,請參閱結構描述和資料類型對應

Azure SQL Database 資料類型 Data Factory 過渡期資料類型
BIGINT Int64
BINARY Byte[]
bit Boolean
char String, Char[]
date Datetime
Datetime Datetime
datetime2 Datetime
Datetimeoffset DateTimeOffset
Decimal Decimal
FILESTREAM attribute (varbinary(max)) Byte[]
Float Double
image Byte[]
int Int32
money Decimal
NCHAR String, Char[]
ntext String, Char[]
NUMERIC Decimal
NVARCHAR String, Char[]
real Single
rowversion Byte[]
smalldatetime Datetime
SMALLINT Int16
SMALLMONEY Decimal
sql_variant Object
text String, Char[]
time TimeSpan
timestamp Byte[]
TINYINT Byte
UNIQUEIDENTIFIER Guid
varbinary Byte[]
varchar String, Char[]
Xml String

注意

針對對應至 Decimal 過渡期類型的資料類型,複製活動目前支援最多 28 個有效位數。 如果您有有效位數超過 28 的資料,則請考慮在 SQL 查詢中將其轉換成字串。

查閱活動屬性

若要了解關於屬性的詳細資料,請參閱查閱活動

GetMetadata 活動屬性

若要了解關於屬性的詳細資料,請參閱 GetMetadata 活動

使用 Always Encrypted

當您使用 Always Encrypted 來回複製 Azure SQL Database 中的資料時,請遵循下列步驟:

  1. 資料行主要金鑰 (CMK) 儲存在 Azure Key Vault 中。 深入了解如何使用 Azure Key Vault 設定 Always Encrypted

  2. 請務必授與資料行主要金鑰 (CMK) 儲存所在金鑰保存庫的存取權。 針對必要權限,請參閱這篇文章

  3. 建立連結服務以連線到您的 SQL 資料庫,並使用受控身分識別或服務主體啟用 'Always Encrypted' 函式。

注意

Azure SQL Database Always Encrypted 支援下列案例:

  1. 來源或接收資料存放區都使用受控身分識別或服務主體作為金鑰提供者驗證類型。
  2. 來源和接收資料存放區都會使用受控身分識別作為金鑰提供者驗證類型。
  3. 來源和接收資料存放區都使用與金鑰提供者驗證類型相同的服務主體。

注意

目前,只有對應資料流程中的來源轉換才支援 Azure SQL DatabaseAlways Encrypted

下一步

如需複製活動支援作為來源和接收器的資料存放區清單,請參閱支援的資料存放區和格式