Asserting the New Rockset Developer Instruments

We’re excited to launch a brand new ecosystem of developer instruments supposed to assist superior customers edit, execute, and deploy Question Lambdas from an area growth setting, whereas integrating seamlessly with Model Management and CI/CD techniques. 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 greatest practices for utilizing these instruments collectively. For extra detailed documentation on utilization of every particular person instrument, please see the README for every instrument. Take a look at 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 simply 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 to your Question Lambda
4. Execute a Question Lambda by tag from its API endpoint or from one in all our SDKs

The Excessive Stage Workflow

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

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

1. Arrange an area Rockset challenge in your supply code.

   a. Initialize a brand new challenge in your repository

   b. [CLI] Obtain your Question Lambdas and test 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 software by its Question Lambda Tag

5. If mandatory, roll again your Question Lambdas

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

A Good day World Instance

0. Set up the Developer Instruments

Set up the Rockset CLI instrument. 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 data
$ rockset auth:add APIKEY

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

You’ll be able to create an API key within the Rockset Console.
Set up the Rockset VS Code plugin by way of the VS Code market. Please see the VS Code documentation for extra particulars about easy methods to set up the extension.

1. Arrange a challenge

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

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

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

That was straightforward! However what’s occurring beneath the hood right here? Let’s view the file system and take a more in-depth look.

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

We have now created 2 information: a SQL file, and a Question Lambda definition file. The Lambda definition file consists of data akin to default parameters and the outline of your Lambda. You’ll be able to 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 challenge (the listing containing rockset.config.json).

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

SELECT
    'Good day, World' AS "Good day World"

You probably have the Rockset SQL extension put in, you need to see full syntax highlighting, in addition to autocomplete performance.

You too can execute this SQL straight 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 too can execute your question utilizing the CLI.

3. Utilizing Parameters

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

SELECT
    CONCAT('Good day ', :identify) AS "Good day World"

This question will now say good day to you by identify — however how can we execute it with parameters? For extra advanced 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 robotically open a webpage in your default browser. Click on “commons.helloWorld” to view the execution web page for this Lambda.

Residence Web page:

Execution Web page:

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

Add Parameters:

Execute with Parameters:

It really works!

4. Deploying and Executing your Question Lambdas from an Software

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 beneath a model hash. Subsequent, we tag our Question Lambda in order that we are able to check with it from our software.

Through the use of Question Lambdas at the side of Tags, we are able to model and replace our Question Lambdas with out having to change our software code.

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

# Deploy to manufacturing
$ rockset challenge: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 reside, and may be executed out of your software!

We are going to use the cURL to check the endpoint. You too can execute a Question Lambda by Tag from any of our Language Purchasers 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 too can 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 software 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 setting
• Handle manufacturing Question Lambdas from CI/CD

Glad Hacking!