CAST supports MongoDB via its NoSQL for .NET extension. As Amazon DocumentDB is MongoDB compatible, the support also applies to Amazon DocumentDB. Details about how this support is provided for .NET source code is discussed below.
Supported Client Libraries
Supported Operations
Operation | Methods Supported |
|---|---|
| Insert | |
| Update | |
| Select | |
| Delete |
Objects
| Icon | Description |
|---|---|
| DotNet MongoDB database |
| DotNet MongoDB collection |
| DotNet unknown MongoDB database |
| DotNet unknown MongoDB collection |
Links
Links are created for transaction and function point needs:
| Link type | Source and destination of link | Methods supported |
|---|---|---|
| belongsTo | From DotNet MongoDB Collection object to DotNet MongoDB Database object | |
useInsertLink | Between the caller .NET Method (C#) object and DotNet MongoDB Collection object Between the caller .NET Method (C#) object and DotNet unknown MongoDB Collection object | |
| ||
| useUpdateLink | ||
| useSelectLink | ||
| useDeleteLink |
Amazon DocumentDB Identification
The below mentioned objects have properties to indicate whether the object is of type MongoDB or Amazon DocumentDB.
Object | Property Description | Type of Property Value | Possible Value(s) | Meaning |
|---|---|---|---|---|
| DotNet MongoDB collection | Is an Amazon DocumentDB collection? | Integer | 1 | The collection object is of type Amazon DocumentDB |
| 0 | The collection object is of type MongoDB | |||
| DotNet unknown MongoDB collection | Is an Amazon DocumentDB collection? | Integer | 1 | The collection object is of type Amazon DocumentDB |
| 0 | The collection object is of type MongoDB |
What results can you expect?
Once the analysis/snapshot generation has completed, you can view the results in the normal manner (for example via CAST Enlighten). Some examples are shown below.
Database and Collection Creation
Database and Collection
static void InsertOneInMongoDB()
{
MongoClient client = new MongoClient("mongodb://127.0.0.1:27017");
IMongoDatabase db = client.GetDatabase("TestDb1");
IMongoCollection<Person> persons = db.GetCollection<Person>("Persons");
IMongoCollection<Dog> dogs = db.GetCollection<Dog>("Dogs");
}
Insert Operation
Insert
{
MongoClient client = new MongoClient("mongodb://127.0.0.1:27017");
IMongoDatabase db = client.GetDatabase("TestDb1");
IMongoCollection<BsonDocument> dogs = db.GetCollection<BsonDocument>("Dogs");
string json = "{Name:'大黄',Age:10,Weight:50}";
BsonDocument d1 = BsonDocument.Parse(json);//解析Json数据
dogs.InsertOne(d1);
}
Delete Operation
Delete
public void DeleteAllPurchases()
{
MyShoppingCollection.DeleteMany(FilterDefinition<PurchaseBson>.Empty, null);
}
Select Operation
Delete
public PurchaseBson[] FindPurchases()
{
var purchases = MyShoppingCollection.Find(FilterDefinition<PurchaseBson>.Empty, null).ToList();
return purchases.ToArray();
}
Update Operation
Update
public async Task<IActionResult> Update()
{
var query = from k in (from a in _context.Books.AsQueryable()
where a.Title == "Test Book 2"
from b in a.Posts
select b)
where k.Title == "Second One"
select k;
var result = await query.FirstOrDefaultAsync();
result.ReadCount = 5;
_context.Books
.FindOneAndUpdate(x => x.Title == "Test Book 2" && x.Posts.Any(p => p.Title == "Second One"),
Builders<Book>.Update.Set(x => x.Posts[-1], result));
return Redirect("/");
}
Amazon DocumentDB Identification
Sample Code
class Program
{
static void Main(string[] args)
{
string template = "mongodb://{0}:{1}@{2}/?replicaSet=rs0&readpreference={3}";
string username = "root";
string password = "rootroot";
string clusterEndpoint = "sample-cluster.cluster-cqjaxx9hbhi0.us-west-2.docdb.amazonaws.com:27017";
string readPreference = "secondaryPreferred";
string connectionString = String.Format(template, username, password, clusterEndpoint, readPreference);
var settings = MongoClientSettings.FromUrl(new MongoUrl(connectionString));
var client = new MongoClient(settings);
var database = client.GetDatabase("library");
var collection = database.GetCollection<BsonDocument>("Books");
var docToInsert = new BsonDocument { { "title", "Harry Potter" } };
collection.InsertOne(docToInsert);
}
}
Reading Database and Collection from Json File
.cs code
public class CustomerService
{
private readonly IMongoCollection<Customer> _customer;
private readonly DeveloperDatabaseConfiguration _settings;
public CustomerService(IOptions<DeveloperDatabaseConfiguration> settings)
{
_settings = settings.Value;
var client = new MongoClient(_settings.ConnectionString);
var database = client.GetDatabase(_settings.DatabaseName);
_customer = database.GetCollection<Customer>(_settings.CustomerCollectionName);
}
public async Task<List<Customer>> GetAllAsync()
{
return await _customer.Find(c => true).ToListAsync();
}
}
.cs file
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace WorkingWithMongoDB.WebAPI.Configuration
{
public class DeveloperDatabaseConfiguration
{
public string CustomerCollectionName { get; set; }
public string ConnectionString { get; set; }
public string DatabaseName { get; set; }
}
}
Json file
{
"DeveloperDatabaseConfiguration": {
"CustomerCollectionName": "Customers",
"ConnectionString": "mongodb://localhost:27017",
"DatabaseName": "DevelopmentDatabase"
},
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"AllowedHosts": "*"
}
Violations in CAST Engineering Dashboard
The CAST Engineering Dashboard recognises code violations in source applications.
Limitations
- Database and Collections are resolved in following situation:
- Anywhere in the .cs files and JSON files
- If Database and Collection values are not resolved, will create Unknown Database and Collection objects
- Setting of properties related to Amazon DocumentDB identification depends on proper resolution of connection string.