Quickstart

This document will help you get started with the Rockset Python Client.

Rockset’s entire Python Client is contained within a single Python module called rockset.

APIs defined in the rockset module allow you to:

1. Securely connect to the Rockset service

2. Create, manage and administer collections

3. Load data into collections

4. Issue queries against collections

In addition, the Python Client SDK also provides a command line utility called rock. See rock CLI documentation for more details.

Installation

Rockset Python client (Python 3.5+) along with the rock CLI tool is contained within a single module called rockset. You can install it using pip3 as follows on all popular Linux, OS X and Windows platforms:

sudo pip3 install rockset

If you have an older version already installed, run with --upgrade as follows:

sudo pip3 install --upgrade rockset

Tip

If you are running into issues with the above command, please ensure that you are not missing depedendent packages that are required in your system.

Instructions to install dependent packages on various plaforms are listed below:

• Ubuntu

Configuration

In order to use Rockset Python Client, you will need to create an API Key using Rockset Console.

Once you have your API key and your API server endpoint, you can start using the Python Client as follows:

from rockset import Client
rs = Client(api_server='api.rs2.usw2.rockset.com',
            api_key='rsJKatr23akr52lu3mte_007rEcT42uwm914orc_FBcdD')

You can also setup your API key and API server in your environment using the rock configure command, so that you don’t have to pass it explicity in your Python program or notebook.

When rock configure is run the first time, you should get a prompt to enter your API key and API server as shown below. The specified API key and API server will be added to your default profile. Run rock configure --help to see more information on how to create multiple API key profiles and switch between those:

$ rock configure
Enter Rockset API key
  API Key [None]: rsJKatr23akr52lu3mte_007rEcT42uwm914orc_FBcdD
Enter Rockset API server hostname or IP address
  API Server [https://api.rs2.usw2.rockset.com]: api.rs2.usw2.rockset.com
PROFILE     API_SERVER                 API_KEY
* default   api.rs2.usw2.rockset.com   rsJK**********BcdD
Credentials stored in /Users/veeve/.rockset/credentials

Once your API key is setup, all subsequent rock commands and calls from your Python program or notebook will automatically use those credentials. So, you can start using the Python client simply as:

#!/usr/bin/python3

# connect to rockset and list all collections
from rockset import Client
rs = Client()
print([vars(c) for c in rs.Collection.list()])

Happy hacking!

Getting Started

• Quickstart
• Examples
  • Create First Collection
  • Use Python Query Builder
  • Code Example

Module Reference

• Client
  • Usage
  • Reference
• Collection
  • Usage
  • Create a new collection
  • List all collections
  • Retrieve an existing collection
  • Describe an existing collection
  • Drop a collection
  • Add documents to a collection
  • Delete documents from a collection
  • Reference
• Field Mappings
  • Introduction
  • Example of basic field mapping
  • Example of field whitelisting
  • Reference
• Cursor
  • Introduction
  • Fetch all results
  • Iterators with automatic pagination
  • Async requests
  • Reference
• Document
  • Introduction
  • Reference
• Exceptions
  • Introduction
  • Authentication Errors
  • Input Errors
  • Limit Reached
  • Not Yet Implemented
  • Request Timeouts
  • Server Errors
  • Transient Server Errors
• Limits
• Q for Query and F for FieldRef
  • Usage
  • Query Operators: Overview
  • Query Operator: Filters
  • Query Operator: Projection
  • Query Operator: Pagination
  • Query Operator: Sorting
  • Query Operator: JOINs
  • Query Operator: Unnest - to expand nested array fields
  • Query Operator: Aggregation
  • Field Expressions Overview
  • Field Expression: Value Comparators
  • Field Expression: Boolean Compositions
  • Field Expression: Array operators
  • Reference for Q and Query
  • Reference for F and FieldRef
• Query Lambda
  • Usage
  • Create a new Query Lambda
  • List all Query Lambdas
  • Retrieve an existing Query Lambda version by a given tag
  • Retrieve an existing Query Lambda version
  • Describe an existing Query Lambda version
  • Execute a specific Query Lambda version
  • Update a Query Lambda by creating a new version
  • Tag a version of a Query Lambda
  • List all versions of a Query Lambda
  • Drop Query Lambda along with all previous versions
• Source
  • Introduction
  • Example usage
  • Create AWS S3 source for a collection
  • Reference
• Workspace
  • Usage
  • Create a new workspace
  • List all workspaces
  • Retrieve an existing workspace
  • Drop a workspace

Help

• Release Notes
• Support
  • Email
  • Slack Channel

Indices and tables

• Index

• Search Page