hotdata 0.1.0

Powerful data platform API for datasets, queries, and analytics.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

# \DatabaseContextApi

All URIs are relative to *https://api.hotdata.dev*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_database_context**](DatabaseContextApi.md#delete_database_context) | **DELETE** /v1/databases/{database_id}/context/{name} | Delete database context
[**get_database_context**](DatabaseContextApi.md#get_database_context) | **GET** /v1/databases/{database_id}/context/{name} | Get one database context
[**list_database_contexts**](DatabaseContextApi.md#list_database_contexts) | **GET** /v1/databases/{database_id}/context | List database contexts
[**upsert_database_context**](DatabaseContextApi.md#upsert_database_context) | **POST** /v1/databases/{database_id}/context | Create or update database context



## delete_database_context

> delete_database_context(database_id, name)
Delete database context

Removes a named context document from a database.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**database_id** | **String** | Database ID | [required] |
**name** | **String** | Context key: same character rules as a dataset table name | [required] |

### Return type

 (empty response body)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

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


## get_database_context

> models::GetDatabaseContextResponse get_database_context(database_id, name)
Get one database context

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**database_id** | **String** | Database ID | [required] |
**name** | **String** | Context key: same character rules as a dataset table name | [required] |

### Return type

[**models::GetDatabaseContextResponse**](GetDatabaseContextResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

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


## list_database_contexts

> models::ListDatabaseContextsResponse list_database_contexts(database_id)
List database contexts

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**database_id** | **String** | Database ID | [required] |

### Return type

[**models::ListDatabaseContextsResponse**](ListDatabaseContextsResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

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


## upsert_database_context

> models::UpsertDatabaseContextResponse upsert_database_context(database_id, upsert_database_context_request)
Create or update database context

Stores a named document (for example Markdown) scoped to a database. Reuses the same name to replace content.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**database_id** | **String** | Database ID | [required] |
**upsert_database_context_request** | [**UpsertDatabaseContextRequest**](UpsertDatabaseContextRequest.md) |  | [required] |

### Return type

[**models::UpsertDatabaseContextResponse**](UpsertDatabaseContextResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

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

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