The python client for the Rockset API.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for rocksetinc from gravatar.com rocksetinc

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

Author: Rockset

Requires: Python >=3.6, <4.0

Classifiers

Project description

In progress

  • README postprocessing
  • polishing
  • QA
  • complete last part of async support

rockset

Rockset's REST API allows for creating and managing all resources in Rockset. Each supported endpoint is documented below.

All requests must be authorized with a Rockset API key, which can be created in the Rockset console. The API key must be provided as ApiKey <api_key> in the Authorization request header. For example:

Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT

All endpoints are only accessible via https.

Build something awesome!

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

Installation & Usage

pip install

Until the library is actually published in Pypi, you can install this client by running:

pip install ./dist/rockset-1.0.0-py3-none-any.whl

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import rockset

Getting Started

Please follow the installation procedure and then run the following:

import time
import rockset
from pprint import pprint
from rockset.api import api_keys_api
from rockset.model.create_api_key_request import CreateApiKeyRequest
from rockset.model.create_api_key_response import CreateApiKeyResponse
from rockset.model.delete_api_key_response import DeleteApiKeyResponse
from rockset.model.error_model import ErrorModel
from rockset.model.get_api_key_response import GetApiKeyResponse
from rockset.model.list_api_keys_response import ListApiKeysResponse
from rockset.model.update_api_key_request import UpdateApiKeyRequest
from rockset.model.update_api_key_response import UpdateApiKeyResponse

