Overview

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.

Getting Started

• Overview
• Installation and Configuration
  • Installation
  • Configuration
• Quickstart
  • Code Example

Complete Reference

• Client Configuration
  • Usage
  • Reference
• Workspaces
  • Usage
  • Create a new workspace
  • List all workspaces
  • Retrieve an existing workspace
  • Drop a workspace
• Collections
  • 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
• Collection Sources
  • Introduction
  • Example usage
  • Create AWS S3 source for a collection
  • Reference
• Collection Field Mappings
  • Introduction
  • Example of basic field mapping
  • Example of field whitelisting
  • Reference
• Collection Aliases
  • Usage
  • Create a new alias
  • List all aliases
  • Retrieve an existing alias
  • Fetch the collections referenced by an alias
  • Update an alias
  • Drop an alias
• Query Lambdas
  • 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
• Python Query Builder
  • 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
• Cursor
  • Introduction
  • Fetch all results
  • Iterators with automatic pagination
  • Async requests
  • Reference
• Document
  • Introduction
  • Reference
• Limits
• Exceptions
  • Introduction
  • Authentication Errors
  • Input Errors
  • Limit Reached
  • Not Yet Implemented
  • Request Timeouts
  • Server Errors
  • Transient Server Errors

Help

• Release Notes
• Support
  • Live Chat
  • Email
  • Slack Channel

Indices and tables

• Index

• Search Page