Skip to content

Commit

Permalink
Update for API changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
jhochmuth committed Feb 15, 2023
1 parent 40da63f commit 52f63e8
Show file tree
Hide file tree
Showing 41 changed files with 1,231 additions and 54 deletions.
9 changes: 9 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ docs/Cluster.md
docs/Collection.md
docs/CollectionMount.md
docs/CollectionMountResponse.md
docs/CollectionMountStats.md
docs/CollectionStats.md
docs/CollectionsApi.md
docs/CreateAliasRequest.md
docs/CreateAliasResponse.md
docs/CreateApiKeyRequest.md
docs/CreateApiKeyResponse.md
docs/CreateCollectionMountRequest.md
docs/CreateCollectionMountsResponse.md
docs/CreateCollectionRequest.md
docs/CreateCollectionResponse.md
docs/CreateIntegrationRequest.md
Expand Down Expand Up @@ -69,6 +71,7 @@ docs/DynamodbIntegrationCreationRequest.md
docs/DynamodbSourceWrapper.md
docs/ErrorModel.md
docs/EventTimeInfo.md
docs/ExecutePublicQueryLambdaRequest.md
docs/ExecuteQueryLambdaRequest.md
docs/FieldMappingQuery.md
docs/FieldMappingV2.md
Expand Down Expand Up @@ -257,12 +260,14 @@ rockset/model/cluster.py
rockset/model/collection.py
rockset/model/collection_mount.py
rockset/model/collection_mount_response.py
rockset/model/collection_mount_stats.py
rockset/model/collection_stats.py
rockset/model/create_alias_request.py
rockset/model/create_alias_response.py
rockset/model/create_api_key_request.py
rockset/model/create_api_key_response.py
rockset/model/create_collection_mount_request.py
rockset/model/create_collection_mounts_response.py
rockset/model/create_collection_request.py
rockset/model/create_collection_response.py
rockset/model/create_integration_request.py
Expand Down Expand Up @@ -298,6 +303,7 @@ rockset/model/dynamodb_integration_creation_request.py
rockset/model/dynamodb_source_wrapper.py
rockset/model/error_model.py
rockset/model/event_time_info.py
rockset/model/execute_public_query_lambda_request.py
rockset/model/execute_query_lambda_request.py
rockset/model/field_mapping_query.py
rockset/model/field_mapping_v2.py
Expand Down Expand Up @@ -461,13 +467,15 @@ test/test_cluster.py
test/test_collection.py
test/test_collection_mount.py
test/test_collection_mount_response.py
test/test_collection_mount_stats.py
test/test_collection_stats.py
test/test_collections_api.py
test/test_create_alias_request.py
test/test_create_alias_response.py
test/test_create_api_key_request.py
test/test_create_api_key_response.py
test/test_create_collection_mount_request.py
test/test_create_collection_mounts_response.py
test/test_create_collection_request.py
test/test_create_collection_response.py
test/test_create_integration_request.py
Expand Down Expand Up @@ -505,6 +513,7 @@ test/test_dynamodb_integration_creation_request.py
test/test_dynamodb_source_wrapper.py
test/test_error_model.py
test/test_event_time_info.py
test/test_execute_public_query_lambda_request.py
test/test_execute_query_lambda_request.py
test/test_field_mapping_query.py
test/test_field_mapping_v2.py
Expand Down
4 changes: 4 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### v1.0.5
- New api changes
- Issue with mount response fixed (was actually an issue with the API) https://github.com/rockset/rockset-python-client/issues/2

### v1.0.4
- Enum added for usw2a1

