hotdata

Powerful data platform API for datasets, queries, and analytics.

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

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

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import hotdata

Setuptools

Install via Setuptools.

python setup.py install --user

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

Then import the package:

import hotdata

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import hotdata
from hotdata.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.hotdata.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = hotdata.Configuration(
    host = "https://app.hotdata.dev"
)



# Enter a context with an instance of the API client
with hotdata.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hotdata.ConnectionsApi(api_client)
    connection_id = 'connection_id_example' # str | Connection ID

    try:
        # Check connection health
        api_response = api_instance.check_connection_health_handler(connection_id)
        print("The response of ConnectionsApi->check_connection_health_handler:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConnectionsApi->check_connection_health_handler: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://app.hotdata.dev

Class	Method	HTTP request	Description
ConnectionsApi	check_connection_health_handler	GET /v1/connections/{connection_id}/health	Check connection health
ConnectionsApi	create_connection_handler	POST /v1/connections	Create connection
ConnectionsApi	delete_connection_handler	DELETE /v1/connections/{connection_id}	Delete connection
ConnectionsApi	get_connection_handler	GET /v1/connections/{connection_id}	Get connection
ConnectionsApi	get_table_profile_handler	GET /v1/connections/{connection_id}/tables/{schema}/{table}/profile	Get table profile
ConnectionsApi	list_connections_handler	GET /v1/connections	List connections
ConnectionsApi	purge_connection_cache_handler	DELETE /v1/connections/{connection_id}/cache	Purge connection cache
ConnectionsApi	purge_table_cache_handler	DELETE /v1/connections/{connection_id}/tables/{schema}/{table}/cache	Purge table cache
DatasetsApi	create_dataset	POST /v1/datasets	Create dataset
DatasetsApi	delete_dataset	DELETE /v1/datasets/{id}	Delete dataset
DatasetsApi	get_dataset	GET /v1/datasets/{id}	Get dataset
DatasetsApi	list_datasets	GET /v1/datasets	List datasets
DatasetsApi	update_dataset	PUT /v1/datasets/{id}	Update dataset
InformationSchemaApi	information_schema_handler	GET /v1/information_schema	List tables
QueryApi	query_handler	POST /v1/query	Execute SQL query
QueryRunsApi	list_query_runs_handler	GET /v1/query-runs	List query runs
RefreshApi	refresh_handler	POST /v1/refresh	Refresh connection data
ResultsApi	get_result_handler	GET /v1/results/{id}	Get result
ResultsApi	list_results_handler	GET /v1/results	List results
SavedQueriesApi	create_saved_query	POST /v1/queries	Create saved query
SavedQueriesApi	delete_saved_query	DELETE /v1/queries/{id}	Delete saved query
SavedQueriesApi	execute_saved_query	POST /v1/queries/{id}/execute	Execute saved query
SavedQueriesApi	get_saved_query	GET /v1/queries/{id}	Get saved query
SavedQueriesApi	list_saved_queries	GET /v1/queries	List saved queries
SavedQueriesApi	list_saved_query_versions	GET /v1/queries/{id}/versions	List saved query versions
SavedQueriesApi	update_saved_query	PUT /v1/queries/{id}	Update saved query
SecretsApi	create_secret_handler	POST /v1/secrets	Create secret
SecretsApi	delete_secret_handler	DELETE /v1/secrets/{name}	Delete secret
SecretsApi	get_secret_handler	GET /v1/secrets/{name}	Get secret
SecretsApi	list_secrets_handler	GET /v1/secrets	List secrets
SecretsApi	update_secret_handler	PUT /v1/secrets/{name}	Update secret
UploadsApi	list_uploads	GET /v1/files	List uploads
UploadsApi	upload_file	POST /v1/files	Upload file
WorkspacesApi	create_workspace	POST /v1/workspaces	Create a workspace
WorkspacesApi	list_workspaces	GET /v1/workspaces	List workspaces

Documentation For Models

• ApiErrorDetail
• ApiErrorResponse
• CategoryValueInfo
• ColumnDefinition
• ColumnInfo
• ColumnProfileDetail
• ColumnProfileDetailOneOf
• ColumnProfileDetailOneOf1
• ColumnProfileDetailOneOf2
• ColumnProfileDetailOneOf3
• ColumnProfileDetailOneOf4
• ColumnProfileInfo
• ColumnTypeSpec
• ConnectionHealthResponse
• ConnectionInfo
• ConnectionRefreshResult
• ConnectionSchemaError
• CreateConnectionRequest
• CreateConnectionResponse
• CreateDatasetRequest
• CreateDatasetResponse
• CreateSavedQueryRequest
• CreateSecretRequest
• CreateSecretResponse
• CreateWorkspace201Response
• CreateWorkspaceRequest
• DatasetSource
• DatasetSourceOneOf
• DatasetSourceOneOf1
• DatasetSummary
• DiscoveryStatus
• Error
• ExecuteSavedQueryRequest
• GetConnectionResponse
• GetDatasetResponse
• GetResultResponse
• GetSecretResponse
• InformationSchemaResponse
• InlineData
• ListConnectionsResponse
• ListDatasetsResponse
• ListQueryRunsResponse
• ListResultsResponse
• ListSavedQueriesResponse
• ListSavedQueryVersionsResponse
• ListSecretsResponse
• ListUploadsResponse
• ListWorkspaces200Response
• QueryRequest
• QueryResponse
• QueryRunInfo
• RefreshRequest
• RefreshResponse
• RefreshWarning
• ResultInfo
• SavedQueryDetail
• SavedQuerySummary
• SavedQueryVersionInfo
• SchemaRefreshResult
• SecretMetadataResponse
• TableInfo
• TableProfileResponse
• TableRefreshError
• TableRefreshResult
• UpdateDatasetRequest
• UpdateDatasetResponse
• UpdateSavedQueryRequest
• UpdateSecretRequest
• UpdateSecretResponse
• UploadInfo
• UploadResponse
• WorkspaceDetail
• WorkspaceListItem

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

WorkspaceId

• Type: API key
• API key parameter name: X-Workspace-Id
• Location: HTTP header

Author