rockset-go-client: github.com/rockset/rockset-go-client/lib/go Index | Files

package rockset

import "github.com/rockset/rockset-go-client/lib/go"

Index

Package Files

api_api_keys.go api_collections.go api_documents.go api_integrations.go api_organizations.go api_queries.go api_query_lambdas.go api_users.go api_workspaces.go client.go configuration.go model_add_documents_request.go model_add_documents_response.go model_api_key.go model_aws_access_key.go model_aws_external_id_integration.go model_aws_key_integration.go model_aws_role.go model_collection.go model_collection_stats.go model_commit_mark.go model_commit_mark_positions.go model_create_api_key_request.go model_create_api_key_response.go model_create_collection_request.go model_create_collection_response.go model_create_integration_request.go model_create_integration_response.go model_create_query_lambda_request.go model_create_query_lambda_response.go model_create_query_lambda_tag_request.go model_create_saved_query_request.go model_create_saved_query_response.go model_create_user_request.go model_create_user_response.go model_create_workspace_request.go model_create_workspace_response.go model_csv_params.go model_delete_api_key_response.go model_delete_collection_response.go model_delete_documents_request.go model_delete_documents_request_data.go model_delete_documents_response.go model_delete_integration_response.go model_delete_query_lambda_response.go model_delete_saved_query_response.go model_delete_user_response.go model_delete_workspace_response.go model_document_status.go model_dynamodb_integration.go model_error_model.go model_error_model_context.go model_event_time_info.go model_execute_query_lambda_request.go model_execute_saved_query_parameter.go model_execute_saved_query_request.go model_field_mapping.go model_field_mapping_v2.go model_field_mask.go model_field_mask_mask.go model_format_params.go model_gcp_service_account.go model_gcs_integration.go model_get_collection_response.go model_get_integration_response.go model_get_query_lambda_response.go model_get_saved_query_response.go model_get_workspace_response.go model_input_field.go model_integration.go model_kafka_integration.go model_kinesis_integration.go model_list_api_keys_response.go model_list_collections_response.go model_list_integrations_response.go model_list_query_lambda_tags_response.go model_list_query_lambda_versions_response.go model_list_query_lambdas_response.go model_list_saved_queries_response.go model_list_users_response.go model_list_workspaces_response.go model_mongo_db_integration.go model_operator_stats.go model_org_membership.go model_organization.go model_organization_response.go model_output_field.go model_patch_document.go model_patch_documents_request.go model_patch_documents_response.go model_patch_operation.go model_query_error.go model_query_field_type.go model_query_lambda.go model_query_lambda_sql.go model_query_lambda_stats.go model_query_lambda_tag.go model_query_lambda_tag_response.go model_query_lambda_version.go model_query_lambda_version_response.go model_query_parameter.go model_query_request.go model_query_request_sql.go model_query_response.go model_query_response_stats.go model_redshift_integration.go model_resource.go model_resource_stats.go model_response.go model_s3_integration.go model_saved_query.go model_saved_query_parameter.go model_saved_query_stats.go model_segment_integration.go model_source.go model_source_dynamo_db.go model_source_file_upload.go model_source_gcs.go model_source_kafka.go model_source_kinesis.go model_source_mongo_db.go model_source_redshift.go model_source_s3.go model_sql_expression.go model_status.go model_status_dynamo_db.go model_status_kafka.go model_status_kafka_partition.go model_status_mongo_db.go model_update_query_lambda_request.go model_update_query_lambda_response.go model_update_saved_query_request.go model_update_saved_query_response.go model_user.go model_validate_query_response.go model_workspace.go model_xml_params.go response.go

Variables

var (
    // ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
    ContextOAuth2 = contextKey("token")

    // ContextBasicAuth takes BasicAuth as authentication for the request.
    ContextBasicAuth = contextKey("basic")

    // ContextAccessToken takes a string oauth2 access token as authentication for the request.
    ContextAccessToken = contextKey("accesstoken")

    // ContextAPIKey takes an APIKey as authentication for the request
    ContextAPIKey = contextKey("apikey")
)

func CacheExpires Uses

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

type APIClient Uses

type APIClient struct {
    // contains filtered or unexported fields
}

APIClient manages communication with the REST API API vv1 In most cases there should be only one, shared, APIClient.

func ApiClient Uses

func ApiClient(cfg *Configuration, apiKey string) *APIClient

Client creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath Uses

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey Uses

