GitLab Data Team, 24 Jan 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Visual Studio Setup - Data Team

Description

We walk through how to set up visual studio for the GitLab data team.

https://about.gitlab.com/handbook/business-ops/data-team/

A

A

A

The meetings being recorded now, alright.

A

B

Was talking on mute? That was one.

A

B

Okay, if we were gonna walk through getting V s code set up with a few of the extensions that make working with DBT a bit easier and if you have the recommended settings to be in line with the sequel style guide.

B

So, first of all we're gonna reference. The data onboarding issue, that's in the analytics repo and we're going to look at the current version of that. So that is in the get lab folder. It's an issued template.

B

And we've got data onboarding.

B

And then going down, we do have a section on getting set up with the s code and it's the last checkbox of this section. Oh.

B

Sorry, just above that yep so yeah, if you go a little bit down, there's a checkbox that says We strongly recommend configure.

A

B

A

B

There are two links there, we're gonna look at both of those.

B

And these were posted on the DVT discourse page around some recommended configurations, so we're gonna start there if we scroll down to the section on vs code and just above that it has a few recommended settings as well around some justification for this.

B

So there is an indent guide which we can reference the data onboarding issue to set that up. But the first step here is installing the letter, Jinja extension. So the easiest way to do that in vs code is to navigate to the extensions button on the pane and you can just search for whatever extension you want.

A

B

B

So that extension is now installed and what this allows for is extra syntax highlighting around Jinja so that it's easier to differentiate between things like macros and loops and things that are common to Jinja. And so the important part here to make sure this shows up in the code. Editor is adding this file Association setting to the settings file within vs code.

B

Yeah- and you can get to what's in recording right now- is the easiest way to get to the settings and under the text editor section, there will be a files option and that will give us a link to the file that we need to update. So when you install Diaz code for the first time, this is good likely to be empty if you've made any other changes to the settings. There might be a few things here.

B

Alright, so now, once this is saved into the settings, what it will do is it will associate all dots, equal files with Jinja sequel, which is provided by the better Jinja extension. So now, if we save this and exit out of BS code and restart it and.

B

To sure this is working, we can open up a file in the analytics repo, that is a sequel file, so that will be the top left button on the left pane and we can open a folder.

B

And in this case, we'll want to navigate to the Analects analytics repo you've cloned into your environment,.

A

B

In this case, it looks like your user directory is not saved as part of favorites so to get there, if you make sure that you have the Finder window selected and then if we go to I'm sorry, you already have it open. So this is fine. It's just making a.

A

B

The right options so in the top left of your Mac, like taskbar on the very top of the screen, there is the go section, go.

A

A

B

Top of the screen top left and then move to the right, but make sure that the Finder window is still selected. Oh.

A

Right here, okay, oh.

A

B

Sorry so yeah what's happening here is the Finder window is open within BS code. So this is giving us all of the vs code options. So I think if you just click off into your desktop or finder.

A

B

B

There we go so now you can go down to home, and this is the see how it has your names. This is like your user directory.

B

What we want to do is add this to the favorites bar, so that it shows up and Finder windows that are embedded in other applications. Okay, so I think if.

B

You might have to actually move one directory up, so if you go back to go and then computer and then now you can click into macintosh HD users and then, if you right-click that, let's see how we add it to favorites.

B

B

Just creates an alias.

A

One minute.

A

One second I think I just dragged it over oh, and that worked awesome.

B

A

A video playing in the background so once I get.

A

Ok, we're good yeah I, just dragged it over. Okay.

B

Easier than what I was thinking, that's good yeah.

A

B

So now you can navigate to that within the via scope window, that's open and then we'll go to repos, analytics and I usually start from here, because occasionally I'm looking at things that are outside of the transform directory. So if we.

A

B

A

B

We can kind of see the same director that we would see if we were working in the analytics repo and to see what this looks like for a particular sequel file and open up the transform section and then we'll go to snowflake models, and we can just pick one at random. It has some Jinja in it that says enough, so we can see now that on line 4, we have some different syntax highlighting for the parts that it recognizes as being related to ginger.

B

