Rockset Python Client

2.1.2 · abandoned · verified Thu Apr 16

The Rockset Python client (`rockset`) provides an SDK for interacting with the Rockset API, a real-time analytics database. It enables users to create and manage resources, execute queries, and handle data. However, as of June 2024, Rockset's public services were shut down following its acquisition by OpenAI, with its technology integrated into OpenAI's infrastructure. Consequently, this client library is no longer functional for public use and is preserved for archival purposes.

Common errors

```
ModuleNotFoundError: No module named 'rockset'
```
cause The `rockset` library is not installed in the current Python environment.

fix Run `pip install rockset` to install the library.
```
NameError: name 'Client' is not defined
```
cause Attempting to use the old client class name `Client` after upgrading to v1.0.0 or later, where it was renamed.

fix Change `Client` to `RocksetClient`. Ensure you import it with `from rockset import RocksetClient`.
```
rockset.ApiException: (401)
Reason: Unauthorized
```
cause The provided API key is invalid, missing, or lacks the necessary permissions, or the service is no longer available.

fix Verify that your `ROCKSET_API_KEY` is correct and has appropriate permissions. Given the service shutdown, this error is now expected.
```
TypeError: __init__() got an unexpected keyword argument 'api_server'
```
cause Attempting to use the old `api_server` parameter for host configuration with `RocksetClient` (v1.0.0+).

fix Replace `api_server` with `host`. Example: `RocksetClient(host=Regions.use1a1, api_key=...)`.

Warnings

breaking Rockset's public cloud service was shut down in June 2024 following its acquisition by OpenAI. The Python client library is no longer functional for connecting to a live Rockset service.
Fix: No direct fix; the underlying service is unavailable. The library is for archival/historical purposes.
breaking Migration from v0 to v1 of the client library introduced breaking changes. The main client class was renamed from `Client` to `RocksetClient`, the `api_server` parameter for specifying the API location was changed to `host`, and the query builder was deprecated. Some endpoints and parameters were also renamed.
Fix: Update client instantiation from `Client(api_server=...)` to `RocksetClient(host=...)`. Review endpoint and parameter names in the updated documentation for v1.
gotcha Users may encounter SSL errors when using the client, potentially due to Python installation issues.
Fix: Set environment variables: `CERT_PATH=$(python3 -m certifi); export SSL_CERT_FILE=${CERT_PATH}; export REQUESTS_CA_BUNDLE=${CERT_PATH}`. As a last resort, SSL verification can be disabled via `config.verify_ssl = False`, but this is not recommended for production.
gotcha When making requests, certain parameters often expect instances of `rockset.models` classes (e.g., `rockset.models.QueryRequestSql`). For brevity, you can often pass a dictionary instead of instantiating the model object directly.
Fix: Instead of `QueryRequestSql(sql='SELECT * FROM my_collection')`, use `{'sql': 'SELECT * FROM my_collection'}`.

Install

pip install rockset Install with pip

Imports

rockset
```
import rockset
```
RocksetClient
wrong:
```
from rockset import Client
```
correct:
```
from rockset import RocksetClient
```
The main client class was renamed from 'Client' to 'RocksetClient' in v1.0.0.
Regions
```
from rockset import Regions
```
Configuration
```
from rockset import Configuration
```

Quickstart

Initializes the Rockset client using an API key from an environment variable and attempts to list workspaces and create an API key. Note that this code will not function as Rockset's public services have been shut down.

import os
from rockset import RocksetClient, Regions, ApiException

# Rockset services were shut down in June 2024. This code is for archival/demonstration only.
# Ensure ROCKSET_API_KEY is set in your environment variables if attempting to run against a hypothetical Rockset instance.
api_key = os.environ.get('ROCKSET_API_KEY', 'YOUR_ROCKSET_API_KEY')
if api_key == 'YOUR_ROCKSET_API_KEY':
    print("WARNING: ROCKSET_API_KEY environment variable not set. Using placeholder.")

try:
    # Initialize the Rockset client
    # The host parameter replaced 'api_server' in v1.0.0
    rs = RocksetClient(host=Regions.use1a1, api_key=api_key)

    # Example: List workspaces
    print("Attempting to list workspaces...")
    workspaces = rs.Workspaces.list_all()
    print(f"Found {len(workspaces)} workspaces:")
    for ws in workspaces:
        print(f"- {ws.name}")

    # Example: Create an API key (demonstration, real usage should handle existing keys)
    # This operation will likely fail as the service is offline.
    try:
        new_api_key_name = "my-test-api-key"
        print(f"\nAttempting to create API key: {new_api_key_name}...")
        created_key = rs.APIKeys.create(name=new_api_key_name, role="member")
        print(f"Successfully created API key: {created_key.name}")
    except ApiException as e:
        print(f"Could not create API key (expected due to service shutdown): {e}")

except ApiException as e:
    print(f"An API error occurred: {e}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")

view raw JSON →