type APIKey struct {
    Key    string
    Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse Uses

type APIResponse struct {
    *http.Response `json:"-"`
    Message        string `json:"message,omitempty"`
    // Operation is the name of the swagger operation.
    Operation string `json:"operation,omitempty"`
    // RequestURL is the request URL. This value is always available, even if the
    // embedded *http.Response is nil.
    RequestURL string `json:"url,omitempty"`
    // Method is the HTTP method used for the request.  This value is always
    // available, even if the embedded *http.Response is nil.
    Method string `json:"method,omitempty"`
    // Payload holds the contents of the response body (which may be nil or empty).
    // This is provided here as the raw response.Body() reader will have already
    // been drained.
    Payload []byte `json:"-"`
}

func NewAPIResponse Uses

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError Uses

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddDocumentsRequest Uses

type AddDocumentsRequest struct {
    // Array of JSON documents
    Data []interface{} `json:"data"`
}

func (AddDocumentsRequest) PrintResponse Uses

func (m AddDocumentsRequest) PrintResponse()

type AddDocumentsResponse Uses

type AddDocumentsResponse struct {
    // information about the added documents
    Data []DocumentStatus `json:"data,omitempty"`
}

func (AddDocumentsResponse) PrintResponse Uses

func (m AddDocumentsResponse) PrintResponse()

type ApiKey Uses

type ApiKey struct {
    // ISO-8601 date
    CreatedAt string `json:"created_at,omitempty"`
    // descriptive label
    Name string `json:"name"`
    // string of 64 alphanumeric characters
    Key string `json:"key"`
    // ISO-8601 date
    LastAccessTime string `json:"last_access_time,omitempty"`
}

API keys are used to authenticate requests to Rockset's API. An API key is tied to the user who creates it. A new API key can be created for each use case, with a maximum of 10 API keys per user.

func (ApiKey) PrintResponse Uses

func (m ApiKey) PrintResponse()

type ApiKeysApiService Uses

type ApiKeysApiService Service

func (*ApiKeysApiService) Create Uses

func (a *ApiKeysApiService) Create(body CreateApiKeyRequest) (CreateApiKeyResponse, *http.Response, error)

ApiKeysApiService Create API Key Create a new API key for the authenticated user.

* @param body JSON object

@return CreateApiKeyResponse

func (*ApiKeysApiService) CreateStream Uses

func (a *ApiKeysApiService) CreateStream(body CreateApiKeyRequest) (string, *http.Response, error)

func (*ApiKeysApiService) Create_1 Uses

func (a *ApiKeysApiService) Create_1(body CreateApiKeyRequest, user string) (CreateApiKeyResponse, *http.Response, error)

ApiKeysApiService Create API Key for any user (admin only) Create a new API key for any user (admin only).

* @param body JSON object
* @param user

@return CreateApiKeyResponse

func (*ApiKeysApiService) Create_1Stream Uses

func (a *ApiKeysApiService) Create_1Stream(body CreateApiKeyRequest, user string) (string, *http.Response, error)

func (*ApiKeysApiService) Delete Uses

func (a *ApiKeysApiService) Delete(name string) (DeleteApiKeyResponse, *http.Response, error)

ApiKeysApiService Delete API Key Delete an API key for the authenticated user.

* @param name name of the API key

@return DeleteApiKeyResponse

func (*ApiKeysApiService) DeleteStream Uses

func (a *ApiKeysApiService) DeleteStream(name string) (string, *http.Response, error)

func (*ApiKeysApiService) Delete_2 Uses

func (a *ApiKeysApiService) Delete_2(name string, user string) (DeleteApiKeyResponse, *http.Response, error)

ApiKeysApiService Delete API Key for any user (admin only) Delete an API key for any user (admin only).

* @param name name of the API key
* @param user

@return DeleteApiKeyResponse

func (*ApiKeysApiService) Delete_2Stream Uses

func (a *ApiKeysApiService) Delete_2Stream(name string, user string) (string, *http.Response, error)

func (*ApiKeysApiService) List Uses

func (a *ApiKeysApiService) List() (ListApiKeysResponse, *http.Response, error)

ApiKeysApiService List API Keys List all API keys for the authenticated user.

@return ListApiKeysResponse

func (*ApiKeysApiService) ListStream Uses

func (a *ApiKeysApiService) ListStream() (string, *http.Response, error)

func (*ApiKeysApiService) List_3 Uses

func (a *ApiKeysApiService) List_3(user string) (ListApiKeysResponse, *http.Response, error)

ApiKeysApiService List API Keys for any user (admin only) List all API keys for any user (admin only).

* @param user

@return ListApiKeysResponse

func (*ApiKeysApiService) List_3Stream Uses

func (a *ApiKeysApiService) List_3Stream(user string) (string, *http.Response, error)

type AwsAccessKey Uses

type AwsAccessKey struct {
    // AWS access key ID
    AwsAccessKeyId string `json:"aws_access_key_id"`
    // AWS secret access key
    AwsSecretAccessKey string `json:"aws_secret_access_key"`
}

func (AwsAccessKey) PrintResponse Uses

func (m AwsAccessKey) PrintResponse()

type AwsExternalIdIntegration Uses

type AwsExternalIdIntegration struct {
    // ARN of rockset-role created in your account
    AwsRoleArn     string `json:"aws_role_arn"`
    AwsExternalId  string `json:"aws_external_id,omitempty"`
    RocksetIamUser string `json:"rockset_iam_user,omitempty"`
}

func (AwsExternalIdIntegration) PrintResponse Uses

func (m AwsExternalIdIntegration) PrintResponse()

type AwsKeyIntegration Uses

type AwsKeyIntegration struct {
    // AWS access key ID
    AwsAccessKeyId string `json:"aws_access_key_id"`
    // AWS secret access key
    AwsSecretAccessKey string `json:"aws_secret_access_key"`
}

func (AwsKeyIntegration) PrintResponse Uses

func (m AwsKeyIntegration) PrintResponse()

type AwsRole Uses

type AwsRole struct {
    // ARN of rockset-role created in your account
    AwsRoleArn string `json:"aws_role_arn"`
}

func (AwsRole) PrintResponse Uses

func (m AwsRole) PrintResponse()

type BasicAuth Uses

type BasicAuth struct {
    UserName string `json:"userName,omitempty"`
    Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Collection Uses

type Collection struct {
    // ISO-8601 date
    CreatedAt string `json:"created_at,omitempty"`
    // email of user who created the collection
    CreatedBy string `json:"created_by,omitempty"`
    // unique identifer for collection, can contain alphanumeric or dash characters
    Name string `json:"name,omitempty"`
    // text describing the collection
    Description string `json:"description,omitempty"`
    // name of the workspace that the collection is in
    Workspace string `json:"workspace,omitempty"`
    // current status of collection, one of: CREATED, READY, DELETED
    Status string `json:"status,omitempty"`
    // list of sources from which collection ingests
    Sources []Source `json:"sources,omitempty"`
    // metrics about the collection
    Stats *CollectionStats `json:"stats,omitempty"`
    // number of seconds after which data is purged based on event time
    RetentionSecs int64 `json:"retention_secs,omitempty"`
    // list of mappings applied on all documents in a collection
    FieldMappings []FieldMappingV2 `json:"field_mappings,omitempty"`
}

func (Collection) PrintResponse Uses

func (m Collection) PrintResponse()

type CollectionStats Uses

type CollectionStats struct {
    // number of documents in the collection
    DocCount int64 `json:"doc_count,omitempty"`
    // number of documents purged from the collection
    PurgedDocCount int64 `json:"purged_doc_count,omitempty"`
    // number between 0 and 1 that indicates progress of collection creation
    FillProgress float64 `json:"fill_progress,omitempty"`
    // milliseconds since Unix epoch Jan 1, 1970
    LastQueriedMs int64 `json:"last_queried_ms,omitempty"`
    // milliseconds since Unix epoch Jan 1, 1970
    LastUpdatedMs int64 `json:"last_updated_ms,omitempty"`
    // total collection size in bytes
    TotalSize int64 `json:"total_size,omitempty"`
    // total collection index size in bytes
    TotalIndexSize int64 `json:"total_index_size,omitempty"`
    // total collection row index size in bytes
    RowIndexSize int64 `json:"row_index_size,omitempty"`
    // total collection column index size in bytes
    ColumnIndexSize int64 `json:"column_index_size,omitempty"`
    // total collection inverted index size in bytes
    InvertedIndexSize int64 `json:"inverted_index_size,omitempty"`
    // total collection range index size in bytes
    RangeIndexSize int64 `json:"range_index_size,omitempty"`
    // total size of bytes purged in bytes
    PurgedDocSize int64 `json:"purged_doc_size,omitempty"`
    // total number of bytes inserted into the collection
    BytesInserted int64 `json:"bytes_inserted,omitempty"`
    // total number of bytes overwritten in writing into the collection
    BytesOverwritten int64 `json:"bytes_overwritten,omitempty"`
}

func (CollectionStats) PrintResponse Uses

func (m CollectionStats) PrintResponse()

type CollectionsApiService Uses

type CollectionsApiService Service

func (*CollectionsApiService) Create Uses

func (a *CollectionsApiService) Create(workspace string, body CreateCollectionRequest) (CreateCollectionResponse, *http.Response, error)

CollectionsApiService Create Collection Create new collection in a workspace.

* @param workspace name of the workspace
* @param body JSON object

@return CreateCollectionResponse

func (*CollectionsApiService) CreateStream Uses

func (a *CollectionsApiService) CreateStream(workspace string, body CreateCollectionRequest) (string, *http.Response, error)

func (*CollectionsApiService) Delete Uses

func (a *CollectionsApiService) Delete(workspace string, collection string) (DeleteCollectionResponse, *http.Response, error)

CollectionsApiService Delete Collection Delete a collection and all its documents from Rockset.

* @param workspace name of the workspace
* @param collection name of the collection

@return DeleteCollectionResponse

func (*CollectionsApiService) DeleteStream Uses

func (a *CollectionsApiService) DeleteStream(workspace string, collection string) (string, *http.Response, error)

func (*CollectionsApiService) Get Uses

func (a *CollectionsApiService) Get(workspace string, collection string) (GetCollectionResponse, *http.Response, error)

CollectionsApiService Get Collection Get details about a collection.

* @param workspace name of the workspace
* @param collection name of the collection

@return GetCollectionResponse

func (*CollectionsApiService) GetStream Uses

func (a *CollectionsApiService) GetStream(workspace string, collection string) (string, *http.Response, error)

func (*CollectionsApiService) List Uses

func (a *CollectionsApiService) List() (ListCollectionsResponse, *http.Response, error)

CollectionsApiService List Collections Retrieve all collections in an organization.

@return ListCollectionsResponse

func (*CollectionsApiService) ListStream Uses

func (a *CollectionsApiService) ListStream() (string, *http.Response, error)

func (*CollectionsApiService) List_1 Uses

func (a *CollectionsApiService) List_1(workspace string, collection string) (ListQueryLambdaVersionsResponse, *http.Response, error)

CollectionsApiService Get Query Lambdas Get all Query Lambdas that hit a specific Rockset Collection.

* @param workspace name of the workspace
* @param collection name of the collection

@return ListQueryLambdaVersionsResponse

func (*CollectionsApiService) List_1Stream Uses

func (a *CollectionsApiService) List_1Stream(workspace string, collection string) (string, *http.Response, error)

func (*CollectionsApiService) Workspace Uses

func (a *CollectionsApiService) Workspace(workspace string) (ListCollectionsResponse, *http.Response, error)

CollectionsApiService List Collections for Workspace Retrieve all collections in a workspace.

* @param workspace name of the workspace

@return ListCollectionsResponse

func (*CollectionsApiService) WorkspaceStream Uses

func (a *CollectionsApiService) WorkspaceStream(workspace string) (string, *http.Response, error)

type CommitMark Uses

type CommitMark struct {
}

func (CommitMark) PrintResponse Uses

func (m CommitMark) PrintResponse()

type CommitMarkPositions Uses

type CommitMarkPositions struct {
}

func (CommitMarkPositions) PrintResponse Uses

func (m CommitMarkPositions) PrintResponse()

type Configuration Uses

type Configuration struct {
    BasePath      string            `json:"basePath,omitempty"`
    Host          string            `json:"host,omitempty"`
    Scheme        string            `json:"scheme,omitempty"`
    DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
    UserAgent     string            `json:"userAgent,omitempty"`
    HTTPClient    *http.Client
    Version       string
}

func NewConfiguration Uses

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader Uses

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateApiKeyRequest Uses

type CreateApiKeyRequest struct {
    // descriptive label
    Name string `json:"name"`
}

func (CreateApiKeyRequest) PrintResponse Uses

func (m CreateApiKeyRequest) PrintResponse()

type CreateApiKeyResponse Uses

type CreateApiKeyResponse struct {
    // the API key that was created
    Data *ApiKey `json:"data,omitempty"`
}

func (CreateApiKeyResponse) PrintResponse Uses

func (m CreateApiKeyResponse) PrintResponse()

type CreateCollectionRequest Uses

type CreateCollectionRequest struct {
    // unique identifer for collection, can contain alphanumeric or dash characters
    Name string `json:"name"`
    // text describing the collection
    Description string `json:"description,omitempty"`
    // list of sources from which to ingest data
    Sources []Source `json:"sources,omitempty"`
    // number of seconds after which data is purged, based on event time
    RetentionSecs int64 `json:"retention_secs,omitempty"`
    // configuration for event data
    EventTimeInfo *EventTimeInfo `json:"event_time_info,omitempty"`
    // list of mappings
    FieldMappings []FieldMappingV2 `json:"field_mappings,omitempty"`
}

func (CreateCollectionRequest) PrintResponse Uses

func (m CreateCollectionRequest) PrintResponse()

type CreateCollectionResponse Uses

type CreateCollectionResponse struct {
    // collection that was created
    Data *Collection `json:"data,omitempty"`
}

func (CreateCollectionResponse) PrintResponse Uses

func (m CreateCollectionResponse) PrintResponse()

type CreateIntegrationRequest Uses

type CreateIntegrationRequest struct {
    // descriptive label
    Name string `json:"name"`
    // longer explanation for the integration
    Description string `json:"description,omitempty"`
    // Amazon S3 details, must have one of aws_access_key or aws_role
    S3  *S3Integration `json:"s3,omitempty"`
    // Amazon Kinesis details, must have one of aws_access_key or aws_role
    Kinesis *KinesisIntegration `json:"kinesis,omitempty"`
    // Amazon DynamoDB details, must have one of aws_access_key or aws_role
    Dynamodb *DynamodbIntegration `json:"dynamodb,omitempty"`
    // Amazon Redshift details
    Redshift *RedshiftIntegration `json:"redshift,omitempty"`
    // GCS details
    Gcs     *GcsIntegration     `json:"gcs,omitempty"`
    Segment *SegmentIntegration `json:"segment,omitempty"`
    Kafka   *KafkaIntegration   `json:"kafka,omitempty"`
    // MongoDb details
    Mongodb *MongoDbIntegration `json:"mongodb,omitempty"`
}

func (CreateIntegrationRequest) PrintResponse Uses

func (m CreateIntegrationRequest) PrintResponse()

type CreateIntegrationResponse Uses

type CreateIntegrationResponse struct {
    // integration object that was created
    Data *Integration `json:"data,omitempty"`
}

func (CreateIntegrationResponse) PrintResponse Uses

func (m CreateIntegrationResponse) PrintResponse()

type CreateQueryLambdaRequest Uses

type CreateQueryLambdaRequest struct {
    // Query Lambda name
    Name string `json:"name"`
    // optional description
    Description string `json:"description,omitempty"`
    // Query Lambda SQL query
    Sql *QueryLambdaSql `json:"sql"`
}

func (CreateQueryLambdaRequest) PrintResponse Uses

func (m CreateQueryLambdaRequest) PrintResponse()

type CreateQueryLambdaResponse Uses

type CreateQueryLambdaResponse struct {
    // Query Lambda data
    Data *QueryLambda `json:"data,omitempty"`
}

func (CreateQueryLambdaResponse) PrintResponse Uses

func (m CreateQueryLambdaResponse) PrintResponse()

type CreateQueryLambdaTagRequest Uses

type CreateQueryLambdaTagRequest struct {
    // name of Query Lambda tag
    TagName string `json:"tag_name,omitempty"`
    // hash identifying a Query Lambda tag
    Version string `json:"version,omitempty"`
}

func (CreateQueryLambdaTagRequest) PrintResponse Uses

func (m CreateQueryLambdaTagRequest) PrintResponse()

type CreateSavedQueryRequest Uses

type CreateSavedQueryRequest struct {
    // query name
    Name string `json:"name"`
    // optional version tag
    VersionTag string `json:"version_tag,omitempty"`
    // SQL text of this query
    QuerySql string `json:"query_sql"`
    // parameters associated with this query
    Parameters []SavedQueryParameter `json:"parameters,omitempty"`
}

func (CreateSavedQueryRequest) PrintResponse Uses

func (m CreateSavedQueryRequest) PrintResponse()

type CreateSavedQueryResponse Uses

type CreateSavedQueryResponse struct {
    // saved query data
    Data *SavedQuery `json:"data,omitempty"`
}

func (CreateSavedQueryResponse) PrintResponse Uses

func (m CreateSavedQueryResponse) PrintResponse()

type CreateUserRequest Uses

type CreateUserRequest struct {
    // user email, must be unique
    Email string `json:"email"`
    // List of roles for a given user
    Roles []string `json:"roles,omitempty"`
}

func (CreateUserRequest) PrintResponse Uses

func (m CreateUserRequest) PrintResponse()

type CreateUserResponse Uses

type CreateUserResponse struct {
    // user that was created
    Data *User `json:"data,omitempty"`
}

func (CreateUserResponse) PrintResponse Uses

func (m CreateUserResponse) PrintResponse()

type CreateWorkspaceRequest Uses

type CreateWorkspaceRequest struct {
    // descriptive label and unique identifier
    Name string `json:"name"`
    // longer explanation for the workspace
    Description string `json:"description,omitempty"`
}

func (CreateWorkspaceRequest) PrintResponse Uses

func (m CreateWorkspaceRequest) PrintResponse()

type CreateWorkspaceResponse Uses

type CreateWorkspaceResponse struct {
    // the workspace that was created
    Data *Workspace `json:"data,omitempty"`
}

func (CreateWorkspaceResponse) PrintResponse Uses

func (m CreateWorkspaceResponse) PrintResponse()

type CsvParams Uses

type CsvParams struct {
    // If the first line in every object specifies the column names
    FirstLineAsColumnNames bool `json:"firstLineAsColumnNames,omitempty"`
    // a single character that is the column separator
    Separator string `json:"separator,omitempty"`
    // can be one of: UTF-8, ISO_8859_1, UTF-16
    Encoding string `json:"encoding,omitempty"`
    // names of columns
    ColumnNames []string `json:"columnNames,omitempty"`
    // names of columns
    ColumnTypes []string `json:"columnTypes,omitempty"`
    // character within which a cell value is enclosed,null character if no such character, default is '\"'
    QuoteChar string `json:"quoteChar,omitempty"`
    // escape character removes any special meaning from the following character,default is '\\'
    EscapeChar string `json:"escapeChar,omitempty"`
}

func (CsvParams) PrintResponse Uses

func (m CsvParams) PrintResponse()

type DeleteApiKeyResponse Uses

type DeleteApiKeyResponse struct {
    // the API key that was deleted
    Data *ApiKey `json:"data,omitempty"`
}

func (DeleteApiKeyResponse) PrintResponse Uses

func (m DeleteApiKeyResponse) PrintResponse()

type DeleteCollectionResponse Uses

type DeleteCollectionResponse struct {
    // collection that was deleted
    Data *Collection `json:"data,omitempty"`
}

func (DeleteCollectionResponse) PrintResponse Uses

func (m DeleteCollectionResponse) PrintResponse()

type DeleteDocumentsRequest Uses

type DeleteDocumentsRequest struct {
    // array of document IDs
    Data []DeleteDocumentsRequestData `json:"data"`
}

func (DeleteDocumentsRequest) PrintResponse Uses

func (m DeleteDocumentsRequest) PrintResponse()

type DeleteDocumentsRequestData Uses

type DeleteDocumentsRequestData struct {
    // unique document ID
    Id string `json:"_id"`
}

func (DeleteDocumentsRequestData) PrintResponse Uses

func (m DeleteDocumentsRequestData) PrintResponse()

type DeleteDocumentsResponse Uses

type DeleteDocumentsResponse struct {
    // information about deleted documents
    Data []DocumentStatus `json:"data,omitempty"`
}

func (DeleteDocumentsResponse) PrintResponse Uses

func (m DeleteDocumentsResponse) PrintResponse()

type DeleteIntegrationResponse Uses

type DeleteIntegrationResponse struct {
    // integration object that was deleted
    Data *Integration `json:"data,omitempty"`
}

func (DeleteIntegrationResponse) PrintResponse Uses

func (m DeleteIntegrationResponse) PrintResponse()

type DeleteQueryLambdaResponse Uses

type DeleteQueryLambdaResponse struct {
    // Query Lambda details
    Data *QueryLambda `json:"data,omitempty"`
}

func (DeleteQueryLambdaResponse) PrintResponse Uses

func (m DeleteQueryLambdaResponse) PrintResponse()

type DeleteSavedQueryResponse Uses

type DeleteSavedQueryResponse struct {
    // saved query details
    Data *SavedQuery `json:"data,omitempty"`
}

func (DeleteSavedQueryResponse) PrintResponse Uses

func (m DeleteSavedQueryResponse) PrintResponse()

type DeleteUserResponse Uses

type DeleteUserResponse struct {
    // user object that was deleted
    Data *User `json:"data,omitempty"`
}

func (DeleteUserResponse) PrintResponse Uses

func (m DeleteUserResponse) PrintResponse()

type DeleteWorkspaceResponse Uses

type DeleteWorkspaceResponse struct {
    // the workspace that was deleted
    Data *Workspace `json:"data,omitempty"`
}

func (DeleteWorkspaceResponse) PrintResponse Uses

func (m DeleteWorkspaceResponse) PrintResponse()

type DocumentStatus Uses

type DocumentStatus struct {
    // collection name
    Collection string `json:"_collection,omitempty"`
    // error message, if any
    Error_ *ErrorModel `json:"error,omitempty"`
    // unique document ID
    Id  string `json:"_id,omitempty"`
    // status, one of ADDED, REPLACED, DELETED, ERROR
    Status string `json:"status,omitempty"`
    // unique id used to represent each patch request
    PatchId string `json:"patch_id,omitempty"`
}

func (DocumentStatus) PrintResponse Uses

func (m DocumentStatus) PrintResponse()

type DocumentsApiService Uses

type DocumentsApiService Service

func (*DocumentsApiService) Add Uses

func (a *DocumentsApiService) Add(workspace string, collection string, body AddDocumentsRequest) (AddDocumentsResponse, *http.Response, error)

DocumentsApiService Add Documents Add documents to a collection in Rockset.

* @param workspace name of the workspace
* @param collection name of the collection
* @param body JSON object

@return AddDocumentsResponse

func (*DocumentsApiService) AddStream Uses

func (a *DocumentsApiService) AddStream(workspace string, collection string, body AddDocumentsRequest) (string, *http.Response, error)

func (*DocumentsApiService) Delete Uses

func (a *DocumentsApiService) Delete(workspace string, collection string, body DeleteDocumentsRequest) (DeleteDocumentsResponse, *http.Response, error)

DocumentsApiService Delete Documents Delete documents from a collection in Rockset.

* @param workspace name of the workspace
* @param collection name of the collection
* @param body JSON object

@return DeleteDocumentsResponse

func (*DocumentsApiService) DeleteStream Uses

func (a *DocumentsApiService) DeleteStream(workspace string, collection string, body DeleteDocumentsRequest) (string, *http.Response, error)

func (*DocumentsApiService) Patch Uses

func (a *DocumentsApiService) Patch(workspace string, collection string, body PatchDocumentsRequest) (PatchDocumentsResponse, *http.Response, error)

DocumentsApiService Patch Documents Patch documents in a collection

* @param workspace name of the workspace
* @param collection name of the collection
* @param body JSON Patch objects

@return PatchDocumentsResponse

func (*DocumentsApiService) PatchStream Uses

func (a *DocumentsApiService) PatchStream(workspace string, collection string, body PatchDocumentsRequest) (string, *http.Response, error)

type DynamodbIntegration Uses

type DynamodbIntegration struct {
    // credentials for an AWS access key integration
    AwsAccessKey *AwsAccessKey `json:"aws_access_key,omitempty"`
    // role used for external id type authentication
    AwsRole *AwsRole `json:"aws_role,omitempty"`
}

func (DynamodbIntegration) PrintResponse Uses

func (m DynamodbIntegration) PrintResponse()

type ErrorModel Uses

type ErrorModel struct {
    // descriptive message about the error
    Message string `json:"message,omitempty"`
    // category of the error
    Type_ string `json:"type,omitempty"`
    // Line where the error happened (if applicable)
    Line int32 `json:"line,omitempty"`
    // Column where the error happened (if applicable)
    Column int32 `json:"column,omitempty"`
    // Internal trace ID to help with debugging
    TraceId string `json:"trace_id,omitempty"`
    // ID of the error
    ErrorId string `json:"error_id,omitempty"`
}

Describes details about an error

func (ErrorModel) PrintResponse Uses

func (m ErrorModel) PrintResponse()

type ErrorModelContext Uses

type ErrorModelContext struct {
    // additional error message
    Lineinfo string `json:"lineinfo,omitempty"`
}

func (ErrorModelContext) PrintResponse Uses

func (m ErrorModelContext) PrintResponse()

type EventTimeInfo Uses

type EventTimeInfo struct {
    // name of the field containing event time
    Field string `json:"field"`
    // format of time field, can be one of: milliseconds_since_epoch, seconds_since_epoch
    Format string `json:"format,omitempty"`
    // default time zone, in standard IANA format
    TimeZone string `json:"time_zone,omitempty"`
}

func (EventTimeInfo) PrintResponse Uses

func (m EventTimeInfo) PrintResponse()

type ExecuteOpts Uses

type ExecuteOpts struct {
    Body optional.Interface
}

type ExecuteQueryLambdaRequest Uses

type ExecuteQueryLambdaRequest struct {
    // list of named parameters
    Parameters []QueryParameter `json:"parameters,omitempty"`
    // Row limit to use if no limit specified in the SQL query text
    DefaultRowLimit int32 `json:"default_row_limit,omitempty"`
    // Whether to generate warnings
    GenerateWarnings bool `json:"generate_warnings,omitempty"`
}

func (ExecuteQueryLambdaRequest) PrintResponse Uses

func (m ExecuteQueryLambdaRequest) PrintResponse()

type ExecuteSavedQueryParameter Uses

type ExecuteSavedQueryParameter struct {
    // name of the field
    Name string `json:"name"`
    // literal value of the field
    Value *interface{} `json:"value"`
}

func (ExecuteSavedQueryParameter) PrintResponse Uses

func (m ExecuteSavedQueryParameter) PrintResponse()

type ExecuteSavedQueryRequest Uses

type ExecuteSavedQueryRequest struct {
    // workspace of this saved query
    Workspace string `json:"workspace,omitempty"`
    // query name
    Name string `json:"name,omitempty"`
    // query version
    Version string `json:"version,omitempty"`
    // list of named parameters
    Parameters []ExecuteSavedQueryParameter `json:"parameters,omitempty"`
    // Row limit to use if no limit specified in the query
    DefaultRowLimit int32 `json:"default_row_limit,omitempty"`
    // Whether to generate warnings
    GenerateWarnings bool `json:"generate_warnings,omitempty"`
}

func (ExecuteSavedQueryRequest) PrintResponse Uses

func (m ExecuteSavedQueryRequest) PrintResponse()

type Execute_4Opts Uses

type Execute_4Opts struct {
    Body optional.Interface
}

type FieldMapping Uses

type FieldMapping struct {
}

func (FieldMapping) PrintResponse Uses

func (m FieldMapping) PrintResponse()

type FieldMappingV2 Uses

type FieldMappingV2 struct {
    // A user specified string that is a name for this mapping
    Name string `json:"name,omitempty"`
    // A boolean that determines whether to drop all fields in this document. If set, input and output fields should not be set
    IsDropAllFields bool `json:"is_drop_all_fields,omitempty"`
    // A List of InputField for this mapping
    InputFields []InputField `json:"input_fields,omitempty"`
    // An OutputField for this mapping
    OutputField *OutputField `json:"output_field,omitempty"`
}

func (FieldMappingV2) PrintResponse Uses

func (m FieldMappingV2) PrintResponse()

type FieldMask Uses

type FieldMask struct {
    InputPath []string       `json:"input_path"`
    Mask      *FieldMaskMask `json:"mask,omitempty"`
}

func (FieldMask) PrintResponse Uses

func (m FieldMask) PrintResponse()

type FieldMaskMask Uses

type FieldMaskMask struct {
    Name string       `json:"name"`
    Args *interface{} `json:"args,omitempty"`
}

Field masking function name + args. The args is a JSON object.

func (FieldMaskMask) PrintResponse Uses

func (m FieldMaskMask) PrintResponse()

type FormatParams Uses

type FormatParams struct {
    // source data is in json format
    Json bool       `json:"json,omitempty"`
    Csv  *CsvParams `json:"csv,omitempty"`
    Xml  *XmlParams `json:"xml,omitempty"`
}

func (FormatParams) PrintResponse Uses

func (m FormatParams) PrintResponse()

type GcpServiceAccount Uses

type GcpServiceAccount struct {
    // Contents of JSON Service Account key file
    ServiceAccountKeyFileJson string `json:"service_account_key_file_json"`
}

func (GcpServiceAccount) PrintResponse Uses

func (m GcpServiceAccount) PrintResponse()

type GcsIntegration Uses

type GcsIntegration struct {
    // credentials for an AWS key integration
    GcpServiceAccount *GcpServiceAccount `json:"gcp_service_account,omitempty"`
}

func (GcsIntegration) PrintResponse Uses

func (m GcsIntegration) PrintResponse()

type GenericSwaggerError Uses

type GenericSwaggerError struct {
    // contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body Uses

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error Uses

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model Uses

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetCollectionResponse Uses

type GetCollectionResponse struct {
    // collection that was requested
    Data *Collection `json:"data,omitempty"`
}

func (GetCollectionResponse) PrintResponse Uses

func (m GetCollectionResponse) PrintResponse()

type GetIntegrationResponse Uses

type GetIntegrationResponse struct {
    // integration object
    Data *Integration `json:"data,omitempty"`
}

func (GetIntegrationResponse) PrintResponse Uses

func (m GetIntegrationResponse) PrintResponse()

type GetQueryLambdaResponse Uses

type GetQueryLambdaResponse struct {
    // Query Lambda details
    Data *QueryLambda `json:"data,omitempty"`
}

func (GetQueryLambdaResponse) PrintResponse Uses

func (m GetQueryLambdaResponse) PrintResponse()

type GetSavedQueryResponse Uses

type GetSavedQueryResponse struct {
    // saved query details
    Data *SavedQuery `json:"data,omitempty"`
}

func (GetSavedQueryResponse) PrintResponse Uses

func (m GetSavedQueryResponse) PrintResponse()

type GetWorkspaceResponse Uses

type GetWorkspaceResponse struct {
    // the workspace that was requested
    Data *Workspace `json:"data,omitempty"`
}

func (GetWorkspaceResponse) PrintResponse Uses

func (m GetWorkspaceResponse) PrintResponse()

type InputField Uses

type InputField struct {
    // The name of a field, parsed as a SQL qualified name
    FieldName string `json:"field_name,omitempty"`
    // Define the behaviour if fieldName is missing or is null
    IfMissing string `json:"if_missing,omitempty"`
    // If true, then drop fieldName from the document
    IsDrop bool `json:"is_drop,omitempty"`
    // Sql parameter name
    Param string `json:"param,omitempty"`
}

func (InputField) PrintResponse Uses

func (m InputField) PrintResponse()

type Integration Uses

type Integration struct {
    // descriptive label and unique identifier
    Name string `json:"name"`
    // longer explanation for the integration
    Description string `json:"description,omitempty"`
    // list of collections that use the integration
    Collections []Collection `json:"collections,omitempty"`
    // email of user who created the integration
    CreatedBy string `json:"created_by"`
    // ISO-8601 date
    CreatedAt string `json:"created_at,omitempty"`
    // Amazon S3 details, must have one of aws_access_key or aws_role
    S3  *S3Integration `json:"s3,omitempty"`
    // Amazon Kinesis details, must have one of aws_access_key or aws_role
    Kinesis *KinesisIntegration `json:"kinesis,omitempty"`
    // Amazon DynamoDB details, must have one of aws_access_key or aws_role
    Dynamodb *DynamodbIntegration `json:"dynamodb,omitempty"`
    // Amazon Redshift details
    Redshift *RedshiftIntegration `json:"redshift,omitempty"`
    // GCS details
    Gcs *GcsIntegration `json:"gcs,omitempty"`
    // Segment details
    Segment *SegmentIntegration `json:"segment,omitempty"`
    // Kafka details
    Kafka *KafkaIntegration `json:"kafka,omitempty"`
    // MongoDb details
    Mongodb *MongoDbIntegration `json:"mongodb,omitempty"`
}

Integrations that can be associated with data sources to create collections. Only one type of integration may be specified.

func (Integration) PrintResponse Uses

func (m Integration) PrintResponse()

type IntegrationsApiService Uses

type IntegrationsApiService Service

func (*IntegrationsApiService) Create Uses

func (a *IntegrationsApiService) Create(body CreateIntegrationRequest) (CreateIntegrationResponse, *http.Response, error)

IntegrationsApiService Create Integration Create a new integration with Rockset.

* @param body integration credentials

@return CreateIntegrationResponse

func (*IntegrationsApiService) CreateStream Uses

func (a *IntegrationsApiService) CreateStream(body CreateIntegrationRequest) (string, *http.Response, error)

func (*IntegrationsApiService) Delete Uses

func (a *IntegrationsApiService) Delete(integration string) (DeleteIntegrationResponse, *http.Response, error)

IntegrationsApiService Delete Integration Remove an integration.

* @param integration name of the integration

@return DeleteIntegrationResponse

func (*IntegrationsApiService) DeleteStream Uses

func (a *IntegrationsApiService) DeleteStream(integration string) (string, *http.Response, error)

func (*IntegrationsApiService) Get Uses

func (a *IntegrationsApiService) Get(integration string) (GetIntegrationResponse, *http.Response, error)

IntegrationsApiService Get Integration Get information about a single integration.

* @param integration name of the integration

@return GetIntegrationResponse

func (*IntegrationsApiService) GetStream Uses

func (a *IntegrationsApiService) GetStream(integration string) (string, *http.Response, error)

func (*IntegrationsApiService) List Uses

func (a *IntegrationsApiService) List() (ListIntegrationsResponse, *http.Response, error)

IntegrationsApiService List Integrations List all integrations for organization.

@return ListIntegrationsResponse

func (*IntegrationsApiService) ListStream Uses

func (a *IntegrationsApiService) ListStream() (string, *http.Response, error)

type KafkaIntegration Uses

type KafkaIntegration struct {
    // Kafka topics to tail
    KafkaTopicNames []string `json:"kafka_topic_names"`
    // The status of the Kafka source by topic
    SourceStatusByTopic map[string]StatusKafka `json:"source_status_by_topic,omitempty"`
    // The format of the Kafka topics being tailed
    KafkaDataFormat string `json:"kafka_data_format"`
    // segment connection string
    ConnectionString string `json:"connection_string,omitempty"`
}

func (KafkaIntegration) PrintResponse Uses

func (m KafkaIntegration) PrintResponse()

type KinesisIntegration Uses

type KinesisIntegration struct {
    // credentials for an AWS access key integration
    AwsAccessKey *AwsAccessKey `json:"aws_access_key,omitempty"`
    // details of an AWS cross-account role integration
    AwsRole *AwsRole `json:"aws_role,omitempty"`
}

func (KinesisIntegration) PrintResponse Uses

func (m KinesisIntegration) PrintResponse()

type ListApiKeysResponse Uses

type ListApiKeysResponse struct {
    // list of API key objects
    Data []ApiKey `json:"data,omitempty"`
}

func (ListApiKeysResponse) PrintResponse Uses

func (m ListApiKeysResponse) PrintResponse()

type ListCollectionsResponse Uses

type ListCollectionsResponse struct {
    // list of all collections
    Data []Collection `json:"data,omitempty"`
}

func (ListCollectionsResponse) PrintResponse Uses

func (m ListCollectionsResponse) PrintResponse()

type ListIntegrationsResponse Uses

type ListIntegrationsResponse struct {
    // list of integration objects
    Data []Integration `json:"data,omitempty"`
}

func (ListIntegrationsResponse) PrintResponse Uses

func (m ListIntegrationsResponse) PrintResponse()

type ListQueryLambdaTagsResponse Uses

type ListQueryLambdaTagsResponse struct {
    // list of all tags associated with a Query Lambda
    Data []QueryLambdaTag `json:"data,omitempty"`
}

func (ListQueryLambdaTagsResponse) PrintResponse Uses

func (m ListQueryLambdaTagsResponse) PrintResponse()

type ListQueryLambdaVersionsResponse Uses

type ListQueryLambdaVersionsResponse struct {
    // list of all versions for a particular Query Lambda
    Data []QueryLambdaVersion `json:"data,omitempty"`
}

func (ListQueryLambdaVersionsResponse) PrintResponse Uses

func (m ListQueryLambdaVersionsResponse) PrintResponse()

type ListQueryLambdasResponse Uses

type ListQueryLambdasResponse struct {
    // list of all Query Lambdas
    Data []QueryLambda `json:"data,omitempty"`
}

func (ListQueryLambdasResponse) PrintResponse Uses

func (m ListQueryLambdasResponse) PrintResponse()

type ListSavedQueriesResponse Uses

type ListSavedQueriesResponse struct {
    // list of all saved queries
    Data []SavedQuery `json:"data,omitempty"`
}

func (ListSavedQueriesResponse) PrintResponse Uses

func (m ListSavedQueriesResponse) PrintResponse()

type ListUsersResponse Uses

type ListUsersResponse struct {
    // list of users
    Data []User `json:"data,omitempty"`
}

func (ListUsersResponse) PrintResponse Uses

func (m ListUsersResponse) PrintResponse()

type ListWorkspacesResponse Uses

type ListWorkspacesResponse struct {
    // list of workspaces
    Data []Workspace `json:"data,omitempty"`
}

func (ListWorkspacesResponse) PrintResponse Uses

func (m ListWorkspacesResponse) PrintResponse()

type MongoDbIntegration Uses

type MongoDbIntegration struct {
    // MongoDB connection URI string
    ConnectionUri string `json:"connection_uri"`
}

func (MongoDbIntegration) PrintResponse Uses

func (m MongoDbIntegration) PrintResponse()

type OperatorStats Uses

type OperatorStats struct {
    // The id of the worker this operator ran on
    Worker string `json:"worker,omitempty"`
    // The id of the fragment this operator belonged to
    Fragment int64 `json:"fragment,omitempty"`
    // The id of the task this operator belonged to
    Task string `json:"task,omitempty"`
    // The id of this operator in the task
    OperatorId int64 `json:"operator_id,omitempty"`
    // The class name of this operator
    OperatorName string `json:"operator_name,omitempty"`
    // Microseconds since UNIX epoch of the first time data was received from any of this operator's inputs
    StartTimeUs int64 `json:"start_time_us,omitempty"`
    // Microseconds since UNIX epoch of the last time data was sent to any of this operator's outputs
    EndTimeUs int64 `json:"end_time_us,omitempty"`
    // Maximum memory used by this operator during execution
    MaxMemory int64 `json:"max_memory,omitempty"`
    // Total bytes received across all inputs
    InputBytes int64 `json:"input_bytes,omitempty"`
    // Total rows received across all inputs
    InputRows int64 `json:"input_rows,omitempty"`
    // Total bytes sent across all outputs
    OutputBytes int64 `json:"output_bytes,omitempty"`
    // Total rows sent across all outputs
    OutputRows int64 `json:"output_rows,omitempty"`
    // Total time in microseconds spent doing useful work
    ProcessingTimeUs int64 `json:"processing_time_us,omitempty"`
}

func (OperatorStats) PrintResponse Uses

func (m OperatorStats) PrintResponse()

type OrgMembership Uses

type OrgMembership struct {
    Organization *Organization `json:"organization"`
    Roles        []string      `json:"roles"`
    InviteState  string        `json:"invite_state"`
    InvitedBy    string        `json:"invited_by"`
    // ISO-8601 date
    ExpiresAt string `json:"expires_at"`
    // ISO-8601 date
    CreatedAt string `json:"created_at"`
}

func (OrgMembership) PrintResponse Uses

func (m OrgMembership) PrintResponse()

type Organization Uses

type Organization struct {
    // unique identifier for the organization
    Id  string `json:"id,omitempty"`
    // ISO-8601 date
    CreatedAt string `json:"created_at,omitempty"`
    // name of the organization
    DisplayName string `json:"display_name,omitempty"`
    // name of the company
    CompanyName string `json:"company_name,omitempty"`
    // organization's unique external ID within Rockset
    ExternalId  string `json:"external_id,omitempty"`
    RocksetUser string `json:"rockset_user,omitempty"`
    // org state
    State string `json:"state,omitempty"`
    // number of dedicated pods
    NumDedicatedPods int32 `json:"num_dedicated_pods,omitempty"`
}

An organization in Rockset is a container for users and collections.

func (Organization) PrintResponse Uses

func (m Organization) PrintResponse()

type OrganizationResponse Uses

type OrganizationResponse struct {
    // Organization object
    Data *Organization `json:"data,omitempty"`
}

func (OrganizationResponse) PrintResponse Uses

func (m OrganizationResponse) PrintResponse()

type OrganizationsApiService Uses

type OrganizationsApiService Service

func (*OrganizationsApiService) Get Uses

func (a *OrganizationsApiService) Get() (OrganizationResponse, *http.Response, error)

OrganizationsApiService Get Organization Retrieve information about current organization.

@return OrganizationResponse

func (*OrganizationsApiService) GetStream Uses

func (a *OrganizationsApiService) GetStream() (string, *http.Response, error)

type OutputField Uses

type OutputField struct {
    // The name of a field, parsed as a SQL qualified name
    FieldName string `json:"field_name,omitempty"`
    // The name of a sql function
    Value *SqlExpression `json:"value,omitempty"`
    // Error in Mapping execution: 'skip' or 'fail'
    OnError string `json:"on_error,omitempty"`
}

func (OutputField) PrintResponse Uses

func (m OutputField) PrintResponse()

type PatchDocument Uses

type PatchDocument struct {
    // Unique id of the document which is being patched
    Id  string `json:"_id"`
    // List of patch operations
    Patch []PatchOperation `json:"patch"`
}

func (PatchDocument) PrintResponse Uses

func (m PatchDocument) PrintResponse()

type PatchDocumentsRequest Uses

type PatchDocumentsRequest struct {
    // List of JSON Patch Documents
    Data []PatchDocument `json:"data"`
}

func (PatchDocumentsRequest) PrintResponse Uses

func (m PatchDocumentsRequest) PrintResponse()

type PatchDocumentsResponse Uses

type PatchDocumentsResponse struct {
    Data []DocumentStatus `json:"data"`
}

func (PatchDocumentsResponse) PrintResponse Uses

func (m PatchDocumentsResponse) PrintResponse()

type PatchOperation Uses

type PatchOperation struct {
    // Operation to be performed in this patch
    Op  string `json:"op"`
    // JSON-Pointer referencing a location in the target document where theoperation is performed
    Path string `json:"path"`
    // Value used in the patch operation. Required for add, replace and test operations
    Value *interface{} `json:"value,omitempty"`
    // JSON-Pointer referencing a location in the target document.Required for copy and move operations
    From string `json:"from,omitempty"`
}

func (PatchOperation) PrintResponse Uses

func (m PatchOperation) PrintResponse()

type QueriesApiService Uses

type QueriesApiService Service

func (*QueriesApiService) Query Uses

func (a *QueriesApiService) Query(body QueryRequest) (QueryResponse, *http.Response, error)

QueriesApiService Query Make a SQL query to Rockset.

* @param body JSON object

@return QueryResponse

func (*QueriesApiService) QueryStream Uses

func (a *QueriesApiService) QueryStream(body QueryRequest) (string, *http.Response, error)

func (*QueriesApiService) Validate Uses

func (a *QueriesApiService) Validate(body QueryRequest, localVarOptionals *ValidateOpts) (ValidateQueryResponse, *http.Response, error)

func (*QueriesApiService) ValidateStream Uses

func (a *QueriesApiService) ValidateStream(body QueryRequest, localVarOptionals *ValidateOpts) (string, *http.Response, error)

type QueryError Uses

type QueryError struct {
    // The type of error
    Type_ string `json:"type,omitempty"`
    // A message associated with the error, containing more information about it
    Message string `json:"message,omitempty"`
    // The HTTP status code associated with this error, had it been sent as the response status code
    StatusCode int32 `json:"status_code,omitempty"`
}

func (QueryError) PrintResponse Uses

func (m QueryError) PrintResponse()

type QueryFieldType Uses

type QueryFieldType struct {
    // name of the field
    Name string `json:"name"`
    // data type of the field
    Type_ string `json:"type"`
}

func (QueryFieldType) PrintResponse Uses

func (m QueryFieldType) PrintResponse()

type QueryLambda Uses

type QueryLambda struct {
    // workspace of this Query Lambda
    Workspace string `json:"workspace,omitempty"`
    // user that created this Query Lambda
    LastUpdatedBy string `json:"last_updated_by,omitempty"`
    // ISO-8601 date of when Query Lambda was last updated
    LastUpdated string `json:"last_updated,omitempty"`
    // Query Lambda name
    Name string `json:"name,omitempty"`
    // number of Query Lambda versions
    VersionCount int32 `json:"version_count,omitempty"`
    // collections queried by underlying SQL query
    Collections []string `json:"collections,omitempty"`
    // Query Lambda version details for most recently created version
    LatestVersion *QueryLambdaVersion `json:"latest_version,omitempty"`
}

func (QueryLambda) PrintResponse Uses

func (m QueryLambda) PrintResponse()

type QueryLambdaSql Uses

type QueryLambdaSql struct {
    // SQL text
    Query string `json:"query"`
    // default parameters for this Query Lambda
    DefaultParameters []QueryParameter `json:"default_parameters,omitempty"`
}

func (QueryLambdaSql) PrintResponse Uses

func (m QueryLambdaSql) PrintResponse()

type QueryLambdaStats Uses

type QueryLambdaStats struct {
    // ISO-8601 date
    LastExecuted string `json:"last_executed,omitempty"`
    // user who last executed Query Lambda
    LastExecutedBy string `json:"last_executed_by,omitempty"`
    // ISO-8601 date of last execution failure
    LastExecutionError string `json:"last_execution_error,omitempty"`
    // error message associated with last failed execution
    LastExecutionErrorMessage string `json:"last_execution_error_message,omitempty"`
}

func (QueryLambdaStats) PrintResponse Uses

func (m QueryLambdaStats) PrintResponse()

type QueryLambdaTag Uses

type QueryLambdaTag struct {
    // name of Query Lambda tag
    TagName string `json:"tag_name,omitempty"`
    // query lambda version
    Version *QueryLambdaVersion `json:"version,omitempty"`
}

func (QueryLambdaTag) PrintResponse Uses

func (m QueryLambdaTag) PrintResponse()

type QueryLambdaTagResponse Uses

type QueryLambdaTagResponse struct {
    // updated Query Lambda tag
    Data *QueryLambdaTag `json:"data,omitempty"`
}

func (QueryLambdaTagResponse) PrintResponse Uses

func (m QueryLambdaTagResponse) PrintResponse()

type QueryLambdaVersion Uses

type QueryLambdaVersion struct {
    // workspace of this Query Lambda
    Workspace string `json:"workspace,omitempty"`
    // user that created this Query Lambda
    CreatedBy string `json:"created_by,omitempty"`
    // ISO-8601 date of when Query Lambda was created
    CreatedAt string `json:"created_at,omitempty"`
    // Query Lambda name
    Name string `json:"name,omitempty"`
    // Query Lambda version
    Version string `json:"version,omitempty"`
    // optional description
    Description string `json:"description,omitempty"`
    // Query Lambda SQL query
    Sql *QueryLambdaSql `json:"sql,omitempty"`
    // collections queried by underlying SQL query
    Collections []string `json:"collections,omitempty"`
    // status of this Query Lambda
    State string `json:"state,omitempty"`
    // stats related to this Query Lambda
    Stats *QueryLambdaStats `json:"stats,omitempty"`
}

func (QueryLambdaVersion) PrintResponse Uses

func (m QueryLambdaVersion) PrintResponse()

type QueryLambdaVersionResponse Uses

type QueryLambdaVersionResponse struct {
    // Query Lambda version details
    Data *QueryLambdaVersion `json:"data,omitempty"`
}

func (QueryLambdaVersionResponse) PrintResponse Uses

func (m QueryLambdaVersionResponse) PrintResponse()

type QueryLambdasApiService Uses

type QueryLambdasApiService Service

func (*QueryLambdasApiService) Create Uses

func (a *QueryLambdasApiService) Create(workspace string, body CreateQueryLambdaRequest) (QueryLambdaVersionResponse, *http.Response, error)

QueryLambdasApiService Create Query Lambda Create a Query Lambda in given workspace.

* @param workspace name of the workspace
* @param body JSON object

@return QueryLambdaVersionResponse

func (*QueryLambdasApiService) CreateStream Uses

func (a *QueryLambdasApiService) CreateStream(workspace string, body CreateQueryLambdaRequest) (string, *http.Response, error)

func (*QueryLambdasApiService) Create_1 Uses

func (a *QueryLambdasApiService) Create_1(workspace string, queryLambda string, body CreateQueryLambdaTagRequest) (QueryLambdaTagResponse, *http.Response, error)

QueryLambdasApiService Create Query Lambda Tag Create a tag for a specific Query Lambda version, or update if it exists

* @param workspace name of the workspace
* @param queryLambda name of the Query Lambda
* @param body JSON object

@return QueryLambdaTagResponse

func (*QueryLambdasApiService) Create_1Stream Uses

func (a *QueryLambdasApiService) Create_1Stream(workspace string, queryLambda string, body CreateQueryLambdaTagRequest) (string, *http.Response, error)

func (*QueryLambdasApiService) Delete Uses

func (a *QueryLambdasApiService) Delete(workspace string, queryLambda string) (DeleteQueryLambdaResponse, *http.Response, error)

QueryLambdasApiService Delete Query Lambda Delete a Query Lambda.

* @param workspace name of the workspace
* @param queryLambda name of the Query Lambda

@return DeleteQueryLambdaResponse

func (*QueryLambdasApiService) DeleteStream Uses

func (a *QueryLambdasApiService) DeleteStream(workspace string, queryLambda string) (string, *http.Response, error)

func (*QueryLambdasApiService) Delete_2 Uses

func (a *QueryLambdasApiService) Delete_2(workspace string, queryLambda string, tag string) (QueryLambdaTagResponse, *http.Response, error)

QueryLambdasApiService Delete Query Lambda Tag Version Delete a tag for a specific Query Lambda

* @param workspace name of the workspace
* @param queryLambda name of the Query Lambda
* @param tag name of the tag

@return QueryLambdaTagResponse

func (*QueryLambdasApiService) Delete_2Stream Uses

func (a *QueryLambdasApiService) Delete_2Stream(workspace string, queryLambda string, tag string) (string, *http.Response, error)

func (*QueryLambdasApiService) Delete_3 Uses

func (a *QueryLambdasApiService) Delete_3(workspace string, queryLambda string, version string) (QueryLambdaVersionResponse, *http.Response, error)

QueryLambdasApiService Delete Query Lambda Version Delete a Query Lambda version.

* @param workspace name of the workspace
* @param queryLambda name of the Query Lambda
* @param version version

@return QueryLambdaVersionResponse

func (*QueryLambdasApiService) Delete_3Stream Uses

func (a *QueryLambdasApiService) Delete_3Stream(workspace string, queryLambda string, version string) (string, *http.Response, error)

func (*QueryLambdasApiService) Execute Uses

func (a *QueryLambdasApiService) Execute(workspace string, queryLambda string, tag string, localVarOptionals *ExecuteOpts) (QueryResponse, *http.Response, error)

func (*QueryLambdasApiService) ExecuteStream Uses

func (a *QueryLambdasApiService) ExecuteStream(workspace string, queryLambda string, tag string, localVarOptionals *ExecuteOpts) (string, *http.Response, error)

func (*QueryLambdasApiService) Execute_4 Uses

func (a *QueryLambdasApiService) Execute_4(workspace string, queryLambda string, version string, localVarOptionals *Execute_4Opts) (QueryResponse, *http.Response, error)

func (*QueryLambdasApiService) Execute_4Stream Uses

func (a *QueryLambdasApiService) Execute_4Stream(workspace string, queryLambda string, version string, localVarOptionals *Execute_4Opts) (string, *http.Response, error)

func (*QueryLambdasApiService) Get Uses

func (a *QueryLambdasApiService) Get(workspace string, queryLambda string, tag string) (QueryLambdaTagResponse, *http.Response, error)

QueryLambdasApiService Get Query Lambda Tag Get the specific Query Lambda version associated with a given tag

* @param workspace name of the workspace
* @param queryLambda name of the Query Lambda
* @param tag name of the tag

@return QueryLambdaTagResponse

func (*QueryLambdasApiService) GetStream Uses

func (a *QueryLambdasApiService) GetStream(workspace string, queryLambda string, tag string) (string, *http.Response, error)

func (*QueryLambdasApiService) Get_5 Uses

func (a *QueryLambdasApiService) Get_5(workspace string, queryLambda string, version string) (QueryLambdaVersionResponse, *http.Response, error)

QueryLambdasApiService Get Query Lambda Version Get a specific version of a Query Lambda

* @param workspace name of the workspace
* @param queryLambda name of the Query Lambda
* @param version version

@return QueryLambdaVersionResponse

func (*QueryLambdasApiService) Get_5Stream Uses

func (a *QueryLambdasApiService) Get_5Stream(workspace string, queryLambda string, version string) (string, *http.Response, error)

func (*QueryLambdasApiService) List Uses

func (a *QueryLambdasApiService) List() (ListQueryLambdasResponse, *http.Response, error)

QueryLambdasApiService List Query Lambdas List all Query Lambdas.

@return ListQueryLambdasResponse

func (*QueryLambdasApiService) ListStream Uses

func (a *QueryLambdasApiService) ListStream() (string, *http.Response, error)

func (*QueryLambdasApiService) List_10 Uses

func (a *QueryLambdasApiService) List_10(workspace string, queryLambda string) (ListQueryLambdaVersionsResponse, *http.Response, error)

QueryLambdasApiService List Query Lambda Versions List all versions of a Query Lambda.

* @param workspace name of the workspace
* @param queryLambda name of the Query Lambda

@return ListQueryLambdaVersionsResponse

func (*QueryLambdasApiService) List_10Stream Uses

func (a *QueryLambdasApiService) List_10Stream(workspace string, queryLambda string) (string, *http.Response, error)

func (*QueryLambdasApiService) List_6 Uses

func (a *QueryLambdasApiService) List_6() (ListQueryLambdaTagsResponse, *http.Response, error)

QueryLambdasApiService List Query Lambda Tags List all tags in an organization

@return ListQueryLambdaTagsResponse

func (*QueryLambdasApiService) List_6Stream Uses

func (a *QueryLambdasApiService) List_6Stream() (string, *http.Response, error)

func (*QueryLambdasApiService) List_7 Uses

func (a *QueryLambdasApiService) List_7(tag string) (ListQueryLambdaVersionsResponse, *http.Response, error)

QueryLambdasApiService List Query Lambda Tag Versions List all Query Lambda versions associated with a tag

* @param tag name of the tag

@return ListQueryLambdaVersionsResponse

func (*QueryLambdasApiService) List_7Stream Uses

func (a *QueryLambdasApiService) List_7Stream(tag string) (string, *http.Response, error)

func (*QueryLambdasApiService) List_8 Uses

func (a *QueryLambdasApiService) List_8(workspace string) (ListQueryLambdasResponse, *http.Response, error)

QueryLambdasApiService List Query Lambdas List all Query Lambdas under given workspace.

* @param workspace name of the workspace

@return ListQueryLambdasResponse

func (*QueryLambdasApiService) List_8Stream Uses

func (a *QueryLambdasApiService) List_8Stream(workspace string) (string, *http.Response, error)

func (*QueryLambdasApiService) List_9 Uses

func (a *QueryLambdasApiService) List_9(workspace string, queryLambda string) (ListQueryLambdaTagsResponse, *http.Response, error)

QueryLambdasApiService List Query Lambda Tags List all tags associated with a Query Lambda

* @param workspace name of the workspace
* @param queryLambda name of the Query Lambda

@return ListQueryLambdaTagsResponse

func (*QueryLambdasApiService) List_9Stream Uses

func (a *QueryLambdasApiService) List_9Stream(workspace string, queryLambda string) (string, *http.Response, error)

func (*QueryLambdasApiService) Update Uses

func (a *QueryLambdasApiService) Update(workspace string, queryLambda string, body UpdateQueryLambdaRequest, localVarOptionals *UpdateOpts) (QueryLambdaVersionResponse, *http.Response, error)

func (*QueryLambdasApiService) UpdateStream Uses

func (a *QueryLambdasApiService) UpdateStream(workspace string, queryLambda string, body UpdateQueryLambdaRequest, localVarOptionals *UpdateOpts) (string, *http.Response, error)

type QueryParameter Uses

type QueryParameter struct {
    // name of the field
    Name string `json:"name"`
    // data type of the field
    Type_ string `json:"type"`
    // literal value of the field
    Value string `json:"value"`
}

func (QueryParameter) PrintResponse Uses

func (m QueryParameter) PrintResponse()

type QueryRequest Uses

type QueryRequest struct {
    // details about the query
    Sql *QueryRequestSql `json:"sql,omitempty"`
}

func (QueryRequest) PrintResponse Uses

func (m QueryRequest) PrintResponse()

type QueryRequestSql Uses

type QueryRequestSql struct {
    // list of named parameters
    Parameters []QueryParameter `json:"parameters,omitempty"`
    // SQL query as a string
    Query string `json:"query"`
    // Row limit to use if no limit specified in the query
    DefaultRowLimit int32 `json:"default_row_limit,omitempty"`
    // Whether to generate warnings
    GenerateWarnings bool `json:"generate_warnings,omitempty"`
    // Whether to generate a performance profile for this query
    ProfilingEnabled bool `json:"profiling_enabled,omitempty"`
}

func (QueryRequestSql) PrintResponse Uses

func (m QueryRequestSql) PrintResponse()

type QueryResponse Uses

type QueryResponse struct {
    // unique id for this query
    QueryId string `json:"query_id,omitempty"`
    // list of collections queried by the query
    Collections []string `json:"collections,omitempty"`
    // list of objects returned by the query
    Results []interface{} `json:"results,omitempty"`
    // meta information about the query
    Stats *QueryResponseStats `json:"stats,omitempty"`
    // warnings received from the query
    Warnings []string `json:"warnings,omitempty"`
    // errors encountered while streaming the query
    QueryErrors []QueryError `json:"query_errors,omitempty"`
    // meta information about each column in the result set
    ColumnFields []QueryFieldType `json:"column_fields,omitempty"`
}

func (QueryResponse) PrintResponse Uses

func (m QueryResponse) PrintResponse()

type QueryResponseStats Uses

type QueryResponseStats struct {
    // query time in milliseconds
    ElapsedTimeMs int64 `json:"elapsed_time_ms,omitempty"`
}

func (QueryResponseStats) PrintResponse Uses

func (m QueryResponseStats) PrintResponse()

type RedshiftIntegration Uses

type RedshiftIntegration struct {
    // AWS access key credentials
    AwsAccessKey *AwsAccessKey `json:"aws_access_key,omitempty"`
    // Username associated with Redshift cluster
    Username string `json:"username"`
    // Password associated with Redshift cluster
    Password string `json:"password"`
    // Redshift Cluster host
    Host string `json:"host"`
    // Redshift Cluster port
    Port int32 `json:"port"`
    // unload S3 bucket path
    S3BucketPath string `json:"s3_bucket_path"`
}

func (RedshiftIntegration) PrintResponse Uses

func (m RedshiftIntegration) PrintResponse()

type Resource Uses

type Resource struct {
    // ISO-8601 date
    CreatedAt string `json:"created_at,omitempty"`
    // email of user who created the collection
    CreatedBy string `json:"created_by,omitempty"`
    // unique identifer for collection, can contain alphanumeric or dash characters
    Name string `json:"name,omitempty"`
    // text describing the collection
    Description string `json:"description,omitempty"`
    // current status of collection, one of: CREATED, READY, DELETED, PAUSED, RESUMING
    Status string `json:"status,omitempty"`
    // list of sources from which collection ingests
    Sources []Source `json:"sources,omitempty"`
    // metrics about the collection
    Stats *ResourceStats `json:"stats,omitempty"`
    // number of seconds after which data is purged based on event time
    RetentionSecs int64 `json:"retention_secs,omitempty"`
    // list of mappings applied on all documents in a collection
    FieldMappings []FieldMappingV2 `json:"field_mappings,omitempty"`
}

func (Resource) PrintResponse Uses

func (m Resource) PrintResponse()

type ResourceStats Uses

type ResourceStats struct {
    // number of documents in the collection
    DocCount int64 `json:"doc_count,omitempty"`
    // total collection size in bytes
    TotalSize int64 `json:"total_size,omitempty"`
    // number between 0 and 1 that indicates progress of collection creation
    FillProgress float64 `json:"fill_progress,omitempty"`
    // milliseconds since Unix epoch Jan 1, 1970
    LastUpdatedMs int64 `json:"last_updated_ms,omitempty"`
    // milliseconds since Unix epoch Jan 1, 1970
    LastQueriedMs int64 `json:"last_queried_ms,omitempty"`
}

func (ResourceStats) PrintResponse Uses

func (m ResourceStats) PrintResponse()

type Response Uses

type Response struct {
    Metadata map[string][]interface{} `json:"metadata,omitempty"`
    Status   int32                    `json:"status,omitempty"`
    Entity   *interface{}             `json:"entity,omitempty"`
}

func (Response) PrintResponse Uses

func (m Response) PrintResponse()

type S3Integration Uses

type S3Integration struct {
    // credentials for an AWS access key integration
    AwsAccessKey *AwsAccessKey `json:"aws_access_key,omitempty"`
    // details of an AWS cross-account role integration
    AwsRole *AwsRole `json:"aws_role,omitempty"`
}

func (S3Integration) PrintResponse Uses

func (m S3Integration) PrintResponse()

type SavedQuery Uses

type SavedQuery struct {
    // workspace of this saved query
    Workspace string `json:"workspace,omitempty"`
    // user that created this query
    CreatedBy string `json:"created_by,omitempty"`
    // ISO-8601 date of when saved query was created
    CreatedAt string `json:"created_at,omitempty"`
    // query name
    Name string `json:"name,omitempty"`
    // query version
    Version int32 `json:"version,omitempty"`
    // optional version tag
    VersionTag string `json:"version_tag,omitempty"`
    // SQL text of this query
    QuerySql string `json:"query_sql,omitempty"`
    // collections queried by this query
    Collections []string `json:"collections,omitempty"`
    // parameters associated with this query
    Parameters []SavedQueryParameter `json:"parameters,omitempty"`
    // status of this query
    State string `json:"state,omitempty"`
    // stats related to this query
    Stats *SavedQueryStats `json:"stats,omitempty"`
}

func (SavedQuery) PrintResponse Uses

func (m SavedQuery) PrintResponse()

type SavedQueryParameter Uses

type SavedQueryParameter struct {
    // name of the field
    Name string `json:"name"`
    // data type of the field
    Type_ string `json:"type"`
    // default value of the field
    DefaultValue *interface{} `json:"default_value"`
}

func (SavedQueryParameter) PrintResponse Uses

func (m SavedQueryParameter) PrintResponse()

type SavedQueryStats Uses

type SavedQueryStats struct {
    // ISO-8601 date
    LastExecuted string `json:"last_executed,omitempty"`
    // user who last executed saved query
    LastExecutedBy string `json:"last_executed_by,omitempty"`
    // ISO-8601 date of last execution failure
    LastExecutionError string `json:"last_execution_error,omitempty"`
    // error message associated with last failed query execution
    LastExecutionErrorMessage string `json:"last_execution_error_message,omitempty"`
}

func (SavedQueryStats) PrintResponse Uses

func (m SavedQueryStats) PrintResponse()

type SegmentIntegration Uses

type SegmentIntegration struct {
    // segment connection string
    ConnectionString string `json:"connection_string,omitempty"`
}

func (SegmentIntegration) PrintResponse Uses

func (m SegmentIntegration) PrintResponse()

type Service Uses

type Service struct {
    Client *APIClient
}

type Source Uses

type Source struct {
    // name of integration to use
    IntegrationName string `json:"integration_name"`
    // configuration for ingestion from S3
    S3  *SourceS3 `json:"s3,omitempty"`
    // configuration for ingestion from kinesis stream
    Kinesis *SourceKinesis `json:"kinesis,omitempty"`
    // configuration for ingestion from GCS
    Gcs *SourceGcs `json:"gcs,omitempty"`
    // configuration for ingestion from Redshift
    Redshift *SourceRedshift `json:"redshift,omitempty"`
    // configuration for ingestion from  a dynamodb table
    Dynamodb *SourceDynamoDb `json:"dynamodb,omitempty"`
    // file upload details
    FileUpload *SourceFileUpload `json:"file_upload,omitempty"`
    // kafka collection identifier
    Kafka *SourceKafka `json:"kafka,omitempty"`
    // MongoDB collection details
    Mongodb *SourceMongoDb `json:"mongodb,omitempty"`
    // the ingest status of this source
    Status *Status `json:"status,omitempty"`
    // format parameters for data from this source
    FormatParams *FormatParams `json:"format_params,omitempty"`
}

Details about the data source for the given collection. Only one of the following fields are allowed to be defined. Only collections can act as data sources for views.

func (Source) PrintResponse Uses

func (m Source) PrintResponse()

type SourceDynamoDb Uses

type SourceDynamoDb struct {
    // AWS region name of DynamoDB table, by default us-west-2 is used
    AwsRegion string `json:"aws_region,omitempty"`
    // name of DynamoDB table containing data
    TableName string `json:"table_name"`
    // DynamoDB source status
    Status *StatusDynamoDb `json:"status,omitempty"`
    // Max RCU usage for scan
    Rcu int64 `json:"rcu,omitempty"`
}

func (SourceDynamoDb) PrintResponse Uses

func (m SourceDynamoDb) PrintResponse()

type SourceFileUpload Uses

type SourceFileUpload struct {
    // name of the file
    FileName string `json:"file_name"`
    // size of the file in bytes
    FileSize int64 `json:"file_size"`
    // time of file upload
    FileUploadTime string `json:"file_upload_time"`
}

func (SourceFileUpload) PrintResponse Uses

func (m SourceFileUpload) PrintResponse()

type SourceGcs Uses

type SourceGcs struct {
    // name of GCS bucket you want to ingest from
    Bucket string `json:"bucket,omitempty"`
    // Prefix that selects keys to ingest.
    Prefix string `json:"prefix,omitempty"`
}

func (SourceGcs) PrintResponse Uses

func (m SourceGcs) PrintResponse()

type SourceKafka Uses

type SourceKafka struct {
    // The Kafka topic to be tailed
    KafkaTopicName string `json:"kafka_topic_name"`
    // Kafka source status
    Status *StatusKafka `json:"status,omitempty"`
}

func (SourceKafka) PrintResponse Uses

func (m SourceKafka) PrintResponse()

type SourceKinesis Uses

type SourceKinesis struct {
    // name of kinesis stream
    StreamName string `json:"stream_name"`
    // AWS region name of Kinesis stream, by default us-west-2 is used
    AwsRegion string `json:"aws_region,omitempty"`
}

func (SourceKinesis) PrintResponse Uses

func (m SourceKinesis) PrintResponse()

type SourceMongoDb Uses

type SourceMongoDb struct {
    // MongoDB database name containing this collection
    DatabaseName string `json:"database_name"`
    // MongoDB collection name
    CollectionName string `json:"collection_name"`
    // MongoDB source status
    Status *StatusMongoDb `json:"status,omitempty"`
}

func (SourceMongoDb) PrintResponse Uses

func (m SourceMongoDb) PrintResponse()

type SourceRedshift Uses

type SourceRedshift struct {
    // name of the database in Redshift Cluster
    Database string `json:"database"`
    // schema which contains the Redshift table
    Schema string `json:"schema"`
    // name of Redshift table containing data
    TableName string `json:"table_name"`
    // field in Redshift source table to monitor for updates
    IncrementalField string `json:"incremental_field,omitempty"`
}

func (SourceRedshift) PrintResponse Uses

func (m SourceRedshift) PrintResponse()

type SourceS3 Uses

type SourceS3 struct {
    // Prefix that selects keys to ingest.
    Prefix string `json:"prefix,omitempty"`
    // Pattern that selects keys to ingest.
    Pattern string `json:"pattern,omitempty"`
    // address of S3 bucket containing data
    Bucket string `json:"bucket"`
}

func (SourceS3) PrintResponse Uses

func (m SourceS3) PrintResponse()

type SqlExpression Uses

type SqlExpression struct {
    // The name of a sql function
    Sql string `json:"sql,omitempty"`
}

func (SqlExpression) PrintResponse Uses

func (m SqlExpression) PrintResponse()

type Status Uses

type Status struct {
    // Status of the Source's ingestion, one of: INITIALIZING, WATCHING, PROCESSING, COMPLETED, ERROR
    State string `json:"state,omitempty"`
    // ISO-8601 date when state was triggered
    Since string `json:"since,omitempty"`
    // state message
    Message string `json:"message,omitempty"`
    // ISO-8601 date when source was last processed
    LastProcessedAt string `json:"last_processed_at,omitempty"`
    // last source item processed by ingester
    LastProcessedItem string `json:"last_processed_item,omitempty"`
    // Total items processed of source
    TotalProcessedItems int64 `json:"total_processed_items,omitempty"`
    // ISO-8601 date when last error occurred
    LastErrorAt string `json:"last_error_at,omitempty"`
    // last source item that errored
    LastErrorItem string `json:"last_error_item,omitempty"`
    // reason for the last error
    LastErrorReason string `json:"last_error_reason,omitempty"`
    // Total items that errored
    TotalErrorItems int64 `json:"total_error_items,omitempty"`
}

func (Status) PrintResponse Uses

func (m Status) PrintResponse()

type StatusDynamoDb Uses

type StatusDynamoDb struct {
    // DynamoDB scan start time
    ScanStartTime string `json:"scan_start_time,omitempty"`
    // DynamoDb scan end time
    ScanEndTime string `json:"scan_end_time,omitempty"`
    // Number of records inserted using scan
    ScanRecordsProcessed int64 `json:"scan_records_processed,omitempty"`
    // Number of records in DynamoDB table at time of scan
    ScanTotalRecords int64 `json:"scan_total_records,omitempty"`
    // state of current ingest for this table
    State string `json:"state,omitempty"`
    // ISO-8601 date when source was last processed
    StreamLastProcessedAt string `json:"stream_last_processed_at,omitempty"`
}

func (StatusDynamoDb) PrintResponse Uses

func (m StatusDynamoDb) PrintResponse()

type StatusKafka Uses

type StatusKafka struct {
    // State of the Kafka source
    State string `json:"state,omitempty"`
    // Time at which the last document was consumed from Kafka
    LastConsumedTime string `json:"last_consumed_time,omitempty"`
    // Number of documents consumed by this Kafka topic
    NumDocumentsProcessed int64 `json:"num_documents_processed,omitempty"`
}

func (StatusKafka) PrintResponse Uses

func (m StatusKafka) PrintResponse()

type StatusKafkaPartition Uses

type StatusKafkaPartition struct {
    // The number of this partition
    PartitionNumber int32 `json:"partition_number,omitempty"`
    // Number of documents consumed by this partition
    NumDocumentsProcessed int64 `json:"num_documents_processed,omitempty"`
}

func (StatusKafkaPartition) PrintResponse Uses

func (m StatusKafkaPartition) PrintResponse()

type StatusMongoDb Uses

type StatusMongoDb struct {
    // MongoDB scan start time
    ScanStartTime string `json:"scan_start_time,omitempty"`
    // MongoDB scan end time
    ScanEndTime string `json:"scan_end_time,omitempty"`
    // Number of records inserted using scan
    ScanRecordsProcessed int64 `json:"scan_records_processed,omitempty"`
    // Number of records in MongoDB table at time of scan
    ScanTotalRecords int64 `json:"scan_total_records,omitempty"`
    // state of current ingest for this table
    State string `json:"state,omitempty"`
    // ISO-8601 date when new insert from source was last processed
    StreamLastInsertProcessedAt string `json:"stream_last_insert_processed_at,omitempty"`
    // ISO-8601 date when update from source was last processed
    StreamLastUpdateProcessedAt string `json:"stream_last_update_processed_at,omitempty"`
    // ISO-8601 date when delete from source was last processed
    StreamLastDeleteProcessedAt string `json:"stream_last_delete_processed_at,omitempty"`
    // Number of new records inserted using stream
    StreamRecordsInserted int64 `json:"stream_records_inserted,omitempty"`
    // Number of new records updated using stream
    StreamRecordsUpdated int64 `json:"stream_records_updated,omitempty"`
    // Number of new records deleted using stream
    StreamRecordsDeleted int64 `json:"stream_records_deleted,omitempty"`
}

func (StatusMongoDb) PrintResponse Uses

func (m StatusMongoDb) PrintResponse()

type UpdateOpts Uses

type UpdateOpts struct {
    Create optional.Bool
}

type UpdateQueryLambdaRequest Uses

type UpdateQueryLambdaRequest struct {
    // optional description
    Description string `json:"description,omitempty"`
    // Query Lambda SQL query
    Sql *QueryLambdaSql `json:"sql,omitempty"`
}

func (UpdateQueryLambdaRequest) PrintResponse Uses

func (m UpdateQueryLambdaRequest) PrintResponse()

type UpdateQueryLambdaResponse Uses

type UpdateQueryLambdaResponse struct {
    // Query Lambda data
    Data *QueryLambda `json:"data,omitempty"`
}

func (UpdateQueryLambdaResponse) PrintResponse Uses

func (m UpdateQueryLambdaResponse) PrintResponse()

type UpdateSavedQueryRequest Uses

type UpdateSavedQueryRequest struct {
    // optional version tag
    VersionTag string `json:"version_tag,omitempty"`
    // SQL text of this query
    QuerySql string `json:"query_sql"`
    // parameters associated with this query
    Parameters []SavedQueryParameter `json:"parameters,omitempty"`
}

func (UpdateSavedQueryRequest) PrintResponse Uses

func (m UpdateSavedQueryRequest) PrintResponse()

type UpdateSavedQueryResponse Uses

type UpdateSavedQueryResponse struct {
    // saved query data
    Data *SavedQuery `json:"data,omitempty"`
}

func (UpdateSavedQueryResponse) PrintResponse Uses

func (m UpdateSavedQueryResponse) PrintResponse()

type User Uses

type User struct {
    // ISO-8601 date
    CreatedAt string `json:"created_at,omitempty"`
    // user email
    Email string `json:"email"`
    // user first name
    FirstName string `json:"first_name,omitempty"`
    // user last name
    LastName string `json:"last_name,omitempty"`
    // List of roles for a given user
    Roles []string `json:"roles,omitempty"`
    // state of user - NEW / ACTIVE
    State          string          `json:"state,omitempty"`
    Org            string          `json:"org,omitempty"`
    InviteState    string          `json:"invite_state,omitempty"`
    Orgs           []Organization  `json:"orgs,omitempty"`
    OrgMemberships []OrgMembership `json:"org_memberships,omitempty"`
}

func (User) PrintResponse Uses

func (m User) PrintResponse()

type UsersApiService Uses

type UsersApiService Service

func (*UsersApiService) Create Uses

func (a *UsersApiService) Create(body CreateUserRequest) (CreateUserResponse, *http.Response, error)

UsersApiService Create User Create a new user for an organization.

* @param body JSON object

@return CreateUserResponse

func (*UsersApiService) CreateStream Uses

func (a *UsersApiService) CreateStream(body CreateUserRequest) (string, *http.Response, error)

func (*UsersApiService) Delete Uses

func (a *UsersApiService) Delete(user string) (DeleteUserResponse, *http.Response, error)

UsersApiService Delete User Delete a user from an organization.

* @param user user email

@return DeleteUserResponse

func (*UsersApiService) DeleteStream Uses

func (a *UsersApiService) DeleteStream(user string) (string, *http.Response, error)

func (*UsersApiService) Get Uses

func (a *UsersApiService) Get() (User, *http.Response, error)

UsersApiService Get Current User Retrieve currently active user.

@return User

func (*UsersApiService) GetStream Uses

func (a *UsersApiService) GetStream() (string, *http.Response, error)

func (*UsersApiService) List Uses

func (a *UsersApiService) List() (ListUsersResponse, *http.Response, error)

UsersApiService List Users Retrieve all users for an organization.

@return ListUsersResponse

func (*UsersApiService) ListStream Uses

func (a *UsersApiService) ListStream() (string, *http.Response, error)

type ValidateOpts Uses

type ValidateOpts struct {
    Parameters optional.Bool
}

type ValidateQueryResponse Uses

type ValidateQueryResponse struct {
    // list of collection specified in query
    Name []string `json:"name"`
    // list of collection specified in query
    Collections []string `json:"collections"`
    // list of parameters specified in query
    Parameters []string `json:"parameters"`
}

func (ValidateQueryResponse) PrintResponse Uses

func (m ValidateQueryResponse) PrintResponse()

type Workspace Uses

type Workspace struct {
    // ISO-8601 date of when workspace was created
    CreatedAt string `json:"created_at,omitempty"`
    // email of user who created the workspace
    CreatedBy string `json:"created_by,omitempty"`
    // descriptive label and unique identifier
    Name string `json:"name,omitempty"`
    // longer explanation for the workspace
    Description string `json:"description,omitempty"`
    // number of collections that are immediate children of workspace
    CollectionCount int64 `json:"collection_count,omitempty"`
}

Workspaces are organizational containers for collections.

func (Workspace) PrintResponse Uses

func (m Workspace) PrintResponse()

type WorkspacesApiService Uses

type WorkspacesApiService Service

func (*WorkspacesApiService) Child Uses

func (a *WorkspacesApiService) Child(workspace string) (ListWorkspacesResponse, *http.Response, error)

WorkspacesApiService List Workspaces List workspaces under given workspace.

* @param workspace name of the workspace

@return ListWorkspacesResponse

func (*WorkspacesApiService) ChildStream Uses

func (a *WorkspacesApiService) ChildStream(workspace string) (string, *http.Response, error)

func (*WorkspacesApiService) Create Uses

func (a *WorkspacesApiService) Create(body CreateWorkspaceRequest) (CreateWorkspaceResponse, *http.Response, error)

WorkspacesApiService Create Workspace Create a new workspace in your org.

* @param body workspace details

@return CreateWorkspaceResponse

func (*WorkspacesApiService) CreateStream Uses

func (a *WorkspacesApiService) CreateStream(body CreateWorkspaceRequest) (string, *http.Response, error)

func (*WorkspacesApiService) Delete Uses

func (a *WorkspacesApiService) Delete(workspace string) (DeleteWorkspaceResponse, *http.Response, error)

WorkspacesApiService Delete Workspace Remove a workspace.

* @param workspace name of the workspace

@return DeleteWorkspaceResponse

func (*WorkspacesApiService) DeleteStream Uses

func (a *WorkspacesApiService) DeleteStream(workspace string) (string, *http.Response, error)

func (*WorkspacesApiService) Get Uses

func (a *WorkspacesApiService) Get(workspace string) (GetWorkspaceResponse, *http.Response, error)

WorkspacesApiService Get Workspace Get information about a single workspace.

* @param workspace name of the workspace

@return GetWorkspaceResponse

func (*WorkspacesApiService) GetStream Uses

func (a *WorkspacesApiService) GetStream(workspace string) (string, *http.Response, error)

func (*WorkspacesApiService) List Uses

func (a *WorkspacesApiService) List() (ListWorkspacesResponse, *http.Response, error)

WorkspacesApiService List Workspaces List all workspaces.

@return ListWorkspacesResponse

func (*WorkspacesApiService) ListStream Uses

func (a *WorkspacesApiService) ListStream() (string, *http.Response, error)

type XmlParams Uses

type XmlParams struct {
    // tag until which xml is ignored
    RootTag string `json:"root_tag,omitempty"`
    // encoding in which data source is encoded
    Encoding string `json:"encoding,omitempty"`
    // tags with which documents are identified
    DocTag string `json:"doc_tag,omitempty"`
    // tag used for the value when there are attributes in the element having no child
    ValueTag string `json:"value_tag,omitempty"`
    // tag to differentiate between attributes and elements
    AttributePrefix string `json:"attribute_prefix,omitempty"`
}

func (XmlParams) PrintResponse Uses

func (m XmlParams) PrintResponse()

Package rockset imports 21 packages (graph) and is imported by 3 packages. Updated 2020-10-06. Refresh now. Tools for package owners.