.Net Foundation On .NET, 21 Nov 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Getting started with OData and Cosmos DB in ASP.NET Core

Description

https://aka.ms/odata-cosmosdb

Optimizing Web Applications with OData $Select
https://devblogs.microsoft.com/odata/optimizing-web-applications-with-odata-select?WT.mc_id=ondotnet-c9-cephilli

Integrating Cosmos DB with OData (Part 1)
https://devblogs.microsoft.com/odata/integrating-cosmos-db-with-odata-part-1?WT.mc_id=ondotnet-c9-cephilli

OData for .NET Documentation
https://docs.microsoft.com/en-us/odata?WT.mc_id=ondotnet-c9-cephilli

Continuing our exploration of OData with ASP.NET, Hassan and Jeremy are back to exploring using OData with Cosmos DB. They walk through creating a new Cosmos DB instance, download the generated sample and show to to add OData functionality to an API.

[03:24] - Setting up a Cosmos DB instance and project
[10:05] - Adding OData support to an ASP.NET Core project

A

You may have heard of planetary-scale databases with.

A

Cosmos db, but did you know that you can place.

A

Odata magic on top of that and have a powerful query engine that runs over the rest. Api at your fingertips?

A

you've got to check this out.

A

Welcome to another episode of on.net.: this is a special odata supercharged edition.

A

We've talked about odata a few times, and today I've got her hassan with me again in the studio.

A

He's an avid user of odata,, a resident odata expert and we're going to talk.

A

About using it with a nontraditional technology.

A

So I think a lot of.net developers are.

A

Used to sql and relational databases,.

A

But there's a whole other world out there of other databases.

A

So tell us first who you are, what you do and then let's dive into this special instance.

A

Hi jeremy,, my name is hassan habib.,.

B

I'm a software engineer here at microsoft..

B

I am at sila organization, which is an organization that handles all legal matters at microsoft.

B

I work on daily basis with different technologies to.

B

Provide better systems for our internal employees here at microsoft,, and I get to play with a lot of these amazing technologies.

B

And try to put them into real life scenarios and learn from them. And I'd like to share that with rest of the world.

A

Awesome. well, let's share planet-scale database with the rest of the world.

B

Let's do it. so remember when we talked about odata,.

B

We said odata doesn't really have any hard dependency on the entity. Framework., it's great to leverage the entity framework.

B

It allows you to run sql or any blind expressions,.

B

Aligned the functions with your c-sharp code., but you don't really have to have it. today, I'm going to show you how odata can work with cosmos, db,.

B

The exact same way, we worked with any other data source in previous video about odata.

B

So what I did here, this is my azure portal. well,. Let's talk about cosmos db, real quick.

A

So cosmos db, is?.

B

It's an amazing technology, storage technology that allows people to rapidly.

B

Execute operations in almost split milliseconds.

B

One of my favorite demos about odata is hanselman dead,.

B

The way they the had an instance in japan that smearing and instance here in the us- and he.

B

Was drawing on the board that sits the data in the instance.

B

That's in japan and it was reflecting immediately on the instance. That's here.

B

that shows fact.

A

So out of the box distributed database and there is several apis, you can pick.

A

So if you're a mongodb developer,, we support mongodb.

A

If you're a sql developer, there's a sql api that allows you to use sql-like syntax for that.

A

There's a graph api,, but it is a no sql database,, which means it's not necessarily relational,.

A

It's so much structured data.. So there are properties and values, but every record doesn't have to be the same, which makes it unique and interesting and relative to certain types of datasets and workloads.

A

But you've got a cosmos, db database setup, here.

B

Yes. absolutely., I'm going to show you first, how do you create that.

B

So you can go here and if you click ''add'' and then you get to select,.

B

''cosmos.'' too much odata, today., so azure cosmos db, and then you get to build that, you create that..

B

Then you get to select whatever api. You want to use.

B

So in this instance, we were using core sql, but you get to choose actually any kind. You want.

B

While we're on the subject,, I want to talk to you about something, here. azure table gives you odata built in.

B

So you don't have to build an api in front of cosmos in order for you to leverage odata., it's actually built in functionality that allows you to hit.

B

The cosmos instance endpoint with your existing knowledge about odata, without having to write one line of code,, that's down to zero, and I don't know how far.

A

Zero line. down to zero lines. so were four lines of code and some others.

B

Down to zero line., so you are promising zero.. So we we've.

A

Got the api that we can pick and azure table will play very nicely with odata out of the box.

A

Then you've got location which is interesting because you've mentioned this, cosmos db. Will geo replicate to multiple locations,.

A

So I can have one.

B

If I want my database to crash and burn,.

A

If that data-center goes down or I can have a dozen spread around the world- and I don't have to change my code,- do I?.

A

To handle that replication across those nodes or so.

B

Because what we want to show you like,, if you're ready,,.

B

