Search icon CANCEL
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
Guide to NoSQL with Azure Cosmos DB
Guide to NoSQL with Azure Cosmos DB

Guide to NoSQL with Azure Cosmos DB: Work with the massively scalable Azure database service with JSON, C#, LINQ, and .NET Core 2

Arrow left icon
Profile Icon Gaston C. Hillar Profile Icon Daron Yöndem
Arrow right icon
€18.99 per month
Full star icon Full star icon Full star icon Full star icon Empty star icon 4 (1 Ratings)
Paperback Sep 2018 214 pages 1st Edition
eBook
€13.98 €19.99
Paperback
€24.99
Subscription
Free Trial
Renews at €18.99p/m
Arrow left icon
Profile Icon Gaston C. Hillar Profile Icon Daron Yöndem
Arrow right icon
€18.99 per month
Full star icon Full star icon Full star icon Full star icon Empty star icon 4 (1 Ratings)
Paperback Sep 2018 214 pages 1st Edition
eBook
€13.98 €19.99
Paperback
€24.99
Subscription
Free Trial
Renews at €18.99p/m
eBook
€13.98 €19.99
Paperback
€24.99
Subscription
Free Trial
Renews at €18.99p/m

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
Table of content icon View table of contents Preview book icon Preview Book

Guide to NoSQL with Azure Cosmos DB

Getting Started with Cosmos DB Development and NoSQL Document Databases

n this chapter, we will provision a Cosmos DB account that uses the SQL API and we will start working with a document database, its collections, and documents. We will work with Cosmos DB on Azure and we will also learn how to work with the Azure Cosmos DB Emulator. We will work with different tools to interact with our Cosmos DB document database that will be extremely useful for our common development tasks. We will do the following:

  • Understand URIs, read-write and read-only keys, and connection strings
  • Create a new document database with the SQL API
  • Create a new collection
  • Populate a collection with documents
  • Understand automatically generated key-value pairs
  • Understand schema-agnostic features
  • Work with the web-based Azure Cosmos DB Explorer
  • Use Azure Storage Explorer to interact with Cosmos DB databases...

Provisioning a Cosmos DB account that uses the SQL API

In Chapter 1, Introduction to NoSQL in Cosmos DB, we learned about the different elements of the Cosmos DB resource model. Now we will use the web-based Azure portal to provision a Cosmos DB account with the SQL API. Then, we will create a document database, generate a collection for this database, and populate the collection with many JSON documents.

In order to follow the next steps, you have the following three options:

  • Work with an already active Azure account
  • Sign up for a new Azure account
  • Use the limited-time try Cosmos DB for free feature
If you want to work with an already active Azure account, you have to take into account that you will spend credits and, based on your free resources or credits, you can end up being billed for the storage, request units, and bandwidth consumed.

If you don't have an active...

Understanding URIs, read-write and read-only keys, and connection strings

After you create a new Cosmos DB account, you will see the Quick start panel. However, the next time you sign in to the Azure portal, you won't see this panel. So, we will follow the necessary steps to access the recently created Cosmos DB account panel, considering we signed out and then signed in to the portal again:

  1. Click Azure Cosmos DB in the left-hand panel. The portal will display a list with all the Cosmos DB accounts, their statuses, locations, and the subscription to which they belong. Note that if you have multiple Azure subscriptions, the list will include only the accounts for the selected subscription. Make sure you select the subscription with which you have created the account. The following screenshot shows a sample list that includes the example001 Cosmos DB account:

  1. Click...

Creating a new document database with the SQL API

We have a Cosmos DB account that works with the SQL API but we still don't have a database. Now we will continue working with the Azure web-based portal and we will create a new document database in the previously created account. We must take into account that we can use other tools, which we will analyze later, to perform this task. It is also possible to automate the task through scripting and to create a new database by using one of the available SDKs. However, it is a good idea to learn how things work in the portal first:

  1. Make sure you are on the page for the Cosmos DB account in the portal. Click on the Data Explorer option on the left-hand side menu. The portal will display the Data Explorer panel, which will allow us to work with the databases for the current Cosmos DB account. In this case, the panel won't...

Creating a new collection

Now we will create a new collection for the database.

  1. Hover on the database name (Competition) and click on the ellipses at the right-hand side (...) to display a context menu, as shown in the next screenshot:

  1. Click on New Collection in the context menu. The Add Collection panel will appear.
  2. Enter VideoGames1 in Collection Id.
  3. Select Fixed (10 GB) in Storage capacity. This way, the maximum storage size for the collection will be 10 GB. In this case, we won't configure a partition key.
  4. Enter 1000 in Throughput (400 - 10,000 RU/s). This way, Azure will provision 1,000 request units per second for this collection. Note that based on the value we enter, the portal displays the estimated spend below this field.
  5. Click + Add unique key and a new textbox will be added below Unique keys. Enter /name in this textbox to specify that we want the name value...

