Asserting the New Rockset Developer Instruments

We’re excited to launch a brand new ecosystem of developer instruments meant to assist superior customers edit, execute, and deploy Question Lambdas from a neighborhood growth surroundings, whereas integrating seamlessly with Model Management and CI/CD methods. Proper now, we’re releasing three instruments into an Open Beta:

1. Rockset CLI
2. Rockset VS Code Extension
3. Rockset Developer UI

On this weblog, we are going to discover finest practices for utilizing these instruments collectively. For extra detailed documentation on utilization of every particular person software, please see the README for every software. Try the video beneath for an in depth walk-through of the brand new instruments.

Embedded content material: https://www.youtube.com/watch?v=WhRueFicCUg&t=2s

Earlier than you begin

Earlier than you begin utilizing the brand new Rockset Developer Instruments, we suggest that you just strive the next from the Rockset Console:

1. Arrange a Rockset Account within the Rockset Console
2. Create a Question Lambda utilizing the Console Question Editor
3. Create a tag in your Question Lambda
4. Execute a Question Lambda by tag from its API endpoint or from certainly one of our SDKs

The Excessive Stage Workflow

The brand new Rockset Developer Instruments allow you to maneuver the supply of reality in your Question Lambdas to your Model Management System (VCS). In addition they present sturdy instruments for creating Rockset SQL and deploying your Question Lambdas to Rockset out of your native growth surroundings.

We suggest the next excessive degree workflow for utilizing the brand new developer instruments. This workflow intently parallels industry-standard steady growth flows.

1. Arrange a neighborhood Rockset mission in your supply code.

   a. Initialize a brand new mission in your repository

   b. [CLI] Obtain your Question Lambdas and examine them into your VCS of selection

2. Develop your Question Lambdas

   a. [CLI] Create / delete Question Lambdas

   b. [VS Code] Edit Question Lambdas

   c. [Dev UI] Execute your native Question Lambdas

   d. Iterate

   e. Commit and push your code

3. Deploy your Question Lambdas (CI/CD)

   a. [CLI] Deploy your Question Lambdas to Rockset with Question Lambda Tags

4. Hit your Question Lambda out of your utility by its Question Lambda Tag

5. If obligatory, roll again your Question Lambdas

   a. [CLI] Re-deploy the Question Lambdas related to the earlier tagged commit

A Hi there World Instance

0. Set up the Developer Instruments

Set up the Rockset CLI software. Set up is presently supported on Linux and MacOS solely.

# Set up 
$ curl https://rockset-cli-artifacts.s3-us-west-2.amazonaws.com/install-standalone.sh | bash

# Restart your terminal to finish set up
# Confirm
$ rockset --version

# Set up CLI autocomplete
$ rockset autocomplete

# Add your authentication info
$ rockset auth:add APIKEY

# Add shell autocomplete help (bash and zsh solely)
$ rockset autocomplete

You may create an API key within the Rockset Console.
Set up the Rockset VS Code plugin via the VS Code market. Please see the VS Code documentation for extra particulars about the right way to set up the extension.

1. Arrange a mission

# Navigate to an empty folder
$ cd ~/tasks/rockset

# Initialize your native mission
$ rockset native:init -y

# Add a Question Lambda to your mission
$ rockset native:queryLambda:add commons.helloWorld

That was simple! However what’s happening underneath the hood right here? Let’s view the file system and take a better look.

$ tree
.
├── rockset.config.json
└── src
    └── commons
        ├── __sql
        │   └── helloWorld.sql
        └── helloWorld.lambda.json

We’ve got created 2 information: a SQL file, and a Question Lambda definition file. The Lambda definition file contains info reminiscent of default parameters and the outline of your Lambda. You may view extra details about these information within the CLI Documentation.

2. Develop your Question Lambdas

We suggest modifying your Question Lambdas in VS Code for the perfect expertise. To get began, open the foundation listing of your mission (the listing containing rockset.config.json).

Open src/commons/__sql/helloWorld.sql, and paste within the following.

SELECT
    'Hi there, World' AS "Hi there World"

When you have the Rockset SQL extension put in, it is best to see full syntax highlighting, in addition to autocomplete performance.

You may as well execute this SQL instantly in VS Code by operating Execute Rockset Question from the command palette (Open the command palette with Ctrl-Shift-P or Cmd-Shift-P). You may as well execute your question utilizing the CLI.

3. Utilizing Parameters

Let’s make our Question Lambda extra fascinating — let’s add a parameter! Reopen the supply in your Lambda, and paste within the following.

SELECT
    CONCAT('Hi there ', :title) AS "Hi there World"

This question will now say good day to you by title — however how will we execute it with parameters? For extra complicated queries that embody parameters, we suggest utilizing the Rockset Developer UI. To get began, open the Developer UI utilizing

$ rockset native:serve -p 3001 # port

This could mechanically open a webpage in your default browser. Click on “commons.helloWorld” to view the execution web page for this Lambda.

House Web page:

Execution Web page:

Clicking the execute button from this web page will mechanically execute the newest SQL textual content that you’ve got saved. But when we click on execute proper now, we see an error — we haven’t specified a price for the “title” parameter but! So as to add parameters, click on the Parameters tab. From right here, you possibly can add execution parameters that might be handed to alongside together with your SQL throughout execution. Add your title as a parameter known as “title”, with sort “string”, and execute your Lambda.

Add Parameters:

Execute with Parameters:

It really works!

4. Deploying and Executing your Question Lambdas from an Utility

Deploying your Question Lambdas consists of two steps. First, we are going to deploy a brand new Question Lambda Model. This bundles the Question Lambda, together with its configuration, and uploads it to Rockset underneath a model hash. Subsequent, we tag our Question Lambda in order that we are able to seek advice from it from our utility.

By utilizing Question Lambdas at the side of Tags, we are able to model and replace our Question Lambdas with out having to switch our utility code.

# Add new variations, then tag them with the event tag
$ rockset mission:deploy -t dev

# Deploy to manufacturing
$ rockset mission:deploy -t prod
Efficiently up to date commons.helloWorld — model 061293cecfb67e36
Efficiently tagged commons.helloWorld model 061293cecfb67e36 with tag "prod"

Your Question Lambda is now dwell, and will be executed out of your utility!

We’ll use the cURL to check the endpoint. You may as well execute a Question Lambda by Tag from any of our Language Shoppers or SDKs.

# Execute the newly deployed CLI
$ rockset api:queryLambdas:execute commons helloWorld prod
[INFO]: POST: /v1/orgs/self/ws/commons/lambdas/helloWorld/tags/prod

You may as well discover your Question Lambda within the Rockset Console. When you choose your Question Lambda, you possibly can see instance snippets for executing your Question Lambda out of your utility within the language of your selection.

Conclusion

We’re extremely excited to announce these new instruments. We hope that by incorporating them into your workflow will allow you to

• Test Question Lambdas into model management
• Develop Question Lambdas in your native growth surroundings
• Handle manufacturing Question Lambdas from CI/CD

Glad Hacking!