@malloydata/db-publisher 0.0.314 → 0.0.316
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/api.d.ts +1594 -528
- package/dist/client/api.js +1820 -553
- package/dist/client/api.js.map +1 -1
- package/dist/client/base.d.ts +1 -1
- package/dist/client/base.js +1 -1
- package/dist/client/common.d.ts +1 -1
- package/dist/client/common.js +1 -1
- package/dist/client/configuration.d.ts +1 -1
- package/dist/client/configuration.js +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.js +1 -1
- package/dist/publisher_connection.d.ts +4 -1
- package/dist/publisher_connection.integration.spec.js +208 -0
- package/dist/publisher_connection.integration.spec.js.map +1 -0
- package/dist/publisher_connection.js +42 -11
- package/dist/publisher_connection.js.map +1 -1
- package/dist/publisher_connection.unit.spec.d.ts +1 -0
- package/dist/{publisher_connection.spec.js → publisher_connection.unit.spec.js} +214 -175
- package/dist/publisher_connection.unit.spec.js.map +1 -0
- package/package.json +2 -2
- package/publisher-api-doc.yaml +1434 -449
- package/src/client/.openapi-generator/FILES +0 -1
- package/src/client/api.ts +2513 -754
- package/src/client/base.ts +1 -1
- package/src/client/common.ts +1 -1
- package/src/client/configuration.ts +1 -1
- package/src/client/index.ts +1 -1
- package/src/publisher_connection.integration.spec.ts +200 -0
- package/src/publisher_connection.ts +67 -19
- package/src/{publisher_connection.spec.ts → publisher_connection.unit.spec.ts} +260 -175
- package/dist/publisher_connection.spec.js.map +0 -1
- /package/dist/{publisher_connection.spec.d.ts → publisher_connection.integration.spec.d.ts} +0 -0
package/dist/client/api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Malloy Publisher - Semantic Model Serving API
|
|
3
|
-
* The Malloy Publisher - Semantic Model Serving API
|
|
3
|
+
* The Malloy Publisher - Semantic Model Serving API provides comprehensive access to Malloy packages and their associated resources. A Malloy package is a directory containing Malloy models (.malloy files), Malloy notebooks (.malloynb files), and embedded databases (.parquet files) with a malloy-publisher.json manifest at the package\'s root directory. ## Key Features - **Project Management**: Create and manage projects with their associated packages and connections - **Package Lifecycle**: Full CRUD operations for Malloy packages and their versions - **Model & Notebook Access**: Retrieve and execute Malloy models and notebooks - **Connection Management**: Secure database connection configuration and testing - **Query Execution**: Execute queries against models and retrieve results - **Watch Mode**: Real-time file watching for development workflows ## Resource Hierarchy The API follows a hierarchical resource structure: ``` Projects ├── Connections └── Packages ├── Models ├── Notebooks └── Databases ``` For examples, see the Malloy samples packages (https://github.com/malloydata/malloy-samples) repository.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -14,141 +14,222 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Attached DuckDB database
|
|
18
18
|
* @export
|
|
19
|
-
* @interface
|
|
19
|
+
* @interface AttachedDatabase
|
|
20
20
|
*/
|
|
21
|
-
export interface
|
|
21
|
+
export interface AttachedDatabase {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Name of the connection
|
|
24
24
|
* @type {string}
|
|
25
|
-
* @memberof
|
|
25
|
+
* @memberof AttachedDatabase
|
|
26
26
|
*/
|
|
27
|
-
'
|
|
27
|
+
'name'?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Type of database connection
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AttachedDatabase
|
|
32
|
+
*/
|
|
33
|
+
'type'?: AttachedDatabaseTypeEnum;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {ConnectionAttributes}
|
|
37
|
+
* @memberof AttachedDatabase
|
|
38
|
+
*/
|
|
39
|
+
'attributes'?: ConnectionAttributes;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {BigqueryConnection}
|
|
43
|
+
* @memberof AttachedDatabase
|
|
44
|
+
*/
|
|
45
|
+
'bigqueryConnection'?: BigqueryConnection;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {SnowflakeConnection}
|
|
49
|
+
* @memberof AttachedDatabase
|
|
50
|
+
*/
|
|
51
|
+
'snowflakeConnection'?: SnowflakeConnection;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {PostgresConnection}
|
|
55
|
+
* @memberof AttachedDatabase
|
|
56
|
+
*/
|
|
57
|
+
'postgresConnection'?: PostgresConnection;
|
|
28
58
|
}
|
|
59
|
+
export declare const AttachedDatabaseTypeEnum: {
|
|
60
|
+
readonly Bigquery: "bigquery";
|
|
61
|
+
readonly Snowflake: "snowflake";
|
|
62
|
+
readonly Postgres: "postgres";
|
|
63
|
+
};
|
|
64
|
+
export type AttachedDatabaseTypeEnum = typeof AttachedDatabaseTypeEnum[keyof typeof AttachedDatabaseTypeEnum];
|
|
29
65
|
/**
|
|
30
|
-
*
|
|
66
|
+
* Google BigQuery database connection configuration
|
|
31
67
|
* @export
|
|
32
68
|
* @interface BigqueryConnection
|
|
33
69
|
*/
|
|
34
70
|
export interface BigqueryConnection {
|
|
35
71
|
/**
|
|
36
|
-
*
|
|
72
|
+
* Default BigQuery project ID for queries
|
|
37
73
|
* @type {string}
|
|
38
74
|
* @memberof BigqueryConnection
|
|
39
75
|
*/
|
|
40
76
|
'defaultProjectId'?: string;
|
|
41
77
|
/**
|
|
42
|
-
*
|
|
78
|
+
* BigQuery project ID for billing purposes
|
|
43
79
|
* @type {string}
|
|
44
80
|
* @memberof BigqueryConnection
|
|
45
81
|
*/
|
|
46
82
|
'billingProjectId'?: string;
|
|
47
83
|
/**
|
|
48
|
-
*
|
|
84
|
+
* BigQuery dataset location/region
|
|
49
85
|
* @type {string}
|
|
50
86
|
* @memberof BigqueryConnection
|
|
51
87
|
*/
|
|
52
88
|
'location'?: string;
|
|
53
89
|
/**
|
|
54
|
-
*
|
|
90
|
+
* JSON string containing Google Cloud service account credentials
|
|
55
91
|
* @type {string}
|
|
56
92
|
* @memberof BigqueryConnection
|
|
57
93
|
*/
|
|
58
94
|
'serviceAccountKeyJson'?: string;
|
|
59
95
|
/**
|
|
60
|
-
*
|
|
96
|
+
* Maximum bytes to bill for query execution (prevents runaway costs)
|
|
61
97
|
* @type {string}
|
|
62
98
|
* @memberof BigqueryConnection
|
|
63
99
|
*/
|
|
64
100
|
'maximumBytesBilled'?: string;
|
|
65
101
|
/**
|
|
66
|
-
*
|
|
102
|
+
* Query timeout in milliseconds
|
|
67
103
|
* @type {string}
|
|
68
104
|
* @memberof BigqueryConnection
|
|
69
105
|
*/
|
|
70
106
|
'queryTimeoutMilliseconds'?: string;
|
|
71
107
|
}
|
|
72
108
|
/**
|
|
73
|
-
*
|
|
109
|
+
* Database column definition
|
|
74
110
|
* @export
|
|
75
|
-
* @interface
|
|
111
|
+
* @interface Column
|
|
76
112
|
*/
|
|
77
|
-
export interface
|
|
113
|
+
export interface Column {
|
|
78
114
|
/**
|
|
79
|
-
*
|
|
115
|
+
* Name of the column
|
|
80
116
|
* @type {string}
|
|
81
|
-
* @memberof
|
|
117
|
+
* @memberof Column
|
|
82
118
|
*/
|
|
83
|
-
'
|
|
119
|
+
'name'?: string;
|
|
120
|
+
/**
|
|
121
|
+
* Data type of the column
|
|
122
|
+
* @type {string}
|
|
123
|
+
* @memberof Column
|
|
124
|
+
*/
|
|
125
|
+
'type'?: string;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Compiled Malloy model with sources, queries, and metadata
|
|
129
|
+
* @export
|
|
130
|
+
* @interface CompiledModel
|
|
131
|
+
*/
|
|
132
|
+
export interface CompiledModel {
|
|
84
133
|
/**
|
|
85
|
-
*
|
|
134
|
+
* Resource path to the model
|
|
86
135
|
* @type {string}
|
|
87
136
|
* @memberof CompiledModel
|
|
88
137
|
*/
|
|
89
|
-
'
|
|
138
|
+
'resource'?: string;
|
|
90
139
|
/**
|
|
91
|
-
*
|
|
140
|
+
* Name of the package containing this model
|
|
92
141
|
* @type {string}
|
|
93
142
|
* @memberof CompiledModel
|
|
94
143
|
*/
|
|
95
|
-
'
|
|
144
|
+
'packageName'?: string;
|
|
96
145
|
/**
|
|
97
|
-
*
|
|
146
|
+
* Relative path to the model file within its package directory
|
|
98
147
|
* @type {string}
|
|
99
148
|
* @memberof CompiledModel
|
|
100
149
|
*/
|
|
101
|
-
'
|
|
150
|
+
'path'?: string;
|
|
102
151
|
/**
|
|
103
|
-
*
|
|
152
|
+
* Version of the Malloy compiler used to generate the model data
|
|
104
153
|
* @type {string}
|
|
105
154
|
* @memberof CompiledModel
|
|
106
155
|
*/
|
|
107
|
-
'
|
|
156
|
+
'malloyVersion'?: string;
|
|
108
157
|
/**
|
|
109
|
-
*
|
|
158
|
+
* JSON string containing model metadata and structure information
|
|
110
159
|
* @type {string}
|
|
111
160
|
* @memberof CompiledModel
|
|
112
161
|
*/
|
|
113
|
-
'
|
|
162
|
+
'modelInfo'?: string;
|
|
114
163
|
/**
|
|
115
|
-
* Array of
|
|
116
|
-
* @type {Array<
|
|
164
|
+
* Array of JSON strings containing source information for each data source
|
|
165
|
+
* @type {Array<string>}
|
|
117
166
|
* @memberof CompiledModel
|
|
118
167
|
*/
|
|
119
|
-
'
|
|
168
|
+
'sourceInfos'?: Array<string>;
|
|
120
169
|
/**
|
|
121
|
-
*
|
|
170
|
+
* Array of named queries defined in the model
|
|
122
171
|
* @type {Array<Query>}
|
|
123
172
|
* @memberof CompiledModel
|
|
124
173
|
*/
|
|
125
174
|
'queries'?: Array<Query>;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Compiled Malloy notebook with cells, results, and execution data
|
|
178
|
+
* @export
|
|
179
|
+
* @interface CompiledNotebook
|
|
180
|
+
*/
|
|
181
|
+
export interface CompiledNotebook {
|
|
182
|
+
/**
|
|
183
|
+
* Resource path to the notebook
|
|
184
|
+
* @type {string}
|
|
185
|
+
* @memberof CompiledNotebook
|
|
186
|
+
*/
|
|
187
|
+
'resource'?: string;
|
|
188
|
+
/**
|
|
189
|
+
* Name of the package containing this notebook
|
|
190
|
+
* @type {string}
|
|
191
|
+
* @memberof CompiledNotebook
|
|
192
|
+
*/
|
|
193
|
+
'packageName'?: string;
|
|
194
|
+
/**
|
|
195
|
+
* Relative path to the notebook file within its package directory
|
|
196
|
+
* @type {string}
|
|
197
|
+
* @memberof CompiledNotebook
|
|
198
|
+
*/
|
|
199
|
+
'path'?: string;
|
|
200
|
+
/**
|
|
201
|
+
* Version of the Malloy compiler used to generate the notebook data
|
|
202
|
+
* @type {string}
|
|
203
|
+
* @memberof CompiledNotebook
|
|
204
|
+
*/
|
|
205
|
+
'malloyVersion'?: string;
|
|
126
206
|
/**
|
|
127
|
-
* Array of notebook cells
|
|
207
|
+
* Array of notebook cells containing code, markdown, and execution results
|
|
128
208
|
* @type {Array<NotebookCell>}
|
|
129
|
-
* @memberof
|
|
209
|
+
* @memberof CompiledNotebook
|
|
130
210
|
*/
|
|
131
211
|
'notebookCells'?: Array<NotebookCell>;
|
|
132
212
|
}
|
|
133
|
-
export declare const CompiledModelTypeEnum: {
|
|
134
|
-
readonly Source: "source";
|
|
135
|
-
readonly Notebook: "notebook";
|
|
136
|
-
};
|
|
137
|
-
export type CompiledModelTypeEnum = typeof CompiledModelTypeEnum[keyof typeof CompiledModelTypeEnum];
|
|
138
213
|
/**
|
|
139
|
-
*
|
|
214
|
+
* Database connection configuration and metadata
|
|
140
215
|
* @export
|
|
141
216
|
* @interface Connection
|
|
142
217
|
*/
|
|
143
218
|
export interface Connection {
|
|
144
219
|
/**
|
|
145
|
-
*
|
|
220
|
+
* Resource path to the connection
|
|
221
|
+
* @type {string}
|
|
222
|
+
* @memberof Connection
|
|
223
|
+
*/
|
|
224
|
+
'resource'?: string;
|
|
225
|
+
/**
|
|
226
|
+
* Name of the connection
|
|
146
227
|
* @type {string}
|
|
147
228
|
* @memberof Connection
|
|
148
229
|
*/
|
|
149
230
|
'name'?: string;
|
|
150
231
|
/**
|
|
151
|
-
*
|
|
232
|
+
* Type of database connection
|
|
152
233
|
* @type {string}
|
|
153
234
|
* @memberof Connection
|
|
154
235
|
*/
|
|
@@ -183,65 +264,109 @@ export interface Connection {
|
|
|
183
264
|
* @memberof Connection
|
|
184
265
|
*/
|
|
185
266
|
'trinoConnection'?: TrinoConnection;
|
|
267
|
+
/**
|
|
268
|
+
*
|
|
269
|
+
* @type {MysqlConnection}
|
|
270
|
+
* @memberof Connection
|
|
271
|
+
*/
|
|
272
|
+
'mysqlConnection'?: MysqlConnection;
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @type {DuckdbConnection}
|
|
276
|
+
* @memberof Connection
|
|
277
|
+
*/
|
|
278
|
+
'duckdbConnection'?: DuckdbConnection;
|
|
186
279
|
}
|
|
187
280
|
export declare const ConnectionTypeEnum: {
|
|
188
281
|
readonly Postgres: "postgres";
|
|
189
282
|
readonly Bigquery: "bigquery";
|
|
190
283
|
readonly Snowflake: "snowflake";
|
|
191
284
|
readonly Trino: "trino";
|
|
285
|
+
readonly Mysql: "mysql";
|
|
286
|
+
readonly Duckdb: "duckdb";
|
|
192
287
|
};
|
|
193
288
|
export type ConnectionTypeEnum = typeof ConnectionTypeEnum[keyof typeof ConnectionTypeEnum];
|
|
194
289
|
/**
|
|
195
|
-
*
|
|
290
|
+
* Connection capabilities and configuration attributes
|
|
196
291
|
* @export
|
|
197
292
|
* @interface ConnectionAttributes
|
|
198
293
|
*/
|
|
199
294
|
export interface ConnectionAttributes {
|
|
200
295
|
/**
|
|
201
|
-
*
|
|
296
|
+
* SQL dialect name for the connection
|
|
202
297
|
* @type {string}
|
|
203
298
|
* @memberof ConnectionAttributes
|
|
204
299
|
*/
|
|
205
300
|
'dialectName'?: string;
|
|
206
301
|
/**
|
|
207
|
-
*
|
|
302
|
+
* Whether the connection uses connection pooling
|
|
208
303
|
* @type {boolean}
|
|
209
304
|
* @memberof ConnectionAttributes
|
|
210
305
|
*/
|
|
211
306
|
'isPool'?: boolean;
|
|
212
307
|
/**
|
|
213
|
-
*
|
|
308
|
+
* Whether the connection supports persistent storage operations
|
|
214
309
|
* @type {boolean}
|
|
215
310
|
* @memberof ConnectionAttributes
|
|
216
311
|
*/
|
|
217
312
|
'canPersist'?: boolean;
|
|
218
313
|
/**
|
|
219
|
-
*
|
|
314
|
+
* Whether the connection supports streaming query results
|
|
220
315
|
* @type {boolean}
|
|
221
316
|
* @memberof ConnectionAttributes
|
|
222
317
|
*/
|
|
223
318
|
'canStream'?: boolean;
|
|
224
319
|
}
|
|
225
320
|
/**
|
|
226
|
-
*
|
|
321
|
+
* Result of testing a database connection
|
|
322
|
+
* @export
|
|
323
|
+
* @interface ConnectionStatus
|
|
324
|
+
*/
|
|
325
|
+
export interface ConnectionStatus {
|
|
326
|
+
/**
|
|
327
|
+
* Connection test result status
|
|
328
|
+
* @type {string}
|
|
329
|
+
* @memberof ConnectionStatus
|
|
330
|
+
*/
|
|
331
|
+
'status'?: ConnectionStatusStatusEnum;
|
|
332
|
+
/**
|
|
333
|
+
* Error message if the connection test failed, null if successful
|
|
334
|
+
* @type {string}
|
|
335
|
+
* @memberof ConnectionStatus
|
|
336
|
+
*/
|
|
337
|
+
'errorMessage'?: string;
|
|
338
|
+
}
|
|
339
|
+
export declare const ConnectionStatusStatusEnum: {
|
|
340
|
+
readonly Ok: "ok";
|
|
341
|
+
readonly Failed: "failed";
|
|
342
|
+
};
|
|
343
|
+
export type ConnectionStatusStatusEnum = typeof ConnectionStatusStatusEnum[keyof typeof ConnectionStatusStatusEnum];
|
|
344
|
+
/**
|
|
345
|
+
* Embedded database within a Malloy package
|
|
227
346
|
* @export
|
|
228
347
|
* @interface Database
|
|
229
348
|
*/
|
|
230
349
|
export interface Database {
|
|
231
350
|
/**
|
|
232
|
-
*
|
|
351
|
+
* Resource path to the database
|
|
352
|
+
* @type {string}
|
|
353
|
+
* @memberof Database
|
|
354
|
+
*/
|
|
355
|
+
'resource'?: string;
|
|
356
|
+
/**
|
|
357
|
+
* Relative path to the database file within its package directory
|
|
233
358
|
* @type {string}
|
|
234
359
|
* @memberof Database
|
|
235
360
|
*/
|
|
236
361
|
'path'?: string;
|
|
237
362
|
/**
|
|
238
|
-
*
|
|
239
|
-
* @type {
|
|
363
|
+
*
|
|
364
|
+
* @type {TableDescription}
|
|
240
365
|
* @memberof Database
|
|
241
366
|
*/
|
|
242
|
-
'
|
|
367
|
+
'info'?: TableDescription;
|
|
243
368
|
/**
|
|
244
|
-
* Type of database
|
|
369
|
+
* Type of embedded database
|
|
245
370
|
* @type {string}
|
|
246
371
|
* @memberof Database
|
|
247
372
|
*/
|
|
@@ -253,84 +378,166 @@ export declare const DatabaseTypeEnum: {
|
|
|
253
378
|
};
|
|
254
379
|
export type DatabaseTypeEnum = typeof DatabaseTypeEnum[keyof typeof DatabaseTypeEnum];
|
|
255
380
|
/**
|
|
256
|
-
*
|
|
381
|
+
* DuckDB database connection configuration
|
|
382
|
+
* @export
|
|
383
|
+
* @interface DuckdbConnection
|
|
384
|
+
*/
|
|
385
|
+
export interface DuckdbConnection {
|
|
386
|
+
/**
|
|
387
|
+
*
|
|
388
|
+
* @type {any}
|
|
389
|
+
* @memberof DuckdbConnection
|
|
390
|
+
*/
|
|
391
|
+
'attachedDatabases'?: any;
|
|
392
|
+
}
|
|
393
|
+
/**
|
|
394
|
+
* Malloy model metadata and status information
|
|
257
395
|
* @export
|
|
258
396
|
* @interface Model
|
|
259
397
|
*/
|
|
260
398
|
export interface Model {
|
|
261
399
|
/**
|
|
262
|
-
*
|
|
400
|
+
* Resource path to the model
|
|
401
|
+
* @type {string}
|
|
402
|
+
* @memberof Model
|
|
403
|
+
*/
|
|
404
|
+
'resource'?: string;
|
|
405
|
+
/**
|
|
406
|
+
* Name of the package containing this model
|
|
263
407
|
* @type {string}
|
|
264
408
|
* @memberof Model
|
|
265
409
|
*/
|
|
266
410
|
'packageName'?: string;
|
|
267
411
|
/**
|
|
268
|
-
*
|
|
412
|
+
* Relative path to the model file within its package directory
|
|
269
413
|
* @type {string}
|
|
270
414
|
* @memberof Model
|
|
271
415
|
*/
|
|
272
416
|
'path'?: string;
|
|
273
417
|
/**
|
|
274
|
-
*
|
|
418
|
+
* Error message if the model failed to compile or load
|
|
275
419
|
* @type {string}
|
|
276
420
|
* @memberof Model
|
|
277
421
|
*/
|
|
278
|
-
'
|
|
422
|
+
'error'?: string;
|
|
279
423
|
}
|
|
280
|
-
export declare const ModelTypeEnum: {
|
|
281
|
-
readonly Source: "source";
|
|
282
|
-
readonly Notebook: "notebook";
|
|
283
|
-
};
|
|
284
|
-
export type ModelTypeEnum = typeof ModelTypeEnum[keyof typeof ModelTypeEnum];
|
|
285
424
|
/**
|
|
286
|
-
*
|
|
425
|
+
* Standard error response format
|
|
287
426
|
* @export
|
|
288
427
|
* @interface ModelError
|
|
289
428
|
*/
|
|
290
429
|
export interface ModelError {
|
|
291
430
|
/**
|
|
292
|
-
*
|
|
431
|
+
* Human-readable error message describing what went wrong
|
|
293
432
|
* @type {string}
|
|
294
433
|
* @memberof ModelError
|
|
295
434
|
*/
|
|
296
|
-
'
|
|
435
|
+
'message': string;
|
|
297
436
|
/**
|
|
298
|
-
*
|
|
437
|
+
* Additional error details or context
|
|
299
438
|
* @type {string}
|
|
300
439
|
* @memberof ModelError
|
|
301
440
|
*/
|
|
302
|
-
'
|
|
441
|
+
'details'?: string;
|
|
442
|
+
}
|
|
443
|
+
/**
|
|
444
|
+
* MySQL database connection configuration
|
|
445
|
+
* @export
|
|
446
|
+
* @interface MysqlConnection
|
|
447
|
+
*/
|
|
448
|
+
export interface MysqlConnection {
|
|
449
|
+
/**
|
|
450
|
+
* MySQL server hostname or IP address
|
|
451
|
+
* @type {string}
|
|
452
|
+
* @memberof MysqlConnection
|
|
453
|
+
*/
|
|
454
|
+
'host'?: string;
|
|
455
|
+
/**
|
|
456
|
+
* MySQL server port number
|
|
457
|
+
* @type {number}
|
|
458
|
+
* @memberof MysqlConnection
|
|
459
|
+
*/
|
|
460
|
+
'port'?: number;
|
|
461
|
+
/**
|
|
462
|
+
* Name of the MySQL database
|
|
463
|
+
* @type {string}
|
|
464
|
+
* @memberof MysqlConnection
|
|
465
|
+
*/
|
|
466
|
+
'database'?: string;
|
|
467
|
+
/**
|
|
468
|
+
* MySQL username for authentication
|
|
469
|
+
* @type {string}
|
|
470
|
+
* @memberof MysqlConnection
|
|
471
|
+
*/
|
|
472
|
+
'user'?: string;
|
|
473
|
+
/**
|
|
474
|
+
* MySQL password for authentication
|
|
475
|
+
* @type {string}
|
|
476
|
+
* @memberof MysqlConnection
|
|
477
|
+
*/
|
|
478
|
+
'password'?: string;
|
|
479
|
+
}
|
|
480
|
+
/**
|
|
481
|
+
* Malloy notebook metadata and status information
|
|
482
|
+
* @export
|
|
483
|
+
* @interface Notebook
|
|
484
|
+
*/
|
|
485
|
+
export interface Notebook {
|
|
486
|
+
/**
|
|
487
|
+
* Resource path to the notebook
|
|
488
|
+
* @type {string}
|
|
489
|
+
* @memberof Notebook
|
|
490
|
+
*/
|
|
491
|
+
'resource'?: string;
|
|
492
|
+
/**
|
|
493
|
+
* Name of the package containing this notebook
|
|
494
|
+
* @type {string}
|
|
495
|
+
* @memberof Notebook
|
|
496
|
+
*/
|
|
497
|
+
'packageName'?: string;
|
|
498
|
+
/**
|
|
499
|
+
* Relative path to the notebook file within its package directory
|
|
500
|
+
* @type {string}
|
|
501
|
+
* @memberof Notebook
|
|
502
|
+
*/
|
|
503
|
+
'path'?: string;
|
|
504
|
+
/**
|
|
505
|
+
* Error message if the notebook failed to compile or load
|
|
506
|
+
* @type {string}
|
|
507
|
+
* @memberof Notebook
|
|
508
|
+
*/
|
|
509
|
+
'error'?: string;
|
|
303
510
|
}
|
|
304
511
|
/**
|
|
305
|
-
*
|
|
512
|
+
* Individual cell within a Malloy notebook
|
|
306
513
|
* @export
|
|
307
514
|
* @interface NotebookCell
|
|
308
515
|
*/
|
|
309
516
|
export interface NotebookCell {
|
|
310
517
|
/**
|
|
311
|
-
* Type of notebook cell
|
|
518
|
+
* Type of notebook cell
|
|
312
519
|
* @type {string}
|
|
313
520
|
* @memberof NotebookCell
|
|
314
521
|
*/
|
|
315
522
|
'type'?: NotebookCellTypeEnum;
|
|
316
523
|
/**
|
|
317
|
-
* Text contents of the notebook cell
|
|
524
|
+
* Text contents of the notebook cell
|
|
318
525
|
* @type {string}
|
|
319
526
|
* @memberof NotebookCell
|
|
320
527
|
*/
|
|
321
528
|
'text'?: string;
|
|
322
529
|
/**
|
|
323
|
-
*
|
|
530
|
+
* JSON string containing the execution result for this cell
|
|
324
531
|
* @type {string}
|
|
325
532
|
* @memberof NotebookCell
|
|
326
533
|
*/
|
|
327
|
-
'
|
|
534
|
+
'result'?: string;
|
|
328
535
|
/**
|
|
329
|
-
*
|
|
330
|
-
* @type {string}
|
|
536
|
+
* Array of JSON strings containing SourceInfo objects made available in this cell
|
|
537
|
+
* @type {Array<string>}
|
|
331
538
|
* @memberof NotebookCell
|
|
332
539
|
*/
|
|
333
|
-
'
|
|
540
|
+
'newSources'?: Array<string>;
|
|
334
541
|
}
|
|
335
542
|
export declare const NotebookCellTypeEnum: {
|
|
336
543
|
readonly Markdown: "markdown";
|
|
@@ -338,94 +545,155 @@ export declare const NotebookCellTypeEnum: {
|
|
|
338
545
|
};
|
|
339
546
|
export type NotebookCellTypeEnum = typeof NotebookCellTypeEnum[keyof typeof NotebookCellTypeEnum];
|
|
340
547
|
/**
|
|
341
|
-
*
|
|
548
|
+
* Represents a Malloy package containing models, notebooks, and embedded databases
|
|
342
549
|
* @export
|
|
343
550
|
* @interface Package
|
|
344
551
|
*/
|
|
345
552
|
export interface Package {
|
|
346
553
|
/**
|
|
347
|
-
*
|
|
554
|
+
* Resource path to the package
|
|
555
|
+
* @type {string}
|
|
556
|
+
* @memberof Package
|
|
557
|
+
*/
|
|
558
|
+
'resource'?: string;
|
|
559
|
+
/**
|
|
560
|
+
* Package name
|
|
348
561
|
* @type {string}
|
|
349
562
|
* @memberof Package
|
|
350
563
|
*/
|
|
351
564
|
'name'?: string;
|
|
352
565
|
/**
|
|
353
|
-
* Package description
|
|
566
|
+
* Package description
|
|
354
567
|
* @type {string}
|
|
355
568
|
* @memberof Package
|
|
356
569
|
*/
|
|
357
570
|
'description'?: string;
|
|
571
|
+
/**
|
|
572
|
+
* Package location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
|
|
573
|
+
* @type {string}
|
|
574
|
+
* @memberof Package
|
|
575
|
+
*/
|
|
576
|
+
'location'?: string;
|
|
358
577
|
}
|
|
359
578
|
/**
|
|
360
579
|
*
|
|
361
580
|
* @export
|
|
581
|
+
* @interface PostSqlsourceRequest
|
|
582
|
+
*/
|
|
583
|
+
export interface PostSqlsourceRequest {
|
|
584
|
+
/**
|
|
585
|
+
*
|
|
586
|
+
* @type {string}
|
|
587
|
+
* @memberof PostSqlsourceRequest
|
|
588
|
+
*/
|
|
589
|
+
'sqlStatement'?: string;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* PostgreSQL database connection configuration
|
|
593
|
+
* @export
|
|
362
594
|
* @interface PostgresConnection
|
|
363
595
|
*/
|
|
364
596
|
export interface PostgresConnection {
|
|
365
597
|
/**
|
|
366
|
-
*
|
|
598
|
+
* PostgreSQL server hostname or IP address
|
|
367
599
|
* @type {string}
|
|
368
600
|
* @memberof PostgresConnection
|
|
369
601
|
*/
|
|
370
602
|
'host'?: string;
|
|
371
603
|
/**
|
|
372
|
-
*
|
|
604
|
+
* PostgreSQL server port number
|
|
373
605
|
* @type {number}
|
|
374
606
|
* @memberof PostgresConnection
|
|
375
607
|
*/
|
|
376
608
|
'port'?: number;
|
|
377
609
|
/**
|
|
378
|
-
*
|
|
610
|
+
* Name of the PostgreSQL database
|
|
379
611
|
* @type {string}
|
|
380
612
|
* @memberof PostgresConnection
|
|
381
613
|
*/
|
|
382
614
|
'databaseName'?: string;
|
|
383
615
|
/**
|
|
384
|
-
*
|
|
616
|
+
* PostgreSQL username for authentication
|
|
385
617
|
* @type {string}
|
|
386
618
|
* @memberof PostgresConnection
|
|
387
619
|
*/
|
|
388
620
|
'userName'?: string;
|
|
389
621
|
/**
|
|
390
|
-
*
|
|
622
|
+
* PostgreSQL password for authentication
|
|
391
623
|
* @type {string}
|
|
392
624
|
* @memberof PostgresConnection
|
|
393
625
|
*/
|
|
394
626
|
'password'?: string;
|
|
395
627
|
/**
|
|
396
|
-
*
|
|
628
|
+
* Complete PostgreSQL connection string (alternative to individual parameters)
|
|
397
629
|
* @type {string}
|
|
398
630
|
* @memberof PostgresConnection
|
|
399
631
|
*/
|
|
400
632
|
'connectionString'?: string;
|
|
401
633
|
}
|
|
402
634
|
/**
|
|
403
|
-
*
|
|
635
|
+
* Represents a Malloy project containing packages, connections, and other resources
|
|
404
636
|
* @export
|
|
405
637
|
* @interface Project
|
|
406
638
|
*/
|
|
407
639
|
export interface Project {
|
|
408
640
|
/**
|
|
409
|
-
*
|
|
641
|
+
* Resource path to the project
|
|
642
|
+
* @type {string}
|
|
643
|
+
* @memberof Project
|
|
644
|
+
*/
|
|
645
|
+
'resource'?: string;
|
|
646
|
+
/**
|
|
647
|
+
* Project name
|
|
410
648
|
* @type {string}
|
|
411
649
|
* @memberof Project
|
|
412
650
|
*/
|
|
413
651
|
'name'?: string;
|
|
652
|
+
/**
|
|
653
|
+
* Project README content
|
|
654
|
+
* @type {string}
|
|
655
|
+
* @memberof Project
|
|
656
|
+
*/
|
|
657
|
+
'readme'?: string;
|
|
658
|
+
/**
|
|
659
|
+
* Project location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
|
|
660
|
+
* @type {string}
|
|
661
|
+
* @memberof Project
|
|
662
|
+
*/
|
|
663
|
+
'location'?: string;
|
|
664
|
+
/**
|
|
665
|
+
* List of database connections configured for this project
|
|
666
|
+
* @type {Array<Connection>}
|
|
667
|
+
* @memberof Project
|
|
668
|
+
*/
|
|
669
|
+
'connections'?: Array<Connection>;
|
|
670
|
+
/**
|
|
671
|
+
* List of Malloy packages in this project
|
|
672
|
+
* @type {Array<Package>}
|
|
673
|
+
* @memberof Project
|
|
674
|
+
*/
|
|
675
|
+
'packages'?: Array<Package>;
|
|
414
676
|
}
|
|
415
677
|
/**
|
|
416
|
-
* Named model query
|
|
678
|
+
* Named model query definition
|
|
417
679
|
* @export
|
|
418
680
|
* @interface Query
|
|
419
681
|
*/
|
|
420
682
|
export interface Query {
|
|
421
683
|
/**
|
|
422
|
-
*
|
|
684
|
+
* Name of the query
|
|
423
685
|
* @type {string}
|
|
424
686
|
* @memberof Query
|
|
425
687
|
*/
|
|
426
688
|
'name'?: string;
|
|
427
689
|
/**
|
|
428
|
-
*
|
|
690
|
+
* Name of the source this query operates on
|
|
691
|
+
* @type {string}
|
|
692
|
+
* @memberof Query
|
|
693
|
+
*/
|
|
694
|
+
'sourceName'?: string;
|
|
695
|
+
/**
|
|
696
|
+
* Annotations attached to the query
|
|
429
697
|
* @type {Array<string>}
|
|
430
698
|
* @memberof Query
|
|
431
699
|
*/
|
|
@@ -437,6 +705,12 @@ export interface Query {
|
|
|
437
705
|
* @interface QueryData
|
|
438
706
|
*/
|
|
439
707
|
export interface QueryData {
|
|
708
|
+
/**
|
|
709
|
+
* Resource path to the query data.
|
|
710
|
+
* @type {string}
|
|
711
|
+
* @memberof QueryData
|
|
712
|
+
*/
|
|
713
|
+
'resource'?: string;
|
|
440
714
|
/**
|
|
441
715
|
*
|
|
442
716
|
* @type {string}
|
|
@@ -445,159 +719,241 @@ export interface QueryData {
|
|
|
445
719
|
'data'?: string;
|
|
446
720
|
}
|
|
447
721
|
/**
|
|
448
|
-
*
|
|
722
|
+
* Request body for executing a Malloy query
|
|
449
723
|
* @export
|
|
450
|
-
* @interface
|
|
724
|
+
* @interface QueryRequest
|
|
451
725
|
*/
|
|
452
|
-
export interface
|
|
726
|
+
export interface QueryRequest {
|
|
453
727
|
/**
|
|
454
|
-
*
|
|
728
|
+
* Query string to execute on the model. If the query parameter is set, the queryName parameter must be empty.
|
|
455
729
|
* @type {string}
|
|
456
|
-
* @memberof
|
|
730
|
+
* @memberof QueryRequest
|
|
457
731
|
*/
|
|
458
|
-
'
|
|
732
|
+
'query'?: string;
|
|
459
733
|
/**
|
|
460
|
-
*
|
|
734
|
+
* Name of the source in the model to use for queryName, search, and topValue requests.
|
|
461
735
|
* @type {string}
|
|
462
|
-
* @memberof
|
|
736
|
+
* @memberof QueryRequest
|
|
463
737
|
*/
|
|
464
|
-
'
|
|
738
|
+
'sourceName'?: string;
|
|
465
739
|
/**
|
|
466
|
-
*
|
|
740
|
+
* Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName parameter is set, the query parameter must be empty.
|
|
467
741
|
* @type {string}
|
|
468
|
-
* @memberof
|
|
742
|
+
* @memberof QueryRequest
|
|
743
|
+
*/
|
|
744
|
+
'queryName'?: string;
|
|
745
|
+
/**
|
|
746
|
+
* Version ID
|
|
747
|
+
* @type {string}
|
|
748
|
+
* @memberof QueryRequest
|
|
469
749
|
*/
|
|
470
|
-
'
|
|
750
|
+
'versionId'?: string;
|
|
471
751
|
}
|
|
472
752
|
/**
|
|
473
|
-
*
|
|
753
|
+
* Results from executing a Malloy query
|
|
474
754
|
* @export
|
|
475
|
-
* @interface
|
|
755
|
+
* @interface QueryResult
|
|
476
756
|
*/
|
|
477
|
-
export interface
|
|
478
|
-
/**
|
|
479
|
-
* Resource in the package that the schedule is attached to.
|
|
480
|
-
* @type {string}
|
|
481
|
-
* @memberof Schedule
|
|
482
|
-
*/
|
|
483
|
-
'resource'?: string;
|
|
757
|
+
export interface QueryResult {
|
|
484
758
|
/**
|
|
485
|
-
*
|
|
759
|
+
* JSON string containing the query results, metadata, and execution information
|
|
486
760
|
* @type {string}
|
|
487
|
-
* @memberof
|
|
761
|
+
* @memberof QueryResult
|
|
488
762
|
*/
|
|
489
|
-
'
|
|
763
|
+
'result'?: string;
|
|
490
764
|
/**
|
|
491
|
-
*
|
|
765
|
+
* Resource path to the query result
|
|
492
766
|
* @type {string}
|
|
493
|
-
* @memberof
|
|
767
|
+
* @memberof QueryResult
|
|
494
768
|
*/
|
|
495
|
-
'
|
|
496
|
-
|
|
497
|
-
|
|
769
|
+
'resource'?: string;
|
|
770
|
+
}
|
|
771
|
+
/**
|
|
772
|
+
* A schema name in a Connection.
|
|
773
|
+
* @export
|
|
774
|
+
* @interface Schema
|
|
775
|
+
*/
|
|
776
|
+
export interface Schema {
|
|
777
|
+
/**
|
|
778
|
+
* Name of the schema
|
|
779
|
+
* @type {string}
|
|
780
|
+
* @memberof Schema
|
|
781
|
+
*/
|
|
782
|
+
'name'?: string;
|
|
783
|
+
/**
|
|
784
|
+
* Description of the schema
|
|
498
785
|
* @type {string}
|
|
499
|
-
* @memberof
|
|
786
|
+
* @memberof Schema
|
|
787
|
+
*/
|
|
788
|
+
'description'?: string;
|
|
789
|
+
/**
|
|
790
|
+
* Whether this schema is the default schema
|
|
791
|
+
* @type {boolean}
|
|
792
|
+
* @memberof Schema
|
|
793
|
+
*/
|
|
794
|
+
'isDefault'?: boolean;
|
|
795
|
+
/**
|
|
796
|
+
* Whether this schema is hidden
|
|
797
|
+
* @type {boolean}
|
|
798
|
+
* @memberof Schema
|
|
500
799
|
*/
|
|
501
|
-
'
|
|
800
|
+
'isHidden'?: boolean;
|
|
801
|
+
}
|
|
802
|
+
/**
|
|
803
|
+
* Current server status and health information
|
|
804
|
+
* @export
|
|
805
|
+
* @interface ServerStatus
|
|
806
|
+
*/
|
|
807
|
+
export interface ServerStatus {
|
|
502
808
|
/**
|
|
503
|
-
*
|
|
809
|
+
* Unix timestamp of the status check
|
|
504
810
|
* @type {number}
|
|
505
|
-
* @memberof
|
|
811
|
+
* @memberof ServerStatus
|
|
506
812
|
*/
|
|
507
|
-
'
|
|
813
|
+
'timestamp'?: number;
|
|
508
814
|
/**
|
|
509
|
-
*
|
|
510
|
-
* @type {
|
|
511
|
-
* @memberof
|
|
815
|
+
* List of available projects
|
|
816
|
+
* @type {Array<Project>}
|
|
817
|
+
* @memberof ServerStatus
|
|
818
|
+
*/
|
|
819
|
+
'projects'?: Array<Project>;
|
|
820
|
+
/**
|
|
821
|
+
* Whether the server is fully initialized and ready to serve requests
|
|
822
|
+
* @type {boolean}
|
|
823
|
+
* @memberof ServerStatus
|
|
512
824
|
*/
|
|
513
|
-
'
|
|
825
|
+
'initialized'?: boolean;
|
|
514
826
|
}
|
|
515
827
|
/**
|
|
516
|
-
*
|
|
828
|
+
* Snowflake database connection configuration
|
|
517
829
|
* @export
|
|
518
830
|
* @interface SnowflakeConnection
|
|
519
831
|
*/
|
|
520
832
|
export interface SnowflakeConnection {
|
|
521
833
|
/**
|
|
522
|
-
*
|
|
834
|
+
* Snowflake account identifier
|
|
523
835
|
* @type {string}
|
|
524
836
|
* @memberof SnowflakeConnection
|
|
525
837
|
*/
|
|
526
838
|
'account'?: string;
|
|
527
839
|
/**
|
|
528
|
-
*
|
|
840
|
+
* Snowflake username for authentication
|
|
529
841
|
* @type {string}
|
|
530
842
|
* @memberof SnowflakeConnection
|
|
531
843
|
*/
|
|
532
844
|
'username'?: string;
|
|
533
845
|
/**
|
|
534
|
-
*
|
|
846
|
+
* Snowflake password for authentication
|
|
535
847
|
* @type {string}
|
|
536
848
|
* @memberof SnowflakeConnection
|
|
537
849
|
*/
|
|
538
850
|
'password'?: string;
|
|
539
851
|
/**
|
|
540
|
-
*
|
|
852
|
+
* Snowflake warehouse name
|
|
541
853
|
* @type {string}
|
|
542
854
|
* @memberof SnowflakeConnection
|
|
543
855
|
*/
|
|
544
856
|
'warehouse'?: string;
|
|
545
857
|
/**
|
|
546
|
-
*
|
|
858
|
+
* Snowflake database name
|
|
547
859
|
* @type {string}
|
|
548
860
|
* @memberof SnowflakeConnection
|
|
549
861
|
*/
|
|
550
862
|
'database'?: string;
|
|
551
863
|
/**
|
|
552
|
-
*
|
|
864
|
+
* Snowflake schema name
|
|
553
865
|
* @type {string}
|
|
554
866
|
* @memberof SnowflakeConnection
|
|
555
867
|
*/
|
|
556
868
|
'schema'?: string;
|
|
557
869
|
/**
|
|
558
|
-
*
|
|
870
|
+
* Snowflake role name
|
|
871
|
+
* @type {string}
|
|
872
|
+
* @memberof SnowflakeConnection
|
|
873
|
+
*/
|
|
874
|
+
'role'?: string;
|
|
875
|
+
/**
|
|
876
|
+
* Query response timeout in milliseconds
|
|
559
877
|
* @type {number}
|
|
560
878
|
* @memberof SnowflakeConnection
|
|
561
879
|
*/
|
|
562
880
|
'responseTimeoutMilliseconds'?: number;
|
|
563
881
|
}
|
|
564
882
|
/**
|
|
565
|
-
*
|
|
883
|
+
*
|
|
566
884
|
* @export
|
|
567
|
-
* @interface
|
|
885
|
+
* @interface SqlSource
|
|
568
886
|
*/
|
|
569
|
-
export interface
|
|
887
|
+
export interface SqlSource {
|
|
570
888
|
/**
|
|
571
|
-
*
|
|
889
|
+
* Resource path to the sql source.
|
|
572
890
|
* @type {string}
|
|
573
|
-
* @memberof
|
|
891
|
+
* @memberof SqlSource
|
|
574
892
|
*/
|
|
575
|
-
'
|
|
893
|
+
'resource'?: string;
|
|
576
894
|
/**
|
|
577
|
-
*
|
|
578
|
-
* @type {
|
|
579
|
-
* @memberof
|
|
895
|
+
*
|
|
896
|
+
* @type {string}
|
|
897
|
+
* @memberof SqlSource
|
|
580
898
|
*/
|
|
581
|
-
'
|
|
899
|
+
'source'?: string;
|
|
900
|
+
}
|
|
901
|
+
/**
|
|
902
|
+
* Request to start file watching for a project
|
|
903
|
+
* @export
|
|
904
|
+
* @interface StartWatchRequest
|
|
905
|
+
*/
|
|
906
|
+
export interface StartWatchRequest {
|
|
582
907
|
/**
|
|
583
|
-
*
|
|
584
|
-
* @type {
|
|
585
|
-
* @memberof
|
|
908
|
+
* Name of the project to start watching for file changes
|
|
909
|
+
* @type {string}
|
|
910
|
+
* @memberof StartWatchRequest
|
|
586
911
|
*/
|
|
587
|
-
'
|
|
912
|
+
'projectName': string;
|
|
588
913
|
}
|
|
589
914
|
/**
|
|
590
915
|
*
|
|
591
916
|
* @export
|
|
592
|
-
* @interface
|
|
917
|
+
* @interface Table
|
|
593
918
|
*/
|
|
594
|
-
export interface
|
|
919
|
+
export interface Table {
|
|
595
920
|
/**
|
|
596
|
-
*
|
|
921
|
+
* Resource path to the table.
|
|
597
922
|
* @type {string}
|
|
598
|
-
* @memberof
|
|
923
|
+
* @memberof Table
|
|
599
924
|
*/
|
|
600
|
-
'
|
|
925
|
+
'resource'?: string;
|
|
926
|
+
/**
|
|
927
|
+
* Table fields
|
|
928
|
+
* @type {Array<Column>}
|
|
929
|
+
* @memberof Table
|
|
930
|
+
*/
|
|
931
|
+
'columns'?: Array<Column>;
|
|
932
|
+
}
|
|
933
|
+
/**
|
|
934
|
+
* Database table structure and metadata
|
|
935
|
+
* @export
|
|
936
|
+
* @interface TableDescription
|
|
937
|
+
*/
|
|
938
|
+
export interface TableDescription {
|
|
939
|
+
/**
|
|
940
|
+
* Name of the table
|
|
941
|
+
* @type {string}
|
|
942
|
+
* @memberof TableDescription
|
|
943
|
+
*/
|
|
944
|
+
'name'?: string;
|
|
945
|
+
/**
|
|
946
|
+
* Number of rows in the table
|
|
947
|
+
* @type {number}
|
|
948
|
+
* @memberof TableDescription
|
|
949
|
+
*/
|
|
950
|
+
'rowCount'?: number;
|
|
951
|
+
/**
|
|
952
|
+
* List of columns in the table
|
|
953
|
+
* @type {Array<Column>}
|
|
954
|
+
* @memberof TableDescription
|
|
955
|
+
*/
|
|
956
|
+
'columns'?: Array<Column>;
|
|
601
957
|
}
|
|
602
958
|
/**
|
|
603
959
|
*
|
|
@@ -605,12 +961,24 @@ export interface SqlSource {
|
|
|
605
961
|
* @interface TableSource
|
|
606
962
|
*/
|
|
607
963
|
export interface TableSource {
|
|
964
|
+
/**
|
|
965
|
+
* Resource path to the table source.
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof TableSource
|
|
968
|
+
*/
|
|
969
|
+
'resource'?: string;
|
|
608
970
|
/**
|
|
609
971
|
*
|
|
610
972
|
* @type {string}
|
|
611
973
|
* @memberof TableSource
|
|
612
974
|
*/
|
|
613
975
|
'source'?: string;
|
|
976
|
+
/**
|
|
977
|
+
* Table fields
|
|
978
|
+
* @type {Array<Column>}
|
|
979
|
+
* @memberof TableSource
|
|
980
|
+
*/
|
|
981
|
+
'columns'?: Array<Column>;
|
|
614
982
|
}
|
|
615
983
|
/**
|
|
616
984
|
*
|
|
@@ -618,6 +986,12 @@ export interface TableSource {
|
|
|
618
986
|
* @interface TemporaryTable
|
|
619
987
|
*/
|
|
620
988
|
export interface TemporaryTable {
|
|
989
|
+
/**
|
|
990
|
+
* Resource path to the temporary table.
|
|
991
|
+
* @type {string}
|
|
992
|
+
* @memberof TemporaryTable
|
|
993
|
+
*/
|
|
994
|
+
'resource'?: string;
|
|
621
995
|
/**
|
|
622
996
|
*
|
|
623
997
|
* @type {string}
|
|
@@ -626,140 +1000,221 @@ export interface TemporaryTable {
|
|
|
626
1000
|
'table'?: string;
|
|
627
1001
|
}
|
|
628
1002
|
/**
|
|
629
|
-
*
|
|
1003
|
+
* Trino database connection configuration
|
|
630
1004
|
* @export
|
|
631
1005
|
* @interface TrinoConnection
|
|
632
1006
|
*/
|
|
633
1007
|
export interface TrinoConnection {
|
|
634
1008
|
/**
|
|
635
|
-
*
|
|
1009
|
+
* Trino server hostname or IP address
|
|
636
1010
|
* @type {string}
|
|
637
1011
|
* @memberof TrinoConnection
|
|
638
1012
|
*/
|
|
639
1013
|
'server'?: string;
|
|
640
1014
|
/**
|
|
641
|
-
*
|
|
1015
|
+
* Trino server port number
|
|
642
1016
|
* @type {number}
|
|
643
1017
|
* @memberof TrinoConnection
|
|
644
1018
|
*/
|
|
645
1019
|
'port'?: number;
|
|
646
1020
|
/**
|
|
647
|
-
*
|
|
1021
|
+
* Trino catalog name
|
|
648
1022
|
* @type {string}
|
|
649
1023
|
* @memberof TrinoConnection
|
|
650
1024
|
*/
|
|
651
1025
|
'catalog'?: string;
|
|
652
1026
|
/**
|
|
653
|
-
*
|
|
1027
|
+
* Trino schema name
|
|
654
1028
|
* @type {string}
|
|
655
1029
|
* @memberof TrinoConnection
|
|
656
1030
|
*/
|
|
657
1031
|
'schema'?: string;
|
|
658
1032
|
/**
|
|
659
|
-
*
|
|
1033
|
+
* Trino username for authentication
|
|
660
1034
|
* @type {string}
|
|
661
1035
|
* @memberof TrinoConnection
|
|
662
1036
|
*/
|
|
663
1037
|
'user'?: string;
|
|
664
1038
|
/**
|
|
665
|
-
*
|
|
1039
|
+
* Trino password for authentication
|
|
666
1040
|
* @type {string}
|
|
667
1041
|
* @memberof TrinoConnection
|
|
668
1042
|
*/
|
|
669
1043
|
'password'?: string;
|
|
670
1044
|
}
|
|
671
1045
|
/**
|
|
672
|
-
* Named model view
|
|
1046
|
+
* Named model view definition
|
|
673
1047
|
* @export
|
|
674
1048
|
* @interface View
|
|
675
1049
|
*/
|
|
676
1050
|
export interface View {
|
|
677
1051
|
/**
|
|
678
|
-
*
|
|
1052
|
+
* Name of the view
|
|
679
1053
|
* @type {string}
|
|
680
1054
|
* @memberof View
|
|
681
1055
|
*/
|
|
682
1056
|
'name'?: string;
|
|
683
1057
|
/**
|
|
684
|
-
* Annotations attached to view
|
|
1058
|
+
* Annotations attached to the view
|
|
685
1059
|
* @type {Array<string>}
|
|
686
1060
|
* @memberof View
|
|
687
1061
|
*/
|
|
688
1062
|
'annotations'?: Array<string>;
|
|
689
1063
|
}
|
|
1064
|
+
/**
|
|
1065
|
+
* Current file watching status and configuration
|
|
1066
|
+
* @export
|
|
1067
|
+
* @interface WatchStatus
|
|
1068
|
+
*/
|
|
1069
|
+
export interface WatchStatus {
|
|
1070
|
+
/**
|
|
1071
|
+
* Whether file watching is currently active
|
|
1072
|
+
* @type {boolean}
|
|
1073
|
+
* @memberof WatchStatus
|
|
1074
|
+
*/
|
|
1075
|
+
'enabled'?: boolean;
|
|
1076
|
+
/**
|
|
1077
|
+
* Name of the project being watched for file changes
|
|
1078
|
+
* @type {string}
|
|
1079
|
+
* @memberof WatchStatus
|
|
1080
|
+
*/
|
|
1081
|
+
'projectName'?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* The file system path being monitored for changes, null if not watching
|
|
1084
|
+
* @type {string}
|
|
1085
|
+
* @memberof WatchStatus
|
|
1086
|
+
*/
|
|
1087
|
+
'watchingPath'?: string;
|
|
1088
|
+
}
|
|
690
1089
|
/**
|
|
691
1090
|
* ConnectionsApi - axios parameter creator
|
|
692
1091
|
* @export
|
|
693
1092
|
*/
|
|
694
1093
|
export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
695
1094
|
/**
|
|
696
|
-
*
|
|
697
|
-
* @summary
|
|
698
|
-
* @param {string} projectName Name of project
|
|
699
|
-
* @param {string} connectionName Name of connection
|
|
1095
|
+
* Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
1096
|
+
* @summary Get connection details
|
|
1097
|
+
* @param {string} projectName Name of the project
|
|
1098
|
+
* @param {string} connectionName Name of the connection
|
|
700
1099
|
* @param {*} [options] Override http request option.
|
|
701
1100
|
* @throws {RequiredError}
|
|
702
1101
|
*/
|
|
703
1102
|
getConnection: (projectName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
704
1103
|
/**
|
|
705
|
-
*
|
|
706
|
-
* @summary
|
|
707
|
-
* @param {string} projectName Name of project
|
|
708
|
-
* @param {string} connectionName Name of connection
|
|
1104
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
1105
|
+
* @summary Execute SQL query (deprecated)
|
|
1106
|
+
* @param {string} projectName Name of the project
|
|
1107
|
+
* @param {string} connectionName Name of the connection
|
|
709
1108
|
* @param {string} [sqlStatement] SQL statement
|
|
710
1109
|
* @param {string} [_options] Options
|
|
711
1110
|
* @param {*} [options] Override http request option.
|
|
1111
|
+
* @deprecated
|
|
712
1112
|
* @throws {RequiredError}
|
|
713
1113
|
*/
|
|
714
1114
|
getQuerydata: (projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
715
1115
|
/**
|
|
716
|
-
*
|
|
717
|
-
* @summary
|
|
718
|
-
* @param {string} projectName Name of project
|
|
719
|
-
* @param {string} connectionName Name of connection
|
|
1116
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1117
|
+
* @summary Get SQL source (deprecated)
|
|
1118
|
+
* @param {string} projectName Name of the project
|
|
1119
|
+
* @param {string} connectionName Name of the connection
|
|
720
1120
|
* @param {string} [sqlStatement] SQL statement
|
|
721
1121
|
* @param {*} [options] Override http request option.
|
|
1122
|
+
* @deprecated
|
|
722
1123
|
* @throws {RequiredError}
|
|
723
1124
|
*/
|
|
724
1125
|
getSqlsource: (projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
725
1126
|
/**
|
|
726
|
-
*
|
|
727
|
-
* @summary
|
|
728
|
-
* @param {string} projectName Name of project
|
|
729
|
-
* @param {string} connectionName Name of connection
|
|
1127
|
+
* Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
|
|
1128
|
+
* @summary Get table details from database
|
|
1129
|
+
* @param {string} projectName Name of the project
|
|
1130
|
+
* @param {string} connectionName Name of the connection
|
|
1131
|
+
* @param {string} schemaName Name of the schema
|
|
1132
|
+
* @param {string} tablePath Full path to the table
|
|
1133
|
+
* @param {*} [options] Override http request option.
|
|
1134
|
+
* @throws {RequiredError}
|
|
1135
|
+
*/
|
|
1136
|
+
getTable: (projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1137
|
+
/**
|
|
1138
|
+
* Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
|
|
1139
|
+
* @summary Get table source information
|
|
1140
|
+
* @param {string} projectName Name of the project
|
|
1141
|
+
* @param {string} connectionName Name of the connection
|
|
730
1142
|
* @param {string} [tableKey] Table key
|
|
731
1143
|
* @param {string} [tablePath] Table path
|
|
732
1144
|
* @param {*} [options] Override http request option.
|
|
1145
|
+
* @deprecated
|
|
733
1146
|
* @throws {RequiredError}
|
|
734
1147
|
*/
|
|
735
1148
|
getTablesource: (projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
736
1149
|
/**
|
|
737
|
-
*
|
|
738
|
-
* @summary
|
|
739
|
-
* @param {string} projectName Name of project
|
|
740
|
-
* @param {string} connectionName Name of connection
|
|
1150
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
|
|
1151
|
+
* @summary Create temporary table (deprecated)
|
|
1152
|
+
* @param {string} projectName Name of the project
|
|
1153
|
+
* @param {string} connectionName Name of the connection
|
|
741
1154
|
* @param {string} [sqlStatement] SQL statement
|
|
742
1155
|
* @param {*} [options] Override http request option.
|
|
1156
|
+
* @deprecated
|
|
743
1157
|
* @throws {RequiredError}
|
|
744
1158
|
*/
|
|
745
1159
|
getTemporarytable: (projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
746
1160
|
/**
|
|
747
|
-
*
|
|
748
|
-
* @summary
|
|
749
|
-
* @param {string} projectName Name of project
|
|
750
|
-
* @param {string} connectionName Name of connection
|
|
1161
|
+
* Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
|
|
1162
|
+
* @summary List project database connections
|
|
1163
|
+
* @param {string} projectName Name of the project
|
|
751
1164
|
* @param {*} [options] Override http request option.
|
|
752
1165
|
* @throws {RequiredError}
|
|
753
1166
|
*/
|
|
754
|
-
|
|
1167
|
+
listConnections: (projectName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
755
1168
|
/**
|
|
756
|
-
*
|
|
757
|
-
* @summary
|
|
758
|
-
* @param {string} projectName Name of project
|
|
1169
|
+
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
1170
|
+
* @summary List database schemas
|
|
1171
|
+
* @param {string} projectName Name of the project
|
|
1172
|
+
* @param {string} connectionName Name of the connection
|
|
759
1173
|
* @param {*} [options] Override http request option.
|
|
760
1174
|
* @throws {RequiredError}
|
|
761
1175
|
*/
|
|
762
|
-
|
|
1176
|
+
listSchemas: (projectName: string, connectionName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1177
|
+
/**
|
|
1178
|
+
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
1179
|
+
* @summary List tables in database
|
|
1180
|
+
* @param {string} projectName Name of the project
|
|
1181
|
+
* @param {string} connectionName Name of the connection
|
|
1182
|
+
* @param {string} schemaName Name of the schema
|
|
1183
|
+
* @param {*} [options] Override http request option.
|
|
1184
|
+
* @throws {RequiredError}
|
|
1185
|
+
*/
|
|
1186
|
+
listTables: (projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1187
|
+
/**
|
|
1188
|
+
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
1189
|
+
* @summary Execute SQL query
|
|
1190
|
+
* @param {string} projectName Name of the project
|
|
1191
|
+
* @param {string} connectionName Name of the connection
|
|
1192
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
|
|
1193
|
+
* @param {string} [_options] Options
|
|
1194
|
+
* @param {*} [options] Override http request option.
|
|
1195
|
+
* @throws {RequiredError}
|
|
1196
|
+
*/
|
|
1197
|
+
postQuerydata: (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1200
|
+
* @summary Create SQL source from statement
|
|
1201
|
+
* @param {string} projectName Name of the project
|
|
1202
|
+
* @param {string} connectionName Name of the connection
|
|
1203
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
1204
|
+
* @param {*} [options] Override http request option.
|
|
1205
|
+
* @throws {RequiredError}
|
|
1206
|
+
*/
|
|
1207
|
+
postSqlsource: (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1208
|
+
/**
|
|
1209
|
+
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
1210
|
+
* @summary Create temporary table
|
|
1211
|
+
* @param {string} projectName Name of the project
|
|
1212
|
+
* @param {string} connectionName Name of the connection
|
|
1213
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
1214
|
+
* @param {*} [options] Override http request option.
|
|
1215
|
+
* @throws {RequiredError}
|
|
1216
|
+
*/
|
|
1217
|
+
postTemporarytable: (projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
763
1218
|
};
|
|
764
1219
|
/**
|
|
765
1220
|
* ConnectionsApi - functional programming interface
|
|
@@ -767,73 +1222,129 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
767
1222
|
*/
|
|
768
1223
|
export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
769
1224
|
/**
|
|
770
|
-
*
|
|
771
|
-
* @summary
|
|
772
|
-
* @param {string} projectName Name of project
|
|
773
|
-
* @param {string} connectionName Name of connection
|
|
1225
|
+
* Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
1226
|
+
* @summary Get connection details
|
|
1227
|
+
* @param {string} projectName Name of the project
|
|
1228
|
+
* @param {string} connectionName Name of the connection
|
|
774
1229
|
* @param {*} [options] Override http request option.
|
|
775
1230
|
* @throws {RequiredError}
|
|
776
1231
|
*/
|
|
777
1232
|
getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connection>>;
|
|
778
1233
|
/**
|
|
779
|
-
*
|
|
780
|
-
* @summary
|
|
781
|
-
* @param {string} projectName Name of project
|
|
782
|
-
* @param {string} connectionName Name of connection
|
|
1234
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
1235
|
+
* @summary Execute SQL query (deprecated)
|
|
1236
|
+
* @param {string} projectName Name of the project
|
|
1237
|
+
* @param {string} connectionName Name of the connection
|
|
783
1238
|
* @param {string} [sqlStatement] SQL statement
|
|
784
1239
|
* @param {string} [_options] Options
|
|
785
1240
|
* @param {*} [options] Override http request option.
|
|
1241
|
+
* @deprecated
|
|
786
1242
|
* @throws {RequiredError}
|
|
787
1243
|
*/
|
|
788
1244
|
getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
789
1245
|
/**
|
|
790
|
-
*
|
|
791
|
-
* @summary
|
|
792
|
-
* @param {string} projectName Name of project
|
|
793
|
-
* @param {string} connectionName Name of connection
|
|
1246
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1247
|
+
* @summary Get SQL source (deprecated)
|
|
1248
|
+
* @param {string} projectName Name of the project
|
|
1249
|
+
* @param {string} connectionName Name of the connection
|
|
794
1250
|
* @param {string} [sqlStatement] SQL statement
|
|
795
1251
|
* @param {*} [options] Override http request option.
|
|
1252
|
+
* @deprecated
|
|
796
1253
|
* @throws {RequiredError}
|
|
797
1254
|
*/
|
|
798
1255
|
getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
799
1256
|
/**
|
|
800
|
-
*
|
|
801
|
-
* @summary
|
|
802
|
-
* @param {string} projectName Name of project
|
|
803
|
-
* @param {string} connectionName Name of connection
|
|
1257
|
+
* Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
|
|
1258
|
+
* @summary Get table details from database
|
|
1259
|
+
* @param {string} projectName Name of the project
|
|
1260
|
+
* @param {string} connectionName Name of the connection
|
|
1261
|
+
* @param {string} schemaName Name of the schema
|
|
1262
|
+
* @param {string} tablePath Full path to the table
|
|
1263
|
+
* @param {*} [options] Override http request option.
|
|
1264
|
+
* @throws {RequiredError}
|
|
1265
|
+
*/
|
|
1266
|
+
getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Table>>;
|
|
1267
|
+
/**
|
|
1268
|
+
* Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
|
|
1269
|
+
* @summary Get table source information
|
|
1270
|
+
* @param {string} projectName Name of the project
|
|
1271
|
+
* @param {string} connectionName Name of the connection
|
|
804
1272
|
* @param {string} [tableKey] Table key
|
|
805
1273
|
* @param {string} [tablePath] Table path
|
|
806
1274
|
* @param {*} [options] Override http request option.
|
|
1275
|
+
* @deprecated
|
|
807
1276
|
* @throws {RequiredError}
|
|
808
1277
|
*/
|
|
809
1278
|
getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TableSource>>;
|
|
810
1279
|
/**
|
|
811
|
-
*
|
|
812
|
-
* @summary
|
|
813
|
-
* @param {string} projectName Name of project
|
|
814
|
-
* @param {string} connectionName Name of connection
|
|
1280
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
|
|
1281
|
+
* @summary Create temporary table (deprecated)
|
|
1282
|
+
* @param {string} projectName Name of the project
|
|
1283
|
+
* @param {string} connectionName Name of the connection
|
|
815
1284
|
* @param {string} [sqlStatement] SQL statement
|
|
816
1285
|
* @param {*} [options] Override http request option.
|
|
1286
|
+
* @deprecated
|
|
817
1287
|
* @throws {RequiredError}
|
|
818
1288
|
*/
|
|
819
1289
|
getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
820
1290
|
/**
|
|
821
|
-
*
|
|
822
|
-
* @summary
|
|
823
|
-
* @param {string} projectName Name of project
|
|
824
|
-
* @param {string} connectionName Name of connection
|
|
1291
|
+
* Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
|
|
1292
|
+
* @summary List project database connections
|
|
1293
|
+
* @param {string} projectName Name of the project
|
|
825
1294
|
* @param {*} [options] Override http request option.
|
|
826
1295
|
* @throws {RequiredError}
|
|
827
1296
|
*/
|
|
828
|
-
|
|
1297
|
+
listConnections(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Connection>>>;
|
|
829
1298
|
/**
|
|
830
|
-
*
|
|
831
|
-
* @summary
|
|
832
|
-
* @param {string} projectName Name of project
|
|
1299
|
+
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
1300
|
+
* @summary List database schemas
|
|
1301
|
+
* @param {string} projectName Name of the project
|
|
1302
|
+
* @param {string} connectionName Name of the connection
|
|
833
1303
|
* @param {*} [options] Override http request option.
|
|
834
1304
|
* @throws {RequiredError}
|
|
835
1305
|
*/
|
|
836
|
-
|
|
1306
|
+
listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Schema>>>;
|
|
1307
|
+
/**
|
|
1308
|
+
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
1309
|
+
* @summary List tables in database
|
|
1310
|
+
* @param {string} projectName Name of the project
|
|
1311
|
+
* @param {string} connectionName Name of the connection
|
|
1312
|
+
* @param {string} schemaName Name of the schema
|
|
1313
|
+
* @param {*} [options] Override http request option.
|
|
1314
|
+
* @throws {RequiredError}
|
|
1315
|
+
*/
|
|
1316
|
+
listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Table>>>;
|
|
1317
|
+
/**
|
|
1318
|
+
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
1319
|
+
* @summary Execute SQL query
|
|
1320
|
+
* @param {string} projectName Name of the project
|
|
1321
|
+
* @param {string} connectionName Name of the connection
|
|
1322
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
|
|
1323
|
+
* @param {string} [_options] Options
|
|
1324
|
+
* @param {*} [options] Override http request option.
|
|
1325
|
+
* @throws {RequiredError}
|
|
1326
|
+
*/
|
|
1327
|
+
postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryData>>;
|
|
1328
|
+
/**
|
|
1329
|
+
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1330
|
+
* @summary Create SQL source from statement
|
|
1331
|
+
* @param {string} projectName Name of the project
|
|
1332
|
+
* @param {string} connectionName Name of the connection
|
|
1333
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
1334
|
+
* @param {*} [options] Override http request option.
|
|
1335
|
+
* @throws {RequiredError}
|
|
1336
|
+
*/
|
|
1337
|
+
postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SqlSource>>;
|
|
1338
|
+
/**
|
|
1339
|
+
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
1340
|
+
* @summary Create temporary table
|
|
1341
|
+
* @param {string} projectName Name of the project
|
|
1342
|
+
* @param {string} connectionName Name of the connection
|
|
1343
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
1344
|
+
* @param {*} [options] Override http request option.
|
|
1345
|
+
* @throws {RequiredError}
|
|
1346
|
+
*/
|
|
1347
|
+
postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TemporaryTable>>;
|
|
837
1348
|
};
|
|
838
1349
|
/**
|
|
839
1350
|
* ConnectionsApi - factory interface
|
|
@@ -841,73 +1352,129 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
841
1352
|
*/
|
|
842
1353
|
export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
843
1354
|
/**
|
|
844
|
-
*
|
|
845
|
-
* @summary
|
|
846
|
-
* @param {string} projectName Name of project
|
|
847
|
-
* @param {string} connectionName Name of connection
|
|
1355
|
+
* Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
1356
|
+
* @summary Get connection details
|
|
1357
|
+
* @param {string} projectName Name of the project
|
|
1358
|
+
* @param {string} connectionName Name of the connection
|
|
848
1359
|
* @param {*} [options] Override http request option.
|
|
849
1360
|
* @throws {RequiredError}
|
|
850
1361
|
*/
|
|
851
1362
|
getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Connection>;
|
|
852
1363
|
/**
|
|
853
|
-
*
|
|
854
|
-
* @summary
|
|
855
|
-
* @param {string} projectName Name of project
|
|
856
|
-
* @param {string} connectionName Name of connection
|
|
1364
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
1365
|
+
* @summary Execute SQL query (deprecated)
|
|
1366
|
+
* @param {string} projectName Name of the project
|
|
1367
|
+
* @param {string} connectionName Name of the connection
|
|
857
1368
|
* @param {string} [sqlStatement] SQL statement
|
|
858
1369
|
* @param {string} [_options] Options
|
|
859
1370
|
* @param {*} [options] Override http request option.
|
|
1371
|
+
* @deprecated
|
|
860
1372
|
* @throws {RequiredError}
|
|
861
1373
|
*/
|
|
862
1374
|
getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
863
1375
|
/**
|
|
864
|
-
*
|
|
865
|
-
* @summary
|
|
866
|
-
* @param {string} projectName Name of project
|
|
867
|
-
* @param {string} connectionName Name of connection
|
|
1376
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1377
|
+
* @summary Get SQL source (deprecated)
|
|
1378
|
+
* @param {string} projectName Name of the project
|
|
1379
|
+
* @param {string} connectionName Name of the connection
|
|
868
1380
|
* @param {string} [sqlStatement] SQL statement
|
|
869
1381
|
* @param {*} [options] Override http request option.
|
|
1382
|
+
* @deprecated
|
|
870
1383
|
* @throws {RequiredError}
|
|
871
1384
|
*/
|
|
872
1385
|
getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
873
1386
|
/**
|
|
874
|
-
*
|
|
875
|
-
* @summary
|
|
876
|
-
* @param {string} projectName Name of project
|
|
877
|
-
* @param {string} connectionName Name of connection
|
|
1387
|
+
* Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
|
|
1388
|
+
* @summary Get table details from database
|
|
1389
|
+
* @param {string} projectName Name of the project
|
|
1390
|
+
* @param {string} connectionName Name of the connection
|
|
1391
|
+
* @param {string} schemaName Name of the schema
|
|
1392
|
+
* @param {string} tablePath Full path to the table
|
|
1393
|
+
* @param {*} [options] Override http request option.
|
|
1394
|
+
* @throws {RequiredError}
|
|
1395
|
+
*/
|
|
1396
|
+
getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): AxiosPromise<Table>;
|
|
1397
|
+
/**
|
|
1398
|
+
* Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
|
|
1399
|
+
* @summary Get table source information
|
|
1400
|
+
* @param {string} projectName Name of the project
|
|
1401
|
+
* @param {string} connectionName Name of the connection
|
|
878
1402
|
* @param {string} [tableKey] Table key
|
|
879
1403
|
* @param {string} [tablePath] Table path
|
|
880
1404
|
* @param {*} [options] Override http request option.
|
|
1405
|
+
* @deprecated
|
|
881
1406
|
* @throws {RequiredError}
|
|
882
1407
|
*/
|
|
883
1408
|
getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): AxiosPromise<TableSource>;
|
|
884
1409
|
/**
|
|
885
|
-
*
|
|
886
|
-
* @summary
|
|
887
|
-
* @param {string} projectName Name of project
|
|
888
|
-
* @param {string} connectionName Name of connection
|
|
1410
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
|
|
1411
|
+
* @summary Create temporary table (deprecated)
|
|
1412
|
+
* @param {string} projectName Name of the project
|
|
1413
|
+
* @param {string} connectionName Name of the connection
|
|
889
1414
|
* @param {string} [sqlStatement] SQL statement
|
|
890
1415
|
* @param {*} [options] Override http request option.
|
|
1416
|
+
* @deprecated
|
|
891
1417
|
* @throws {RequiredError}
|
|
892
1418
|
*/
|
|
893
1419
|
getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
894
1420
|
/**
|
|
895
|
-
*
|
|
896
|
-
* @summary
|
|
897
|
-
* @param {string} projectName Name of project
|
|
898
|
-
* @param {string} connectionName Name of connection
|
|
1421
|
+
* Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
|
|
1422
|
+
* @summary List project database connections
|
|
1423
|
+
* @param {string} projectName Name of the project
|
|
899
1424
|
* @param {*} [options] Override http request option.
|
|
900
1425
|
* @throws {RequiredError}
|
|
901
1426
|
*/
|
|
902
|
-
|
|
1427
|
+
listConnections(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Connection>>;
|
|
903
1428
|
/**
|
|
904
|
-
*
|
|
905
|
-
* @summary
|
|
906
|
-
* @param {string} projectName Name of project
|
|
1429
|
+
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
1430
|
+
* @summary List database schemas
|
|
1431
|
+
* @param {string} projectName Name of the project
|
|
1432
|
+
* @param {string} connectionName Name of the connection
|
|
907
1433
|
* @param {*} [options] Override http request option.
|
|
908
1434
|
* @throws {RequiredError}
|
|
909
1435
|
*/
|
|
910
|
-
|
|
1436
|
+
listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Schema>>;
|
|
1437
|
+
/**
|
|
1438
|
+
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
1439
|
+
* @summary List tables in database
|
|
1440
|
+
* @param {string} projectName Name of the project
|
|
1441
|
+
* @param {string} connectionName Name of the connection
|
|
1442
|
+
* @param {string} schemaName Name of the schema
|
|
1443
|
+
* @param {*} [options] Override http request option.
|
|
1444
|
+
* @throws {RequiredError}
|
|
1445
|
+
*/
|
|
1446
|
+
listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Table>>;
|
|
1447
|
+
/**
|
|
1448
|
+
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
1449
|
+
* @summary Execute SQL query
|
|
1450
|
+
* @param {string} projectName Name of the project
|
|
1451
|
+
* @param {string} connectionName Name of the connection
|
|
1452
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
|
|
1453
|
+
* @param {string} [_options] Options
|
|
1454
|
+
* @param {*} [options] Override http request option.
|
|
1455
|
+
* @throws {RequiredError}
|
|
1456
|
+
*/
|
|
1457
|
+
postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryData>;
|
|
1458
|
+
/**
|
|
1459
|
+
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1460
|
+
* @summary Create SQL source from statement
|
|
1461
|
+
* @param {string} projectName Name of the project
|
|
1462
|
+
* @param {string} connectionName Name of the connection
|
|
1463
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
1464
|
+
* @param {*} [options] Override http request option.
|
|
1465
|
+
* @throws {RequiredError}
|
|
1466
|
+
*/
|
|
1467
|
+
postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlSource>;
|
|
1468
|
+
/**
|
|
1469
|
+
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
1470
|
+
* @summary Create temporary table
|
|
1471
|
+
* @param {string} projectName Name of the project
|
|
1472
|
+
* @param {string} connectionName Name of the connection
|
|
1473
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
1474
|
+
* @param {*} [options] Override http request option.
|
|
1475
|
+
* @throws {RequiredError}
|
|
1476
|
+
*/
|
|
1477
|
+
postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<TemporaryTable>;
|
|
911
1478
|
};
|
|
912
1479
|
/**
|
|
913
1480
|
* ConnectionsApi - object-oriented interface
|
|
@@ -917,206 +1484,267 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
917
1484
|
*/
|
|
918
1485
|
export declare class ConnectionsApi extends BaseAPI {
|
|
919
1486
|
/**
|
|
920
|
-
*
|
|
921
|
-
* @summary
|
|
922
|
-
* @param {string} projectName Name of project
|
|
923
|
-
* @param {string} connectionName Name of connection
|
|
1487
|
+
* Retrieves detailed information about a specific database connection within a project. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
1488
|
+
* @summary Get connection details
|
|
1489
|
+
* @param {string} projectName Name of the project
|
|
1490
|
+
* @param {string} connectionName Name of the connection
|
|
924
1491
|
* @param {*} [options] Override http request option.
|
|
925
1492
|
* @throws {RequiredError}
|
|
926
1493
|
* @memberof ConnectionsApi
|
|
927
1494
|
*/
|
|
928
1495
|
getConnection(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Connection, any>>;
|
|
929
1496
|
/**
|
|
930
|
-
*
|
|
931
|
-
* @summary
|
|
932
|
-
* @param {string} projectName Name of project
|
|
933
|
-
* @param {string} connectionName Name of connection
|
|
1497
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Executes a SQL statement against the specified database connection and returns the results. The query results include data, metadata, and execution information.
|
|
1498
|
+
* @summary Execute SQL query (deprecated)
|
|
1499
|
+
* @param {string} projectName Name of the project
|
|
1500
|
+
* @param {string} connectionName Name of the connection
|
|
934
1501
|
* @param {string} [sqlStatement] SQL statement
|
|
935
1502
|
* @param {string} [_options] Options
|
|
936
1503
|
* @param {*} [options] Override http request option.
|
|
1504
|
+
* @deprecated
|
|
937
1505
|
* @throws {RequiredError}
|
|
938
1506
|
* @memberof ConnectionsApi
|
|
939
1507
|
*/
|
|
940
1508
|
getQuerydata(projectName: string, connectionName: string, sqlStatement?: string, _options?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryData, any>>;
|
|
941
1509
|
/**
|
|
942
|
-
*
|
|
943
|
-
* @summary
|
|
944
|
-
* @param {string} projectName Name of project
|
|
945
|
-
* @param {string} connectionName Name of connection
|
|
1510
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a Malloy source from a SQL statement using the specified connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1511
|
+
* @summary Get SQL source (deprecated)
|
|
1512
|
+
* @param {string} projectName Name of the project
|
|
1513
|
+
* @param {string} connectionName Name of the connection
|
|
946
1514
|
* @param {string} [sqlStatement] SQL statement
|
|
947
1515
|
* @param {*} [options] Override http request option.
|
|
1516
|
+
* @deprecated
|
|
948
1517
|
* @throws {RequiredError}
|
|
949
1518
|
* @memberof ConnectionsApi
|
|
950
1519
|
*/
|
|
951
1520
|
getSqlsource(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SqlSource, any>>;
|
|
952
1521
|
/**
|
|
953
|
-
*
|
|
954
|
-
* @summary
|
|
955
|
-
* @param {string} projectName Name of project
|
|
956
|
-
* @param {string} connectionName Name of connection
|
|
1522
|
+
* Retrieves a table from the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed. The tablePath is the full path to the table, including the schema name.
|
|
1523
|
+
* @summary Get table details from database
|
|
1524
|
+
* @param {string} projectName Name of the project
|
|
1525
|
+
* @param {string} connectionName Name of the connection
|
|
1526
|
+
* @param {string} schemaName Name of the schema
|
|
1527
|
+
* @param {string} tablePath Full path to the table
|
|
1528
|
+
* @param {*} [options] Override http request option.
|
|
1529
|
+
* @throws {RequiredError}
|
|
1530
|
+
* @memberof ConnectionsApi
|
|
1531
|
+
*/
|
|
1532
|
+
getTable(projectName: string, connectionName: string, schemaName: string, tablePath: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Table, any>>;
|
|
1533
|
+
/**
|
|
1534
|
+
* Retrieves information about a specific table or view from the database connection. This includes table schema, column definitions, and metadata. The table can be specified by either tableKey or tablePath parameters, depending on the database type.
|
|
1535
|
+
* @summary Get table source information
|
|
1536
|
+
* @param {string} projectName Name of the project
|
|
1537
|
+
* @param {string} connectionName Name of the connection
|
|
957
1538
|
* @param {string} [tableKey] Table key
|
|
958
1539
|
* @param {string} [tablePath] Table path
|
|
959
1540
|
* @param {*} [options] Override http request option.
|
|
1541
|
+
* @deprecated
|
|
960
1542
|
* @throws {RequiredError}
|
|
961
1543
|
* @memberof ConnectionsApi
|
|
962
1544
|
*/
|
|
963
1545
|
getTablesource(projectName: string, connectionName: string, tableKey?: string, tablePath?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TableSource, any>>;
|
|
964
1546
|
/**
|
|
965
|
-
*
|
|
966
|
-
* @summary
|
|
967
|
-
* @param {string} projectName Name of project
|
|
968
|
-
* @param {string} connectionName Name of connection
|
|
1547
|
+
* **DEPRECATED**: This endpoint is deprecated and may be removed in future versions. Use the POST version instead for better security and functionality. Creates a temporary table from a SQL statement using the specified connection. Temporary tables are useful for storing intermediate results during complex queries.
|
|
1548
|
+
* @summary Create temporary table (deprecated)
|
|
1549
|
+
* @param {string} projectName Name of the project
|
|
1550
|
+
* @param {string} connectionName Name of the connection
|
|
969
1551
|
* @param {string} [sqlStatement] SQL statement
|
|
970
1552
|
* @param {*} [options] Override http request option.
|
|
1553
|
+
* @deprecated
|
|
971
1554
|
* @throws {RequiredError}
|
|
972
1555
|
* @memberof ConnectionsApi
|
|
973
1556
|
*/
|
|
974
1557
|
getTemporarytable(projectName: string, connectionName: string, sqlStatement?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TemporaryTable, any>>;
|
|
975
1558
|
/**
|
|
976
|
-
*
|
|
977
|
-
* @summary
|
|
978
|
-
* @param {string} projectName Name of project
|
|
979
|
-
* @param {string} connectionName Name of connection
|
|
1559
|
+
* Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.
|
|
1560
|
+
* @summary List project database connections
|
|
1561
|
+
* @param {string} projectName Name of the project
|
|
980
1562
|
* @param {*} [options] Override http request option.
|
|
981
1563
|
* @throws {RequiredError}
|
|
982
1564
|
* @memberof ConnectionsApi
|
|
983
1565
|
*/
|
|
984
|
-
|
|
1566
|
+
listConnections(projectName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Connection[], any>>;
|
|
985
1567
|
/**
|
|
986
|
-
*
|
|
987
|
-
* @summary
|
|
988
|
-
* @param {string} projectName Name of project
|
|
1568
|
+
* Retrieves a list of all schemas (databases) available in the specified connection. Each schema includes metadata such as name, description, and whether it\'s the default schema. This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
1569
|
+
* @summary List database schemas
|
|
1570
|
+
* @param {string} projectName Name of the project
|
|
1571
|
+
* @param {string} connectionName Name of the connection
|
|
989
1572
|
* @param {*} [options] Override http request option.
|
|
990
1573
|
* @throws {RequiredError}
|
|
991
1574
|
* @memberof ConnectionsApi
|
|
992
1575
|
*/
|
|
993
|
-
|
|
994
|
-
}
|
|
995
|
-
/**
|
|
996
|
-
* DatabasesApi - axios parameter creator
|
|
997
|
-
* @export
|
|
998
|
-
*/
|
|
999
|
-
export declare const DatabasesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1576
|
+
listSchemas(projectName: string, connectionName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Schema[], any>>;
|
|
1000
1577
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
* @summary
|
|
1003
|
-
* @param {string} projectName Name of project
|
|
1004
|
-
* @param {string}
|
|
1005
|
-
* @param {string}
|
|
1578
|
+
* Retrieves a list of all tables and views available in the specified database schema. This endpoint is useful for discovering available data sources and exploring the database structure. The schema must exist in the connection for this operation to succeed.
|
|
1579
|
+
* @summary List tables in database
|
|
1580
|
+
* @param {string} projectName Name of the project
|
|
1581
|
+
* @param {string} connectionName Name of the connection
|
|
1582
|
+
* @param {string} schemaName Name of the schema
|
|
1006
1583
|
* @param {*} [options] Override http request option.
|
|
1007
1584
|
* @throws {RequiredError}
|
|
1585
|
+
* @memberof ConnectionsApi
|
|
1008
1586
|
*/
|
|
1009
|
-
|
|
1010
|
-
};
|
|
1011
|
-
/**
|
|
1012
|
-
* DatabasesApi - functional programming interface
|
|
1013
|
-
* @export
|
|
1014
|
-
*/
|
|
1015
|
-
export declare const DatabasesApiFp: (configuration?: Configuration) => {
|
|
1587
|
+
listTables(projectName: string, connectionName: string, schemaName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Table[], any>>;
|
|
1016
1588
|
/**
|
|
1017
|
-
*
|
|
1018
|
-
* @summary
|
|
1019
|
-
* @param {string} projectName Name of project
|
|
1020
|
-
* @param {string}
|
|
1021
|
-
* @param {
|
|
1589
|
+
* Executes a SQL statement against the specified database connection and returns the results. The results include data, metadata, and execution information.
|
|
1590
|
+
* @summary Execute SQL query
|
|
1591
|
+
* @param {string} projectName Name of the project
|
|
1592
|
+
* @param {string} connectionName Name of the connection
|
|
1593
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to execute
|
|
1594
|
+
* @param {string} [_options] Options
|
|
1022
1595
|
* @param {*} [options] Override http request option.
|
|
1023
1596
|
* @throws {RequiredError}
|
|
1597
|
+
* @memberof ConnectionsApi
|
|
1024
1598
|
*/
|
|
1025
|
-
|
|
1026
|
-
};
|
|
1027
|
-
/**
|
|
1028
|
-
* DatabasesApi - factory interface
|
|
1029
|
-
* @export
|
|
1030
|
-
*/
|
|
1031
|
-
export declare const DatabasesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1599
|
+
postQuerydata(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, _options?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryData, any>>;
|
|
1032
1600
|
/**
|
|
1033
|
-
*
|
|
1034
|
-
* @summary
|
|
1035
|
-
* @param {string} projectName Name of project
|
|
1036
|
-
* @param {string}
|
|
1037
|
-
* @param {
|
|
1601
|
+
* Creates a Malloy source from a SQL statement using the specified database connection. The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
1602
|
+
* @summary Create SQL source from statement
|
|
1603
|
+
* @param {string} projectName Name of the project
|
|
1604
|
+
* @param {string} connectionName Name of the connection
|
|
1605
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to fetch the SQL source
|
|
1038
1606
|
* @param {*} [options] Override http request option.
|
|
1039
1607
|
* @throws {RequiredError}
|
|
1608
|
+
* @memberof ConnectionsApi
|
|
1040
1609
|
*/
|
|
1041
|
-
|
|
1042
|
-
};
|
|
1043
|
-
/**
|
|
1044
|
-
* DatabasesApi - object-oriented interface
|
|
1045
|
-
* @export
|
|
1046
|
-
* @class DatabasesApi
|
|
1047
|
-
* @extends {BaseAPI}
|
|
1048
|
-
*/
|
|
1049
|
-
export declare class DatabasesApi extends BaseAPI {
|
|
1610
|
+
postSqlsource(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SqlSource, any>>;
|
|
1050
1611
|
/**
|
|
1051
|
-
*
|
|
1052
|
-
* @summary
|
|
1053
|
-
* @param {string} projectName Name of project
|
|
1054
|
-
* @param {string}
|
|
1055
|
-
* @param {
|
|
1612
|
+
* Creates a temporary table from a SQL statement using the specified database connection. Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
1613
|
+
* @summary Create temporary table
|
|
1614
|
+
* @param {string} projectName Name of the project
|
|
1615
|
+
* @param {string} connectionName Name of the connection
|
|
1616
|
+
* @param {PostSqlsourceRequest} postSqlsourceRequest SQL statement to create the temporary table
|
|
1056
1617
|
* @param {*} [options] Override http request option.
|
|
1057
1618
|
* @throws {RequiredError}
|
|
1058
|
-
* @memberof
|
|
1619
|
+
* @memberof ConnectionsApi
|
|
1059
1620
|
*/
|
|
1060
|
-
|
|
1621
|
+
postTemporarytable(projectName: string, connectionName: string, postSqlsourceRequest: PostSqlsourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TemporaryTable, any>>;
|
|
1061
1622
|
}
|
|
1062
1623
|
/**
|
|
1063
|
-
*
|
|
1624
|
+
* ConnectionsTestApi - axios parameter creator
|
|
1064
1625
|
* @export
|
|
1065
1626
|
*/
|
|
1066
|
-
export declare const
|
|
1627
|
+
export declare const ConnectionsTestApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1067
1628
|
/**
|
|
1068
|
-
*
|
|
1069
|
-
* @summary
|
|
1070
|
-
* @param {
|
|
1629
|
+
* Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
1630
|
+
* @summary Test database connection configuration
|
|
1631
|
+
* @param {Connection} connection
|
|
1071
1632
|
* @param {*} [options] Override http request option.
|
|
1072
1633
|
* @throws {RequiredError}
|
|
1073
1634
|
*/
|
|
1074
|
-
|
|
1635
|
+
testConnectionConfiguration: (connection: Connection, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1075
1636
|
};
|
|
1076
1637
|
/**
|
|
1077
|
-
*
|
|
1638
|
+
* ConnectionsTestApi - functional programming interface
|
|
1078
1639
|
* @export
|
|
1079
1640
|
*/
|
|
1080
|
-
export declare const
|
|
1641
|
+
export declare const ConnectionsTestApiFp: (configuration?: Configuration) => {
|
|
1081
1642
|
/**
|
|
1082
|
-
*
|
|
1083
|
-
* @summary
|
|
1084
|
-
* @param {
|
|
1643
|
+
* Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
1644
|
+
* @summary Test database connection configuration
|
|
1645
|
+
* @param {Connection} connection
|
|
1085
1646
|
* @param {*} [options] Override http request option.
|
|
1086
1647
|
* @throws {RequiredError}
|
|
1087
1648
|
*/
|
|
1088
|
-
|
|
1649
|
+
testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectionStatus>>;
|
|
1089
1650
|
};
|
|
1090
1651
|
/**
|
|
1091
|
-
*
|
|
1652
|
+
* ConnectionsTestApi - factory interface
|
|
1092
1653
|
* @export
|
|
1093
1654
|
*/
|
|
1094
|
-
export declare const
|
|
1655
|
+
export declare const ConnectionsTestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1095
1656
|
/**
|
|
1096
|
-
*
|
|
1097
|
-
* @summary
|
|
1098
|
-
* @param {
|
|
1657
|
+
* Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
1658
|
+
* @summary Test database connection configuration
|
|
1659
|
+
* @param {Connection} connection
|
|
1099
1660
|
* @param {*} [options] Override http request option.
|
|
1100
1661
|
* @throws {RequiredError}
|
|
1101
1662
|
*/
|
|
1102
|
-
|
|
1663
|
+
testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): AxiosPromise<ConnectionStatus>;
|
|
1103
1664
|
};
|
|
1104
1665
|
/**
|
|
1105
|
-
*
|
|
1666
|
+
* ConnectionsTestApi - object-oriented interface
|
|
1106
1667
|
* @export
|
|
1107
|
-
* @class
|
|
1668
|
+
* @class ConnectionsTestApi
|
|
1108
1669
|
* @extends {BaseAPI}
|
|
1109
1670
|
*/
|
|
1110
|
-
export declare class
|
|
1671
|
+
export declare class ConnectionsTestApi extends BaseAPI {
|
|
1111
1672
|
/**
|
|
1112
|
-
*
|
|
1113
|
-
* @summary
|
|
1114
|
-
* @param {
|
|
1673
|
+
* Validates a database connection configuration without adding it to any project. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to a project. Useful for troubleshooting connection issues and validating configurations during setup.
|
|
1674
|
+
* @summary Test database connection configuration
|
|
1675
|
+
* @param {Connection} connection
|
|
1115
1676
|
* @param {*} [options] Override http request option.
|
|
1116
1677
|
* @throws {RequiredError}
|
|
1117
|
-
* @memberof
|
|
1678
|
+
* @memberof ConnectionsTestApi
|
|
1118
1679
|
*/
|
|
1119
|
-
|
|
1680
|
+
testConnectionConfiguration(connection: Connection, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConnectionStatus, any>>;
|
|
1681
|
+
}
|
|
1682
|
+
/**
|
|
1683
|
+
* DatabasesApi - axios parameter creator
|
|
1684
|
+
* @export
|
|
1685
|
+
*/
|
|
1686
|
+
export declare const DatabasesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1687
|
+
/**
|
|
1688
|
+
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
1689
|
+
* @summary List embedded databases
|
|
1690
|
+
* @param {string} projectName Name of the project
|
|
1691
|
+
* @param {string} packageName Name of the package
|
|
1692
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1693
|
+
* @param {*} [options] Override http request option.
|
|
1694
|
+
* @throws {RequiredError}
|
|
1695
|
+
*/
|
|
1696
|
+
listDatabases: (projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1697
|
+
};
|
|
1698
|
+
/**
|
|
1699
|
+
* DatabasesApi - functional programming interface
|
|
1700
|
+
* @export
|
|
1701
|
+
*/
|
|
1702
|
+
export declare const DatabasesApiFp: (configuration?: Configuration) => {
|
|
1703
|
+
/**
|
|
1704
|
+
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
1705
|
+
* @summary List embedded databases
|
|
1706
|
+
* @param {string} projectName Name of the project
|
|
1707
|
+
* @param {string} packageName Name of the package
|
|
1708
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1709
|
+
* @param {*} [options] Override http request option.
|
|
1710
|
+
* @throws {RequiredError}
|
|
1711
|
+
*/
|
|
1712
|
+
listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Database>>>;
|
|
1713
|
+
};
|
|
1714
|
+
/**
|
|
1715
|
+
* DatabasesApi - factory interface
|
|
1716
|
+
* @export
|
|
1717
|
+
*/
|
|
1718
|
+
export declare const DatabasesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1719
|
+
/**
|
|
1720
|
+
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
1721
|
+
* @summary List embedded databases
|
|
1722
|
+
* @param {string} projectName Name of the project
|
|
1723
|
+
* @param {string} packageName Name of the package
|
|
1724
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1725
|
+
* @param {*} [options] Override http request option.
|
|
1726
|
+
* @throws {RequiredError}
|
|
1727
|
+
*/
|
|
1728
|
+
listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Database>>;
|
|
1729
|
+
};
|
|
1730
|
+
/**
|
|
1731
|
+
* DatabasesApi - object-oriented interface
|
|
1732
|
+
* @export
|
|
1733
|
+
* @class DatabasesApi
|
|
1734
|
+
* @extends {BaseAPI}
|
|
1735
|
+
*/
|
|
1736
|
+
export declare class DatabasesApi extends BaseAPI {
|
|
1737
|
+
/**
|
|
1738
|
+
* Retrieves a list of all embedded databases within the specified package. These are typically DuckDB databases stored as .parquet files that provide local data storage for the package. Each database entry includes metadata about the database structure and content.
|
|
1739
|
+
* @summary List embedded databases
|
|
1740
|
+
* @param {string} projectName Name of the project
|
|
1741
|
+
* @param {string} packageName Name of the package
|
|
1742
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1743
|
+
* @param {*} [options] Override http request option.
|
|
1744
|
+
* @throws {RequiredError}
|
|
1745
|
+
* @memberof DatabasesApi
|
|
1746
|
+
*/
|
|
1747
|
+
listDatabases(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Database[], any>>;
|
|
1120
1748
|
}
|
|
1121
1749
|
/**
|
|
1122
1750
|
* ModelsApi - axios parameter creator
|
|
@@ -1124,22 +1752,33 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1124
1752
|
*/
|
|
1125
1753
|
export declare const ModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1126
1754
|
/**
|
|
1127
|
-
*
|
|
1128
|
-
* @summary
|
|
1129
|
-
* @param {string} projectName Name of project
|
|
1130
|
-
* @param {string} packageName Name of package
|
|
1131
|
-
* @param {string} path Path to model
|
|
1132
|
-
* @param {
|
|
1755
|
+
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
1756
|
+
* @summary Execute Malloy query
|
|
1757
|
+
* @param {string} projectName Name of the project
|
|
1758
|
+
* @param {string} packageName Name of the package
|
|
1759
|
+
* @param {string} path Path to the model within the package
|
|
1760
|
+
* @param {QueryRequest} queryRequest
|
|
1761
|
+
* @param {*} [options] Override http request option.
|
|
1762
|
+
* @throws {RequiredError}
|
|
1763
|
+
*/
|
|
1764
|
+
executeQueryModel: (projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1765
|
+
/**
|
|
1766
|
+
* Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
|
|
1767
|
+
* @summary Get compiled Malloy model
|
|
1768
|
+
* @param {string} projectName Name of the project
|
|
1769
|
+
* @param {string} packageName Name of the package
|
|
1770
|
+
* @param {string} path Path to the model within the package
|
|
1771
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1133
1772
|
* @param {*} [options] Override http request option.
|
|
1134
1773
|
* @throws {RequiredError}
|
|
1135
1774
|
*/
|
|
1136
1775
|
getModel: (projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1137
1776
|
/**
|
|
1138
|
-
*
|
|
1139
|
-
* @summary
|
|
1140
|
-
* @param {string} projectName Name of project
|
|
1141
|
-
* @param {string} packageName Name of package
|
|
1142
|
-
* @param {string} [versionId] Version
|
|
1777
|
+
* Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
|
|
1778
|
+
* @summary List package models
|
|
1779
|
+
* @param {string} projectName Name of the project
|
|
1780
|
+
* @param {string} packageName Name of the package
|
|
1781
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1143
1782
|
* @param {*} [options] Override http request option.
|
|
1144
1783
|
* @throws {RequiredError}
|
|
1145
1784
|
*/
|
|
@@ -1151,22 +1790,33 @@ export declare const ModelsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1151
1790
|
*/
|
|
1152
1791
|
export declare const ModelsApiFp: (configuration?: Configuration) => {
|
|
1153
1792
|
/**
|
|
1154
|
-
*
|
|
1155
|
-
* @summary
|
|
1156
|
-
* @param {string} projectName Name of project
|
|
1157
|
-
* @param {string} packageName Name of package
|
|
1158
|
-
* @param {string} path Path to model
|
|
1159
|
-
* @param {
|
|
1793
|
+
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
1794
|
+
* @summary Execute Malloy query
|
|
1795
|
+
* @param {string} projectName Name of the project
|
|
1796
|
+
* @param {string} packageName Name of the package
|
|
1797
|
+
* @param {string} path Path to the model within the package
|
|
1798
|
+
* @param {QueryRequest} queryRequest
|
|
1799
|
+
* @param {*} [options] Override http request option.
|
|
1800
|
+
* @throws {RequiredError}
|
|
1801
|
+
*/
|
|
1802
|
+
executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryResult>>;
|
|
1803
|
+
/**
|
|
1804
|
+
* Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
|
|
1805
|
+
* @summary Get compiled Malloy model
|
|
1806
|
+
* @param {string} projectName Name of the project
|
|
1807
|
+
* @param {string} packageName Name of the package
|
|
1808
|
+
* @param {string} path Path to the model within the package
|
|
1809
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1160
1810
|
* @param {*} [options] Override http request option.
|
|
1161
1811
|
* @throws {RequiredError}
|
|
1162
1812
|
*/
|
|
1163
1813
|
getModel(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompiledModel>>;
|
|
1164
1814
|
/**
|
|
1165
|
-
*
|
|
1166
|
-
* @summary
|
|
1167
|
-
* @param {string} projectName Name of project
|
|
1168
|
-
* @param {string} packageName Name of package
|
|
1169
|
-
* @param {string} [versionId] Version
|
|
1815
|
+
* Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
|
|
1816
|
+
* @summary List package models
|
|
1817
|
+
* @param {string} projectName Name of the project
|
|
1818
|
+
* @param {string} packageName Name of the package
|
|
1819
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1170
1820
|
* @param {*} [options] Override http request option.
|
|
1171
1821
|
* @throws {RequiredError}
|
|
1172
1822
|
*/
|
|
@@ -1178,22 +1828,33 @@ export declare const ModelsApiFp: (configuration?: Configuration) => {
|
|
|
1178
1828
|
*/
|
|
1179
1829
|
export declare const ModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1180
1830
|
/**
|
|
1181
|
-
*
|
|
1182
|
-
* @summary
|
|
1183
|
-
* @param {string} projectName Name of project
|
|
1184
|
-
* @param {string} packageName Name of package
|
|
1185
|
-
* @param {string} path Path to model
|
|
1186
|
-
* @param {
|
|
1831
|
+
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
1832
|
+
* @summary Execute Malloy query
|
|
1833
|
+
* @param {string} projectName Name of the project
|
|
1834
|
+
* @param {string} packageName Name of the package
|
|
1835
|
+
* @param {string} path Path to the model within the package
|
|
1836
|
+
* @param {QueryRequest} queryRequest
|
|
1837
|
+
* @param {*} [options] Override http request option.
|
|
1838
|
+
* @throws {RequiredError}
|
|
1839
|
+
*/
|
|
1840
|
+
executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryResult>;
|
|
1841
|
+
/**
|
|
1842
|
+
* Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
|
|
1843
|
+
* @summary Get compiled Malloy model
|
|
1844
|
+
* @param {string} projectName Name of the project
|
|
1845
|
+
* @param {string} packageName Name of the package
|
|
1846
|
+
* @param {string} path Path to the model within the package
|
|
1847
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1187
1848
|
* @param {*} [options] Override http request option.
|
|
1188
1849
|
* @throws {RequiredError}
|
|
1189
1850
|
*/
|
|
1190
1851
|
getModel(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompiledModel>;
|
|
1191
1852
|
/**
|
|
1192
|
-
*
|
|
1193
|
-
* @summary
|
|
1194
|
-
* @param {string} projectName Name of project
|
|
1195
|
-
* @param {string} packageName Name of package
|
|
1196
|
-
* @param {string} [versionId] Version
|
|
1853
|
+
* Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
|
|
1854
|
+
* @summary List package models
|
|
1855
|
+
* @param {string} projectName Name of the project
|
|
1856
|
+
* @param {string} packageName Name of the package
|
|
1857
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1197
1858
|
* @param {*} [options] Override http request option.
|
|
1198
1859
|
* @throws {RequiredError}
|
|
1199
1860
|
*/
|
|
@@ -1207,52 +1868,205 @@ export declare const ModelsApiFactory: (configuration?: Configuration, basePath?
|
|
|
1207
1868
|
*/
|
|
1208
1869
|
export declare class ModelsApi extends BaseAPI {
|
|
1209
1870
|
/**
|
|
1210
|
-
*
|
|
1211
|
-
* @summary
|
|
1212
|
-
* @param {string} projectName Name of project
|
|
1213
|
-
* @param {string} packageName Name of package
|
|
1214
|
-
* @param {string} path Path to model
|
|
1215
|
-
* @param {
|
|
1871
|
+
* Executes a Malloy query against a model and returns the results. The query can be specified as a raw Malloy query string or by referencing a named query within the model. This endpoint supports both ad-hoc queries and predefined model queries, making it flexible for various use cases including data exploration, reporting, and application integration.
|
|
1872
|
+
* @summary Execute Malloy query
|
|
1873
|
+
* @param {string} projectName Name of the project
|
|
1874
|
+
* @param {string} packageName Name of the package
|
|
1875
|
+
* @param {string} path Path to the model within the package
|
|
1876
|
+
* @param {QueryRequest} queryRequest
|
|
1877
|
+
* @param {*} [options] Override http request option.
|
|
1878
|
+
* @throws {RequiredError}
|
|
1879
|
+
* @memberof ModelsApi
|
|
1880
|
+
*/
|
|
1881
|
+
executeQueryModel(projectName: string, packageName: string, path: string, queryRequest: QueryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryResult, any>>;
|
|
1882
|
+
/**
|
|
1883
|
+
* Retrieves a compiled Malloy model with its source information, queries, and metadata. The model is compiled using the specified version of the Malloy compiler. This endpoint provides access to the model\'s structure, sources, and named queries for use in applications.
|
|
1884
|
+
* @summary Get compiled Malloy model
|
|
1885
|
+
* @param {string} projectName Name of the project
|
|
1886
|
+
* @param {string} packageName Name of the package
|
|
1887
|
+
* @param {string} path Path to the model within the package
|
|
1888
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1216
1889
|
* @param {*} [options] Override http request option.
|
|
1217
1890
|
* @throws {RequiredError}
|
|
1218
1891
|
* @memberof ModelsApi
|
|
1219
1892
|
*/
|
|
1220
1893
|
getModel(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CompiledModel, any>>;
|
|
1221
1894
|
/**
|
|
1222
|
-
*
|
|
1223
|
-
* @summary
|
|
1224
|
-
* @param {string} projectName Name of project
|
|
1225
|
-
* @param {string} packageName Name of package
|
|
1226
|
-
* @param {string} [versionId] Version
|
|
1895
|
+
* Retrieves a list of all Malloy models within the specified package. Each model entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available models and checking their status.
|
|
1896
|
+
* @summary List package models
|
|
1897
|
+
* @param {string} projectName Name of the project
|
|
1898
|
+
* @param {string} packageName Name of the package
|
|
1899
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1227
1900
|
* @param {*} [options] Override http request option.
|
|
1228
1901
|
* @throws {RequiredError}
|
|
1229
1902
|
* @memberof ModelsApi
|
|
1230
1903
|
*/
|
|
1231
1904
|
listModels(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Model[], any>>;
|
|
1232
1905
|
}
|
|
1906
|
+
/**
|
|
1907
|
+
* NotebooksApi - axios parameter creator
|
|
1908
|
+
* @export
|
|
1909
|
+
*/
|
|
1910
|
+
export declare const NotebooksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1911
|
+
/**
|
|
1912
|
+
* Retrieves a compiled Malloy notebook with its cells, results, and metadata. The notebook is compiled using the specified version of the Malloy compiler. This endpoint provides access to the notebook\'s structure, cells, and execution results for use in applications.
|
|
1913
|
+
* @summary Get compiled Malloy notebook
|
|
1914
|
+
* @param {string} projectName Name of the project
|
|
1915
|
+
* @param {string} packageName Name of the package
|
|
1916
|
+
* @param {string} path Path to notebook within the package.
|
|
1917
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1918
|
+
* @param {*} [options] Override http request option.
|
|
1919
|
+
* @throws {RequiredError}
|
|
1920
|
+
*/
|
|
1921
|
+
getNotebook: (projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1922
|
+
/**
|
|
1923
|
+
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
1924
|
+
* @summary List package notebooks
|
|
1925
|
+
* @param {string} projectName Name of the project
|
|
1926
|
+
* @param {string} packageName Name of the package
|
|
1927
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1928
|
+
* @param {*} [options] Override http request option.
|
|
1929
|
+
* @throws {RequiredError}
|
|
1930
|
+
*/
|
|
1931
|
+
listNotebooks: (projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1932
|
+
};
|
|
1933
|
+
/**
|
|
1934
|
+
* NotebooksApi - functional programming interface
|
|
1935
|
+
* @export
|
|
1936
|
+
*/
|
|
1937
|
+
export declare const NotebooksApiFp: (configuration?: Configuration) => {
|
|
1938
|
+
/**
|
|
1939
|
+
* Retrieves a compiled Malloy notebook with its cells, results, and metadata. The notebook is compiled using the specified version of the Malloy compiler. This endpoint provides access to the notebook\'s structure, cells, and execution results for use in applications.
|
|
1940
|
+
* @summary Get compiled Malloy notebook
|
|
1941
|
+
* @param {string} projectName Name of the project
|
|
1942
|
+
* @param {string} packageName Name of the package
|
|
1943
|
+
* @param {string} path Path to notebook within the package.
|
|
1944
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1945
|
+
* @param {*} [options] Override http request option.
|
|
1946
|
+
* @throws {RequiredError}
|
|
1947
|
+
*/
|
|
1948
|
+
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompiledNotebook>>;
|
|
1949
|
+
/**
|
|
1950
|
+
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
1951
|
+
* @summary List package notebooks
|
|
1952
|
+
* @param {string} projectName Name of the project
|
|
1953
|
+
* @param {string} packageName Name of the package
|
|
1954
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1955
|
+
* @param {*} [options] Override http request option.
|
|
1956
|
+
* @throws {RequiredError}
|
|
1957
|
+
*/
|
|
1958
|
+
listNotebooks(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Notebook>>>;
|
|
1959
|
+
};
|
|
1960
|
+
/**
|
|
1961
|
+
* NotebooksApi - factory interface
|
|
1962
|
+
* @export
|
|
1963
|
+
*/
|
|
1964
|
+
export declare const NotebooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1965
|
+
/**
|
|
1966
|
+
* Retrieves a compiled Malloy notebook with its cells, results, and metadata. The notebook is compiled using the specified version of the Malloy compiler. This endpoint provides access to the notebook\'s structure, cells, and execution results for use in applications.
|
|
1967
|
+
* @summary Get compiled Malloy notebook
|
|
1968
|
+
* @param {string} projectName Name of the project
|
|
1969
|
+
* @param {string} packageName Name of the package
|
|
1970
|
+
* @param {string} path Path to notebook within the package.
|
|
1971
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1972
|
+
* @param {*} [options] Override http request option.
|
|
1973
|
+
* @throws {RequiredError}
|
|
1974
|
+
*/
|
|
1975
|
+
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompiledNotebook>;
|
|
1976
|
+
/**
|
|
1977
|
+
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
1978
|
+
* @summary List package notebooks
|
|
1979
|
+
* @param {string} projectName Name of the project
|
|
1980
|
+
* @param {string} packageName Name of the package
|
|
1981
|
+
* @param {string} [versionId] Version identifier for the package
|
|
1982
|
+
* @param {*} [options] Override http request option.
|
|
1983
|
+
* @throws {RequiredError}
|
|
1984
|
+
*/
|
|
1985
|
+
listNotebooks(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Notebook>>;
|
|
1986
|
+
};
|
|
1987
|
+
/**
|
|
1988
|
+
* NotebooksApi - object-oriented interface
|
|
1989
|
+
* @export
|
|
1990
|
+
* @class NotebooksApi
|
|
1991
|
+
* @extends {BaseAPI}
|
|
1992
|
+
*/
|
|
1993
|
+
export declare class NotebooksApi extends BaseAPI {
|
|
1994
|
+
/**
|
|
1995
|
+
* Retrieves a compiled Malloy notebook with its cells, results, and metadata. The notebook is compiled using the specified version of the Malloy compiler. This endpoint provides access to the notebook\'s structure, cells, and execution results for use in applications.
|
|
1996
|
+
* @summary Get compiled Malloy notebook
|
|
1997
|
+
* @param {string} projectName Name of the project
|
|
1998
|
+
* @param {string} packageName Name of the package
|
|
1999
|
+
* @param {string} path Path to notebook within the package.
|
|
2000
|
+
* @param {string} [versionId] Version identifier for the package
|
|
2001
|
+
* @param {*} [options] Override http request option.
|
|
2002
|
+
* @throws {RequiredError}
|
|
2003
|
+
* @memberof NotebooksApi
|
|
2004
|
+
*/
|
|
2005
|
+
getNotebook(projectName: string, packageName: string, path: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CompiledNotebook, any>>;
|
|
2006
|
+
/**
|
|
2007
|
+
* Retrieves a list of all Malloy notebooks within the specified package. Each notebook entry includes the relative path, package name, and any compilation errors. This endpoint is useful for discovering available notebooks and checking their status.
|
|
2008
|
+
* @summary List package notebooks
|
|
2009
|
+
* @param {string} projectName Name of the project
|
|
2010
|
+
* @param {string} packageName Name of the package
|
|
2011
|
+
* @param {string} [versionId] Version identifier for the package
|
|
2012
|
+
* @param {*} [options] Override http request option.
|
|
2013
|
+
* @throws {RequiredError}
|
|
2014
|
+
* @memberof NotebooksApi
|
|
2015
|
+
*/
|
|
2016
|
+
listNotebooks(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Notebook[], any>>;
|
|
2017
|
+
}
|
|
1233
2018
|
/**
|
|
1234
2019
|
* PackagesApi - axios parameter creator
|
|
1235
2020
|
* @export
|
|
1236
2021
|
*/
|
|
1237
2022
|
export declare const PackagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1238
2023
|
/**
|
|
1239
|
-
*
|
|
1240
|
-
* @summary
|
|
1241
|
-
* @param {string} projectName Name of project
|
|
2024
|
+
* Creates a new Malloy package within the specified project. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
|
|
2025
|
+
* @summary Create a new package
|
|
2026
|
+
* @param {string} projectName Name of the project
|
|
2027
|
+
* @param {Package} _package
|
|
2028
|
+
* @param {*} [options] Override http request option.
|
|
2029
|
+
* @throws {RequiredError}
|
|
2030
|
+
*/
|
|
2031
|
+
createPackage: (projectName: string, _package: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2032
|
+
/**
|
|
2033
|
+
* Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
|
|
2034
|
+
* @summary Delete a package
|
|
2035
|
+
* @param {string} projectName Name of the project
|
|
2036
|
+
* @param {string} packageName Name of the package
|
|
2037
|
+
* @param {*} [options] Override http request option.
|
|
2038
|
+
* @throws {RequiredError}
|
|
2039
|
+
*/
|
|
2040
|
+
deletePackage: (projectName: string, packageName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2041
|
+
/**
|
|
2042
|
+
* Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
|
|
2043
|
+
* @summary Get package details and metadata
|
|
2044
|
+
* @param {string} projectName Name of the project
|
|
1242
2045
|
* @param {string} packageName Package name
|
|
1243
|
-
* @param {string} [versionId] Version
|
|
2046
|
+
* @param {string} [versionId] Version identifier for the package
|
|
2047
|
+
* @param {boolean} [reload] Load / reload the package before returning result
|
|
1244
2048
|
* @param {*} [options] Override http request option.
|
|
1245
2049
|
* @throws {RequiredError}
|
|
1246
2050
|
*/
|
|
1247
|
-
getPackage: (projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2051
|
+
getPackage: (projectName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1248
2052
|
/**
|
|
1249
|
-
*
|
|
1250
|
-
* @summary
|
|
1251
|
-
* @param {string} projectName Name of project
|
|
2053
|
+
* Retrieves a list of all Malloy packages within the specified project. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
|
|
2054
|
+
* @summary List project packages
|
|
2055
|
+
* @param {string} projectName Name of the project
|
|
1252
2056
|
* @param {*} [options] Override http request option.
|
|
1253
2057
|
* @throws {RequiredError}
|
|
1254
2058
|
*/
|
|
1255
2059
|
listPackages: (projectName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2060
|
+
/**
|
|
2061
|
+
* Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
|
|
2062
|
+
* @summary Update package configuration
|
|
2063
|
+
* @param {string} projectName Name of the project
|
|
2064
|
+
* @param {string} packageName Name of the package
|
|
2065
|
+
* @param {Package} _package
|
|
2066
|
+
* @param {*} [options] Override http request option.
|
|
2067
|
+
* @throws {RequiredError}
|
|
2068
|
+
*/
|
|
2069
|
+
updatePackage: (projectName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1256
2070
|
};
|
|
1257
2071
|
/**
|
|
1258
2072
|
* PackagesApi - functional programming interface
|
|
@@ -1260,23 +2074,52 @@ export declare const PackagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1260
2074
|
*/
|
|
1261
2075
|
export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
1262
2076
|
/**
|
|
1263
|
-
*
|
|
1264
|
-
* @summary
|
|
1265
|
-
* @param {string} projectName Name of project
|
|
2077
|
+
* Creates a new Malloy package within the specified project. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
|
|
2078
|
+
* @summary Create a new package
|
|
2079
|
+
* @param {string} projectName Name of the project
|
|
2080
|
+
* @param {Package} _package
|
|
2081
|
+
* @param {*} [options] Override http request option.
|
|
2082
|
+
* @throws {RequiredError}
|
|
2083
|
+
*/
|
|
2084
|
+
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
2085
|
+
/**
|
|
2086
|
+
* Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
|
|
2087
|
+
* @summary Delete a package
|
|
2088
|
+
* @param {string} projectName Name of the project
|
|
2089
|
+
* @param {string} packageName Name of the package
|
|
2090
|
+
* @param {*} [options] Override http request option.
|
|
2091
|
+
* @throws {RequiredError}
|
|
2092
|
+
*/
|
|
2093
|
+
deletePackage(projectName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
2094
|
+
/**
|
|
2095
|
+
* Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
|
|
2096
|
+
* @summary Get package details and metadata
|
|
2097
|
+
* @param {string} projectName Name of the project
|
|
1266
2098
|
* @param {string} packageName Package name
|
|
1267
|
-
* @param {string} [versionId] Version
|
|
2099
|
+
* @param {string} [versionId] Version identifier for the package
|
|
2100
|
+
* @param {boolean} [reload] Load / reload the package before returning result
|
|
1268
2101
|
* @param {*} [options] Override http request option.
|
|
1269
2102
|
* @throws {RequiredError}
|
|
1270
2103
|
*/
|
|
1271
|
-
getPackage(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
2104
|
+
getPackage(projectName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
1272
2105
|
/**
|
|
1273
|
-
*
|
|
1274
|
-
* @summary
|
|
1275
|
-
* @param {string} projectName Name of project
|
|
2106
|
+
* Retrieves a list of all Malloy packages within the specified project. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
|
|
2107
|
+
* @summary List project packages
|
|
2108
|
+
* @param {string} projectName Name of the project
|
|
1276
2109
|
* @param {*} [options] Override http request option.
|
|
1277
2110
|
* @throws {RequiredError}
|
|
1278
2111
|
*/
|
|
1279
2112
|
listPackages(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Package>>>;
|
|
2113
|
+
/**
|
|
2114
|
+
* Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
|
|
2115
|
+
* @summary Update package configuration
|
|
2116
|
+
* @param {string} projectName Name of the project
|
|
2117
|
+
* @param {string} packageName Name of the package
|
|
2118
|
+
* @param {Package} _package
|
|
2119
|
+
* @param {*} [options] Override http request option.
|
|
2120
|
+
* @throws {RequiredError}
|
|
2121
|
+
*/
|
|
2122
|
+
updatePackage(projectName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Package>>;
|
|
1280
2123
|
};
|
|
1281
2124
|
/**
|
|
1282
2125
|
* PackagesApi - factory interface
|
|
@@ -1284,23 +2127,52 @@ export declare const PackagesApiFp: (configuration?: Configuration) => {
|
|
|
1284
2127
|
*/
|
|
1285
2128
|
export declare const PackagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1286
2129
|
/**
|
|
1287
|
-
*
|
|
1288
|
-
* @summary
|
|
1289
|
-
* @param {string} projectName Name of project
|
|
2130
|
+
* Creates a new Malloy package within the specified project. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
|
|
2131
|
+
* @summary Create a new package
|
|
2132
|
+
* @param {string} projectName Name of the project
|
|
2133
|
+
* @param {Package} _package
|
|
2134
|
+
* @param {*} [options] Override http request option.
|
|
2135
|
+
* @throws {RequiredError}
|
|
2136
|
+
*/
|
|
2137
|
+
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
2138
|
+
/**
|
|
2139
|
+
* Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
|
|
2140
|
+
* @summary Delete a package
|
|
2141
|
+
* @param {string} projectName Name of the project
|
|
2142
|
+
* @param {string} packageName Name of the package
|
|
2143
|
+
* @param {*} [options] Override http request option.
|
|
2144
|
+
* @throws {RequiredError}
|
|
2145
|
+
*/
|
|
2146
|
+
deletePackage(projectName: string, packageName: string, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
2147
|
+
/**
|
|
2148
|
+
* Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
|
|
2149
|
+
* @summary Get package details and metadata
|
|
2150
|
+
* @param {string} projectName Name of the project
|
|
1290
2151
|
* @param {string} packageName Package name
|
|
1291
|
-
* @param {string} [versionId] Version
|
|
2152
|
+
* @param {string} [versionId] Version identifier for the package
|
|
2153
|
+
* @param {boolean} [reload] Load / reload the package before returning result
|
|
1292
2154
|
* @param {*} [options] Override http request option.
|
|
1293
2155
|
* @throws {RequiredError}
|
|
1294
2156
|
*/
|
|
1295
|
-
getPackage(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
2157
|
+
getPackage(projectName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
1296
2158
|
/**
|
|
1297
|
-
*
|
|
1298
|
-
* @summary
|
|
1299
|
-
* @param {string} projectName Name of project
|
|
2159
|
+
* Retrieves a list of all Malloy packages within the specified project. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
|
|
2160
|
+
* @summary List project packages
|
|
2161
|
+
* @param {string} projectName Name of the project
|
|
1300
2162
|
* @param {*} [options] Override http request option.
|
|
1301
2163
|
* @throws {RequiredError}
|
|
1302
2164
|
*/
|
|
1303
2165
|
listPackages(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Package>>;
|
|
2166
|
+
/**
|
|
2167
|
+
* Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
|
|
2168
|
+
* @summary Update package configuration
|
|
2169
|
+
* @param {string} projectName Name of the project
|
|
2170
|
+
* @param {string} packageName Name of the package
|
|
2171
|
+
* @param {Package} _package
|
|
2172
|
+
* @param {*} [options] Override http request option.
|
|
2173
|
+
* @throws {RequiredError}
|
|
2174
|
+
*/
|
|
2175
|
+
updatePackage(projectName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): AxiosPromise<Package>;
|
|
1304
2176
|
};
|
|
1305
2177
|
/**
|
|
1306
2178
|
* PackagesApi - object-oriented interface
|
|
@@ -1310,25 +2182,57 @@ export declare const PackagesApiFactory: (configuration?: Configuration, basePat
|
|
|
1310
2182
|
*/
|
|
1311
2183
|
export declare class PackagesApi extends BaseAPI {
|
|
1312
2184
|
/**
|
|
1313
|
-
*
|
|
1314
|
-
* @summary
|
|
1315
|
-
* @param {string} projectName Name of project
|
|
2185
|
+
* Creates a new Malloy package within the specified project. A package serves as a container for models, notebooks, embedded databases, and other resources. The package will be initialized with the provided metadata and can immediately accept content.
|
|
2186
|
+
* @summary Create a new package
|
|
2187
|
+
* @param {string} projectName Name of the project
|
|
2188
|
+
* @param {Package} _package
|
|
2189
|
+
* @param {*} [options] Override http request option.
|
|
2190
|
+
* @throws {RequiredError}
|
|
2191
|
+
* @memberof PackagesApi
|
|
2192
|
+
*/
|
|
2193
|
+
createPackage(projectName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any>>;
|
|
2194
|
+
/**
|
|
2195
|
+
* Permanently deletes a package and all its associated resources including models, notebooks, databases, and metadata. This operation cannot be undone, so use with caution. The package must exist and be accessible for deletion.
|
|
2196
|
+
* @summary Delete a package
|
|
2197
|
+
* @param {string} projectName Name of the project
|
|
2198
|
+
* @param {string} packageName Name of the package
|
|
2199
|
+
* @param {*} [options] Override http request option.
|
|
2200
|
+
* @throws {RequiredError}
|
|
2201
|
+
* @memberof PackagesApi
|
|
2202
|
+
*/
|
|
2203
|
+
deletePackage(projectName: string, packageName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any>>;
|
|
2204
|
+
/**
|
|
2205
|
+
* Retrieves detailed information about a specific package, including its models, notebooks, databases, and metadata. The reload parameter can be used to refresh the package state from disk before returning the information. The versionId parameter allows access to specific package versions.
|
|
2206
|
+
* @summary Get package details and metadata
|
|
2207
|
+
* @param {string} projectName Name of the project
|
|
1316
2208
|
* @param {string} packageName Package name
|
|
1317
|
-
* @param {string} [versionId] Version
|
|
2209
|
+
* @param {string} [versionId] Version identifier for the package
|
|
2210
|
+
* @param {boolean} [reload] Load / reload the package before returning result
|
|
1318
2211
|
* @param {*} [options] Override http request option.
|
|
1319
2212
|
* @throws {RequiredError}
|
|
1320
2213
|
* @memberof PackagesApi
|
|
1321
2214
|
*/
|
|
1322
|
-
getPackage(projectName: string, packageName: string, versionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any>>;
|
|
2215
|
+
getPackage(projectName: string, packageName: string, versionId?: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any>>;
|
|
1323
2216
|
/**
|
|
1324
|
-
*
|
|
1325
|
-
* @summary
|
|
1326
|
-
* @param {string} projectName Name of project
|
|
2217
|
+
* Retrieves a list of all Malloy packages within the specified project. Each package contains models, notebooks, databases, and other resources. This endpoint is useful for discovering available packages and their basic metadata.
|
|
2218
|
+
* @summary List project packages
|
|
2219
|
+
* @param {string} projectName Name of the project
|
|
1327
2220
|
* @param {*} [options] Override http request option.
|
|
1328
2221
|
* @throws {RequiredError}
|
|
1329
2222
|
* @memberof PackagesApi
|
|
1330
2223
|
*/
|
|
1331
2224
|
listPackages(projectName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package[], any>>;
|
|
2225
|
+
/**
|
|
2226
|
+
* Updates the configuration and metadata of an existing package. This allows you to modify package settings, update the description, change the location, or update other package-level properties. The package must exist and be accessible.
|
|
2227
|
+
* @summary Update package configuration
|
|
2228
|
+
* @param {string} projectName Name of the project
|
|
2229
|
+
* @param {string} packageName Name of the package
|
|
2230
|
+
* @param {Package} _package
|
|
2231
|
+
* @param {*} [options] Override http request option.
|
|
2232
|
+
* @throws {RequiredError}
|
|
2233
|
+
* @memberof PackagesApi
|
|
2234
|
+
*/
|
|
2235
|
+
updatePackage(projectName: string, packageName: string, _package: Package, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Package, any>>;
|
|
1332
2236
|
}
|
|
1333
2237
|
/**
|
|
1334
2238
|
* ProjectsApi - axios parameter creator
|
|
@@ -1336,12 +2240,46 @@ export declare class PackagesApi extends BaseAPI {
|
|
|
1336
2240
|
*/
|
|
1337
2241
|
export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1338
2242
|
/**
|
|
1339
|
-
*
|
|
1340
|
-
* @summary
|
|
2243
|
+
* Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
2244
|
+
* @summary Create a new project
|
|
2245
|
+
* @param {Project} project
|
|
2246
|
+
* @param {*} [options] Override http request option.
|
|
2247
|
+
* @throws {RequiredError}
|
|
2248
|
+
*/
|
|
2249
|
+
createProject: (project: Project, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2250
|
+
/**
|
|
2251
|
+
* Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
|
|
2252
|
+
* @summary Delete a project
|
|
2253
|
+
* @param {string} projectName Name of the project
|
|
2254
|
+
* @param {*} [options] Override http request option.
|
|
2255
|
+
* @throws {RequiredError}
|
|
2256
|
+
*/
|
|
2257
|
+
deleteProject: (projectName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2258
|
+
/**
|
|
2259
|
+
* Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
|
|
2260
|
+
* @summary Get project details and metadata
|
|
2261
|
+
* @param {string} projectName Name of the project
|
|
2262
|
+
* @param {boolean} [reload] Load / reload the project before returning result
|
|
2263
|
+
* @param {*} [options] Override http request option.
|
|
2264
|
+
* @throws {RequiredError}
|
|
2265
|
+
*/
|
|
2266
|
+
getProject: (projectName: string, reload?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2267
|
+
/**
|
|
2268
|
+
* Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
|
|
2269
|
+
* @summary List all available projects
|
|
1341
2270
|
* @param {*} [options] Override http request option.
|
|
1342
2271
|
* @throws {RequiredError}
|
|
1343
2272
|
*/
|
|
1344
2273
|
listProjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2274
|
+
/**
|
|
2275
|
+
* Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
|
|
2276
|
+
* @summary Update project configuration
|
|
2277
|
+
* @param {string} projectName Name of the project
|
|
2278
|
+
* @param {Project} project
|
|
2279
|
+
* @param {*} [options] Override http request option.
|
|
2280
|
+
* @throws {RequiredError}
|
|
2281
|
+
*/
|
|
2282
|
+
updateProject: (projectName: string, project: Project, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1345
2283
|
};
|
|
1346
2284
|
/**
|
|
1347
2285
|
* ProjectsApi - functional programming interface
|
|
@@ -1349,12 +2287,46 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1349
2287
|
*/
|
|
1350
2288
|
export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
1351
2289
|
/**
|
|
1352
|
-
*
|
|
1353
|
-
* @summary
|
|
2290
|
+
* Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
2291
|
+
* @summary Create a new project
|
|
2292
|
+
* @param {Project} project
|
|
2293
|
+
* @param {*} [options] Override http request option.
|
|
2294
|
+
* @throws {RequiredError}
|
|
2295
|
+
*/
|
|
2296
|
+
createProject(project: Project, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
2297
|
+
/**
|
|
2298
|
+
* Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
|
|
2299
|
+
* @summary Delete a project
|
|
2300
|
+
* @param {string} projectName Name of the project
|
|
2301
|
+
* @param {*} [options] Override http request option.
|
|
2302
|
+
* @throws {RequiredError}
|
|
2303
|
+
*/
|
|
2304
|
+
deleteProject(projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
2305
|
+
/**
|
|
2306
|
+
* Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
|
|
2307
|
+
* @summary Get project details and metadata
|
|
2308
|
+
* @param {string} projectName Name of the project
|
|
2309
|
+
* @param {boolean} [reload] Load / reload the project before returning result
|
|
2310
|
+
* @param {*} [options] Override http request option.
|
|
2311
|
+
* @throws {RequiredError}
|
|
2312
|
+
*/
|
|
2313
|
+
getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
2314
|
+
/**
|
|
2315
|
+
* Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
|
|
2316
|
+
* @summary List all available projects
|
|
1354
2317
|
* @param {*} [options] Override http request option.
|
|
1355
2318
|
* @throws {RequiredError}
|
|
1356
2319
|
*/
|
|
1357
2320
|
listProjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Project>>>;
|
|
2321
|
+
/**
|
|
2322
|
+
* Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
|
|
2323
|
+
* @summary Update project configuration
|
|
2324
|
+
* @param {string} projectName Name of the project
|
|
2325
|
+
* @param {Project} project
|
|
2326
|
+
* @param {*} [options] Override http request option.
|
|
2327
|
+
* @throws {RequiredError}
|
|
2328
|
+
*/
|
|
2329
|
+
updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
1358
2330
|
};
|
|
1359
2331
|
/**
|
|
1360
2332
|
* ProjectsApi - factory interface
|
|
@@ -1362,12 +2334,46 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1362
2334
|
*/
|
|
1363
2335
|
export declare const ProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1364
2336
|
/**
|
|
1365
|
-
*
|
|
1366
|
-
* @summary
|
|
2337
|
+
* Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
2338
|
+
* @summary Create a new project
|
|
2339
|
+
* @param {Project} project
|
|
2340
|
+
* @param {*} [options] Override http request option.
|
|
2341
|
+
* @throws {RequiredError}
|
|
2342
|
+
*/
|
|
2343
|
+
createProject(project: Project, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
|
|
2344
|
+
/**
|
|
2345
|
+
* Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
|
|
2346
|
+
* @summary Delete a project
|
|
2347
|
+
* @param {string} projectName Name of the project
|
|
2348
|
+
* @param {*} [options] Override http request option.
|
|
2349
|
+
* @throws {RequiredError}
|
|
2350
|
+
*/
|
|
2351
|
+
deleteProject(projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
|
|
2352
|
+
/**
|
|
2353
|
+
* Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
|
|
2354
|
+
* @summary Get project details and metadata
|
|
2355
|
+
* @param {string} projectName Name of the project
|
|
2356
|
+
* @param {boolean} [reload] Load / reload the project before returning result
|
|
2357
|
+
* @param {*} [options] Override http request option.
|
|
2358
|
+
* @throws {RequiredError}
|
|
2359
|
+
*/
|
|
2360
|
+
getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
|
|
2361
|
+
/**
|
|
2362
|
+
* Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
|
|
2363
|
+
* @summary List all available projects
|
|
1367
2364
|
* @param {*} [options] Override http request option.
|
|
1368
2365
|
* @throws {RequiredError}
|
|
1369
2366
|
*/
|
|
1370
2367
|
listProjects(options?: RawAxiosRequestConfig): AxiosPromise<Array<Project>>;
|
|
2368
|
+
/**
|
|
2369
|
+
* Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
|
|
2370
|
+
* @summary Update project configuration
|
|
2371
|
+
* @param {string} projectName Name of the project
|
|
2372
|
+
* @param {Project} project
|
|
2373
|
+
* @param {*} [options] Override http request option.
|
|
2374
|
+
* @throws {RequiredError}
|
|
2375
|
+
*/
|
|
2376
|
+
updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
|
|
1371
2377
|
};
|
|
1372
2378
|
/**
|
|
1373
2379
|
* ProjectsApi - object-oriented interface
|
|
@@ -1377,161 +2383,221 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
1377
2383
|
*/
|
|
1378
2384
|
export declare class ProjectsApi extends BaseAPI {
|
|
1379
2385
|
/**
|
|
1380
|
-
*
|
|
1381
|
-
* @summary
|
|
2386
|
+
* Creates a new Malloy project with the specified configuration. A project serves as a container for packages, connections, and other resources. The project will be initialized with the provided metadata and can immediately accept packages and connections.
|
|
2387
|
+
* @summary Create a new project
|
|
2388
|
+
* @param {Project} project
|
|
2389
|
+
* @param {*} [options] Override http request option.
|
|
2390
|
+
* @throws {RequiredError}
|
|
2391
|
+
* @memberof ProjectsApi
|
|
2392
|
+
*/
|
|
2393
|
+
createProject(project: Project, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
|
|
2394
|
+
/**
|
|
2395
|
+
* Permanently deletes a project and all its associated resources including packages, connections, and metadata. This operation cannot be undone, so use with caution. The project must exist and be accessible for deletion.
|
|
2396
|
+
* @summary Delete a project
|
|
2397
|
+
* @param {string} projectName Name of the project
|
|
2398
|
+
* @param {*} [options] Override http request option.
|
|
2399
|
+
* @throws {RequiredError}
|
|
2400
|
+
* @memberof ProjectsApi
|
|
2401
|
+
*/
|
|
2402
|
+
deleteProject(projectName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
|
|
2403
|
+
/**
|
|
2404
|
+
* Retrieves detailed information about a specific project, including its packages, connections, configuration, and metadata. The reload parameter can be used to refresh the project state from disk before returning the information.
|
|
2405
|
+
* @summary Get project details and metadata
|
|
2406
|
+
* @param {string} projectName Name of the project
|
|
2407
|
+
* @param {boolean} [reload] Load / reload the project before returning result
|
|
2408
|
+
* @param {*} [options] Override http request option.
|
|
2409
|
+
* @throws {RequiredError}
|
|
2410
|
+
* @memberof ProjectsApi
|
|
2411
|
+
*/
|
|
2412
|
+
getProject(projectName: string, reload?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
|
|
2413
|
+
/**
|
|
2414
|
+
* Retrieves a list of all projects currently hosted on this Malloy Publisher server. Each project contains metadata about its packages, connections, and configuration. This endpoint is typically used to discover available projects and their basic information.
|
|
2415
|
+
* @summary List all available projects
|
|
1382
2416
|
* @param {*} [options] Override http request option.
|
|
1383
2417
|
* @throws {RequiredError}
|
|
1384
2418
|
* @memberof ProjectsApi
|
|
1385
2419
|
*/
|
|
1386
2420
|
listProjects(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project[], any>>;
|
|
2421
|
+
/**
|
|
2422
|
+
* Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
|
|
2423
|
+
* @summary Update project configuration
|
|
2424
|
+
* @param {string} projectName Name of the project
|
|
2425
|
+
* @param {Project} project
|
|
2426
|
+
* @param {*} [options] Override http request option.
|
|
2427
|
+
* @throws {RequiredError}
|
|
2428
|
+
* @memberof ProjectsApi
|
|
2429
|
+
*/
|
|
2430
|
+
updateProject(projectName: string, project: Project, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
|
|
1387
2431
|
}
|
|
1388
2432
|
/**
|
|
1389
|
-
*
|
|
2433
|
+
* PublisherApi - axios parameter creator
|
|
1390
2434
|
* @export
|
|
1391
2435
|
*/
|
|
1392
|
-
export declare const
|
|
2436
|
+
export declare const PublisherApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1393
2437
|
/**
|
|
1394
|
-
*
|
|
1395
|
-
* @summary
|
|
1396
|
-
* @param {string} projectName Name of project
|
|
1397
|
-
* @param {string} packageName Name of package
|
|
1398
|
-
* @param {string} path Path to model within the package.
|
|
1399
|
-
* @param {string} [query] Query string to execute on the model. If the query is paramter is set, the queryName parameter must be empty.
|
|
1400
|
-
* @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
|
|
1401
|
-
* @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName is paramter is set, the query parameter must be empty.
|
|
1402
|
-
* @param {string} [versionId] Version ID
|
|
2438
|
+
* Returns the current status of the Malloy Publisher server, including initialization state, available projects, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
|
|
2439
|
+
* @summary Get server status and health information
|
|
1403
2440
|
* @param {*} [options] Override http request option.
|
|
1404
2441
|
* @throws {RequiredError}
|
|
1405
2442
|
*/
|
|
1406
|
-
|
|
2443
|
+
getStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1407
2444
|
};
|
|
1408
2445
|
/**
|
|
1409
|
-
*
|
|
2446
|
+
* PublisherApi - functional programming interface
|
|
1410
2447
|
* @export
|
|
1411
2448
|
*/
|
|
1412
|
-
export declare const
|
|
2449
|
+
export declare const PublisherApiFp: (configuration?: Configuration) => {
|
|
1413
2450
|
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @summary
|
|
1416
|
-
* @param {string} projectName Name of project
|
|
1417
|
-
* @param {string} packageName Name of package
|
|
1418
|
-
* @param {string} path Path to model within the package.
|
|
1419
|
-
* @param {string} [query] Query string to execute on the model. If the query is paramter is set, the queryName parameter must be empty.
|
|
1420
|
-
* @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
|
|
1421
|
-
* @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName is paramter is set, the query parameter must be empty.
|
|
1422
|
-
* @param {string} [versionId] Version ID
|
|
2451
|
+
* Returns the current status of the Malloy Publisher server, including initialization state, available projects, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
|
|
2452
|
+
* @summary Get server status and health information
|
|
1423
2453
|
* @param {*} [options] Override http request option.
|
|
1424
2454
|
* @throws {RequiredError}
|
|
1425
2455
|
*/
|
|
1426
|
-
|
|
2456
|
+
getStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerStatus>>;
|
|
1427
2457
|
};
|
|
1428
2458
|
/**
|
|
1429
|
-
*
|
|
2459
|
+
* PublisherApi - factory interface
|
|
1430
2460
|
* @export
|
|
1431
2461
|
*/
|
|
1432
|
-
export declare const
|
|
2462
|
+
export declare const PublisherApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1433
2463
|
/**
|
|
1434
|
-
*
|
|
1435
|
-
* @summary
|
|
1436
|
-
* @param {string} projectName Name of project
|
|
1437
|
-
* @param {string} packageName Name of package
|
|
1438
|
-
* @param {string} path Path to model within the package.
|
|
1439
|
-
* @param {string} [query] Query string to execute on the model. If the query is paramter is set, the queryName parameter must be empty.
|
|
1440
|
-
* @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
|
|
1441
|
-
* @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName is paramter is set, the query parameter must be empty.
|
|
1442
|
-
* @param {string} [versionId] Version ID
|
|
2464
|
+
* Returns the current status of the Malloy Publisher server, including initialization state, available projects, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
|
|
2465
|
+
* @summary Get server status and health information
|
|
1443
2466
|
* @param {*} [options] Override http request option.
|
|
1444
2467
|
* @throws {RequiredError}
|
|
1445
2468
|
*/
|
|
1446
|
-
|
|
2469
|
+
getStatus(options?: RawAxiosRequestConfig): AxiosPromise<ServerStatus>;
|
|
1447
2470
|
};
|
|
1448
2471
|
/**
|
|
1449
|
-
*
|
|
2472
|
+
* PublisherApi - object-oriented interface
|
|
1450
2473
|
* @export
|
|
1451
|
-
* @class
|
|
2474
|
+
* @class PublisherApi
|
|
1452
2475
|
* @extends {BaseAPI}
|
|
1453
2476
|
*/
|
|
1454
|
-
export declare class
|
|
2477
|
+
export declare class PublisherApi extends BaseAPI {
|
|
1455
2478
|
/**
|
|
1456
|
-
*
|
|
1457
|
-
* @summary
|
|
1458
|
-
* @param {string} projectName Name of project
|
|
1459
|
-
* @param {string} packageName Name of package
|
|
1460
|
-
* @param {string} path Path to model within the package.
|
|
1461
|
-
* @param {string} [query] Query string to execute on the model. If the query is paramter is set, the queryName parameter must be empty.
|
|
1462
|
-
* @param {string} [sourceName] Name of the source in the model to use for queryName, search, and topValue requests.
|
|
1463
|
-
* @param {string} [queryName] Name of a query to execute on a source in the model. Requires the sourceName parameter is set. If the queryName is paramter is set, the query parameter must be empty.
|
|
1464
|
-
* @param {string} [versionId] Version ID
|
|
2479
|
+
* Returns the current status of the Malloy Publisher server, including initialization state, available projects, and server timestamp. This endpoint is useful for health checks and monitoring server availability.
|
|
2480
|
+
* @summary Get server status and health information
|
|
1465
2481
|
* @param {*} [options] Override http request option.
|
|
1466
2482
|
* @throws {RequiredError}
|
|
1467
|
-
* @memberof
|
|
2483
|
+
* @memberof PublisherApi
|
|
1468
2484
|
*/
|
|
1469
|
-
|
|
2485
|
+
getStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServerStatus, any>>;
|
|
1470
2486
|
}
|
|
1471
2487
|
/**
|
|
1472
|
-
*
|
|
2488
|
+
* WatchModeApi - axios parameter creator
|
|
1473
2489
|
* @export
|
|
1474
2490
|
*/
|
|
1475
|
-
export declare const
|
|
2491
|
+
export declare const WatchModeApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1476
2492
|
/**
|
|
1477
|
-
*
|
|
1478
|
-
* @summary
|
|
1479
|
-
* @param {
|
|
1480
|
-
* @
|
|
1481
|
-
|
|
2493
|
+
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which project is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
|
|
2494
|
+
* @summary Get watch mode status
|
|
2495
|
+
* @param {*} [options] Override http request option.
|
|
2496
|
+
* @throws {RequiredError}
|
|
2497
|
+
*/
|
|
2498
|
+
getWatchStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2499
|
+
/**
|
|
2500
|
+
* Initiates file watching for the specified project. This enables real-time monitoring of file changes within the project directory, allowing for automatic reloading and updates during development. Only one project can be watched at a time.
|
|
2501
|
+
* @summary Start file watching
|
|
2502
|
+
* @param {StartWatchRequest} startWatchRequest
|
|
2503
|
+
* @param {*} [options] Override http request option.
|
|
2504
|
+
* @throws {RequiredError}
|
|
2505
|
+
*/
|
|
2506
|
+
startWatching: (startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2507
|
+
/**
|
|
2508
|
+
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different project.
|
|
2509
|
+
* @summary Stop file watching
|
|
1482
2510
|
* @param {*} [options] Override http request option.
|
|
1483
2511
|
* @throws {RequiredError}
|
|
1484
2512
|
*/
|
|
1485
|
-
|
|
2513
|
+
stopWatching: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1486
2514
|
};
|
|
1487
2515
|
/**
|
|
1488
|
-
*
|
|
2516
|
+
* WatchModeApi - functional programming interface
|
|
1489
2517
|
* @export
|
|
1490
2518
|
*/
|
|
1491
|
-
export declare const
|
|
2519
|
+
export declare const WatchModeApiFp: (configuration?: Configuration) => {
|
|
1492
2520
|
/**
|
|
1493
|
-
*
|
|
1494
|
-
* @summary
|
|
1495
|
-
* @param {
|
|
1496
|
-
* @
|
|
1497
|
-
|
|
2521
|
+
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which project is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
|
|
2522
|
+
* @summary Get watch mode status
|
|
2523
|
+
* @param {*} [options] Override http request option.
|
|
2524
|
+
* @throws {RequiredError}
|
|
2525
|
+
*/
|
|
2526
|
+
getWatchStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchStatus>>;
|
|
2527
|
+
/**
|
|
2528
|
+
* Initiates file watching for the specified project. This enables real-time monitoring of file changes within the project directory, allowing for automatic reloading and updates during development. Only one project can be watched at a time.
|
|
2529
|
+
* @summary Start file watching
|
|
2530
|
+
* @param {StartWatchRequest} startWatchRequest
|
|
2531
|
+
* @param {*} [options] Override http request option.
|
|
2532
|
+
* @throws {RequiredError}
|
|
2533
|
+
*/
|
|
2534
|
+
startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2535
|
+
/**
|
|
2536
|
+
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different project.
|
|
2537
|
+
* @summary Stop file watching
|
|
1498
2538
|
* @param {*} [options] Override http request option.
|
|
1499
2539
|
* @throws {RequiredError}
|
|
1500
2540
|
*/
|
|
1501
|
-
|
|
2541
|
+
stopWatching(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1502
2542
|
};
|
|
1503
2543
|
/**
|
|
1504
|
-
*
|
|
2544
|
+
* WatchModeApi - factory interface
|
|
1505
2545
|
* @export
|
|
1506
2546
|
*/
|
|
1507
|
-
export declare const
|
|
2547
|
+
export declare const WatchModeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1508
2548
|
/**
|
|
1509
|
-
*
|
|
1510
|
-
* @summary
|
|
1511
|
-
* @param {
|
|
1512
|
-
* @
|
|
1513
|
-
|
|
2549
|
+
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which project is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
|
|
2550
|
+
* @summary Get watch mode status
|
|
2551
|
+
* @param {*} [options] Override http request option.
|
|
2552
|
+
* @throws {RequiredError}
|
|
2553
|
+
*/
|
|
2554
|
+
getWatchStatus(options?: RawAxiosRequestConfig): AxiosPromise<WatchStatus>;
|
|
2555
|
+
/**
|
|
2556
|
+
* Initiates file watching for the specified project. This enables real-time monitoring of file changes within the project directory, allowing for automatic reloading and updates during development. Only one project can be watched at a time.
|
|
2557
|
+
* @summary Start file watching
|
|
2558
|
+
* @param {StartWatchRequest} startWatchRequest
|
|
2559
|
+
* @param {*} [options] Override http request option.
|
|
2560
|
+
* @throws {RequiredError}
|
|
2561
|
+
*/
|
|
2562
|
+
startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2563
|
+
/**
|
|
2564
|
+
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different project.
|
|
2565
|
+
* @summary Stop file watching
|
|
1514
2566
|
* @param {*} [options] Override http request option.
|
|
1515
2567
|
* @throws {RequiredError}
|
|
1516
2568
|
*/
|
|
1517
|
-
|
|
2569
|
+
stopWatching(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1518
2570
|
};
|
|
1519
2571
|
/**
|
|
1520
|
-
*
|
|
2572
|
+
* WatchModeApi - object-oriented interface
|
|
1521
2573
|
* @export
|
|
1522
|
-
* @class
|
|
2574
|
+
* @class WatchModeApi
|
|
1523
2575
|
* @extends {BaseAPI}
|
|
1524
2576
|
*/
|
|
1525
|
-
export declare class
|
|
2577
|
+
export declare class WatchModeApi extends BaseAPI {
|
|
1526
2578
|
/**
|
|
1527
|
-
*
|
|
1528
|
-
* @summary
|
|
1529
|
-
* @param {
|
|
1530
|
-
* @
|
|
1531
|
-
* @
|
|
2579
|
+
* Retrieves the current status of the file watching system. This includes whether watch mode is enabled, which project is being watched, and the path being monitored. Useful for monitoring the development workflow and ensuring file changes are being detected.
|
|
2580
|
+
* @summary Get watch mode status
|
|
2581
|
+
* @param {*} [options] Override http request option.
|
|
2582
|
+
* @throws {RequiredError}
|
|
2583
|
+
* @memberof WatchModeApi
|
|
2584
|
+
*/
|
|
2585
|
+
getWatchStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchStatus, any>>;
|
|
2586
|
+
/**
|
|
2587
|
+
* Initiates file watching for the specified project. This enables real-time monitoring of file changes within the project directory, allowing for automatic reloading and updates during development. Only one project can be watched at a time.
|
|
2588
|
+
* @summary Start file watching
|
|
2589
|
+
* @param {StartWatchRequest} startWatchRequest
|
|
2590
|
+
* @param {*} [options] Override http request option.
|
|
2591
|
+
* @throws {RequiredError}
|
|
2592
|
+
* @memberof WatchModeApi
|
|
2593
|
+
*/
|
|
2594
|
+
startWatching(startWatchRequest: StartWatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2595
|
+
/**
|
|
2596
|
+
* Stops the current file watching session. This disables real-time monitoring of file changes and releases system resources. Use this when development is complete or when switching to a different project.
|
|
2597
|
+
* @summary Stop file watching
|
|
1532
2598
|
* @param {*} [options] Override http request option.
|
|
1533
2599
|
* @throws {RequiredError}
|
|
1534
|
-
* @memberof
|
|
2600
|
+
* @memberof WatchModeApi
|
|
1535
2601
|
*/
|
|
1536
|
-
|
|
2602
|
+
stopWatching(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1537
2603
|
}
|