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 <http://docs.rockset.com/cli> for more details.

Installation

The rock command-line tool is packaged as part of the Rockset Python client (Python 3.5+). 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

After installation, setup your API key and API server endpoint using the rock configure command.

Tip

You can generate your API key by logging into `Rockset Console`_. Your API server endpoint should also be shown in the same page that lists all your API keys.

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
  • Create Collection from AWS S3
  • Code Example

Python Client

• Usage
  • Example
• Connect
  • Usage
• Load Data
  • 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
• Query using Query Builder
  • Usage
  • Query Operators: Overview
  • Field Expressions Overview
  • Query Operator: Filters
  • Query Operator: Projection
  • Query Operator: Pagination
  • Query Operator: Sorting
  • Query Operator: Aggregation
  • Query Operator: Joins
  • Field Expression: Value Comparators
  • Field Expression: Boolean Compositions

Module Reference

• Client
• Collection
• Cursor
• Exceptions
  • Introduction
  • Authentication Errors
  • Input Errors
  • Limit Reached
  • Not Yet Implemented
  • Request Timeouts
  • Server Errors
  • Transient Server Errors
• F and FieldRef
• Limits
• Q and Query
• Source

Help

• Release Notes
• Support
  • Email
  • Slack Channel

Indices and tables

• Index
• Search Page