Most of the people that we're trying to talk to,, they already have apis,. They want to use different data sources..

B

I want you to go ahead and explore with azure table,, that's out of the box., I'm going to send, we're going to put a link in the description about the official documentation about azure table, how to leverage odata with azure table..

B

I want to show you today with the core sql cosmos, how that works. Out.

B

So you just select core sql and click ''review'' and ''create''..

B

We're already created one,, so we don't have to create another one..

B

So I'm just going to go back here to my resource groups in here,.

B

And I have one in here: that's called cosmoswithsql.

B

So here's how you get started with this real quick and you start learning about things..

B

If you go to the ''quickstart'' part, you'll notice, they have a lot of samples that you can download and run,.

B

Plug-And-Play without having to write one line of code, right?.

B

Yes. so I'm going to go to the .net core one,, I'm just going to download an existing sample that has all that.

B

The table key, and a private key,.

B

And the url, all of that.

A

Okay., so it's got their credentials and it's all simple.

B

All set, automatically set up. in addition to that,. Let me extract that real, quick and then I'll. Show you how much beautiful this is.

B

In addition to that,, it actually comes in with prebuilt amvcui and prebuilt repository pattern.

B

To handle the data for you.

A

Okay. so we've already abstracted the data, we're not getting it directly from our views?.

B

A

So it sounds like a place where you might be able to maybe sneak in a little code?.

B

Odata stuff. yes.: that's what we're going to show you today.

B

Let's run the project first and see how things go.

B

don't download stuff from the internet,. So this isn't a trust. Worthy. you've got your-. You've got your warning.

A

You probably know about this warning too,. You are in legal, right?.

B

Yes. absolutely., so this is quickstart core.

B

It has everything built for us.. Let me just rebuild the project real quick, so it can retrieve..

B

You can also do load project dependencies., I'm just going to rebuild it, so I can run it,, but you can also load project's dependencies. If you decide to.

B

Change your nuget packages at any point in time.

B

So I'm just going to rebuild the project here: real quick.

B

rebuild succeeded, or so it claims.

B

now, give it a second there.

B

So you know the trick: here,.

A

Right if it ever slows down just move the mouse.

A

yeah., I was to do like this. all right.

B

So we have that.. Let me show you what the project that comes out of the box.. You build a cosmos db..

B

If I run my project right now,, it's already connected to my cosmos db and I get to control the data full crud, operations,.

B

Delete details,, edit, and create..

B

So that's a nice example out of the box.

A

You get all the operations. you'd, probably want to performing, wait, we're pulling up something and it's a to-do. List, awesome.

B

Yeah. so we created a sample to-do list and then you get to go,.

B

Let's just create one for fun., so let's say, "jeremy is awesome.".

B

I like that to-do.

A

Well,, why isn't to-do? in your implying that this is something that can happen in the future.

B

To-Do jeremy is also okay.. Let's say, "brush your teeth.", I guess brush your teeth.

A

Jeremy is awesome as well.

B

Anyways, either way.

B

so brush your teeth, brush your teeth.

B

That's from the previous session,, so the control c. okay, right?.

B

If I go and create, people who are familiar with crud operations with asp.net mvc,.

B

They know exactly they're very familiar with this native bootstrap.

B

You get to-do full operation, delete and whatnot, right?.

B

Okay. this list here is built to list tasks that are not completed,.

B

The tasks that are completed disappear., but they are still there.

A

They're just send their in the database.

B

But just to make sure that this is actually is the case.

B

Again,, you don't have to have a lot of knowledge. There.

B

If you're already familiar with sql,, there is a data exploring here that shows you..

B

So I have a todolist in here and I have bunch of items.

B

If you'll look,, I have already an item in here,.

B

"You should wash your teeth, everyday." wash your teeth.. This is not that exact same one that we've created.. This is a different one., so we can create. However many we want., but what I want to show you here today, is,.

B

Out of this example on probably people watching us right, now,.

B

They could probably do that by themselves..

B

If you look at the example,, it already comes in with idocumentdbrepository,.

B

That's our repository pattern and they have the document repository pattern which have all the secrets and the keys,, and it comes in with all the operations that I need.

B

I have no entity framework in here just pre-built.

B

Client for me to interact and full crud operations with cosmos, db.

A

B

So now you'd think,. The next thing I want to do is just add, odata and it is magic and see what happens.

A

B

So the first thing I want to do, I'm just going to go in here, just like we did last time and manage odata nuget packages.

B

If you go to browse, type in odata.,.

B

This is microsoft and we want the one with the core,.

B

Asp.Net core odata, since we downloaded the 2.2 core odata.

B

So I'm just going to install that real quick.

B

second,, let say yes, odata, right?.

B

A

Then I want to add a controller in here.

B

All of this like,, if you're using visual studio, this has been around for a while.

B

You can have full crud operations generated for you out of the box..

B