So this is a pretty good first step, depending on the color theme that you choose for your editor this you know it can be more distinct from the rest of the code. In this case, the default setting has a lot of blue in it, so the syntax, highlighting that this extension provides it's like enough, but there's you know you can always play with this as needed.

B

That was the first step. So now we have ginger highlighting it gets a little bit easier to look at if we go back to that same discourse, DDT page we'll be able to some other recommended settings that helped us along.

B

The second tab: do you have open? Oh.

B

All right, so this is all that was recommended at the top of this post, but you can see that they have add DDT snippets coming soon that actually comes later in the file. So if we open that third tab that you have open, this is the post that Taylor added recently. So this actually has two things there and we can install both of these extensions. The first one is: it adds this rule set so that from any file that you're looking at you can look at other related files to this.

B

This is important for us where, let's say I'm looking at the of a model, it may have a lot of extra DBT code in it or like ginger in it. Sometimes I want to look at the compiled version of that to see what's actually going to be run and snowflake okay, so we can start with that.

B

So if you go back to the extensions and BS code and there's unrelated files, which it looks like that's already enabled yeah.

A

B

Pretty nice, so the only thing that we have to do is pad this rule set to that same settings file that yeah I think we lost it. When we opened up the directory yeah.

A

B

So it'll be the same thing, text editor and then files, oh well, my bad that I made I made this mistake earlier. It's totally not there. If you go to the settings for find related files, there should be configure extension settings.

A

So say that one more time so.

B

Find related files is installed and then there's the little gear icon on the bottom right of the left. Pane, where find related files is selected right.

A

B

A

B

You go to the top of the left pane, so we're. Finally, yep yeah.

A

B

Configure extension settings on the very bottom and then, if we go to the bottom, where it says find related rule sets.

B

Yeah so we'll add the edit in settings a JSON, yeah yeah, so I misspoke, there's actually two things we have to change the first one is here: I was confused because you also have to update a setting the page root previously on, but the first step is to add the snippet here that Taylor is created.

B

So what we want to do here is we actually want to add a comma after the first closing curly bracket.

B

We'll add this as a new line.

B

B

So now we'll just save that and then, if we go back to the settings that we were looking at for this so yep so at the very top we have to add.

B

Like all the way at the very top there's a list of sorry up, the right pane like that I know.

A

B

So you have to scroll up to the top of this one.

A

B

Can see here that it has rule sets for different types of files, but you can see in the snippet the Taylor created on the left. The name of this rule set is sequel, so we need to make sure that that rule set is also here. So, if you click add items and it's just equal.

B

So now all of these settings are saved and we can exit out of es code and go back in to look through what this gives us.

B

B

If you go, if you click the top left again to open up open up folder and then we'll do the same thing, yeah and just a quick comment here, this is something that I've been I, think there's probably a setting to make sure it opens up the same location every time you start it. My.

A

B

Just been to pretty much leave vs code open all the time, but there probably is a way that you can change it. So you don't have to open up folders repeatedly.

B

All right so I think the most common use case that we'll have is wanting to bounce between the uncompelled and compiled version of a model. So this is documented earlier in that discourse page. But the shortcut for this is, if you press, alt r.

B

What it gives you is a drop-down of all of the related files to this file, and you can see that in the pane to the left, it's actually already navigated you to the compiled version of the the model that we were just looking at, and so you can see that, rather than having the Jinja code up top now, it's saying that: okay, it's selecting everything from the raw database bamboo HR compensation.

B

This is another one of those. It's just a convenience thing. If you want to know how certain code is being compiled without having to scroll down open up all the folders and find the same name of the file that you were looking at, just a small time-saver I, don't think it's like a huge deal, but pretty nice to have.

B

And then, if we look at the the open window again, there's also a recommendation about the vs code, DBT age at the bottom of Taylor's comment.

A

B

So this is a pretty cool one. What it allows for is being able to tab autocomplete various the TBT commands it's like. If you don't want to remember all of the things that need to go into a ref statement, or you want to go ahead and just build out like a for loop pretty easily. It allows you to autocomplete that in a nice way and I think at the bottom, there are instructions about how to install this. So this one is not part of the vs code extension marketplace.