Expand Down
3 changes: 3 additions & 0 deletions docs/BulkStats.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,19 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data_downloaded_bytes** | **int** | Size in bytes of documents downloaded from source during an ongoing or completed bulk ingest. This includes documents that are dropped and reingested. | [optional]
**data_indexed_bytes** | **int** | Size in bytes of documents indexed. This is the total size of documents after transformations and dropping before indexes are built. | [optional]
**data_indexed_throughput_bytes** | **float** | Throughput of documents indexed in the last minute measured in bytes/s. This is based off the data_indexed_bytes size. Throughput during the download stage is shown on a per-source granularity in the sources field of the Collection response. | [optional]
**documents_downloaded** | **int** | Number of documents downloaded from source during an ongoing or completed bulk ingest. This includes documents that are dropped and reingested. | [optional]
**download_compute_ms** | **int** | Bulk ingest compute units in milliseconds used for downloading documents. | [optional]
**downloading_stage_done_at** | **str** | ISO-8601 date of when the downloading stage was completed. | [optional]
**finalizing_stage_done_at** | **str** | ISO-8601 date of when the finalizing stage was completed. | [optional]
**index_compute_ms** | **int** | Bulk ingest compute units in milliseconds used for indexing documents. | [optional]
**indexing_stage_done_at** | **str** | ISO-8601 date of when the indexing stage was completed. | [optional]
**initializing_stage_done_at** | **str** | ISO-8601 date of when the initializing stage was completed. | [optional]
**pre_index_size_bytes** | **int** | Size in bytes of documents before being indexed. This is the total size of documents after decompression, transformations, and dropping. This is equal to data_indexed_bytes after the indexing stage is done unless there are retries during indexing the data. | [optional]
**provisioning_stage_done_at** | **str** | ISO-8601 date of when the provisioning stage was completed. | [optional]
**started_at** | **str** | ISO-8601 date of when the bulk ingest was started. | [optional]
**total_index_size_bytes** | **int** | Total size of indexes after the completed bulk ingest. This is the same as collection size. | [optional]
**transformation_compute_ms** | **int** | Bulk ingest compute units in milliseconds used for ingest transformation. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
1 change: 1 addition & 0 deletions docs/CollectionMount.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**rrn** | **str** | Mount RRN. | [optional]
**snapshot_expiration_time_millis** | **int** | Time in millis at which the snapshot expires. | [optional]
**state** | **str** | Mount type. | [optional]
**stats** | [**CollectionMountStats**](CollectionMountStats.md) | | [optional]
**type** | **str** | Mount type. | [optional]
**virtual_instance_id** | **str** | Virtual instance ID. | [optional]
**virtual_instance_rrn** | **str** | Virtual Instance RRN. | [optional]
Expand Down
12 changes: 12 additions & 0 deletions docs/CollectionMountStats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CollectionMountStats


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**last_queried_ms** | **int** | Milliseconds since Unix epoch Jan 1, 1970. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/CreateCollectionMountsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CreateCollectionMountsResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**[CollectionMount]**](CollectionMount.md) | Mounts created. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 2 additions & 0 deletions docs/CreateUserRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | User email, must be unique. |
**roles** | **[str]** | List of roles for a given user. |
**first_name** | **str** | User first name. | [optional]
**last_name** | **str** | User last name. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
14 changes: 14 additions & 0 deletions docs/ExecutePublicQueryLambdaRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ExecutePublicQueryLambdaRequest


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**default_row_limit** | **int** | Row limit to use if no limit specified in the SQL query text. | [optional]
**generate_warnings** | **bool** | Whether to generate warnings. | [optional]
**parameters** | [**[QueryParameter]**](QueryParameter.md) | List of named parameters. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


9 changes: 5 additions & 4 deletions docs/QueriesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ Name | Type | Description | Notes
**query_id** | **str** | |
**cursor** | **str** | Cursor to current page. If unset, will default to the first page. | [optional]
**docs** | **int** | Number of documents to fetch. | [optional]
**offset** | **int** | Offset from the cursor of the first document to be returned | [optional]

### Return type