So if I choose api controller with read writes,, so I'm not using the entity framework here., I'm just going to go in here until it build me full crud operations for items.

B

So that's my itemscontroller,.

A

And then I'm going to create that.

B

I'll just create a sample full crud for you for an api controller.

B

We got just that in a second.

A

So much nicer,, I'm going to show my age a little bit. I've been developing for many years and it used to be file new,.

A

And then you're scrambling to find examples.

A

searching on the web, go into bulletin boards, dialing into momentum in bbs.

B

Okay,, maybe to further.. This is.

A

Nicer we get this scaffolded for us., so we've got a template that we can work from.

B

Yes. so this is to say, created a template for us.

B

We have everything here that we need.

B

now, before we add stuff in here,.

B

Let's just test the thing itself, lets use the document repository..

B

So if you look here at the existing control that we were using,.

B

It's called the itemcontroller already it does some initiation for you for the repository.

B

So I'm just going to steal that from here. I'm going to steal that in here. I'm going to select this.

B

I'm going to go to the itemscontroller.

B

I'm going to put this right here.. The only difference here is that the constructor is.

B

Itemscontroller instead of itemcontroller, like that.

B

Then I just want to pull in if you do, control period,.

B

It will pull in whatever this idocumentrepository is defined.

B

Okay., so I just insane guided repo ready.

B

I got everything ready for me.

A

B

The other thing I want is from the itemcontroller here,.

B

As you can see,, it's returning a bunch of items that are not completed, right?.

B

The items are not completed., we going to return the items that are completed., so I'm confusing myself, just to show people what's out there..

B

We could create new ones., we have the ui., we have everything., so I can just do that.

B

So this is returning repository.getitemsasync, right?.

B

The difference here is that,. I want to return on an iron innumerable for the item instead of a string..

B

So let me do that in here., then, in addition to that,, this is an awaitable call.. So we want a sink and a task that encapsulates.

A

B

This goal, there we go. everything is happy.

B

Okay. now,: we need to put that to test, right?. So I'm saying give me the items that are complete, not completed..

B

So far, we've added the odata package,.

A

But no data has been involved in the making of this demo.

B

Yes. we're just creating a controller that just returns a bunch of things.

B

okay.. So that's run,, let see what's the endpoint here, /api/items, right?, so I'm just going to go ahead in here and run my project.

B

Give it a second there.

A

Tony, you just got to crank that mouse.

B

You got to okay,, let see.

A

How the spinners going the other way.

B

Yes., so that's the trick. yeah., that's the trick. okay.. So this is our normal crud operations.

B

If I go and say,, we know that this list is only displaying the items are not completed, which makes sense, because it's a to-do list.. Why would you see items that are completed, and then you go /api/items.?

B

If I hit that endpoint, what happens? it's returning., so I just turned a view: controller into a normal controller,, no magic in there., okay., right. now, comes the interesting part..

B

We want to add odata to this, right?.

B

So just like we did last time, if I go into services in.

B

Here and say, services add odata.

B

Then I'll just have the control period just to pull.

B

In the library that the nuget package that we just pulled in.

B

Okay., so that's one part., then again, down here at the routes level. This is already broken down for us.

B

So we don't have to do anything, routes., and then I want to enable dependency injection.

B

Remember how we said, we want to enable the dependency injection for odata services to be in effect, and I also want to have the expand,.

B

The select all kinds of stuff that I want.

B

Right,, this is that opt-in of.

A

The different functionality that you're going to expose.

B

Exactly. so order by whatever is out there, right?

B

okay., all right.. What else is left? what's left is that,. I want to go back to my itemscontroller and add enablequery.

A

B

What happens now? we'll see, let's find out., let's run this and see what happens.

A

I can hear the music playing in the background.

A

it's building up the exciting moment., all right.

B

All right., let's see what happens.. So if I go and say /api/items,.

B

We want to make sure the system is still working., so system is still working., but if I go in and say, I don't really care about all of that,.

B

I want some odata magic. Give me just the name of the item.

B

B

wow,, that's it.

B

That's it.. Whatever we talked about in the past, about odata,.

B

Like you, don't need entity framework, whatever storage you have good.

A

No,, I'm just saying, wow, that seemed too easy. yes., so basically,. If you'd chosen azure table storage.

A

You're saying, we'd get this out of the box., but if we don't,, we add a package, configure it,.

A

And tag the controller endpoint and we're back in the races.

B

The only difference is four lines of code..

B

It's up to you to decide. What do you want to do.

A

That's amazing., so I understand that,, you have a blog post, that's tied into this functionality.

A

It seems easy, but if you want to follow through step-by-step,.

A

We've got a link for you,, it's aka.ms/odata-cosmosdb, that's o-d-a-t-a, hyphen c-o-s-m-o-s-db,,.

A

Odata-Cosmosdb, check it out.. Thank you. Sir.

A

Yeah. absolutely. sir, thank you., cosmos, db.

A