Skip to content

Latest commit

 

History

History
194 lines (136 loc) · 7.64 KB

create-mongodb-xamarin.md

File metadata and controls

194 lines (136 loc) · 7.64 KB
title description services author ms.service ms.component ms.custom ms.devlang ms.topic ms.date ms.author
Azure Cosmos DB: Build a Xamarin.Forms app with .NET and the MongoDB API
Presents a Xamarin code sample you can use to connect to and query the Azure Cosmos DB MongoDB API
cosmos-db
codemillmatt
cosmos-db
cosmosdb-mongo
quickstart, xamarin
dotnet
quickstart
06/20/2018
masoucou

QuickStart: Build a MongoDB API Xamarin.Forms app with .NET and the Azure portal

[!div class="op_single_selector"]

Azure Cosmos DB is Microsoft’s globally distributed multi-model database service. You can quickly create and query document, key/value, and graph databases, all of which benefit from the global distribution and horizontal scale capabilities at the core of Azure Cosmos DB.

This quickstart demonstrates how to create an Azure Cosmos DB MongoDB API account, document database, and collection using the Azure portal. You'll then build a todo app Xamarin.Forms app by using the MongoDB .NET driver.

Prerequisites to run the sample app

To run the sample, you'll need Visual Studio or Visual Studio for Mac and a valid Azure CosmosDB account.

If you don't already have Visual Studio, download Visual Studio 2017 Community Edition with the Mobile development with .NET workload installed with setup.

If you prefer to work on a Mac, download Visual Studio for Mac and run the setup.

[!INCLUDE quickstarts-free-trial-note]

Create a database account

[!INCLUDE cosmos-db-create-dbaccount]

The sample described in this article is compatible with MongoDB.Driver version 2.6.1.

Clone the sample app

First, download the sample MongoDB API app from GitHub. It implements a todo app with MongoDB's document storage model.

  1. Open a command prompt, create a new folder named git-samples, then close the command prompt.

    md "C:\git-samples"

  2. Open a git terminal window, such as git bash, and use the cd command to change to the new folder to install the sample app.

    cd "C:\git-samples"

  3. Run the following command to clone the sample repository. This command creates a copy of the sample app on your computer.

    git clone https://github.com/Azure-Samples/azure-cosmos-db-mongodb-xamarin-getting-started.git

If you don't wish to use git, you can also download the project as a ZIP file

Review the code

This step is optional. If you're interested in learning how the database resources are created in the code, you can review the following snippets. Otherwise, you can skip ahead to Update your connection string.

The following snippets are all taken from the MongoService class, found at the following path: src/TaskList.Core/Services/MongoService.cs.

  • Initialize the Mongo Client.

    MongoClientSettings settings = MongoClientSettings.FromUrl(
    new MongoUrl(APIKeys.ConnectionString)
);

settings.SslSettings =
    new SslSettings() { EnabledSslProtocols = SslProtocols.Tls12 };

MongoClient mongoClient = new MongoClient(settings);

  • Retrieve a reference to the database and collection. The MongoDB .NET SDK will automatically create both the database and collection if they do not already exist.

    string dbName = "MyTasks";
string collectionName = "TaskList";

var db = mongoClient.GetDatabase(dbName);

var collectionSettings = new MongoCollectionSettings {
    ReadPreference = ReadPreference.Nearest
};

tasksCollection = db.GetCollection<MyTask>(collectionName, collectionSettings);

  • Retrieve all documents as a List.

    var allTasks = await TasksCollection
                .Find(new BsonDocument())
                .ToListAsync();

  • Query for particular documents.

    public async Task<List<MyTask>> GetIncompleteTasksDueBefore(DateTime date)
{
    var tasks = await TasksCollection
                    .AsQueryable()
                    .Where(t => t.Complete == false)
                    .Where(t => t.DueDate < date)
                    .ToListAsync();

    return tasks;
}

  • Create a task and insert it into the MongoDB collection.

    public async Task CreateTask(MyTask task)
{
    await TasksCollection.InsertOneAsync(task);
}

  • Update a task in a MongoDB collection.

    public async Task UpdateTask(MyTask task)
{
    await TasksCollection.ReplaceOneAsync(t => t.Id.Equals(task.Id), task);
}

  • Delete a task from a MongoDB collection.

    public async Task DeleteTask(MyTask task)
{
    await TasksCollection.DeleteOneAsync(t => t.Id.Equals(task.Id));
}

Update your connection string

Now go back to the Azure portal to get your connection string information and copy it into the app.

  1. In the Azure portal, in your Azure Cosmos DB account, in the left navigation click Connection String, and then click Read-write Keys. You'll use the copy buttons on the right side of the screen to copy the Primary Connection String in the next steps.

  2. Open the APIKeys.cs file in the Helpers directory of the TaskList.Core project.

  3. Copy your primary connection string value from the portal (using the copy button) and make it the value of the ConnectionString field in your APIKeys.cs file.

You've now updated your app with all the info it needs to communicate with Azure Cosmos DB.

Run the app

Visual Studio 2017

  1. In Visual Studio, right-click on each project in Solution Explorer and then click Manage NuGet Packages.
  2. Click Restore all NuGet packages.
  3. Right click on the TaskList.Android and select Set as startup project.
  4. Press F5 to start debugging the application.
  5. If you want to run on iOS, first your machine is connected to a Mac (here are instructions on how to do so).
  6. Right click on TaskList.iOS project and select Set as startup project.
  7. Click F5 to start debugging the application.

Visual Studio for Mac

  1. In the platform dropdown list, select either TaskList.iOS or TaskList.Android, depending which platform you want to run on.
  2. Press cmd+Enter to start debugging the application.

Review SLAs in the Azure portal

[!INCLUDE cosmosdb-tutorial-review-slas]

Clean up resources

[!INCLUDE cosmosdb-delete-resource-group]

Next steps

In this quickstart, you've learned how to create an Azure Cosmos DB account and run a Xamarin.Forms app using the API for MongoDB. You can now import additional data to your Cosmos DB account.

[!div class="nextstepaction"] Import data into Azure Cosmos DB for the MongoDB API