@databricks/sdk-queryhistory 0.0.0-dev → 0.1.0-dev.1
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/LICENSE +203 -0
- package/dist/v1/client.d.ts +20 -0
- package/dist/v1/client.d.ts.map +1 -0
- package/dist/v1/client.js +86 -0
- package/dist/v1/client.js.map +1 -0
- package/dist/v1/index.d.ts +4 -0
- package/dist/v1/index.d.ts.map +1 -0
- package/dist/v1/index.js +4 -0
- package/dist/v1/index.js.map +1 -0
- package/dist/v1/model.d.ts +360 -0
- package/dist/v1/model.d.ts.map +1 -0
- package/dist/v1/model.js +424 -0
- package/dist/v1/model.js.map +1 -0
- package/dist/v1/transport.d.ts +5 -0
- package/dist/v1/transport.d.ts.map +1 -0
- package/dist/v1/transport.js +57 -0
- package/dist/v1/transport.js.map +1 -0
- package/dist/v1/utils.d.ts +22 -0
- package/dist/v1/utils.d.ts.map +1 -0
- package/dist/v1/utils.js +113 -0
- package/dist/v1/utils.js.map +1 -0
- package/package.json +38 -4
- package/src/v1/client.ts +115 -0
- package/src/v1/index.ts +25 -0
- package/src/v1/model.ts +720 -0
- package/src/v1/transport.ts +73 -0
- package/src/v1/utils.ts +156 -0
- package/README.md +0 -1
- package/index.js +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/v1/utils.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAG/E,OAAO,EAAC,OAAO,EAAC,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAC,QAAQ,EAAC,MAAM,+BAA+B,CAAC;AAQvD,OAAO,OAAO,MAAM,aAAa,CAAC;AAGlC,0EAA0E;AAC1E,6EAA6E;AAC7E,gEAAgE;AAChE,MAAM,UAAU,GAAG,OAAO,CAAC,EAAC,eAAe,EAAE,IAAI,EAAC,CAAC,CAAC;AAQpD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,IAAU,EACV,OAAqB;IAErB,MAAM,IAAI,GAAY;QACpB,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,IAAI,EAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAC,CAAC;QACjE,GAAG,CAAC,OAAO,EAAE,WAAW,KAAK,SAAS,IAAI;YACxC,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC;QACF,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,IAAI,EAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAC,CAAC;KAClE,CAAC;IACF,OAAO,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,OAAO,CACpB,IAAuC;IAEvC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAChC,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,SAAS,CAAC;QACR,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAC1C,IAAI,IAAI,EAAE,CAAC;YACT,MAAM;QACR,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACzE,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;IAC3C,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,IAAqB;IAErB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE;QAChC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;QAC3B,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;KACtB,CAAC,CAAC;IAEH,IAAI,IAAkB,CAAC;IACvB,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,MAAM,CAAC,CAAC;IACV,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEtC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;QACjC,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;KACrC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3E,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,MAAM,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,MAAc,EACd,GAAW,EACX,OAAgB,EAChB,MAAoB,EACpB,IAA0C;IAE1C,MAAM,GAAG,GAAgB,EAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAC,CAAC;IAChD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,IAAgB,EAAE,MAAoB;IACrE,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAY,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAa,EAAE,MAAiB;IAC7D,OAAO,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,MAAc,EACd,KAAc,EACd,MAAuB;IAEvB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO;IACT,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,0CAA0C;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;YAC1E,kBAAkB,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;SAAM,IACL,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,SAAS;QAC1B,OAAO,KAAK,KAAK,QAAQ,EACzB,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,qCAAqC,OAAO,KAAK,EAAE,CAAC,CAAC;IACvE,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,41 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@databricks/sdk-queryhistory",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
5
|
-
"
|
|
6
|
-
"
|
|
3
|
+
"version": "0.1.0-dev.1",
|
|
4
|
+
"description": "",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"exports": {
|
|
7
|
+
"./v1": {
|
|
8
|
+
"types": "./dist/v1/index.d.ts",
|
|
9
|
+
"import": "./dist/v1/index.js"
|
|
10
|
+
}
|
|
11
|
+
},
|
|
12
|
+
"files": [
|
|
13
|
+
"dist",
|
|
14
|
+
"src",
|
|
15
|
+
"LICENSE"
|
|
16
|
+
],
|
|
17
|
+
"scripts": {
|
|
18
|
+
"build": "tsc -b",
|
|
19
|
+
"lint": "eslint src --ext .ts",
|
|
20
|
+
"lint:fix": "eslint src --ext .ts --fix",
|
|
21
|
+
"format": "prettier --write \"src/**/*.ts\"",
|
|
22
|
+
"format:check": "prettier --check \"src/**/*.ts\"",
|
|
23
|
+
"typecheck": "tsc --noEmit",
|
|
24
|
+
"clean": "rm -rf dist tsconfig.tsbuildinfo",
|
|
25
|
+
"test": "echo 'no tests'",
|
|
26
|
+
"test:browser": "echo 'no tests'"
|
|
27
|
+
},
|
|
28
|
+
"author": "Databricks",
|
|
29
|
+
"license": "Apache-2.0",
|
|
30
|
+
"dependencies": {
|
|
31
|
+
"@databricks/sdk-auth": ">=0.1.0-dev.2 <1.0.0",
|
|
32
|
+
"@databricks/sdk-core": ">=0.1.0-dev.3 <1.0.0",
|
|
33
|
+
"@databricks/sdk-options": ">=0.1.0-dev.2 <1.0.0",
|
|
34
|
+
"@js-temporal/polyfill": "^0.5.0",
|
|
35
|
+
"json-bigint": "^1.0.0",
|
|
36
|
+
"zod": "^4.3.6"
|
|
37
|
+
},
|
|
38
|
+
"engines": {
|
|
39
|
+
"node": ">=22.0.0"
|
|
40
|
+
}
|
|
7
41
|
}
|
package/src/v1/client.ts
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
import {VERSION as AUTH_VERSION} from '@databricks/sdk-auth';
|
|
4
|
+
import type {Call} from '@databricks/sdk-core/api';
|
|
5
|
+
import {createDefault} from '@databricks/sdk-core/clientinfo';
|
|
6
|
+
import type {Logger} from '@databricks/sdk-core/logger';
|
|
7
|
+
import {NoOpLogger} from '@databricks/sdk-core/logger';
|
|
8
|
+
import type {CallOptions} from '@databricks/sdk-options/call';
|
|
9
|
+
import type {ClientOptions} from '@databricks/sdk-options/client';
|
|
10
|
+
import type {HttpClient} from '@databricks/sdk-core/http';
|
|
11
|
+
import {newHttpClient} from './transport';
|
|
12
|
+
import {
|
|
13
|
+
buildHttpRequest,
|
|
14
|
+
executeCall,
|
|
15
|
+
executeHttpCall,
|
|
16
|
+
parseResponse,
|
|
17
|
+
flattenQueryParams,
|
|
18
|
+
} from './utils';
|
|
19
|
+
import pkgJson from '../../package.json' with {type: 'json'};
|
|
20
|
+
import type {ListQueriesRequest, ListQueriesRequest_Response} from './model';
|
|
21
|
+
import {
|
|
22
|
+
marshalQueryFilterSchema,
|
|
23
|
+
unmarshalListQueriesRequest_ResponseSchema,
|
|
24
|
+
} from './model';
|
|
25
|
+
|
|
26
|
+
// Package identity segment for this client to be used in the User-Agent header.
|
|
27
|
+
const PACKAGE_SEGMENT = {
|
|
28
|
+
key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
|
|
29
|
+
value: pkgJson.version,
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
export class QueryhistoryClient {
|
|
33
|
+
private readonly host: string;
|
|
34
|
+
// Workspace ID used to route workspace-level calls on unified hosts (SPOG).
|
|
35
|
+
// When set, workspace-level methods send X-Databricks-Org-Id on every
|
|
36
|
+
// request.
|
|
37
|
+
private readonly workspaceId: string | undefined;
|
|
38
|
+
private readonly httpClient: HttpClient;
|
|
39
|
+
private readonly logger: Logger;
|
|
40
|
+
// User-Agent header value. Composed once at construction from
|
|
41
|
+
// createDefault() merged with this package's identity and the active
|
|
42
|
+
// credential's name.
|
|
43
|
+
private readonly userAgent: string;
|
|
44
|
+
|
|
45
|
+
constructor(options: ClientOptions) {
|
|
46
|
+
if (options.host === undefined) {
|
|
47
|
+
throw new Error('Host is required.');
|
|
48
|
+
}
|
|
49
|
+
this.host = options.host.replace(/\/$/, '');
|
|
50
|
+
this.workspaceId = options.workspaceId;
|
|
51
|
+
this.logger = options.logger ?? new NoOpLogger();
|
|
52
|
+
const info = createDefault()
|
|
53
|
+
.with(PACKAGE_SEGMENT)
|
|
54
|
+
.with({key: 'sdk-js-auth', value: AUTH_VERSION})
|
|
55
|
+
.with({key: 'auth', value: options.credentials?.name() ?? 'default'});
|
|
56
|
+
this.userAgent = info.toString();
|
|
57
|
+
this.httpClient = newHttpClient(options);
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* List the history of queries through SQL warehouses, and serverless compute.
|
|
62
|
+
*
|
|
63
|
+
* You can filter by user ID, warehouse ID, status, and time range.
|
|
64
|
+
* Most recently started queries are returned first (up to max_results in request).
|
|
65
|
+
* The pagination token returned in response can be used to list subsequent query statuses.
|
|
66
|
+
*/
|
|
67
|
+
async listQueries(
|
|
68
|
+
req: ListQueriesRequest,
|
|
69
|
+
options?: CallOptions
|
|
70
|
+
): Promise<ListQueriesRequest_Response> {
|
|
71
|
+
const url = `${this.host}/api/2.0/sql/history/queries`;
|
|
72
|
+
const params = new URLSearchParams();
|
|
73
|
+
if (req.filterBy !== undefined) {
|
|
74
|
+
flattenQueryParams(
|
|
75
|
+
'filter_by',
|
|
76
|
+
marshalQueryFilterSchema.parse(req.filterBy),
|
|
77
|
+
params
|
|
78
|
+
);
|
|
79
|
+
}
|
|
80
|
+
if (req.maxResults !== undefined) {
|
|
81
|
+
params.append('max_results', String(req.maxResults));
|
|
82
|
+
}
|
|
83
|
+
if (req.pageToken !== undefined) {
|
|
84
|
+
params.append('page_token', req.pageToken);
|
|
85
|
+
}
|
|
86
|
+
if (req.includeMetrics !== undefined) {
|
|
87
|
+
params.append('include_metrics', String(req.includeMetrics));
|
|
88
|
+
}
|
|
89
|
+
const query = params.toString();
|
|
90
|
+
const fullUrl = query !== '' ? `${url}?${query}` : url;
|
|
91
|
+
let resp: ListQueriesRequest_Response | undefined;
|
|
92
|
+
const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
|
|
93
|
+
const headers = new Headers();
|
|
94
|
+
if (this.workspaceId !== undefined) {
|
|
95
|
+
headers.set('X-Databricks-Org-Id', this.workspaceId);
|
|
96
|
+
}
|
|
97
|
+
headers.set('User-Agent', this.userAgent);
|
|
98
|
+
const httpReq = buildHttpRequest('GET', fullUrl, headers, callSignal);
|
|
99
|
+
const respBody = await executeHttpCall({
|
|
100
|
+
request: httpReq,
|
|
101
|
+
httpClient: this.httpClient,
|
|
102
|
+
logger: this.logger,
|
|
103
|
+
});
|
|
104
|
+
resp = parseResponse(
|
|
105
|
+
respBody,
|
|
106
|
+
unmarshalListQueriesRequest_ResponseSchema
|
|
107
|
+
);
|
|
108
|
+
};
|
|
109
|
+
await executeCall(call, options);
|
|
110
|
+
if (resp === undefined) {
|
|
111
|
+
throw new Error('API call completed without a result.');
|
|
112
|
+
}
|
|
113
|
+
return resp;
|
|
114
|
+
}
|
|
115
|
+
}
|
package/src/v1/index.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
export {QueryhistoryClient} from './client';
|
|
4
|
+
|
|
5
|
+
export {
|
|
6
|
+
ChannelName,
|
|
7
|
+
PlansState,
|
|
8
|
+
QueryStatementType,
|
|
9
|
+
QueryStatus,
|
|
10
|
+
} from './model';
|
|
11
|
+
|
|
12
|
+
export type {
|
|
13
|
+
ChannelInfo,
|
|
14
|
+
ExternalQuerySource,
|
|
15
|
+
ExternalQuerySource_JobInfo,
|
|
16
|
+
ListQueriesRequest,
|
|
17
|
+
ListQueriesRequest_Response,
|
|
18
|
+
QueryFilter,
|
|
19
|
+
QueryInfo,
|
|
20
|
+
QueryMetrics,
|
|
21
|
+
QueryTag,
|
|
22
|
+
TaskTimeOverRange,
|
|
23
|
+
TaskTimeOverRangeEntry,
|
|
24
|
+
TimeRange,
|
|
25
|
+
} from './model';
|