# Enter a context with an instance of the API client
# Defining the host is optional and defaults to https://api.rs2.usw2.rockset.com
with rockset.RocksetClient(host="https://api.rs2.usw2.rockset.com", apikey="APIKEY") as rs:
    try:
        rs.APIKeysApi.create_api_key(name="api-key-name", role="member")
    except rockset.ApiException as e:
        print("Exception when calling ApiKey->create_api_key: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.rs2.usw2.rockset.com

Class Method HTTP request Description
APIKeysApi create_api_key POST /v1/orgs/self/users/self/apikeys Create API Key
APIKeysApi delete_api_key DELETE /v1/orgs/self/users/{user}/apikeys/{name} Delete API Key
APIKeysApi get_api_key GET /v1/orgs/self/users/{user}/apikeys/{name} Retrieve API Key
APIKeysApi list_api_keys GET /v1/orgs/self/users/{user}/apikeys List API Keys
APIKeysApi update_api_key POST /v1/orgs/self/users/{user}/apikeys/{name} Update API Key State
AliasesApi create_alias POST /v1/orgs/self/ws/{workspace}/aliases Create Alias
AliasesApi delete_alias DELETE /v1/orgs/self/ws/{workspace}/aliases/{alias} Delete Alias
AliasesApi get_alias GET /v1/orgs/self/ws/{workspace}/aliases/{alias} Retrieve Alias
AliasesApi list_aliases GET /v1/orgs/self/aliases List Aliases
AliasesApi update_alias POST /v1/orgs/self/ws/{workspace}/aliases/{alias} Update Alias
AliasesApi workspace_aliases GET /v1/orgs/self/ws/{workspace}/aliases List Aliases in Workspace
CollectionsApi create_azure_blob_storage_collection POST /v1/orgs/self/ws/{workspace}/collections#AzureBlobStorage Create azure blob storage collection
CollectionsApi create_azure_event_hubs_collection POST /v1/orgs/self/ws/{workspace}/collections#AzureEventHubs Create azure event hubs collection
CollectionsApi create_azure_service_bus_collection POST /v1/orgs/self/ws/{workspace}/collections#AzureServiceBus Create azure service bus collection
CollectionsApi create_dynamodb_collection POST /v1/orgs/self/ws/{workspace}/collections#Dynamodb Create dynamodb collection
CollectionsApi create_file_upload_collection POST /v1/orgs/self/ws/{workspace}/collections#FileUpload Create file upload collection
CollectionsApi create_gcs_collection POST /v1/orgs/self/ws/{workspace}/collections#Gcs Create gcs collection
CollectionsApi create_kafka_collection POST /v1/orgs/self/ws/{workspace}/collections#Kafka Create kafka collection
CollectionsApi create_kinesis_collection POST /v1/orgs/self/ws/{workspace}/collections#Kinesis Create kinesis collection
CollectionsApi create_mongodb_collection POST /v1/orgs/self/ws/{workspace}/collections#Mongodb Create mongodb collection
CollectionsApi create_s3_collection POST /v1/orgs/self/ws/{workspace}/collections#S3 Create s3 collection
CollectionsApi delete_collection DELETE /v1/orgs/self/ws/{workspace}/collections/{collection} Delete Collection
CollectionsApi get_collection GET /v1/orgs/self/ws/{workspace}/collections/{collection} Retrieve Collection
CollectionsApi list_collections GET /v1/orgs/self/collections List Collections
CollectionsApi workspace_collections GET /v1/orgs/self/ws/{workspace}/collections List Collections in Workspace
CustomRolesBetaApi create_role POST /v1/orgs/self/roles Create a Role
CustomRolesBetaApi delete_role DELETE /v1/orgs/self/roles/{roleName} Delete a Role
CustomRolesBetaApi list_roles GET /v1/orgs/self/roles List Roles
CustomRolesBetaApi update_role POST /v1/orgs/self/roles/{roleName} Update a Role
DocumentsApi add_documents POST /v1/orgs/self/ws/{workspace}/collections/{collection}/docs Add Documents
DocumentsApi delete_documents DELETE /v1/orgs/self/ws/{workspace}/collections/{collection}/docs Delete Documents
DocumentsApi patch_documents PATCH /v1/orgs/self/ws/{workspace}/collections/{collection}/docs Patch Documents
IntegrationsApi create_azure_blob_storage_integration POST /v1/orgs/self/integrations#AzureBlobStorage Create azure blob storage integration
IntegrationsApi create_azure_event_hubs_integration POST /v1/orgs/self/integrations#AzureEventHubs Create azure event hubs integration
IntegrationsApi create_dynamodb_integration POST /v1/orgs/self/integrations#Dynamodb Create dynamodb integration
IntegrationsApi create_gcs_integration POST /v1/orgs/self/integrations#Gcs Create gcs integration
IntegrationsApi create_kafka_integration POST /v1/orgs/self/integrations#Kafka Create kafka integration
IntegrationsApi create_kinesis_integration POST /v1/orgs/self/integrations#Kinesis Create kinesis integration
IntegrationsApi create_mongodb_integration POST /v1/orgs/self/integrations#Mongodb Create mongodb integration
IntegrationsApi create_s3_integration POST /v1/orgs/self/integrations#S3 Create s3 integration
IntegrationsApi create_segment_integration POST /v1/orgs/self/integrations#Segment Create segment integration
IntegrationsApi delete_integration DELETE /v1/orgs/self/integrations/{integration} Delete Integration
IntegrationsApi get_integration GET /v1/orgs/self/integrations/{integration} Retrieve Integration
IntegrationsApi list_integrations GET /v1/orgs/self/integrations List Integrations
OrganizationsApi get_organization GET /v1/orgs/self Get Organization
QueriesApi query POST /v1/orgs/self/queries Query
QueriesApi validate POST /v1/orgs/self/queries/validations Validate Query
QueryLambdasApi create_query_lambda POST /v1/orgs/self/ws/{workspace}/lambdas Create Query Lambda
QueryLambdasApi create_query_lambda_tag POST /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags Create Query Lambda Tag
QueryLambdasApi delete_query_lambda DELETE /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda} Delete Query Lambda
QueryLambdasApi delete_query_lambda_tag DELETE /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag} Delete Query Lambda Tag Version
QueryLambdasApi delete_query_lambda_version DELETE /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/version/{version} Delete Query Lambda Version
QueryLambdasApi execute_query_lambda POST /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version} Execute Query Lambda By Version
QueryLambdasApi execute_query_lambda_by_tag POST /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag} Execute Query Lambda By Tag
QueryLambdasApi get_query_lambda_tag_version GET /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag} Retrieve Query Lambda Tag
QueryLambdasApi get_query_lambda_version GET /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version} Retrieve Query Lambda Version
QueryLambdasApi list_all_query_lambdas GET /v1/orgs/self/lambdas List Query Lambdas
QueryLambdasApi list_query_lambda_tags GET /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags List Query Lambda Tags
QueryLambdasApi list_query_lambda_versions GET /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions List Query Lambda Versions
QueryLambdasApi list_query_lambdas_in_workspace GET /v1/orgs/self/ws/{workspace}/lambdas List Query Lambdas in Workspace
QueryLambdasApi update_query_lambda POST /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions Update Query Lambda
UsersApi create_user POST /v1/orgs/self/users Create User
UsersApi delete_user DELETE /v1/orgs/self/users/{user} Delete User
UsersApi get_current_user GET /v1/orgs/self/users/self Retrieve Current User
UsersApi get_user GET /v1/orgs/self/users/{user} Retrieve User
UsersApi list_unsubscribe_preferences GET /v1/orgs/self/users/self/preferences Retrieve Notification Preferences
UsersApi list_users GET /v1/orgs/self/users List Users
UsersApi update_unsubscribe_preferences POST /v1/orgs/self/users/self/preferences Update Notification Preferences
ViewsApi create_view POST /v1/orgs/self/ws/{workspace}/views Create View
ViewsApi delete_view DELETE /v1/orgs/self/ws/{workspace}/views/{view} Delete View
ViewsApi get_view GET /v1/orgs/self/ws/{workspace}/views/{view} Retrieve View
ViewsApi list_views GET /v1/orgs/self/views List Views
ViewsApi update_view POST /v1/orgs/self/ws/{workspace}/views/{view} Update View
ViewsApi workspace_views GET /v1/orgs/self/ws/{workspace}/views List Views in Workspace
VirtualInstancesApi get_virtual_instance GET /v1/orgs/self/virtualinstances/{virtualInstanceId} Retrieve Virtual Instance
VirtualInstancesApi list_virtual_instances GET /v1/orgs/self/virtualinstances List Virtual Instances
VirtualInstancesApi set_virtual_instance POST /v1/orgs/self/virtualinstances/{virtualInstanceId} Update Virtual Instance
WorkspacesApi child_workspaces GET /v1/orgs/self/ws/{workspace}/ws List Workspaces in Workspace
WorkspacesApi create_workspace POST /v1/orgs/self/ws Create Workspace
WorkspacesApi delete_workspace DELETE /v1/orgs/self/ws/{workspace} Delete Workspace
WorkspacesApi get_workspace GET /v1/orgs/self/ws/{workspace} Retrieve Workspace
WorkspacesApi list_workspaces GET /v1/orgs/self/ws List Workspaces

Documentation For Models

Documentation For Authorization

The RocksetClient object must be instantiated with an apikey. You can create your first apikey in the Rockset console. The provided apikey will be used for all requests that are made using the instance of the client.

Author

Rockset

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in rockset.apis and rockset.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from rockset.api.default_api import DefaultApi
  • from rockset.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import rockset
from rockset.apis import *
from rockset.models import *

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for rocksetinc from gravatar.com rocksetinc

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

Author: Rockset

Requires: Python >=3.6, <4.0

Classifiers

Release history Release notifications | RSS feed

0.1.13

0.1.12

0.1.11

0.1.10

0.1.9

0.1.8

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.12

0.0.11

0.0.10

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

This version

0.0.2

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rockset-v2-alpha-0.0.2.tar.gz (217.6 kB view hashes)

Uploaded Source

Built Distribution

rockset_v2_alpha-0.0.2-py3-none-any.whl (960.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page