@rockset/cli
Advanced tools
Official Rockset CLI
curl (Recommended)This standalone installation is ideal for most environments as it contains its own Node.js binary and automatically updates. However, it is not Windows compatible.
curl https://rockset-cli-artifacts.s3-us-west-2.amazonaws.com/install-standalone.sh | bash
Running this script requires sudo access. Be sure to restart your command line once the installation is completed.
npm (Not Recommended)As a standalone Node.js binary, you can also install the @rockset/cli package directly from npm. However, it is strongly recommended that you use another installation method as the package will not be able to autoupdate and requires you to use your system's version of Node.js. If you choose to use this installation method, ensure you are on Node.js 10.x or 12.x before attempting it.
npm install -g @rockset/cli
To verify that your installation was completed successfully, run rockset --version in your command line.
$ rockset --version
The following steps will help you configure the CLI tool.
To view the list of available commands, run rockset -h in your command line.
$ rockset -h
You can update the Rockset CLI to the latest version at any time using rockset update.
$ rockset update
After an update, run rockset autocomplete -r to rebuild the autocomplete cache.
The Rockset CLI Autocomplete feature allows you to preview and complete commands using the tab key. It is currently compatible with bash and zsh.
To install this feature, run rockset autocomplete in your command line. You will receive different instructions depending on which shell you are using.
$ rockset update
$ rockset autocomplete
Note: If you are installing autocomplete on macOS and using it from a login shell, you may need to run the following command:
$ echo 'source ~/.bashrc' >> ~/.bash_profile
You may need to restart your command line after all steps to enable the autocomplete feature after installation.
To use the Rockset CLI tool, you will need to create an authentication profile using your API Key which can be created and found in the Rockset Console.
Once you have successfully obtained your API key, run the rockset auth:add command to create your authentication profile. Running the following command will create an authentication profile named default:
$ rockset auth:add default [API Key]
The new Rockset CLI supports 4 core workflows.
rockset auth)rockset sql)rockset api)
rockset local)
Basic usage is demonstrated below:
#. Get specific help for a command
$ rockset -h [COMMAND]
USAGE
$ rockset COMMAND
#. View different auth profiles
$ rockset auth:list
#. Use a different auth profile
$ rockset auth:use
#. Run a SQL query
$ rockset sql "SELECT 'hello, world!'"
#. List all Query Lambdas in "commons" workspace
$ rockset api:queryLambdas:listQueryLambdasInWorkspace commons
#. Initialize a local project in the current directory
$ rockset local:init
#. Download your Query Lambdas
$ rockset local:download
#. Serve the Rockset Developer UI to test your local Query Lambdas
$ rockset local:serve
#. Deploy your local Query Lambdas to Rockset
$ rockset local:deploy
#. Update to the latest CLI version
$ rockset update
If you want to get live Query Lambdas working as quickly as possible, this Hello World example will get you there. Please start in an empty directory. This guide assumes you have set up authentication successfully above.
#. Initialize your local rockset project, skipping confirmation messages
$ rockset local:init -y
#. Add a Query Lambda to your project
$ rockset local:queryLambda:add commons.helloWorld
#. Write text to your Query Lambda
$ echo "SELECT 'hello, world' \"Hello World\"" > `rockset local:resolve --sql commons.helloWorld`
#. Execute your Query Lambda, and select the result
$ rockset local:queryLambda:execute commons.helloWorld | jq '.results'
[INFO]: About to execute commons.helloWorld from local project...
[INFO]: SQL: SELECT 'hello, world' "Hello World"
[INFO]: Parameters: []
[INFO]: Successfully executed query.
[
{
"Hello World": "hello, world"
}
]
#. Deploy your Query Lambda, and tag it with the dev tag
$ rockset local:deploy -l commons.helloWorld -t dev
Successfully updated commons.helloWorld — version e71f9de16aa66e3c
Successfully tagged commons.helloWorld version e71f9de16aa66e3c with tag "dev"
#. Your Query Lambda is now live!
#. Execute your Query Lambda from the API
$ rockset api:queryLambdas:executeQueryLambdaByTag commons helloWorld dev
[INFO]: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}
[INFO]: Arguments:
[INFO]: {
"workspace": "commons",
"queryLambda": "helloWorld",
"tag": "dev"
}
Hello World
hello, world
#. Alternatively, execute your Query Lambda with cURL
$ curl --request POST \
--url https://api.rs2.usw2.rockset.com/v1/orgs/self/ws/commons/lambdas/helloWorld/tags/dev \
-H 'Authorization: ApiKey [your apikey]' \
-H 'Content-Type: application/json' | jq '.results'
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 202 100 202 0 0 1004 0 --:--:-- --:--:-- --:--:-- 1004
[
{
"Hello World": "hello, world"
}
]
Congratulations, you have finished setting up your Hello World Query Lambda! For a more detailed discussion of how to develop more complex Query Lambdas with Parameters, please see the Local Query Lambda Development Details.
The API tool is contained in rockset api. This tool is designed to very closely match the layout of our REST API endpoints. The remainder of this section provides examples for using these commands.
The API calls are further broken into subcommands based on the resource that the command affects. This reflects the breakdown of our API Documentation.
For example, all endpoints for creating, deleting, and managing Collections will appear under the rockset api:collections path.
To view all available endpoints for a resource, use the -h flag.
$ rockset api:collections -h
USAGE
$ rockset api:collections:COMMAND
DESCRIPTION
Create Collection
Create new collection in a workspace.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/collections
Endpoint Documentation: https://docs.rockset.com/rest-api#createcollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
COMMANDS
api:collections:createCollection
api:collections:deleteCollection
api:collections:getCollection
api:collections:listCollections
api:collections:listQueryLambdasInCollection
api:collections:workspaceCollections
Each API command will accept positional arguments that translate to the URL parameters of the REST endpoint that they wrap. API Commands that wrap POST requests will additionally accept a JSON string for the Body of the POST request. This JSON string will be passed directly to the API Endpoint, and should thus match the API specification.
#. GET All Collections
$ rockset api:collections:listCollections
[INFO]: GET: /v1/orgs/self/collections
[INFO]: Arguments:
[INFO]: {}
Created at Created by Name Description
2020-06-24T00:12:30Z scott@rockset.com Collections null
2020-06-30T17:24:03Z ben@rockset.com Collections2 null
2020-07-01T21:03:07Z joe@rockset.com JoeTest null
#. GET One Collection
$ rockset api:collections:getCollection commons Collections
[INFO]: GET: /v1/orgs/self/ws/{workspace}/collections/{collection}
[INFO]: Arguments:
[INFO]: {
"workspace": "commons",
"collection": "Collections"
}
{
"created_at": "2020-06-24T00:12:30Z",
"created_by": "scott@rockset.com",
"name": "Collections",
"description": null,
...
}
Arguments can also be passed in as a JSON file specification using the -f flag. This is especially useful for POST requests that may require large specifications.
#. The following two JSON files are treated identically
#. Commons.foo is a Query Lambda with text 'SELECT :foo'
$ cat spec1.json
{
"workspace": "commons",
"querylambda": "foo",
"tag": "test",
"body": {
"parameters": [
{
"name": "foo",
"type": "string",
"value": "bar"
}
]
}
}
$ cat spec2.json
{
"workspace": "commons",
"querylambda": "foo",
"tag": "test",
"parameters": [
{
"name": "foo",
"type": "string",
"value": "bar"
}
]
}
#. These two commands likewise produce the same output
$ rockset api:queryLambdas:executeQueryLambdaByTag -f spec2.json
$ rockset api:queryLambdas:executeQueryLambdaByTag -f spec1.json
[INFO]: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}
[INFO]: Arguments:
[INFO]: {
"workspace": "commons",
"queryLambda": "foo",
"tag": "test",
"body": {
"parameters": [
{
"name": "foo",
"type": "string",
"value": "bar"
}
]
}
}
Foo
bar
All API Commands by default will intelligently grab the most relevant part of the response data and display it for you in a table. The most commonly used flags are shown below. The full set of flags can be found by setting the -h flag.
--columns=columns only show provided columns (comma-separated)
--filter=filter filter property by partial string matching, ex: name=foo
--full Show the full results JSON object
--no-header hide table header from output
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
Some API commands support running load tests to test the performance of your queries under real load. Currently this includes API commands in the following categories.
To run a load test, run the command as usual and pass the -l flag with the number of requests you wish to make per second.
#. Run a load test against Query Lambda commons.foo, with text 'SELECT :foo'
$ cat spec2.json
{
"workspace": "commons",
"querylambda": "foo",
"tag": "test",
"parameters": [
{
"name": "foo",
"type": "string",
"value": "bar"
}
]
}
#. Start load test
$ rockset api:queryLambdas:executeQueryLambdaByTag -f spec2.json -l 5
[INFO]: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}
[INFO]: Arguments:
[INFO]: {
"workspace": "commons",
"queryLambda": "foo",
"tag": "test",
"body": {
"parameters": [
{
"name": "foo",
"type": "string",
"value": "bar"
}
]
}
}
? Please confirm that you would like to send 5 API requests per second to the endpoint show above.
Sending huge amounts of requests may cause performance issues for the rest of your organization. Please be careful › (y/N) ... yes
****
Sent: 0
Success: 0
Failure: 0
Pending: 0
Average Success Latency: NaN ms
Average Failure Latency: NaN ms
****
Sent: 5
Success: 5
Failure: 0
Pending: 0
Average Success Latency: 257 ms
Average Failure Latency: NaN ms
****
Sent: 10
Success: 10
Failure: 0
Pending: 0
Average Success Latency: 168 ms
Average Failure Latency: NaN ms
****
Sent: 15
Success: 15
Failure: 0
Pending: 0
Average Success Latency: 140 ms
Average Failure Latency: NaN ms
...
#. Load test will continue to run until it is killed
Create a Collection
#. YAML Spec for this collection
name: footest
workspace: commons
sources:
- s3:
access_key: ''
secret_access: ''
prefix: partial-cities
region: us-west-2
bucket: rockset-public-datasets
prefixes:
- partial-cities
mappings: []
format: JSON
retention_secs: 100000
field_mappings:
- name: transformation538cvdohk
is_drop_all_fields:
input_fields:
- field_name: fields.country
if_missing: PASS
is_drop: true
param: country
output_field:
field_name: lenCountry
value:
sql: LENGTH(:country)
on_error: SKIP
$ rockset api:collections:createCollection -f spec.yaml
[INFO]: POST: /v1/orgs/self/ws/{workspace}/collections
[INFO]: Arguments:
[INFO]: {
"workspace": "commons",
"body": {
"name": "footest",
"sources": [
{
"s3": {
"access_key": "",
"secret_access": "",
"prefix": "partial-cities",
"region": "us-west-2",
"bucket": "rockset-public-datasets",
"prefixes": [
"partial-cities"
],
"mappings": []
},
"format": "JSON"
}
],
"retention_secs": 100000,
"field_mappings": [
{
"name": "transformation538cvdohk",
"is_drop_all_fields": null,
"input_fields": [
{
"field_name": "fields.country",
"if_missing": "PASS",
"is_drop": true,
"param": "country"
}
],
"output_field": {
"field_name": "lenCountry",
"value": {
"sql": "LENGTH(:country)"
},
"on_error": "SKIP"
}
}
]
}
}
...
The local Query Lambda tool under rockset local is designed to help you easily manage your Query Lambdas and integrate well with versioning tools like Git.
To get started, first set up your local project by creating a rockset.config.json file in your project root. We highly recommend that this directory be under version control. All of the files handled by the tool can be safely checked in.
$ rockset local:init
✔ Enter the root path for your Query Lambdas … src
Created root config at rockset.config.json
$ cat rockset.config.json
{
"source_root": "src"
}
#. Download your existing Query Lambdas from Rockset's API Server
#. This will download the latest versions of your Query Lambdas
#. You can also download lambdas by tag using the -t flag
$ rockset local:download
✔ WARNING: This will overwrite all Query Lambda objects downloaded to the current project, and can result in loss of work. Are you sure? … yes
Downloaded lambda commons.QLBar
Downloaded lambda commons.QLFoo
Downloaded lambda frontend.QLFrontend
#. Visualize the project structure
$ tree
.
├── rockset.config.json
└── src
├── commons
│ ├── QLBar.lambda.json
│ ├── QLFoo.lambda.json
│ └── __sql
│ ├── QLBar.sql
│ └── QLFoo.sql
└── frontend
├── QLFrontend.lambda.json
└── __sql
└── QLFrontend.sql
As you can see, each Query Lambda is placed in a directory with the same name as its workspace. Each Query Lambda has two files associated with it.
<workspace/path>/QL.lambda.json This is the Lambda Definition file. It includes information such as the description and the default parameters of the Query Lambda.
.lambda.json. The name of the associated QL must be the name of the file<workspace/path>/__sql/QL.sql This file contains the SQL associated with the Query Lambda.You can also use nested workspaces. If we continue the example above:
$ rockset local:queryLambda:add prod.frontend.QLFrontend
$ tree
.
├── rockset.config.json
└── src
├── commons
│ ├── QLBar.lambda.json
│ ├── QLFoo.lambda.json
│ └── __sql
│ ├── QLBar.sql
│ └── QLFoo.sql
├── frontend
│ ├── QLFrontend.lambda.json
│ └── __sql
│ └── QLFrontend.sql
└── prod
└── frontend
├── QLFrontend.lambda.json
└── __sql
└── QLFrontend.sql
This yields nested directories to represent the nested workspace prod.frontend.
Let's take a look at the Query Lambda definition file. This file is the source of truth for properties about your Query Lambda.
#. `rockset local:resolve` gives the path for a particular Query Lambda given it's Qualified Name
$ cat `rockset local:resolve prod.frontend.QLFrontend`
{
"sql_path": "__sql/QLFrontend.sql",
"default_parameters": [],
"description": ""
}
The definition includes 3 fields:
sql_path which gives the path of the SQL file relative to the parent of the definition filedefault_parameters which specifies the default parameters that this Query Lambda will use after it has been deployeddescription The description that will show for this Query Lambda after it has been deployedLet's update our Query Lambda definition to the following.
{
"sql_path": "__sql/QLFrontend.sql",
"default_parameters": [
{
"name": "foo",
"type": "string",
"value": "my foo"
}
],
"description": "My foo Query Lambda"
}
And then update our Query Lambda SQL to
select :foo
Now we can execute the Query Lambda to see the result.
$ rockset local:queryLambda:execute prod.frontend.QLFrontend
[INFO]: About to execute prod.frontend.QLFrontend from local project...
[INFO]: SQL: select :foo
[INFO]: Parameters: [
{
"name": "foo",
"type": "string",
"value": "my foo"
}
]
[INFO]: Successfully executed query.
{
"collections": [],
"column_fields": [
{
"name": "?field0",
"type": ""
}
],
"results": [
{
"?field0": "my foo"
}
],
"query_id": "d9e2e2ab-75ac-4cfe-a3ca-e8346e4ee4a7:up50MQy:0",
"stats": {
"elapsed_time_ms": 2
}
}
The recommended way to edit your Query Lambdas is with the Rockset VSCode plugin, which provides Syntax Highlighting, Autocomplete, Error Highlighting, and more. VSCode also provides an excellent tools for editing JSON to assist you in editing your Query Lambda definition file.
However, if you choose not to use the VSCode plugin, you can also easily edit your Query Lambdas using your preferred command line editor.
For the best experience, we recommend opening your project root (the directory containing rockset.config.json) as the root directory in VSCode.
$ rockset local:resolve --sql prod.frontend.QLFrontend
/Users/tchordia/rockset-js/packages/cli/testLambdas/src/prod/frontend/__sql/QLFrontend.sql
#. open in your preferred editor
$ $EDITOR `rockset local:resolve --sql prod.frontend.QLFrontend`
Note: this section covers executing the local version of your Query Lambda. This will not help you execute a Query Lambda on Rockset's API Server. For that, please use the API tool described above
The recommended way to execute your local Query Lambdas is with the Rockset Developer UI.
#. Open a UI to execute local Query Lambdas
$ rockset local:serve
This will open a UI for you to add parameters and inspect the results of your query. It will also set up a mock of Rockset's API server that can execute Query Lambdas. Please see the Rockset Developer UI Docs for more information.
You can also execute your Query Lambdas from the CLI tool. The CLI tool will do the following to execute your Query Lambda.
#. Print out the text of the query we will run
$ cat `rockset local:resolve prod.frontend.QLFrontend --sql`
select :foo
#. Execute the query with parameter "foo" set to value "bar"
$ rockset local:queryLambda:execute prod.frontend.QLFrontend -p '[{"name": "foo", "type": "string", "value": "bar"}]'
{
"collections": [],
"column_fields": [
{
"name": "?field0",
"type": ""
}
],
"results": [
{
"?field0": "bar"
}
],
"query_id": "6f2e8211-dd9e-408d-a8bc-55a498ef5307:5Rtq9NK:0",
"stats": {
"elapsed_time_ms": 2
}
}
When you are ready, you can use rockset local:deploy to deploy your Query Lambdas to Rockset's service. At that point, your Query Lambdas are live to any applications that may try to hit them, so please proceed with caution.
#. This shows all Query Lambdas that will be deployed
$ rockset local:deploy --dryRun
commons.QLBar
commons.QLFoo
frontend.QLFrontend
frontend.l1
prod.frontend.QLFrontend
#. You can narrow the list by specifying a workspace
$ rockset local:deploy -w commons --dryRun
commons.QLBar
commons.QLFoo
› Warning: Skipping: frontend.QLFrontend
› Warning: Skipping: frontend.l1
› Warning: Skipping: prod.frontend.QLFrontend
#. You can also specify one lambda to deploy
$ rockset local:deploy --dryRun -l commons.QLBar
commons.QLBar
› Warning: Skipping: commons.QLFoo
› Warning: Skipping: frontend.QLFrontend
› Warning: Skipping: frontend.l1
› Warning: Skipping: prod.frontend.QLFrontend
#. When you are ready, remove the --dryRun flag to deploy
#. In practice, you should always tag your Query Lambdas, so that your application can execute them by tag
$ rockset local:deploy -l commons.QLBar -t dev
› Warning: Skipping: frontend.QLFrontend
› Warning: Skipping: frontend.l1
› Warning: Skipping: prod.frontend.QLFrontend
Successfully updated commons.QLFoo — version bb765a336e5eea9a
Successfully updated commons.QLBar — version ff631d5e8085613d
Successfully tagged commons.QLFoo version bb765a336e5eea9a with tag "dev"
Successfully tagged commons.QLBar version ff631d5e8085613d with tag "dev"
Sometimes, you may have added a new Query Lambda in a workspace that doesn't exist yet. In this situation, you should pass the --createMissingWorkspaces flag to create any workspaces that you are missing.
The deploy tool deploys lambdas in 2 steps:
If the specified Query Lambda already exists, the first step is idempotent. Furthermore, the first step is idempotent with respect to your applications: since Query Lambdas are versioned by their hash, no application should be targeting the new Query Lambda yet. When the second step occurs, your application traffic may be redirected through your new Query Lambda. Please be careful: if you tag your Query Lambda with a production tag, it is possible to break your application.
We highly recommend that you check all of your project files into Version Control as you might with any other application files. We also recommend deploying your Query Lambdas automatically in CI/CD.
#. In CI/CD
rockset local:deploy -t development
...
#. When you want to deploy to production
git checkout <commit hash>
rockset local:deploy -t production
Then, your application can hit Lambda QLFoo with tag development in development, and hit QLFoo with tag production in the production environment.
// JS Application Example
rockset.queryLambdas.executeQueryLambdaByTag('commons', 'QLFoo', isProduction() ? 'production' : 'development');
The Rockset CLI includes a telemetry feature that collects some usage data. This feature is enabled by default. We never log any sensitive data, query text, or query result data.
To opt out of telemetry, set the ROCKSET_CLI_TELEMETRY_OPTOUT environment variable to 1 or true.
rockset api:apikeys:createApiKey -f request.yamlrockset api:apikeys:createApiKeyAdmin -f request.yamlrockset api:apikeys:deleteApiKey NAMErockset api:apikeys:deleteApiKeyAdmin NAME USERrockset api:apikeys:listApiKeysrockset api:apikeys:listApiKeysAdmin USERrockset api:collections:createCollection -f request.yamlrockset api:collections:deleteCollection WORKSPACE COLLECTIONrockset api:collections:getCollection WORKSPACE COLLECTIONrockset api:collections:listCollectionsrockset api:collections:listQueryLambdasInCollection WORKSPACE COLLECTIONrockset api:collections:workspaceCollections WORKSPACErockset api:documents:addDocuments -f request.yamlrockset api:documents:deleteDocumentsrockset api:documents:patchDocumentsrockset api:integrations:createIntegration -f request.yamlrockset api:integrations:deleteIntegration INTEGRATIONrockset api:integrations:getIntegration INTEGRATIONrockset api:integrations:listIntegrationsrockset api:orgs:getOrganizationrockset api:queries:query -f request.yamlrockset api:queryLambdas:createQueryLambda -f request.yamlrockset api:queryLambdas:createQueryLambdaTag -f request.yamlrockset api:queryLambdas:deleteQueryLambda WORKSPACE QUERYLAMBDArockset api:queryLambdas:deleteQueryLambdaTag WORKSPACE QUERYLAMBDA TAGrockset api:queryLambdas:deleteQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSIONrockset api:queryLambdas:executeQueryLambda -f request.yamlrockset api:queryLambdas:executeQueryLambdaByTag -f request.yamlrockset api:queryLambdas:getQueryLambdaTagVersion WORKSPACE QUERYLAMBDA TAGrockset api:queryLambdas:getQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSIONrockset api:queryLambdas:listAllQueryLambdasrockset api:queryLambdas:listOrganizationTagsrockset api:queryLambdas:listQueryLambdaTagVersions TAGrockset api:queryLambdas:listQueryLambdaTags WORKSPACE QUERYLAMBDArockset api:queryLambdas:listQueryLambdaVersions WORKSPACE QUERYLAMBDArockset api:queryLambdas:listQueryLambdasInWorkspace WORKSPACErockset api:queryLambdas:updateQueryLambda -f request.yamlrockset api:users:createUser -f request.yamlrockset api:users:deleteUser USERrockset api:users:getCurrentUserrockset api:users:listUsersrockset api:workspaces:childWorkspaces WORKSPACErockset api:workspaces:createWorkspace -f request.yamlrockset api:workspaces:deleteWorkspace WORKSPACErockset api:workspaces:getWorkspace WORKSPACErockset api:workspaces:listWorkspacesrockset auth:add NAME APIKEY [APISERVER]rockset auth:delete NAMErockset auth:listrockset auth:use NAMErockset autocomplete [SHELL]rockset help [COMMAND]rockset local:deployrockset local:downloadrockset local:initrockset local:queryLambda:add NAMErockset local:queryLambda:delete NAMErockset local:queryLambda:execute NAMErockset local:queryLambda:listrockset local:resolve NAMErockset local:serverockset sql [SQL]rockset update [CHANNEL]rockset api:apikeys:createApiKey -f request.yamlCreate API Key
USAGE
$ rockset api:apikeys:createApiKey -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml]. Keys are
translated into arguments of the same name. If no BODY argument is specified, the whole
object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Create API Key
Create a new API key for the authenticated user.
Endpoint: POST: /v1/orgs/self/users/self/apikeys
Endpoint Documentation: https://docs.rockset.com/rest-api#createapikey
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/createApiKey.ts
rockset api:apikeys:createApiKeyAdmin -f request.yamlCreate API Key for any user (admin only)
USAGE
$ rockset api:apikeys:createApiKeyAdmin -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml]. Keys are
translated into arguments of the same name. If no BODY argument is specified, the whole
object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Create API Key for any user (admin only)
Create a new API key for any user (admin only).
Endpoint: POST: /v1/orgs/self/users/{user}/apikeys
Endpoint Documentation: https://docs.rockset.com/rest-api#createapikeyadmin
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/createApiKeyAdmin.ts
rockset api:apikeys:deleteApiKey NAMEDelete API Key
USAGE
$ rockset api:apikeys:deleteApiKey NAME
ARGUMENTS
NAME name of the API key
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete API Key
Delete an API key for the authenticated user.
Endpoint: DELETE: /v1/orgs/self/users/self/apikeys/{name}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteapikey
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/deleteApiKey.ts
rockset api:apikeys:deleteApiKeyAdmin NAME USERDelete API Key for any user (admin only)
USAGE
$ rockset api:apikeys:deleteApiKeyAdmin NAME USER
ARGUMENTS
NAME name of the API key
USER
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete API Key for any user (admin only)
Delete an API key for any user (admin only).
Endpoint: DELETE: /v1/orgs/self/users/{user}/apikeys/{name}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteapikeyadmin
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/deleteApiKeyAdmin.ts
rockset api:apikeys:listApiKeysList API Keys
USAGE
$ rockset api:apikeys:listApiKeys
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List API Keys
List all API keys for the authenticated user.
Endpoint: GET: /v1/orgs/self/users/self/apikeys
Endpoint Documentation: https://docs.rockset.com/rest-api#listapikeys
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/listApiKeys.ts
rockset api:apikeys:listApiKeysAdmin USERList API Keys for any user (admin only)
USAGE
$ rockset api:apikeys:listApiKeysAdmin USER
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List API Keys for any user (admin only)
List all API keys for any user (admin only).
Endpoint: GET: /v1/orgs/self/users/{user}/apikeys
Endpoint Documentation: https://docs.rockset.com/rest-api#listapikeysadmin
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/listApiKeysAdmin.ts
rockset api:collections:createCollection -f request.yamlCreate Collection
USAGE
$ rockset api:collections:createCollection -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml]. Keys are
translated into arguments of the same name. If no BODY argument is specified, the whole
object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Create Collection
Create new collection in a workspace.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/collections
Endpoint Documentation: https://docs.rockset.com/rest-api#createcollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/createCollection.ts
rockset api:collections:deleteCollection WORKSPACE COLLECTIONDelete Collection
USAGE
$ rockset api:collections:deleteCollection WORKSPACE COLLECTION
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete Collection
Delete a collection and all its documents from Rockset.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}/collections/{collection}
Endpoint Documentation: https://docs.rockset.com/rest-api#deletecollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/deleteCollection.ts
rockset api:collections:getCollection WORKSPACE COLLECTIONGet Collection
USAGE
$ rockset api:collections:getCollection WORKSPACE COLLECTION
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Get Collection
Get details about a collection.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/collections/{collection}
Endpoint Documentation: https://docs.rockset.com/rest-api#getcollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/getCollection.ts
rockset api:collections:listCollectionsList Collections
USAGE
$ rockset api:collections:listCollections
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Collections
Retrieve all collections in an organization.
Endpoint: GET: /v1/orgs/self/collections
Endpoint Documentation: https://docs.rockset.com/rest-api#listcollections
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/listCollections.ts
rockset api:collections:listQueryLambdasInCollection WORKSPACE COLLECTIONGet Query Lambdas
USAGE
$ rockset api:collections:listQueryLambdasInCollection WORKSPACE COLLECTION
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Get Query Lambdas
Get all Query Lambdas that hit a specific Rockset Collection.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/collections/{collection}/lambdas
Endpoint Documentation: https://docs.rockset.com/rest-api#listquerylambdasincollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/listQueryLambdasInCollection.ts
rockset api:collections:workspaceCollections WORKSPACEList Collections for Workspace
USAGE
$ rockset api:collections:workspaceCollections WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Collections for Workspace
Retrieve all collections in a workspace.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/collections
Endpoint Documentation: https://docs.rockset.com/rest-api#workspacecollections
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/workspaceCollections.ts
rockset api:documents:addDocuments -f request.yamlAdd Documents
USAGE
$ rockset api:documents:addDocuments -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Add Documents
Add documents to a collection in Rockset.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/collections/{collection}/docs
Endpoint Documentation: https://docs.rockset.com/rest-api#adddocuments
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/documents/addDocuments.ts
rockset api:documents:deleteDocumentsDelete Documents
USAGE
$ rockset api:documents:deleteDocuments
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete Documents
Delete documents from a collection in Rockset.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}/collections/{collection}/docs
Endpoint Documentation: https://docs.rockset.com/rest-api#deletedocuments
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/documents/deleteDocuments.ts
rockset api:documents:patchDocumentsPatch Documents
USAGE
$ rockset api:documents:patchDocuments
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Patch Documents
Patch documents in a collection
Endpoint: PATCH: /v1/orgs/self/ws/{workspace}/collections/{collection}/docs
Endpoint Documentation: https://docs.rockset.com/rest-api#patchdocuments
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/documents/patchDocuments.ts
rockset api:integrations:createIntegration -f request.yamlCreate Integration
USAGE
$ rockset api:integrations:createIntegration -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml]. Keys are
translated into arguments of the same name. If no BODY argument is specified, the whole
object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Create Integration
Create a new integration with Rockset.
Endpoint: POST: /v1/orgs/self/integrations
Endpoint Documentation: https://docs.rockset.com/rest-api#createintegration
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/integrations/createIntegration.ts
rockset api:integrations:deleteIntegration INTEGRATIONDelete Integration
USAGE
$ rockset api:integrations:deleteIntegration INTEGRATION
ARGUMENTS
INTEGRATION name of the integration
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete Integration
Remove an integration.
Endpoint: DELETE: /v1/orgs/self/integrations/{integration}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteintegration
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/integrations/deleteIntegration.ts
rockset api:integrations:getIntegration INTEGRATIONGet Integration
USAGE
$ rockset api:integrations:getIntegration INTEGRATION
ARGUMENTS
INTEGRATION name of the integration
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Get Integration
Get information about a single integration.
Endpoint: GET: /v1/orgs/self/integrations/{integration}
Endpoint Documentation: https://docs.rockset.com/rest-api#getintegration
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/integrations/getIntegration.ts
rockset api:integrations:listIntegrationsList Integrations
USAGE
$ rockset api:integrations:listIntegrations
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Integrations
List all integrations for organization.
Endpoint: GET: /v1/orgs/self/integrations
Endpoint Documentation: https://docs.rockset.com/rest-api#listintegrations
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/integrations/listIntegrations.ts
rockset api:orgs:getOrganizationGet Organization
USAGE
$ rockset api:orgs:getOrganization
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Get Organization
Retrieve information about current organization.
Endpoint: GET: /v1/orgs/self
Endpoint Documentation: https://docs.rockset.com/rest-api#getorganization
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/orgs/getOrganization.ts
rockset api:queries:query -f request.yamlQuery
USAGE
$ rockset api:queries:query -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Query
Make a SQL query to Rockset.
Endpoint: POST: /v1/orgs/self/queries
Endpoint Documentation: https://docs.rockset.com/rest-api#query
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queries/query.ts
rockset api:queryLambdas:createQueryLambda -f request.yamlCreate Query Lambda
USAGE
$ rockset api:queryLambdas:createQueryLambda -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Create Query Lambda
Create a Query Lambda in given workspace.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/lambdas
Endpoint Documentation: https://docs.rockset.com/rest-api#createquerylambda
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/createQueryLambda.ts
rockset api:queryLambdas:createQueryLambdaTag -f request.yamlCreate Query Lambda Tag
USAGE
$ rockset api:queryLambdas:createQueryLambdaTag -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Create Query Lambda Tag
Create a tag for a specific Query Lambda version, or update if it exists
Endpoint: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags
Endpoint Documentation: https://docs.rockset.com/rest-api#createquerylambdatag
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/createQueryLambdaTag.ts
rockset api:queryLambdas:deleteQueryLambda WORKSPACE QUERYLAMBDADelete Query Lambda
USAGE
$ rockset api:queryLambdas:deleteQueryLambda WORKSPACE QUERYLAMBDA
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete Query Lambda
Delete a Query Lambda.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}
Endpoint Documentation: https://docs.rockset.com/rest-api#deletequerylambda
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/deleteQueryLambda.ts
rockset api:queryLambdas:deleteQueryLambdaTag WORKSPACE QUERYLAMBDA TAGDelete Query Lambda Tag Version
USAGE
$ rockset api:queryLambdas:deleteQueryLambdaTag WORKSPACE QUERYLAMBDA TAG
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
TAG name of the tag
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete Query Lambda Tag Version
Delete a tag for a specific Query Lambda
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}
Endpoint Documentation: https://docs.rockset.com/rest-api#deletequerylambdatag
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/deleteQueryLambdaTag.ts
rockset api:queryLambdas:deleteQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSIONDelete Query Lambda Version
USAGE
$ rockset api:queryLambdas:deleteQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSION
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
VERSION version
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete Query Lambda Version
Delete a Query Lambda version.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/version/{version}
Endpoint Documentation: https://docs.rockset.com/rest-api#deletequerylambdaversion
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/deleteQueryLambdaVersion.ts
rockset api:queryLambdas:executeQueryLambda -f request.yamlRun Query Lambda
USAGE
$ rockset api:queryLambdas:executeQueryLambda -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Run Query Lambda
Run a particular version of a Query Lambda.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version}
Endpoint Documentation: https://docs.rockset.com/rest-api#executequerylambda
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/executeQueryLambda.ts
rockset api:queryLambdas:executeQueryLambdaByTag -f request.yamlRun Query Lambda By Tag
USAGE
$ rockset api:queryLambdas:executeQueryLambdaByTag -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Run Query Lambda By Tag
Run the Query Lambda version associated with a given tag.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}
Endpoint Documentation: https://docs.rockset.com/rest-api#executequerylambdabytag
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/executeQueryLambdaByTag.ts
rockset api:queryLambdas:getQueryLambdaTagVersion WORKSPACE QUERYLAMBDA TAGGet Query Lambda Tag
USAGE
$ rockset api:queryLambdas:getQueryLambdaTagVersion WORKSPACE QUERYLAMBDA TAG
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
TAG name of the tag
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Get Query Lambda Tag
Get the specific Query Lambda version associated with a given tag
Endpoint: GET: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag}
Endpoint Documentation: https://docs.rockset.com/rest-api#getquerylambdatagversion
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/getQueryLambdaTagVersion.ts
rockset api:queryLambdas:getQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSIONGet Query Lambda Version
USAGE
$ rockset api:queryLambdas:getQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSION
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
VERSION version
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Get Query Lambda Version
Get a specific version of a Query Lambda
Endpoint: GET: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version}
Endpoint Documentation: https://docs.rockset.com/rest-api#getquerylambdaversion
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/getQueryLambdaVersion.ts
rockset api:queryLambdas:listAllQueryLambdasList Query Lambdas
USAGE
$ rockset api:queryLambdas:listAllQueryLambdas
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Query Lambdas
List all Query Lambdas.
Endpoint: GET: /v1/orgs/self/lambdas
Endpoint Documentation: https://docs.rockset.com/rest-api#listallquerylambdas
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listAllQueryLambdas.ts
rockset api:queryLambdas:listOrganizationTagsList Query Lambda Tags
USAGE
$ rockset api:queryLambdas:listOrganizationTags
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Query Lambda Tags
List all tags in an organization
Endpoint: GET: /v1/orgs/self/lambdas/tags
Endpoint Documentation: https://docs.rockset.com/rest-api#listorganizationtags
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listOrganizationTags.ts
rockset api:queryLambdas:listQueryLambdaTagVersions TAGList Query Lambda Tag Versions
USAGE
$ rockset api:queryLambdas:listQueryLambdaTagVersions TAG
ARGUMENTS
TAG name of the tag
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Query Lambda Tag Versions
List all Query Lambda versions associated with a tag
Endpoint: GET: /v1/orgs/self/lambdas/tags/{tag}
Endpoint Documentation: https://docs.rockset.com/rest-api#listquerylambdatagversions
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listQueryLambdaTagVersions.ts
rockset api:queryLambdas:listQueryLambdaTags WORKSPACE QUERYLAMBDAList Query Lambda Tags
USAGE
$ rockset api:queryLambdas:listQueryLambdaTags WORKSPACE QUERYLAMBDA
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Query Lambda Tags
List all tags associated with a Query Lambda
Endpoint: GET: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags
Endpoint Documentation: https://docs.rockset.com/rest-api#listquerylambdatags
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listQueryLambdaTags.ts
rockset api:queryLambdas:listQueryLambdaVersions WORKSPACE QUERYLAMBDAList Query Lambda Versions
USAGE
$ rockset api:queryLambdas:listQueryLambdaVersions WORKSPACE QUERYLAMBDA
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Query Lambda Versions
List all versions of a Query Lambda.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions
Endpoint Documentation: https://docs.rockset.com/rest-api#listquerylambdaversions
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listQueryLambdaVersions.ts
rockset api:queryLambdas:listQueryLambdasInWorkspace WORKSPACEList Query Lambdas
USAGE
$ rockset api:queryLambdas:listQueryLambdasInWorkspace WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Query Lambdas
List all Query Lambdas under given workspace.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/lambdas
Endpoint Documentation: https://docs.rockset.com/rest-api#listquerylambdasinworkspace
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listQueryLambdasInWorkspace.ts
rockset api:queryLambdas:updateQueryLambda -f request.yamlUpdate Query Lambda
USAGE
$ rockset api:queryLambdas:updateQueryLambda -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml].
Keys are translated into arguments of the same name. If no BODY argument is specified,
the whole object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-l, --loadTestRps=loadTestRps If this flag is active, a load test will be conducted using this apicall. The value
passed to this flag determines how many requests per second will be sent
-x, --extended show extra columns
-y, --yes Skip all safety prompts
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Update Query Lambda
Create a new version of a Query Lambda in given workspace.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions
Endpoint Documentation: https://docs.rockset.com/rest-api#updatequerylambda
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/updateQueryLambda.ts
rockset api:users:createUser -f request.yamlCreate User
USAGE
$ rockset api:users:createUser -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml]. Keys are
translated into arguments of the same name. If no BODY argument is specified, the whole
object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Create User
Create a new user for an organization.
Endpoint: POST: /v1/orgs/self/users
Endpoint Documentation: https://docs.rockset.com/rest-api#createuser
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/users/createUser.ts
rockset api:users:deleteUser USERDelete User
USAGE
$ rockset api:users:deleteUser USER
ARGUMENTS
USER user email
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete User
Delete a user from an organization.
Endpoint: DELETE: /v1/orgs/self/users/{user}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteuser
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/users/deleteUser.ts
rockset api:users:getCurrentUserGet Current User
USAGE
$ rockset api:users:getCurrentUser
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Get Current User
Retrieve currently active user.
Endpoint: GET: /v1/orgs/self/users/self
Endpoint Documentation: https://docs.rockset.com/rest-api#getcurrentuser
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/users/getCurrentUser.ts
rockset api:users:listUsersList Users
USAGE
$ rockset api:users:listUsers
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Users
Retrieve all users for an organization.
Endpoint: GET: /v1/orgs/self/users
Endpoint Documentation: https://docs.rockset.com/rest-api#listusers
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/users/listUsers.ts
rockset api:workspaces:childWorkspaces WORKSPACEList Workspaces
USAGE
$ rockset api:workspaces:childWorkspaces WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Workspaces
List workspaces under given workspace.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/ws
Endpoint Documentation: https://docs.rockset.com/rest-api#childworkspaces
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/childWorkspaces.ts
rockset api:workspaces:createWorkspace -f request.yamlCreate Workspace
USAGE
$ rockset api:workspaces:createWorkspace -f request.yaml
OPTIONS
-f, --file=file (required) The config file to execute this command from. Format must be [json|yaml]. Keys are
translated into arguments of the same name. If no BODY argument is specified, the whole
object, minus keys used as other arguments, will be passed in as the BODY.
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Create Workspace
Create a new workspace in your org.
Endpoint: POST: /v1/orgs/self/ws
Endpoint Documentation: https://docs.rockset.com/rest-api#createworkspace
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/createWorkspace.ts
rockset api:workspaces:deleteWorkspace WORKSPACEDelete Workspace
USAGE
$ rockset api:workspaces:deleteWorkspace WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Delete Workspace
Remove a workspace.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteworkspace
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/deleteWorkspace.ts
rockset api:workspaces:getWorkspace WORKSPACEGet Workspace
USAGE
$ rockset api:workspaces:getWorkspace WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
Get Workspace
Get information about a single workspace.
Endpoint: GET: /v1/orgs/self/ws/{workspace}
Endpoint Documentation: https://docs.rockset.com/rest-api#getworkspace
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/getWorkspace.ts
rockset api:workspaces:listWorkspacesList Workspaces
USAGE
$ rockset api:workspaces:listWorkspaces
OPTIONS
-h, --help show CLI help
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--raw Show the raw output from the server, instead of grabbing the results. Usually used in
conjunction with --output=json
--sort=sort property to sort by (prepend '-' for descending)
DESCRIPTION
List Workspaces
List all workspaces.
Endpoint: GET: /v1/orgs/self/ws
Endpoint Documentation: https://docs.rockset.com/rest-api#listworkspaces
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/listWorkspaces.ts
rockset auth:add NAME APIKEY [APISERVER]Create a new profile with the specified name and apikey.
USAGE
$ rockset auth:add NAME APIKEY [APISERVER]
ARGUMENTS
NAME The name of the profile you wish to create.
APIKEY The apikey for your account
APISERVER [default: https://api.rs2.usw2.rockset.com] The url for the apiserver to include in this profile
OPTIONS
-a, --activate Whether to activate the profile after creating it
-h, --help show CLI help
DESCRIPTION
Create a new profile with the specified name and apikey.
See code: src/commands/auth/add.ts
rockset auth:delete NAMEDelete a profile with the specified name.
USAGE
$ rockset auth:delete NAME
ARGUMENTS
NAME The name of the profile you wish to delete.
OPTIONS
-h, --help show CLI help
DESCRIPTION
Delete a profile with the specified name.
See code: src/commands/auth/delete.ts
rockset auth:listList all of the available profiles.
USAGE
$ rockset auth:list
OPTIONS
-h, --help show CLI help
-s, --showKeys Uncensor all API Keys
DESCRIPTION
List all of the available profiles.
See code: src/commands/auth/list.ts
rockset auth:use NAMEUse a specific authentication profile.
USAGE
$ rockset auth:use NAME
ARGUMENTS
NAME The name of the profile you wish to use.
OPTIONS
-h, --help show CLI help
DESCRIPTION
Use a specific authentication profile.
See code: src/commands/auth/use.ts
rockset autocomplete [SHELL]display autocomplete installation instructions
USAGE
$ rockset autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ rockset autocomplete
$ rockset autocomplete bash
$ rockset autocomplete zsh
$ rockset autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
rockset help [COMMAND]display help for rockset
USAGE
$ rockset help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
rockset local:deployDeploy Query Lambda entities to Rockset from your local project.
USAGE
$ rockset local:deploy
OPTIONS
-h, --help show CLI help
-l, --lambda=lambda The qualified name of the lambda to
deploy
-t, --tag= Specify a tag name to be applied to these Query Lambda versions.
-w, --workspace=workspace The qualified name of the workspace to
deploy
--dryRun If this flag is set, the tool will print
out the names of the Query Lambdas it
would deploy and return
--failOnMissingWorkspace If a workspace does not exist in the
remote, the deploy will fail instead of
creating one
DESCRIPTION
Deploy Query Lambda entities to Rockset from your local project.
If a workspace parameter is passed, only that workspace will be deployed.
If a lambda parameter is passed, only that lambda will be deployed.
These two parameters are mutually exclusive, only one may be passed.
See code: src/commands/local/deploy.ts
rockset local:downloadDownload Query Lambda entities from Rockset to your local project.
USAGE
$ rockset local:download
OPTIONS
-h, --help show CLI help
-t, --tag=Specify a value to download all Query Lambda versions tagged with this tag.
Query Lambdas that do not have a version with this tag name will be skipped.
-y, --yes Bypass the safety checks, and
automatically engage in
dangerous actions.
DESCRIPTION
Download Query Lambda entities from Rockset to your local project.
See code: src/commands/local/download.ts
rockset local:initInitialize your project.
USAGE
$ rockset local:init
OPTIONS
-h, --help show CLI help
-y, --yes
DESCRIPTION
Initialize your project.
This command initializes your project with a rockset.config.json file.
See code: src/commands/local/init.ts
rockset local:queryLambda:add NAMEAdd an empty lambda with the specified name to the project
USAGE
$ rockset local:queryLambda:add NAME
ARGUMENTS
NAME The fully qualified name of the lambda you wish to add. A Qualified Name is a string formatted like
"{ws}.{name}".
OPTIONS
-d, --description=description Set the description for the new query lambda
-h, --help show CLI help
EXAMPLE
$ rockset local:queryLambda:add commons.helloWorld -d "my lambda"
Successfully added Query Lambda commons.helloWorld to path /Users/tchordia/rockset/src/commons/helloWorld.lambda.json
See code: src/commands/local/queryLambda/add.ts
rockset local:queryLambda:delete NAMEDelete a lambda with the specified name from the project
USAGE
$ rockset local:queryLambda:delete NAME
ARGUMENTS
NAME The fully qualified name of the lambda you wish to add. A Qualified Name is a string formatted like
"{ws}.{name}".
OPTIONS
-h, --help show CLI help
-y, --yes Bypass the safety checks, and automatically engage in dangerous actions.
EXAMPLE
$ rockset local:queryLambda:delete commons.foo
✔ WARNING: This operation will delete commons.foo, and all associated files in the current project, and can result in
a loss of work. Are you sure you would like to proceed? … no
See code: src/commands/local/queryLambda/delete.ts
rockset local:queryLambda:execute NAMEExecute a specific version of a Query Lambda in the current project.
USAGE
$ rockset local:queryLambda:execute NAME
ARGUMENTS
NAME The fully qualified name of the Query Lambda you wish to execute
OPTIONS
-h, --help show CLI help
-p, --parameters=parameters A JSON string of parameters to execute the query with.
DESCRIPTION
Execute a specific version of a Query Lambda in the current project.
You must specify the fully qualified name of the Query Lambda: eg. 'commons.foo'.
EXAMPLE
$ rockset local:queryLambda:execute commons.helloWorld
See code: src/commands/local/queryLambda/execute.ts
rockset local:queryLambda:listList all of the entities in the current project. Note: this does not list entities on remote. For that, please use
USAGE
$ rockset local:queryLambda:list
OPTIONS
-h, --help show CLI help
DESCRIPTION
List all of the entities in the current project. Note: this does not list entities on remote. For that, please use
the API endpoints present in 'rockset api:...'
See code: src/commands/local/queryLambda/list.ts
rockset local:resolve NAMEResolve the absolute path of an entity in the current project.
USAGE
$ rockset local:resolve NAME
ARGUMENTS
NAME The fully qualified name of the entity you wish to resolve
OPTIONS
-e, --entity=lambda|workspace [default: lambda] the type of entity you wish to resolve
-h, --help show CLI help
--[no-]exists Return with an error if file does not exist
--sql Return the SQL file path. Only for Query Lambdas.
DESCRIPTION
Resolve the absolute path of an entity in the current project.
You must specify the fully qualified name of the entity: eg. 'commons.foo'.
You must specify the type of entity that will be resolved.
See code: src/commands/local/resolve.ts
rockset local:serveStart a development server that allows you to execute Query Lambdas from your local project from a development UI.
USAGE
$ rockset local:serve
OPTIONS
-h, --help show CLI help
-p, --port=port [default: 3001] The port to start the server at
DESCRIPTION
Start a development server that allows you to execute Query Lambdas from your local project from a development UI.
See code: src/commands/local/serve.ts
rockset sql [SQL]execute a SQL expression
USAGE
$ rockset sql [SQL]
ARGUMENTS
SQL Rockset SQL string to execute
OPTIONS
-h, --help show CLI help
-l, --defaultLimit=defaultLimit Set the default row limit property on the query. This will set a default limit on the
query that can be overrided by a limit in the SQL text.
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
EXAMPLES
rockset sql "Select 'hello world'"
rockset sql
See code: src/commands/sql.ts
rockset update [CHANNEL]update the rockset CLI
USAGE
$ rockset update [CHANNEL]
See code: @oclif/plugin-update
FAQs
Official Rockset CLI
The npm package @rockset/cli receives a total of 235 weekly downloads. As such, @rockset/cli popularity was classified as not popular.
We found that @rockset/cli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.