Populating a collection with documents

Now we will populate the recently created collection with a few documents that represent games that were part of eSports competitions with specific tags, definitions for their levels, and the high score achievements. We will continue working with the Azure web-based portal, but we will learn to use other tools to perform the same task in the following sections.

Create a new JSON file with the following contents in your favorite text editor and save it in a temporary folder as videogame1_01.json. The following lines show the code that defines the game with its tags, levels, and high score achievements. The code file for the sample is included in the learning_cosmos_db_02_01 folder in the videogames/videogame1_01.json file:

{ 
    "id": "1", 
    "name": "Battle Royale Kingdoms", 
    "lastCompetitionDate...

Understanding automatically generated key-value pairs

Scroll down to the latest lines of the document in the web-based editor and you will see new key-value pairs that were not part of the original document. The following screenshot shows the last lines in the embedded JSON editor:

The following lines show an example of the new key-value pairs. Note that many values will be different in your case:

    "_rid": "prUNAKtPjRoFAAAAAAAAAA==", 
    "_self": "dbs/prUNAA==/colls/prUNAKtPjRo=/docs/prUNAKtPjRoFAAAAAAAAAA==/", 
    "_etag": "\"22007fea-0000-0000-0000-5b86dbd60000\"", 
    "_attachments": "attachments/", 
    "_ts": 1535564758 
} 

Cosmos DB added the following keys to our document, which start with an underscore (_) as a prefix and contain system-generated values for the document...

Understanding schema-agnostic features

Now we will add another document to the same collection. In this case, the new document will have new keys that didn't exist in the previously inserted document.

Create a new JSON file with the following contents in your favorite text editor and save it in a temporary folder as videogame1_02.json. The following lines show the code that defines a new game with its tags, levels, high score achievements, and prizes. The code file for the sample is included in the learning_cosmos_db_02_01 folder in the videogames/videogame1_02.json file:

