Asserting the New Rockset Developer Instruments

0/5 No votes

Report this app



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 setting, whereas integrating seamlessly with Model Management and CI/CD programs. 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 device, please see the README for every device. Take a look at the video beneath for an in depth walk-through of the brand new instruments.

Embedded content material:

Earlier than you begin

Earlier than you begin utilizing the brand new Rockset Developer Instruments, we advocate 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 Degree 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). Additionally they present sturdy instruments for growing Rockset SQL and deploying your Question Lambdas to Rockset out of your native growth setting.

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

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

    a. Initialize a brand new venture in your repository

    b. [CLI] Obtain your Question Lambdas and verify them into your VCS of alternative

  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 Hey World Instance

0. Set up the Developer Instruments

Set up the Rockset CLI device. Set up is at present supported on Linux and MacOS solely.

# Set up 
$ curl | 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 may create an API key within the Rockset Console.
Set up the Rockset VS Code plugin by means of the VS Code market. Please see the VS Code documentation for extra particulars about the best way to set up the extension.

1. Arrange a venture

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

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

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

That was simple! However what’s happening below 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’ve got created 2 recordsdata: a SQL file, and a Question Lambda definition file. The Lambda definition file contains data akin to default parameters and the outline of your Lambda. You may view extra details about these recordsdata within the CLI Documentation.

2. Develop your Question Lambdas

We advocate enhancing your Question Lambdas in VS Code for the most effective expertise. To get began, open the foundation listing of your venture (the listing containing rockset.config.json).

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

    'Hey, World' AS "Hey World"

When you’ve got the Rockset SQL extension put in, it’s best to see full syntax highlighting, in addition to autocomplete performance.

You can too execute this SQL instantly in VS Code by working Execute Rockset Question from the command palette (Open the command palette with Ctrl-Shift-P or Cmd-Shift-P). You can too 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 to your Lambda, and paste within the following.

    CONCAT('Hey ', :title) AS "Hey World"

This question will now say howdy to you by title — however how can we execute it with parameters? For extra advanced queries that embody parameters, we advocate 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.

Residence Web page:

Rockset Developer UI Index

Execution Web page:

Screen Shot 2020-08-17 at 1.03.55 PM

Clicking the execute button from this web page will mechanically execute the most recent SQL textual content that you’ve 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 will likely be handed to alongside along with your SQL throughout execution. Add your title as a parameter referred to as “title”, with kind “string”, and execute your Lambda.

Add Parameters:

Screen Shot 2020-08-17 at 1.08.22 PM

Execute with Parameters:

Screen Shot 2020-08-17 at 1.08.28 PM

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

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

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

# Deploy to manufacturing
$ rockset venture: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 could be executed out of your utility!

We’ll use the cURL to check the endpoint. You can too 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 can too 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 alternative.


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

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

Blissful Hacking!


Leave a Reply

Your email address will not be published.

This site uses Akismet to reduce spam. Learn how your comment data is processed.