Azure Document DB Repository 的實現
閱讀 需要大約 5 分鐘。
前景:
Azure Cosmos DB 由 Microsoft 提供，是全球分散式多模型資料庫。 通過 Azure Cosmos DB 跨任意數量的 Azure 地理區域彈性且獨立地縮放吞吐量和儲存。 它通過綜合服務級別協議 (SLA) 提供吞吐量、延遲、可用性和一致性保證。Azure Cosmos DB 可以輕鬆地生成可縮放且響應迅速的全域性規模應用程式。
介紹：
多個數據模型和用於訪問及查詢資料的常用 API。
- Azure Cosmos DB 本身所基於的資料模型以 Atom 記錄序列 (ARS) 為基礎，該模型支援多個數據模型，包括但不限於文件、圖形、鍵-值、表以及列系列資料模型。
- 多種語言的 SDK 均支援以下資料模型的 API：
- SQL API：具有豐富 SQL 查詢功能的無架構 JSON 資料庫引擎。
- MongoDB API：一種可大規模縮放的服務型 MongoDB，由 Azure Cosmos DB 平臺提供支援。 與現有 MongoDB 庫、驅動程式、工具和應用程式相容。
- Cassandra API：一種可全域性分發的服務型 Cassandra，由 Azure Cosmos DB 平臺提供支援。 與現有Apache Cassandra 庫、驅動程式、工具和應用程式相容。
- Gremlin API：一種完全託管的、可橫向縮放的圖形資料庫服務，可以輕鬆地用於生成和執行特定的應用程式，這些應用程式適用於支援開放式 Gremlin API（基於 Apache TinkerPop 規範：Apache Gremlin）的高度連線資料集。
- 表 API：一種鍵值對型資料庫服務，可以在不進行任何應用更改的情況下，為現有的 Azure 表儲存應用程式提供高階功能（例如，自動索引、低延遲保證、全域性分發）
以上是引用Microsoft 官網中文文件，地址：https://docs.microsoft.com/zh-cn/azure/cosmos-db/introduction。
Azure Cosmos DB 是Microsoft 推出的雲服務資料庫，提供多種API 服務，以下主要講的是SQL API，以json 形式的文件資料庫。
Step 1: 配置環境（使用的是.net core 解決方案）
A > 在appsetting.json 中新增 AccountEndpoint 和 AccountKey
"DocumentDb": {
"Endpoint": "https://localhost:8081",
"Key":"C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5WF2nQ9nDuVTqoch9b8mGGyPMbIZnqyMsEdsGQy67XIw/Jw=="
}
B > 建立Model 類,引數命名需要和appsetting.json 中的命名一樣
public class DocumentDbSetting
{
public string Endpoint { get; set; }
public string Key { get; set; }
}
C > 在 startup.cs 中 新增 配置資訊
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
// 新增的配置
var documentDbSection = Configuration.GetSection("DocumentDb");
services.Configure<DocumentDbSetting>(documentDbSection);
}
D > 建立DocumentDbRepository，獲取appsetting.json 中的endpoint 和 key，構造client
private readonly Lazy<IDocumentClient> _client;
public DocumentDbRepository(IOptions<DocumentDbSetting> documentDbSetting)
{
var uri = new Uri(documentDbSetting.Value.Endpoint);
var documentClient = new DocumentClient(uri, documentDbSetting.Value.Key);
_client = new Lazy<IDocumentClient>(() => documentClient, true);
}
Step 2: 增刪改查的實現
A > create document(databaseName 指資料庫名，collectionName 指的是文件名（相當於表的名稱），document 就是儲存的一條記錄)(以下程式碼中catch exception 簡寫了)
public async Task<bool> CreateDocumentAsync<T>(string databaseName, string collectionName, T document) where T : class
{
try
{
await CreateDocumentCollectionAsync(collectionName, databaseName);
var uri = UriFactory.CreateDocumentCollectionUri(databaseName, collectionName);
var response = await _client.Value.CreateDocumentAsync(uri, document);
bool result = (response != null && (response.StatusCode == HttpStatusCode.Created || response.StatusCode == HttpStatusCode.OK));
return result;
}
catch (Exception ex)
{
throw new Exception(ex.Message);
}
}
在建立資料時，需要驗證database和collection 是否存在，當不存在時，會建立的對應的database和collection。
protected async Task<bool> CreateDatabaseAsync(string databaseName)
{
var db = await _client.Value.CreateDatabaseIfNotExistsAsync(new DocDatabase { Id = databaseName });
return db.StatusCode == HttpStatusCode.Created || db.StatusCode == HttpStatusCode.OK;
}
protected async Task<bool> CreateDocumentCollectionAsync(string collectionName, string databaseName)
{
if (string.IsNullOrWhiteSpace(databaseName))
{
throw new ArgumentNullException(nameof(databaseName));
}
if (await CreateDatabaseAsync(databaseName))
{
var result = await _client.Value.CreateDocumentCollectionIfNotExistsAsync(
UriFactory.CreateDatabaseUri(databaseName), new DocumentCollection
{
Id = collectionName,
IndexingPolicy = new IndexingPolicy(new RangeIndex(DataType.String) { Precision = -1 })
});
return result.StatusCode == HttpStatusCode.Created || result.StatusCode == HttpStatusCode.OK;
}
return false;
}
B > 修改document有兩種方式Upsert 和Replace，Upsert 的特點是 當沒有這條資料時，會建立一條，而Replace 會報異常。
Upsert Document
public async Task<bool> UpdateDocumentAsync<T>(string databaseName, string collectionName, T document) where T : class
{
try
{
var uri = UriFactory.CreateDocumentCollectionUri(databaseName, collectionName);
var result = await _client.Value.UpsertDocumentAsync(uri, document);
return result.StatusCode == HttpStatusCode.OK || result.StatusCode == HttpStatusCode.Created;
}
catch (Exception ex)
{
throw new Exception(ex.Message);
}
}
Replace Document
public async Task<bool> ReplaceDocumentAsync<T>(string databaseName, string collectionName, T document, string id) where T : class
{
try
{
var uri = UriFactory.CreateDocumentUri(databaseName, collectionName, id);
var result = await _client.Value.ReplaceDocumentAsync(uri, document);
return result.StatusCode == HttpStatusCode.OK;
}
catch (Exception ex)
{
throw new Exception(ex.Message);
}
}
C > Get Document
根據Id獲取Document
public async Task<T> GetDocument<T>(string databaseName, string collectionName, string id, FeedOptions feedOptions = null) where T : class
{
try
{
Document document = await _client.Value.ReadDocumentAsync(UriFactory.CreateDocumentUri(databaseName, collectionName, id));
return (T)(dynamic)document;
}
catch (Exception ex)
{
throw new Exception(ex.Message);
}
}
根據條件獲取Documents
public async Task<IEnumerable<T>> GetQueryable<T>(string databaseName, string collectionName, Expression<Func<T, bool>> predicate, FeedOptions feedOptions = null) where T : new()
{
var dummy = new T();
IDocumentQuery<T> query = _client.Value.CreateDocumentQuery<T>(UriFactory.CreateDocumentCollectionUri(databaseName, collectionName), feedOptions)
.Where(predicate)
.AsDocumentQuery();
var results = new List<T>();
while (query.HasMoreResults)
{
results.AddRange(await query.ExecuteNextAsync<T>());
}
return results;
}
D > Delete Document
public async Task<bool> DeleteDocumentAsync(string databaseName, string collectionName, string documentId)
{
try
{
var documentResponse = await _client.Value.DeleteDocumentAsync(UriFactory.CreateDocumentUri(databaseName, collectionName, documentId));
return documentResponse.StatusCode == HttpStatusCode.NoContent;
}
catch (Exception ex)
{
throw new Exception(ex.Message);
}
}
本地測試開發使用工具：
Azure Cosmos DB Emulator. 下載地址：https://aka.ms/cosmosdb-emulator ，使用方法。
Microsoft Azure Storage Explorer 是儲存資源管理器 下載地址：https://azure.microsoft.com/en-us/features/storage-explorer/ ，使用方法。
在當前的版本中 不支援skip 分頁 和group by 分組。
以上只是本人學習筆記分享！有許多不足之處，還在繼續新增和更正。