Hyper Cloud hyper, 3 Dec 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Hyper Connect Workshop NodeJS

Description

In this workshop, you will learn about hyper connect and create an update, remove and list endpoints for the Mario Wiki API.

Github Repository:

https://github.com/hyper63/workshops-nodejs

A

Hello welcome to the hyper connect workshop. This is part two of a three-part data service series of hyper workshops in this workshop, we'll dive into the hyper connect, client and we'll implement kind of the rest of our crud features for our mario wiki api. We'll do an update, a remove and a list, and this will help you get a better idea of how to use hyperconnect as well as how to work with the hyper data service.

A

So if you would like to follow along head over to hyper 63 workshops, dash, nodejs and sign in with your github account, and we will get started.

A

So what you need to know to take advantage of this workshop is http json, apis, javascript, async await get and you'll need a github account, so hyper connect is our module that you can use either in dino or in node.js, and this module allows you to connect to our hyper services.

A

In this case, we'll use our data service, but basically the whole api is rest, so you could use any language to connect to it, but we wanted to really make it easier for our javascript slash, typescript community. So we have this hyperconnect client, and if you want to learn more about the hyperconnect client, you can go to docs and I'll.

A

Add that to the screen: https docs, dot, hyper dot, io, slash cloud, slash, hyper connect and it gives you some documentation on how to install hyper connect and some of the apis for hyperconnect cool, so to get started. We're going to be using hyper. So you need an account on hyper, so you will want to go to dashboard.hyper.io.

A

And I will open that up.

A

And if you've taken the hello world, you should already have an account on hyper. But if not you just follow the signs and it'll create an account, and once you go through the sign up process, the accounts are free.

A

You get three free apps and I've created one app from the hello world and um open that up and the biggest thing is keys. So we want to be on the keys tab and we want to grab our connection string and just hit the icon over to the right to copy that connection string so that we can use that in our workshop.

A

So now that we have that, we want to launch a github a get pod instance of our workshop repository and in order to do that, what you want to do is you want to in a new tab, type getpod.io pound and then the repository that you want to use. In our case we're going to do github, hyper 63 workshops dash node.js right.

A

So I've already got a running workspace and I'm just going to load that up.

A

And I was working on the hello world, so I'm going to close those down and what we want to do is work in our hyper connect.

A

Folder data dash connect and we want to take that copied connection string that we made and we'll create a new file, dot emv file and in that new file, we're going to type hyper equals and we're going to paste that connection string into this dot. Emv file, the dot emv file will load our environment variables for our development environment so that we can securely connect to our hyper data service.

A

Okay, once we have that and then we want to change our directory into data dash connect and we just want to install hyper connect, so we're going to run yarn or you can run mpm install and then we'll say, yarn, add hyper connect or you could use npm.

A

And then we want to say yarn start to run our api server. That's going to run on port 3000. We can open it up in preview and we are running our api server awesome.

A

So now what we want to do is update a document. So if you followed the hello world um workshop, you should already have a few character documents in your database. I think I have one so I'm going to make sure by doing localhost, 3000, curl, localhost, 3000, api characters, character-1.

A

Cool, so I have one character in and I want to update it so the way that I would do that in my api is run a curl command and send a put http verb to localhost, 3000, right api characters and then the character, id character dash one and this content type is going to be application, dash, json and I'm going to create a data document on this line and it'll be id character, dash 1, and this whole document is going to replace whatever's in there.

A

So I need to provide what you know what I want to keep in there in this document. So we want to keep the id. We want to keep the character or the type, and we want to keep the name.

A

A

Then we want to add a description.

A

A

A

Character in nintendo universe, cool, okay, so we'll close our json document and add a single quote and then um run this and we get back not implemented because we haven't implemented the code to make this work.

A

So let's just queue that up again and let's go into our api folder here and we're going to do, update character and we're going to import connect from.

A

Hyper connect, then we're going to grab hyper from connect and we're going to pass in the hyper connection string that we set up in our dot emv file and then we're going to await hyper dot data dot, update and with this api, the update.

A

We need to give it the id and the document, so we're going to say, request, dot, rams, dot id, because it's passed in this um url string down here right and then we're going to give it the document which comes in as request dot body like that, then we're just going to return the result cool all right. We've got that.

A

Let's hit enter down here and we've got okay, true great, so we can verify that by just doing a get curl command that we did before, and we should now see our description famous character in nintendo universe, yay, okay,.

A

The next thing we want to um do is the remove character, so we're going to remove a character by going to the remove character.js file and bringing in hyper again so import connect from hyper connect and then we'll create a hyper instance.

A

And use our environment settings and then we're going to say: const result equals a weight, hyper dot, remove data dot, remove and we just need an id so request. uh Params.Id.

A

And we show the result.

A

Okay and now, if we wanted to remove mario from our database, we just do curl x, delete.

A

And then localhost.

A

3000 api characters, character, dash, one and okay. True mario is gone. We can verify that by doing a curl, mario is not found and we can add. Mario back. We change this put to a post.

A

So we'll change this to our post.

A

And we add mario back cool.

A

All right now that we've implemented the update and the remove feature next is to update or to implement the uh list characters feature and to do that, we'll go into the list, characters file and we will import hyper connect. So we'll import connect from hyper connect and then we will create our hyperinstance by calling connect and passing in the environment.

A

Variable called hyper from our dot emv file and we're going to get a result which we will await hyper dot data dot. You guessed it list, so we call list that's going to return all the documents from our hyper data store.

A

So if we send the result to the client and let's make sure that we're running our service, so we'll say yarn start and we'll open up the new terminal here and we'll say: curl localhost, 3000, api characters that and boom there we go. We got a ok, true and then our docs node and it returned all our characters. So if we wanted just to return just the array, we could say results: dot, dot, docs that and that returns just our character array.

A

Now one of the things is: if we're building a mario wiki api that can have games and characters, we need to kind of filter on the document type because we want to make sure we return a list of characters.

A

One way to do that is we get all the docs from the data service and then we just call a filter and then test if doc, dot type equals character that and then that would give us all the characters. Now we may want to filter on the database using the list command. We can do a couple of things because we're prefixing our id with character for all the character type documents.

A

We can do a start key and an end key, so we can say start key equals character like that and n t equals character, dash and um z, or something like that right and then we can just do the results. Docs.

A

And that gives us our docs.

A

We can also specify specific keys with this list command, so we can say keys and say character, dash, one etc and and just add all the keys that we want to pull and run that and then that will give us a list of our misspelled universe. No good. Maybe we can update that.

A

Give us all of our documents so and then other things you can do is.

A

Limit, we can, we could say, limit of 10 for like pagination things like that, and we can also say descending true.

A

I can spell it correctly descending true, and that would list the characters in reverse or of their identifier.

A

So that's hyper.data.list.

A

In the next workshop, we'll cover hyper.data.query, which allows you to do more advanced query functions as well as bulk, which allows you to upload multiple documents or update multiple documents or remove uh a batch of documents with just one call. So those are some cool features so check it out in our hyper query workshop and thanks for your time.