{ 
    "id": "2", 
    "name": "Fortnite vs Zombies", 
    "lastCompetitionDate": "2018-09-30T03:31:20.7251173Z", 
    "tags": [ 
        "3D", "battle royale", "monsters", "shooter" 
    ], 
  ...

Provisioning a Cosmos DB account that uses the SQL API


In Chapter 1, Introduction to NoSQL in Cosmos DB, we learned about the different elements of the Cosmos DB resource model. Now we will use the web-based Azure portal to provision a Cosmos DB account with the SQL API. Then, we will create a document database, generate a collection for this database, and populate the collection with many JSON documents.

In order to follow the next steps, you have the following three options:

  • Work with an already active Azure account
  • Sign up for a new Azure account
  • Use the limited-time try Cosmos DB for free feature

Note

If you want to work with an already active Azure account, you have to take into account that you will spend credits and, based on your free resources or credits, you can end up being billed for the storage, request units, and bandwidth consumed.

If you don't have an active Azure account, you can take advantage of the free $200 in Azure credits that you will receive to explore the services for...

Understanding URIs, read-write and read-only keys, and connection strings


After you create a new Cosmos DB account, you will see the Quick start panel. However, the next time you sign in to the Azure portal, you won't see this panel. So, we will follow the necessary steps to access the recently created Cosmos DB account panel, considering we signed out and then signed in to the portal again:

  1. Click Azure Cosmos DB in the left-hand panel. The portal will display a list with all the Cosmos DB accounts, their statuses, locations, and the subscription to which they belong. Note that if you have multiple Azure subscriptions, the list will include only the accounts for the selected subscription. Make sure you select the subscription with which you have created the account. The following screenshot shows a sample list that includes the example001 Cosmos DB account:

 

 

  1. Click on the name for the recently created Cosmos DB account (example001) and the portal will open the page for this account with a...

Creating a new document database with the SQL API


We have a Cosmos DB account that works with the SQL API but we still don't have a database. Now we will continue working with the Azure web-based portal and we will create a new document database in the previously created account. We must take into account that we can use other tools, which we will analyze later, to perform this task. It is also possible to automate the task through scripting and to create a new database by using one of the available SDKs. However, it is a good idea to learn how things work in the portal first:

  1. Make sure you are on the page for the Cosmos DB account in the portal. Click on the Data Explorer option on the left-hand side menu. The portal will display the Data Explorer panel, which will allow us to work with the databases for the current Cosmos DB account. In this case, the panel won't list any databases because we haven't created any yet.
  2. Click onNew Databasein the toolbar located at the top of the panel. The...

Creating a new collection


Now we will create a new collection for the database.

  1. Hover on the database name (Competition) and click on the ellipses at the right-hand side (...) to display a context menu, as shown in the next screenshot:
  1. Click on New Collection in the context menu. The Add Collection panel will appear.
  2. Enter VideoGames1 in Collection Id.
  3. Select Fixed (10 GB) in Storage capacity. This way, the maximum storage size for the collection will be 10 GB. In this case, we won't configure a partition key.
  4. Enter 1000 in Throughput (400 - 10,000 RU/s). This way, Azure will provision 1,000 request units per second for this collection. Note that based on the value we enter, the portal displays the estimated spend below this field.
  5. Click + Add unique key and a new textbox will be added below Unique keys. Enter /name in this textbox to specify that we want the name value to be unique per partition key. In this case, there is only one partition, and therefore, the data integrity layer will make...

Populating a collection with documents


Now we will populate the recently created collection with a few documents that represent games that were part of eSports competitions with specific tags, definitions for their levels, and the high score achievements. We will continue working with the Azure web-based portal, but we will learn to use other tools to perform the same task in the following sections.

 

Create a new JSON file with the following contents in your favorite text editor and save it in a temporary folder as videogame1_01.json. The following lines show the code that defines the game with its tags, levels, and high score achievements. The code file for the sample is included in the learning_cosmos_db_02_01 folder in the videogames/videogame1_01.json file:

{ 
    "id": "1", 
    "name": "Battle Royale Kingdoms", 
    "lastCompetitionDate": "2018-09-29T04:36:22.7251173Z", 
    "tags": [ 
        "mobile", "2D", "card game" 
    ], 
    "levels": [ 
        { 
            "title": "Training...
Left arrow icon Right arrow icon
Download code icon Download Code

Key benefits

  • Work with the latest available tools related to Cosmos DB
  • Learn to work with the latest version of the .NET Core SDK, C# and the SQL API
  • Work with a database service that doesn’t require you to use an ORM and provides flexibility

Description

Cosmos DB is a NoSQL database service included in Azure that is continuously adding new features and has quickly become one of the most innovative services found in Azure, targeting mission-critical applications at a global scale. This book starts off by showing you the main features of Cosmos DB, their supported NoSQL data models and the foundations of its scalable and distributed architecture. You will learn to work with the latest available tools that simplify your tasks with Cosmos DB and reduce development costs, such as the Data Explorer in the Azure portal, Microsoft Azure Storage Explorer, and the Cosmos DB Emulator. Next, move on to working with databases and document collections. We will use the tools to run schema agnostic queries against collections with the Cosmos DB SQL dialect and understand their results. Then, we will create a first version of an application that uses the latest .NET Core SDK to interact with Cosmos DB. Next, we will create a second version of the application that will take advantage of important features that the combination of C# and the .NET Core SDK provides, such as POCOs and LINQ queries. By the end of the book, you will be able to build an application that works with a Cosmos DB NoSQL document database with C#, the .NET Core SDK, LINQ, and JSON.

Who is this book for?

This book is for C# developers. You do not require any knowledge of Azure Cosmos DB, but familiarity with the Azure platform is expected.

What you will learn

  • Understand the supported NoSQL data models and the resource hierarchy
  • Learn the latest tools to work with Cosmos DB accounts and collections
  • Reduce your development costs by working with the Cosmos DB Emulator
  • Understand request units, automatic indexing, partitioning, and billing
  • Build an application with C#, Cosmos DB, .NET Core SDK, and the SQL API
  • Perform asynchronous operations with databases, and documents in C#
  • Work with models, and customize serialization of LINQ queries

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Sep 28, 2018
Length: 214 pages
Edition : 1st
Language : English
ISBN-13 : 9781789612899
Vendor :
Microsoft
Category :
Languages :
Concepts :
Tools :

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

Product Details

Publication date : Sep 28, 2018
Length: 214 pages
Edition : 1st
Language : English
ISBN-13 : 9781789612899
Vendor :
Microsoft
Category :
Languages :
Concepts :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
€18.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
€189.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts
€264.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total 68.98
Hands-On Azure for Developers
€43.99
Guide to NoSQL with Azure Cosmos DB
€24.99
Total 68.98 Stars icon

Table of Contents

8 Chapters
Introduction to NoSQL in Cosmos DB Chevron down icon Chevron up icon
Getting Started with Cosmos DB Development and NoSQL Document Databases Chevron down icon Chevron up icon
Writing and Running Queries on NoSQL Document Databases Chevron down icon Chevron up icon
Building an Application with C#, Cosmos DB, a NoSQL Document Database, and the SQL API Chevron down icon Chevron up icon
Working with POCOs, LINQ, and a NoSQL Document Database Chevron down icon Chevron up icon
Tuning and Managing Scalability with Cosmos DB Chevron down icon Chevron up icon
Answers Chevron down icon Chevron up icon
Other Books You May Enjoy Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
(1 Ratings)
5 star 0%
4 star 100%
3 star 0%
2 star 0%
1 star 0%
rav Dec 06, 2023
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
Some good information to get you started with Cosmos DB, though some of the information is a bit dated at this point.Check out Kramer in the Windows Store for a good Cosmos DB querying tool.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.