Azure Cosmos DB の添付ファイル
適用対象: 
NoSQL MongoDB
Azure Cosmos DB の添付ファイルは、外部 BLOB またはメディア ファイルと関連付けられているメタデータへの参照を含む特殊な項目です。
Azure Cosmos DB では 2 種類の添付ファイルがサポートされます。
- 管理対象外の添付ファイルは、外部サービス (たとえば、Azure Storage、OneDrive など) に格納されている BLOB への URI 参照のラッパーです。 この方法は、標準の Azure Cosmos DB 項目に URI プロパティを格納することと似ています。
- 管理対象の添付ファイルは、Azure Cosmos DB によって内部的に管理および格納され、システムによって生成された mediaLink を介して公開される BLOB です。
注意
添付ファイルはレガシ機能です。 この機能を既に使用している場合は、機能が引き続きサポートされます。
添付ファイルを使用する代わりに、BLOB データを格納するための専用の BLOB ストレージ サービスとして Azure Blob Storage を使用することをお勧めします。 BLOB に関連するメタデータは、参照 URI リンクと共に、Azure Cosmos DB に項目プロパティとして引き続き格納できます。 このデータを Azure Cosmos DB に格納することで、メタデータを照会し、Azure Blob Storage に格納されている BLOB へのリンクを提供することができます。
Microsoft は、添付ファイルを完全に非推奨にする前に、36 か月以上の通知期間を提供することを約束しています。これは、今後発表される予定です。
既知の制限事項
Azure Cosmos DB の管理対象の添付ファイルは、標準項目のサポートとは異なります。標準項目に対しては、無制限のスケーラビリティ、グローバル配信、および他の Azure サービスとの統合が提供されます。
- Azure Cosmos DB の SDK には、添付ファイルがサポートされていないバージョンもあります。
- 管理対象の添付ファイルは、データベース アカウントごとに 2 GB のストレージに制限されます。
- 管理対象の添付ファイルは、Azure Cosmos DB のグローバル配信と互換性がなく、リージョン間でレプリケートされません。
注意
Azure Cosmos DB for MongoDB バージョン 3.2 では、GridFS の管理対象の添付ファイルが使用され、これらには同じ制限が適用されます。
MongoDB の GridFS 機能セットを使用する開発者は Azure Cosmos DB for MongoDB バージョン 3.6 以降にアップグレードすることをお勧めします。これは、添付ファイルから分離されるため、より良いエクスペリエンスが得られます。 または、MongoDB の GridFS 機能セットを使用する開発者は Azure Blob Storage を使用することも検討する必要があります。これは、Blob コンテンツの格納専用であり、GridFS と比較して低コストで拡張された機能が提供されます。
添付ファイルの Azure BLOB ストレージへの移行
次の手順で Azure Cosmos DB の添付ファイルを Azure Blob Storage に移行することをお勧めします。
- 移行元の Azure Cosmos DB コンテナーから移行先の Azure Blob Storage コンテナーに、添付ファイルのデータをコピーします。
- アップロードされた BLOB データを移行先の Azure Blob Storage コンテナーで検証します。
- 必要に応じて、Azure Blob Storage に含まれている BLOB への URI 参照を Azure Cosmos DB データセット内の文字列プロパティとして追加します。
- 新しい Azure Blob Storage コンテナーから BLOB の読み取りと書き込みを行うようにアプリケーション コードをリファクタリングします。
次のコード サンプルは、Azure Cosmos DB の .NET SDK v2 と Azure Blob Storage .NET SDK v12 を使用して、移行フローの一部として Azure Cosmos DB から Azure BLOB ストレージに添付ファイルをコピーする方法を示しています。 移行元の Azure Cosmos DB アカウントと移行先の Azure BLOB ストレージ コンテナーの <placeholder values> を必ず置き換えてください。
using System;
using System.IO;
using System.Threading.Tasks;
using Microsoft.Azure.Documents;
using Microsoft.Azure.Documents.Client;
using Azure.Storage.Blobs;
using Azure.Storage.Blobs.Models;
namespace attachments
{
class Program
{
private static string cosmosAccount = "<Your_Azure_Cosmos_account_URI>";
private static string cosmosKey = "<Your_Azure_Cosmos_account_PRIMARY_KEY>";
private static string cosmosDatabaseName = "<Your_Azure_Cosmos_database>";
private static string cosmosCollectionName = "<Your_Azure_Cosmos_collection>";
private static string storageConnectionString = "<Your_Azure_Storage_connection_string>";
private static string storageContainerName = "<Your_Azure_Storage_container_name>";
private static DocumentClient cosmosClient = new DocumentClient(new Uri(cosmosAccount), cosmosKey);
private static BlobServiceClient storageClient = new BlobServiceClient(storageConnectionString);
private static BlobContainerClient storageContainerClient = storageClient.GetBlobContainerClient(storageContainerName);
static void Main(string[] args)
{
CopyAttachmentsToBlobsAsync().Wait();
}
private async static Task CopyAttachmentsToBlobsAsync()
{
Console.WriteLine("Copying Azure Cosmos DB Attachments to Azure Blob Storage ...");
int totalCount = 0;
string docContinuation = null;
// Iterate through each item (document in v2) in the Azure Cosmos DB container (collection in v2) to look for attachments.
do
{
FeedResponse<dynamic> response = await cosmosClient.ReadDocumentFeedAsync(
UriFactory.CreateDocumentCollectionUri(cosmosDatabaseName, cosmosCollectionName),
new FeedOptions
{
MaxItemCount = -1,
RequestContinuation = docContinuation
});
docContinuation = response.ResponseContinuation;
foreach (Document document in response)
{
string attachmentContinuation = null;
PartitionKey docPartitionKey = new PartitionKey(document.Id);
// Iterate through each attachment within the item (if any).
do
{
FeedResponse<Attachment> attachments = await cosmosClient.ReadAttachmentFeedAsync(
document.SelfLink,
new FeedOptions
{
PartitionKey = docPartitionKey,
RequestContinuation = attachmentContinuation
}
);
attachmentContinuation = attachments.ResponseContinuation;
foreach (var attachment in attachments)
{
// Download the attachment in to local memory.
MediaResponse content = await cosmosClient.ReadMediaAsync(attachment.MediaLink);
byte[] buffer = new byte[content.ContentLength];
await content.Media.ReadAsync(buffer, 0, buffer.Length);
// Upload the locally buffered attachment to blob storage
string blobId = String.Concat(document.Id, "-", attachment.Id);
Azure.Response<BlobContentInfo> uploadedBob = await storageContainerClient.GetBlobClient(blobId).UploadAsync(
new MemoryStream(buffer, writable: false),
true
);
Console.WriteLine("Copied attachment ... Item Id: {0} , Attachment Id: {1}, Blob Id: {2}", document.Id, attachment.Id, blobId);
totalCount++;
// Clean up attachment from Azure Cosmos DB.
// Warning: please verify you've succesfully migrated attachments to blog storage prior to cleaning up Azure Cosmos DB.
// await cosmosClient.DeleteAttachmentAsync(
// attachment.SelfLink,
// new RequestOptions { PartitionKey = docPartitionKey }
// );
// Console.WriteLine("Cleaned up attachment ... Document Id: {0} , Attachment Id: {1}", document.Id, attachment.Id);
}
} while (!string.IsNullOrEmpty(attachmentContinuation));
}
}
while (!string.IsNullOrEmpty(docContinuation));
Console.WriteLine("Finished copying {0} attachments to blob storage", totalCount);
}
}
}
次のステップ
- Azure BLOB ストレージを使用する
- Azure Cosmos DB の .NET SDK v2 を用いて添付ファイルを使用するための参照を取得する
- Azure Cosmos DB の Java SDK v2 を用いて添付ファイルを使用するための参照を取得する
- Azure Cosmos DB の REST API を用いて添付ファイルを使用するための参照を取得する