B

We have to do a little bit of annual work if we'll download that and then, if you.

B

So I think we can take the first one you're just gonna copy the vs code, DB T, we're.

A

B

Gonna copy that folder, okay and then, if you go to your user directory and then there is a shortcut to view all of the hidden files on your computer, so that is command shift period on a Mac.

A

B

So this is for, like all of those directories, that start with a dot and it's usually where a lot of configuration files are stored. Okay, so in this case we're looking for that dot, vs code, folder.

A

B

We have extensions and then we're just gonna paste that folder into here cool.

A

B

Now the extension is there, but since it wasn't from the market place, we will have to close down BS code and reopen it again.

A

One opening closing yeah.

A

B

Now like, if you just enter down a few lines and be in the uncompelled version of a model, sorry.

A

B

Still in the compiled directory, okay.

B

That's just if we scroll up to models.

A

B

Yeah, like any of these, oh.

A

B

So now we can test this out and you can do this on like an empty file of any sort. But if you just in turn down a few lines and then you type re f, we can see now that we have this new option and it will tab complete part of these things, which is pretty cool. Okay,.

A

B

Good one is like, if you tried source.

B

And then it's the second option there. No, it provides it nice.

A

B

So that is all of the extensions that we have is part of onboarding that are recommended. If we go back to the onboarding template. There are a few other recommendations that we have.

B

Alright and so there's this whole section about the editor settings so detect indentation, insert spaces and tack size. This is mostly around how, in the style guide that we have, we recommend for spaces at for the start of sequel code. It might exist in a CTE. This makes sure that when you tab, it won't be like two or three spaces: it'll just be for pretty consistently.

B

So these are settings that you can select within the settings portion of BS code.

A

B

And then I think we might have to scroll through to find this I, don't remember there being an obvious way to find where this was, but I will check this online as well. Okay,.

A

If you do a search at the top he'll get to it as well.

A

We have the type of indentation is deselected, I.

A

Don't know detect an indentation so.

B

We want to make sure that that is deselected.

A

B

Then this and we also have insert spaces.

A

B

It says to make sure that is selected. So that's good.

B

Good try searching for that one too. Yes,.

A

B

That's why and rose there's one other thing that I just found yesterday, which is you search for snippet suggestions,.

A

B

I think this will probably differ depending on people's workflow, but what I did was I changed this to be top so that the DBT autocomplete, so we just resolved, will actually be the first thing. That's available and tab complete, okay, what we saw before where it had source and then the autocomplete was the second option that we'll just move that to the top okay.

A

B

And I think that's all good nice. So now it's pretty good to go. I think one other things that that I useful is the setup yeah. So I think if you go back to settings.

B

There's one thing that we want to check, and so, if you just search for terminal.

B

And you see how it says about halfway down the page terminal, external OSX execution, uh-huh.

A

B

Actually want to change this to be the I terminal app because we installed a bunch of handy configurations for that via the onboarding script. Okay,.

A

B

It looks like there's not a drop down, but what I have typed into mine is just I term. Dot have ID.

A

Okay, I was like I, don't think it's I terminal.

A

Does yeah okay, cool.

B

And then from here you can go to view in the top left of your desktop and then, if you click terminal.

B

It adds a terminal here and then the way that I usually have this setup is to the right of plus sign in the terminal page there's a split button, and so what this allows for is you can have two terminals open and what I usually do is I. Make sure that one of these terminals has a docker containers fun up that I, just can't even all the time, and so from here you can just do like the make DBT image, command and you'll always be available.

A

Image can't remember, or just it's.

B

Yeah, it's image with no spaces between them. Okay,.

B

And this is really nice, because then you can use the left-hand terminal to like do all your git commands and write serve it all for just the DBT commands nice.

A

B

Cool I think that.

A

B

A

Yeah, thank you for walking through that yeah.

B

I know he's I think we can stop the recording now. I gather all.

A

Righty I hope I have a safe, somewhere I think.

B

It's still recording it's just not and that fair anymore yep.