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 improvement setting, 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’ll 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. 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 advocate that you simply attempt 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 certainly one of 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 improvement setting.

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

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

   a. Initialize a brand new undertaking 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 software by its Question Lambda Tag

5. If crucial, roll again your Question Lambdas

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

A Howdy World Instance

0. Set up the Developer Instruments

Set up the Rockset CLI software. Set up is at the moment 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 help (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 the right way to set up the extension.

1. Arrange a undertaking

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

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

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

That was simple! However what’s occurring beneath 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 created 2 recordsdata: a SQL file, and a Question Lambda definition file. The Lambda definition file consists of data corresponding to default parameters and the outline of your Lambda. You’ll be able to view extra details about these recordsdata within the CLI Documentation.

2. Develop your Question Lambdas

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

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

SELECT
    'Howdy, World' AS "Howdy World"

When you have the Rockset SQL extension put in, you need 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 attention-grabbing — let’s add a parameter! Reopen the supply to your Lambda, and paste within the following.

SELECT
    CONCAT('Howdy ', :title) AS "Howdy World"

This question will now say whats up to you by title — however how will 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 robotically 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 robotically execute the most recent 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 may add execution parameters that will probably 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’ll 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 confer with it from our software.

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

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

# Deploy to manufacturing
$ rockset undertaking: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 software!

We are going to 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 may 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 improvement setting
• Handle manufacturing Question Lambdas from CI/CD

Joyful Hacking!