Expand Down Expand Up @@ -377,7 +378,7 @@ rs = RocksetClient(api_key="abc123", host=Regions.use1a1)
api_response = rs.Queries.query(
sql=QueryRequestSql(
default_row_limit=1,
generate_warnings=True,
generate_warnings=False,
initial_paginate_response_doc_count=1,
paginate=True,
parameters=[
Expand Down Expand Up @@ -406,7 +407,7 @@ api_response = await rs.Queries.query(
),
sql=QueryRequestSql(
default_row_limit=1,
generate_warnings=True,
generate_warnings=False,
initial_paginate_response_doc_count=1,
paginate=True,
parameters=[
Expand Down Expand Up @@ -495,7 +496,7 @@ rs = RocksetClient(api_key="abc123", host=Regions.use1a1)
api_response = rs.Queries.validate(
sql=QueryRequestSql(
default_row_limit=1,
generate_warnings=True,
generate_warnings=False,
initial_paginate_response_doc_count=1,
paginate=True,
parameters=[
Expand Down Expand Up @@ -524,7 +525,7 @@ api_response = await rs.Queries.validate(
),
sql=QueryRequestSql(
default_row_limit=1,
generate_warnings=True,
generate_warnings=False,
initial_paginate_response_doc_count=1,
paginate=True,
parameters=[
Expand Down
2 changes: 1 addition & 1 deletion docs/QueryRequestSql.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**default_row_limit** | **int** | Row limit to use. Limits specified in the query text will override this default. | [optional]
**generate_warnings** | **bool** | Flag to enable warnings. Warnings can help debug query issues but negatively affect performance. | [optional]
**initial_paginate_response_doc_count** | **int** | Number of documents to return in addition to paginating for this query call. Only relevant if `paginate` flag is also set. | [optional]
**paginate** | **bool** | Flag to paginate and store the results of this query for later / sequential retrieval. | [optional]
**paginate** | **bool** | Flag to paginate and store the results of this query for later sequential retrieval. | [optional]
**parameters** | [**[QueryParameter]**](QueryParameter.md) | List of named parameters. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

Expand Down
22 changes: 13 additions & 9 deletions docs/SharedLambdasApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ All URIs are relative to *https://api.use1a1.rockset.com* or the apiserver provi

Method | HTTP request | Description
------------- | ------------- | -------------
[**execute_public_query_lambda**](SharedLambdasApi.md#execute_public_query_lambda) | **GET** /v1/public/shared_lambdas/{public_access_id} | Execute a Public Query Lambda
[**execute_public_query_lambda_with_params**](SharedLambdasApi.md#execute_public_query_lambda_with_params) | **POST** /v1/public/shared_lambdas/{public_access_id} | Execute a Public Query Lambda


# **execute_public_query_lambda**
> QueryResponse execute_public_query_lambda(public_access_id)
# **execute_public_query_lambda_with_params**
> QueryResponse execute_public_query_lambda_with_params(public_access_id)
Execute a Public Query Lambda

Execute a public query lambda.
Execute a public query lambda (full version).

### Example

Expand All @@ -28,23 +28,23 @@ rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Execute a Public Query Lambda
api_response = rs.SharedLambdas.execute_public_query_lambda(
api_response = rs.SharedLambdas.execute_public_query_lambda_with_params(
public_access_id="public_access_id_example",
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
# print("Exception when calling SharedLambdas->execute_public_query_lambda: %s\n" % e)
# print("Exception when calling SharedLambdas->execute_public_query_lambda_with_params: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Execute a Public Query Lambda
api_response = await rs.SharedLambdas.execute_public_query_lambda(
api_response = await rs.SharedLambdas.execute_public_query_lambda_with_params(
public_access_id="public_access_id_example",
async_req=True,
)
if isinstance(api_response, rockset.ApiException):
print("Exception when calling SharedLambdas->execute_public_query_lambda: %s\n" % e)
print("Exception when calling SharedLambdas->execute_public_query_lambda_with_params: %s\n" % e)
return
pprint(api_response)

Expand All @@ -56,6 +56,10 @@ pprint(api_response)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**public_access_id** | **str** | public access ID of the query lambda |
**default_row_limit** | **int** | Row limit to use if no limit specified in the SQL query text. | [optional]
**generate_warnings** | **bool** | Whether to generate warnings. | [optional]
**parameters** | [**[QueryParameter]**](QueryParameter.md) | List of named parameters. | [optional]


### Return type

Expand All @@ -68,7 +72,7 @@ All requests must use apikeys for [authorization](../README.md#Documentation-For

### HTTP request headers

- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/json


Expand Down
1 change: 1 addition & 0 deletions docs/Status.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detected_size_bytes** | **int** | Size in bytes detected for the source at collection initialization. This size can be 0 or null for event stream sources. | [optional]
**last_processed_at** | **str** | ISO-8601 date when source was last processed. | [optional]
**last_processed_item** | **str** | Last source item processed by ingester. | [optional]
**message** | **str** | State message. | [optional]
Expand Down
4 changes: 4 additions & 0 deletions docs/UsersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ pprint(api_response)
# Create User
api_response = await rs.Users.create(
email="[email protected]",
first_name="John",
last_name="Doe",
roles=["admin","member","read-only"],
async_req=True,
)
Expand All @@ -65,6 +67,8 @@ pprint(api_response)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**email** | **str** | User email, must be unique. |
**first_name** | **str** | User first name. | [optional]
**last_name** | **str** | User last name. | [optional]
**roles** | **[str]** | List of roles for a given user. | [optional]

### Return type
Expand Down
8 changes: 4 additions & 4 deletions docs/VirtualInstancesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ All requests must use apikeys for [authorization](../README.md#Documentation-For
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **mount_collection**
> CollectionMountResponse mount_collection(virtual_instance_id, create_collection_mount_request)
> CreateCollectionMountsResponse mount_collection(virtual_instance_id, create_collection_mount_request)
Mount Collection

Expand Down Expand Up @@ -681,7 +681,7 @@ Name | Type | Description | Notes

### Return type

[**CollectionMountResponse**](CollectionMountResponse.md)
[**CreateCollectionMountsResponse**](CreateCollectionMountsResponse.md)

### Authorization

Expand Down Expand Up @@ -740,7 +740,7 @@ api_response = rs.VirtualInstances.query_virtual_instance(
virtual_instance_id="virtualInstanceId_example",
sql=QueryRequestSql(
default_row_limit=1,
generate_warnings=True,
generate_warnings=False,
initial_paginate_response_doc_count=1,
paginate=True,
parameters=[
Expand Down Expand Up @@ -770,7 +770,7 @@ api_response = await rs.VirtualInstances.query_virtual_instance(
),
sql=QueryRequestSql(
default_row_limit=1,
generate_warnings=True,
generate_warnings=False,
initial_paginate_response_doc_count=1,
paginate=True,
parameters=[
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "rockset"
version = "1.0.4"
version = "1.0.5"
description = "The python client for the Rockset API."
authors = ["Rockset <[email protected]>"]
packages = [
Expand Down
Loading

0 comments on commit 52f63e8

Please sign in to comment.