@osdk/foundry.functions 2.66.0 → 2.68.0
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/CHANGELOG.md +24 -0
- package/build/browser/_components.d.ts +1 -1
- package/build/browser/public/Query.d.ts +11 -54
- package/build/browser/public/Query.d.ts.map +1 -1
- package/build/browser/public/Query.js +11 -45
- package/build/browser/public/Query.js.map +1 -1
- package/build/browser/public/VersionId.d.ts +1 -1
- package/build/browser/public/VersionId.js +1 -1
- package/build/browser/public/VersionId.js.map +1 -1
- package/build/esm/_components.d.ts +1 -1
- package/build/esm/public/Query.d.ts +11 -54
- package/build/esm/public/Query.d.ts.map +1 -1
- package/build/esm/public/Query.js +11 -45
- package/build/esm/public/Query.js.map +1 -1
- package/build/esm/public/VersionId.d.ts +1 -1
- package/build/esm/public/VersionId.js +1 -1
- package/build/esm/public/VersionId.js.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# @osdk/foundry.functions
|
|
2
2
|
|
|
3
|
+
## 2.68.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 7357b5f: Regenerate SDKs with API version 1.1695.1
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies [7357b5f]
|
|
12
|
+
- @osdk/foundry.core@2.68.0
|
|
13
|
+
- @osdk/foundry.ontologies@2.68.0
|
|
14
|
+
|
|
15
|
+
## 2.67.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- 241d1bb: Regenerate SDKs with API version 1.1695.0
|
|
20
|
+
|
|
21
|
+
### Patch Changes
|
|
22
|
+
|
|
23
|
+
- Updated dependencies [241d1bb]
|
|
24
|
+
- @osdk/foundry.core@2.67.0
|
|
25
|
+
- @osdk/foundry.ontologies@2.67.0
|
|
26
|
+
|
|
3
27
|
## 2.66.0
|
|
4
28
|
|
|
5
29
|
### Minor Changes
|
|
@@ -406,7 +406,7 @@ export interface StreamingExecuteQueryRequest {
|
|
|
406
406
|
branch?: _Core.FoundryBranch;
|
|
407
407
|
}
|
|
408
408
|
/**
|
|
409
|
-
* A single
|
|
409
|
+
* A single message in a streaming Query execution response. Each message contains either a data batch or an error.
|
|
410
410
|
*
|
|
411
411
|
* Log Safety: UNSAFE
|
|
412
412
|
*/
|
|
@@ -5,7 +5,7 @@ import type * as _Functions from "../_components.js";
|
|
|
5
5
|
/**
|
|
6
6
|
* Gets a specific query type with the given API name. By default, this gets the latest version of the query.
|
|
7
7
|
*
|
|
8
|
-
* @
|
|
8
|
+
* @beta
|
|
9
9
|
*
|
|
10
10
|
* Required Scopes: [api:functions-read]
|
|
11
11
|
* URL: /v2/functions/queries/{queryApiName}
|
|
@@ -20,7 +20,7 @@ export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldCl
|
|
|
20
20
|
/**
|
|
21
21
|
* Gets a specific query type with the given RID. By default, this gets the latest version of the query.
|
|
22
22
|
*
|
|
23
|
-
* @
|
|
23
|
+
* @beta
|
|
24
24
|
*
|
|
25
25
|
* Required Scopes: [api:functions-read]
|
|
26
26
|
* URL: /v2/functions/queries/getByRid
|
|
@@ -41,7 +41,7 @@ export declare function getByRid($ctx: $Client | $ClientContext | $OldClient | $
|
|
|
41
41
|
*
|
|
42
42
|
* The maximum batch size for this endpoint is 100.
|
|
43
43
|
*
|
|
44
|
-
* @
|
|
44
|
+
* @beta
|
|
45
45
|
*
|
|
46
46
|
* Required Scopes: [api:functions-read]
|
|
47
47
|
* URL: /v2/functions/queries/getByRidBatch
|
|
@@ -53,14 +53,16 @@ export declare function getByRidBatch($ctx: $Client | $ClientContext | $OldClien
|
|
|
53
53
|
}
|
|
54
54
|
]): Promise<_Functions.GetByRidQueriesBatchResponse>;
|
|
55
55
|
/**
|
|
56
|
-
* Executes a Query
|
|
56
|
+
* Executes a Query and returns the result as a single JSON object. By default, this executes
|
|
57
|
+
* the latest version of the query. The latest version is the one that was most recently
|
|
58
|
+
* published, which may be a pre-release version.
|
|
57
59
|
*
|
|
58
|
-
* This endpoint
|
|
60
|
+
* This endpoint executes global (non-ontology-scoped) query functions. For ontology-scoped
|
|
61
|
+
* functions, use the equivalent endpoint under
|
|
62
|
+
* `/v2/ontologies/{ontology}/queries/{queryApiName}/execute`. For streaming or incremental
|
|
63
|
+
* result delivery, use `streamingExecute`.
|
|
59
64
|
*
|
|
60
|
-
*
|
|
61
|
-
* and provides enhanced functionality.
|
|
62
|
-
*
|
|
63
|
-
* @alpha
|
|
65
|
+
* @beta
|
|
64
66
|
*
|
|
65
67
|
* Required Scopes: [api:functions-execute]
|
|
66
68
|
* URL: /v2/functions/queries/{queryApiName}/execute
|
|
@@ -78,51 +80,6 @@ export declare function execute($ctx: $Client | $ClientContext | $OldClient | $O
|
|
|
78
80
|
traceState?: _Core.TraceState | undefined;
|
|
79
81
|
}
|
|
80
82
|
]): Promise<_Functions.ExecuteQueryResponse>;
|
|
81
|
-
/**
|
|
82
|
-
* Executes a Query using the given parameters, returning results as an NDJSON stream. By default, this executes the latest version of the query.
|
|
83
|
-
*
|
|
84
|
-
* This endpoint supports all Query functions. The endpoint name 'streamingExecute' refers to the NDJSON
|
|
85
|
-
* streaming response format. Both streaming and non-streaming functions can use this endpoint.
|
|
86
|
-
* Non-streaming functions return a single-line NDJSON response, while streaming functions return multi-line NDJSON responses.
|
|
87
|
-
* This is the recommended endpoint for all query execution.
|
|
88
|
-
*
|
|
89
|
-
* The response is returned as a binary stream in NDJSON (Newline Delimited JSON) format, where each line
|
|
90
|
-
* is a StreamingExecuteQueryResponse containing either a data batch or an error.
|
|
91
|
-
*
|
|
92
|
-
* For a function returning a list of 5 records with a batch size of 3, the response stream would contain
|
|
93
|
-
* two lines. The first line contains the first 3 items, and the second line contains the remaining 2 items:
|
|
94
|
-
*
|
|
95
|
-
* ```
|
|
96
|
-
* {"type":"data","value":[{"productId":"SKU-001","price":29.99},{"productId":"SKU-002","price":49.99},{"productId":"SKU-003","price":19.99}]}
|
|
97
|
-
* {"type":"data","value":[{"productId":"SKU-004","price":39.99},{"productId":"SKU-005","price":59.99}]}
|
|
98
|
-
* ```
|
|
99
|
-
*
|
|
100
|
-
* Each line is a separate JSON object followed by a newline character. Clients should parse the stream
|
|
101
|
-
* line-by-line to process results as they arrive. If an error occurs during execution, the stream will
|
|
102
|
-
* contain an error line:
|
|
103
|
-
*
|
|
104
|
-
* ```
|
|
105
|
-
* {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
106
|
-
* ```
|
|
107
|
-
*
|
|
108
|
-
* @alpha
|
|
109
|
-
*
|
|
110
|
-
* Required Scopes: [api:functions-execute]
|
|
111
|
-
* URL: /v2/functions/queries/{queryApiName}/streamingExecute
|
|
112
|
-
*/
|
|
113
|
-
export declare function streamingExecute($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
114
|
-
queryApiName: _Functions.QueryApiName,
|
|
115
|
-
$body: _Functions.StreamingExecuteQueryRequest,
|
|
116
|
-
$queryParams?: {
|
|
117
|
-
transactionId?: _Functions.TransactionId | undefined;
|
|
118
|
-
preview?: _Core.PreviewMode | undefined;
|
|
119
|
-
},
|
|
120
|
-
$headerParams?: {
|
|
121
|
-
attribution?: _Core.Attribution | undefined;
|
|
122
|
-
traceParent?: _Core.TraceParent | undefined;
|
|
123
|
-
traceState?: _Core.TraceState | undefined;
|
|
124
|
-
}
|
|
125
|
-
]): Promise<Response>;
|
|
126
83
|
/**
|
|
127
84
|
* Submits a Query for asynchronous execution. Returns either an execution ID
|
|
128
85
|
* for polling, or the complete result if execution finished immediately.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../src/public/Query.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAcrD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE,UAAU,CAAC,YAAY;IAErC,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,SAAS,CAAC;QACjD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAE3B;AAWD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE;QACZ,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC;QAC5B,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,SAAS,CAAC;QACjD,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QACxC,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAE3B;AASD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAC3D,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAElD;AAkBD
|
|
1
|
+
{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../src/public/Query.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAcrD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE,UAAU,CAAC,YAAY;IAErC,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,SAAS,CAAC;QACjD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAE3B;AAWD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE;QACZ,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC;QAC5B,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,SAAS,CAAC;QACjD,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QACxC,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAE3B;AASD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAC3D,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAElD;AAkBD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE,UAAU,CAAC,YAAY;IACrC,KAAK,EAAE,UAAU,CAAC,mBAAmB;IACrC,YAAY,CAAC,EAAE;QACb,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;IACD,aAAa,CAAC,EAAE;QACd,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAC5C,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAC5C,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,SAAS,CAAC;KAC3C;CACF,GACA,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAE1C;AAkBD;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE,UAAU,CAAC,YAAY;IACrC,KAAK,EAAE,UAAU,CAAC,wBAAwB;IAC1C,YAAY,CAAC,EAAE;QACb,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;IACD,aAAa,CAAC,EAAE;QACd,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAC5C,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAC5C,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,SAAS,CAAC;KAC3C;CACF,GACA,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAE/C"}
|
|
@@ -19,7 +19,7 @@ const _get = [0, "/v2/functions/queries/{0}", 2];
|
|
|
19
19
|
/**
|
|
20
20
|
* Gets a specific query type with the given API name. By default, this gets the latest version of the query.
|
|
21
21
|
*
|
|
22
|
-
* @
|
|
22
|
+
* @beta
|
|
23
23
|
*
|
|
24
24
|
* Required Scopes: [api:functions-read]
|
|
25
25
|
* URL: /v2/functions/queries/{queryApiName}
|
|
@@ -31,7 +31,7 @@ const _getByRid = [0, "/v2/functions/queries/getByRid", 2];
|
|
|
31
31
|
/**
|
|
32
32
|
* Gets a specific query type with the given RID. By default, this gets the latest version of the query.
|
|
33
33
|
*
|
|
34
|
-
* @
|
|
34
|
+
* @beta
|
|
35
35
|
*
|
|
36
36
|
* Required Scopes: [api:functions-read]
|
|
37
37
|
* URL: /v2/functions/queries/getByRid
|
|
@@ -48,7 +48,7 @@ const _getByRidBatch = [1, "/v2/functions/queries/getByRidBatch", 3];
|
|
|
48
48
|
*
|
|
49
49
|
* The maximum batch size for this endpoint is 100.
|
|
50
50
|
*
|
|
51
|
-
* @
|
|
51
|
+
* @beta
|
|
52
52
|
*
|
|
53
53
|
* Required Scopes: [api:functions-read]
|
|
54
54
|
* URL: /v2/functions/queries/getByRidBatch
|
|
@@ -58,14 +58,16 @@ export function getByRidBatch($ctx, ...args) {
|
|
|
58
58
|
}
|
|
59
59
|
const _execute = [1, "/v2/functions/queries/{0}/execute", 7];
|
|
60
60
|
/**
|
|
61
|
-
* Executes a Query
|
|
61
|
+
* Executes a Query and returns the result as a single JSON object. By default, this executes
|
|
62
|
+
* the latest version of the query. The latest version is the one that was most recently
|
|
63
|
+
* published, which may be a pre-release version.
|
|
62
64
|
*
|
|
63
|
-
* This endpoint
|
|
65
|
+
* This endpoint executes global (non-ontology-scoped) query functions. For ontology-scoped
|
|
66
|
+
* functions, use the equivalent endpoint under
|
|
67
|
+
* `/v2/ontologies/{ontology}/queries/{queryApiName}/execute`. For streaming or incremental
|
|
68
|
+
* result delivery, use `streamingExecute`.
|
|
64
69
|
*
|
|
65
|
-
*
|
|
66
|
-
* and provides enhanced functionality.
|
|
67
|
-
*
|
|
68
|
-
* @alpha
|
|
70
|
+
* @beta
|
|
69
71
|
*
|
|
70
72
|
* Required Scopes: [api:functions-execute]
|
|
71
73
|
* URL: /v2/functions/queries/{queryApiName}/execute
|
|
@@ -73,42 +75,6 @@ const _execute = [1, "/v2/functions/queries/{0}/execute", 7];
|
|
|
73
75
|
export function execute($ctx, ...args) {
|
|
74
76
|
return $foundryPlatformFetch($ctx, _execute, ...args);
|
|
75
77
|
}
|
|
76
|
-
const _streamingExecute = [1, "/v2/functions/queries/{0}/streamingExecute", 7,, "application/octet-stream"];
|
|
77
|
-
/**
|
|
78
|
-
* Executes a Query using the given parameters, returning results as an NDJSON stream. By default, this executes the latest version of the query.
|
|
79
|
-
*
|
|
80
|
-
* This endpoint supports all Query functions. The endpoint name 'streamingExecute' refers to the NDJSON
|
|
81
|
-
* streaming response format. Both streaming and non-streaming functions can use this endpoint.
|
|
82
|
-
* Non-streaming functions return a single-line NDJSON response, while streaming functions return multi-line NDJSON responses.
|
|
83
|
-
* This is the recommended endpoint for all query execution.
|
|
84
|
-
*
|
|
85
|
-
* The response is returned as a binary stream in NDJSON (Newline Delimited JSON) format, where each line
|
|
86
|
-
* is a StreamingExecuteQueryResponse containing either a data batch or an error.
|
|
87
|
-
*
|
|
88
|
-
* For a function returning a list of 5 records with a batch size of 3, the response stream would contain
|
|
89
|
-
* two lines. The first line contains the first 3 items, and the second line contains the remaining 2 items:
|
|
90
|
-
*
|
|
91
|
-
* ```
|
|
92
|
-
* {"type":"data","value":[{"productId":"SKU-001","price":29.99},{"productId":"SKU-002","price":49.99},{"productId":"SKU-003","price":19.99}]}
|
|
93
|
-
* {"type":"data","value":[{"productId":"SKU-004","price":39.99},{"productId":"SKU-005","price":59.99}]}
|
|
94
|
-
* ```
|
|
95
|
-
*
|
|
96
|
-
* Each line is a separate JSON object followed by a newline character. Clients should parse the stream
|
|
97
|
-
* line-by-line to process results as they arrive. If an error occurs during execution, the stream will
|
|
98
|
-
* contain an error line:
|
|
99
|
-
*
|
|
100
|
-
* ```
|
|
101
|
-
* {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
102
|
-
* ```
|
|
103
|
-
*
|
|
104
|
-
* @alpha
|
|
105
|
-
*
|
|
106
|
-
* Required Scopes: [api:functions-execute]
|
|
107
|
-
* URL: /v2/functions/queries/{queryApiName}/streamingExecute
|
|
108
|
-
*/
|
|
109
|
-
export function streamingExecute($ctx, ...args) {
|
|
110
|
-
return $foundryPlatformFetch($ctx, _streamingExecute, ...args);
|
|
111
|
-
}
|
|
112
78
|
const _executeAsync = [1, "/v2/functions/queries/{0}/executeAsync", 7];
|
|
113
79
|
/**
|
|
114
80
|
* Submits a Query for asynchronous execution. Returns either an execution ID
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Query.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args","_getByRid","getByRid","_getByRidBatch","getByRidBatch","_execute","execute","
|
|
1
|
+
{"version":3,"file":"Query.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args","_getByRid","getByRid","_getByRidBatch","getByRidBatch","_execute","execute","_executeAsync","executeAsync"],"sources":["Query.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _get = [0, \"/v2/functions/queries/{0}\", 2];\n/**\n * Gets a specific query type with the given API name. By default, this gets the latest version of the query.\n *\n * @beta\n *\n * Required Scopes: [api:functions-read]\n * URL: /v2/functions/queries/{queryApiName}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _getByRid = [0, \"/v2/functions/queries/getByRid\", 2];\n/**\n * Gets a specific query type with the given RID. By default, this gets the latest version of the query.\n *\n * @beta\n *\n * Required Scopes: [api:functions-read]\n * URL: /v2/functions/queries/getByRid\n */\nexport function getByRid($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getByRid, ...args);\n}\nconst _getByRidBatch = [1, \"/v2/functions/queries/getByRidBatch\", 3];\n/**\n * Gets a list of query types by RID in bulk. By default, this gets the latest version of each query.\n *\n * Queries are filtered from the response if they don't exist or the requesting token lacks the required\n * permissions.\n *\n * The maximum batch size for this endpoint is 100.\n *\n * @beta\n *\n * Required Scopes: [api:functions-read]\n * URL: /v2/functions/queries/getByRidBatch\n */\nexport function getByRidBatch($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getByRidBatch, ...args);\n}\nconst _execute = [1, \"/v2/functions/queries/{0}/execute\", 7];\n/**\n * Executes a Query and returns the result as a single JSON object. By default, this executes\n * the latest version of the query. The latest version is the one that was most recently\n * published, which may be a pre-release version.\n *\n * This endpoint executes global (non-ontology-scoped) query functions. For ontology-scoped\n * functions, use the equivalent endpoint under\n * `/v2/ontologies/{ontology}/queries/{queryApiName}/execute`. For streaming or incremental\n * result delivery, use `streamingExecute`.\n *\n * @beta\n *\n * Required Scopes: [api:functions-execute]\n * URL: /v2/functions/queries/{queryApiName}/execute\n */\nexport function execute($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _execute, ...args);\n}\nconst _executeAsync = [1, \"/v2/functions/queries/{0}/executeAsync\", 7];\n/**\n * Submits a Query for asynchronous execution. Returns either an execution ID\n * for polling, or the complete result if execution finished immediately.\n *\n * Use the Execution resource's getResult endpoint to poll for the\n * result of a submitted execution.\n *\n * @alpha\n *\n * Required Scopes: [api:functions-execute]\n * URL: /v2/functions/queries/{queryApiName}/executeAsync\n */\nexport function executeAsync($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _executeAsync, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,2BAA2B,EAAE,CAAC,CAAC;AAChD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,IAAI,EAAE,GAAGG,IAAI,CAAC;AACrD;AACA,MAAMC,SAAS,GAAG,CAAC,CAAC,EAAE,gCAAgC,EAAE,CAAC,CAAC;AAC1D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EACpC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,SAAS,EAAE,GAAGD,IAAI,CAAC;AAC1D;AACA,MAAMG,cAAc,GAAG,CAAC,CAAC,EAAE,qCAAqC,EAAE,CAAC,CAAC;AACpE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EACzC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,cAAc,EAAE,GAAGH,IAAI,CAAC;AAC/D;AACA,MAAMK,QAAQ,GAAG,CAAC,CAAC,EAAE,mCAAmC,EAAE,CAAC,CAAC;AAC5D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,OAAOA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACnC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,QAAQ,EAAE,GAAGL,IAAI,CAAC;AACzD;AACA,MAAMO,aAAa,GAAG,CAAC,CAAC,EAAE,wCAAwC,EAAE,CAAC,CAAC;AACtE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EACxC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,aAAa,EAAE,GAAGP,IAAI,CAAC;AAC9D","ignoreList":[]}
|
|
@@ -3,7 +3,7 @@ import type { SharedClient as $OldClient, SharedClientContext as $OldClientConte
|
|
|
3
3
|
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
|
|
4
4
|
import type * as _Functions from "../_components.js";
|
|
5
5
|
/**
|
|
6
|
-
* Gets a specific value type with the given RID
|
|
6
|
+
* Gets a specific version of a value type with the given RID and version ID.
|
|
7
7
|
*
|
|
8
8
|
* @alpha
|
|
9
9
|
*
|
|
@@ -17,7 +17,7 @@ import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.
|
|
|
17
17
|
//
|
|
18
18
|
const _get = [0, "/v2/functions/valueTypes/{0}/versionIds/{1}", 2];
|
|
19
19
|
/**
|
|
20
|
-
* Gets a specific value type with the given RID
|
|
20
|
+
* Gets a specific version of a value type with the given RID and version ID.
|
|
21
21
|
*
|
|
22
22
|
* @alpha
|
|
23
23
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VersionId.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args"],"sources":["VersionId.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _get = [0, \"/v2/functions/valueTypes/{0}/versionIds/{1}\", 2];\n/**\n * Gets a specific value type with the given RID
|
|
1
|
+
{"version":3,"file":"VersionId.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args"],"sources":["VersionId.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _get = [0, \"/v2/functions/valueTypes/{0}/versionIds/{1}\", 2];\n/**\n * Gets a specific version of a value type with the given RID and version ID.\n *\n * @alpha\n *\n * Required Scopes: [api:functions-read]\n * URL: /v2/functions/valueTypes/{valueTypeRid}/versionIds/{versionIdVersionId}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,6CAA6C,EAAE,CAAC,CAAC;AAClE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,IAAI,EAAE,GAAGG,IAAI,CAAC;AACrD","ignoreList":[]}
|
|
@@ -406,7 +406,7 @@ export interface StreamingExecuteQueryRequest {
|
|
|
406
406
|
branch?: _Core.FoundryBranch;
|
|
407
407
|
}
|
|
408
408
|
/**
|
|
409
|
-
* A single
|
|
409
|
+
* A single message in a streaming Query execution response. Each message contains either a data batch or an error.
|
|
410
410
|
*
|
|
411
411
|
* Log Safety: UNSAFE
|
|
412
412
|
*/
|
|
@@ -5,7 +5,7 @@ import type * as _Functions from "../_components.js";
|
|
|
5
5
|
/**
|
|
6
6
|
* Gets a specific query type with the given API name. By default, this gets the latest version of the query.
|
|
7
7
|
*
|
|
8
|
-
* @
|
|
8
|
+
* @beta
|
|
9
9
|
*
|
|
10
10
|
* Required Scopes: [api:functions-read]
|
|
11
11
|
* URL: /v2/functions/queries/{queryApiName}
|
|
@@ -20,7 +20,7 @@ export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldCl
|
|
|
20
20
|
/**
|
|
21
21
|
* Gets a specific query type with the given RID. By default, this gets the latest version of the query.
|
|
22
22
|
*
|
|
23
|
-
* @
|
|
23
|
+
* @beta
|
|
24
24
|
*
|
|
25
25
|
* Required Scopes: [api:functions-read]
|
|
26
26
|
* URL: /v2/functions/queries/getByRid
|
|
@@ -41,7 +41,7 @@ export declare function getByRid($ctx: $Client | $ClientContext | $OldClient | $
|
|
|
41
41
|
*
|
|
42
42
|
* The maximum batch size for this endpoint is 100.
|
|
43
43
|
*
|
|
44
|
-
* @
|
|
44
|
+
* @beta
|
|
45
45
|
*
|
|
46
46
|
* Required Scopes: [api:functions-read]
|
|
47
47
|
* URL: /v2/functions/queries/getByRidBatch
|
|
@@ -53,14 +53,16 @@ export declare function getByRidBatch($ctx: $Client | $ClientContext | $OldClien
|
|
|
53
53
|
}
|
|
54
54
|
]): Promise<_Functions.GetByRidQueriesBatchResponse>;
|
|
55
55
|
/**
|
|
56
|
-
* Executes a Query
|
|
56
|
+
* Executes a Query and returns the result as a single JSON object. By default, this executes
|
|
57
|
+
* the latest version of the query. The latest version is the one that was most recently
|
|
58
|
+
* published, which may be a pre-release version.
|
|
57
59
|
*
|
|
58
|
-
* This endpoint
|
|
60
|
+
* This endpoint executes global (non-ontology-scoped) query functions. For ontology-scoped
|
|
61
|
+
* functions, use the equivalent endpoint under
|
|
62
|
+
* `/v2/ontologies/{ontology}/queries/{queryApiName}/execute`. For streaming or incremental
|
|
63
|
+
* result delivery, use `streamingExecute`.
|
|
59
64
|
*
|
|
60
|
-
*
|
|
61
|
-
* and provides enhanced functionality.
|
|
62
|
-
*
|
|
63
|
-
* @alpha
|
|
65
|
+
* @beta
|
|
64
66
|
*
|
|
65
67
|
* Required Scopes: [api:functions-execute]
|
|
66
68
|
* URL: /v2/functions/queries/{queryApiName}/execute
|
|
@@ -78,51 +80,6 @@ export declare function execute($ctx: $Client | $ClientContext | $OldClient | $O
|
|
|
78
80
|
traceState?: _Core.TraceState | undefined;
|
|
79
81
|
}
|
|
80
82
|
]): Promise<_Functions.ExecuteQueryResponse>;
|
|
81
|
-
/**
|
|
82
|
-
* Executes a Query using the given parameters, returning results as an NDJSON stream. By default, this executes the latest version of the query.
|
|
83
|
-
*
|
|
84
|
-
* This endpoint supports all Query functions. The endpoint name 'streamingExecute' refers to the NDJSON
|
|
85
|
-
* streaming response format. Both streaming and non-streaming functions can use this endpoint.
|
|
86
|
-
* Non-streaming functions return a single-line NDJSON response, while streaming functions return multi-line NDJSON responses.
|
|
87
|
-
* This is the recommended endpoint for all query execution.
|
|
88
|
-
*
|
|
89
|
-
* The response is returned as a binary stream in NDJSON (Newline Delimited JSON) format, where each line
|
|
90
|
-
* is a StreamingExecuteQueryResponse containing either a data batch or an error.
|
|
91
|
-
*
|
|
92
|
-
* For a function returning a list of 5 records with a batch size of 3, the response stream would contain
|
|
93
|
-
* two lines. The first line contains the first 3 items, and the second line contains the remaining 2 items:
|
|
94
|
-
*
|
|
95
|
-
* ```
|
|
96
|
-
* {"type":"data","value":[{"productId":"SKU-001","price":29.99},{"productId":"SKU-002","price":49.99},{"productId":"SKU-003","price":19.99}]}
|
|
97
|
-
* {"type":"data","value":[{"productId":"SKU-004","price":39.99},{"productId":"SKU-005","price":59.99}]}
|
|
98
|
-
* ```
|
|
99
|
-
*
|
|
100
|
-
* Each line is a separate JSON object followed by a newline character. Clients should parse the stream
|
|
101
|
-
* line-by-line to process results as they arrive. If an error occurs during execution, the stream will
|
|
102
|
-
* contain an error line:
|
|
103
|
-
*
|
|
104
|
-
* ```
|
|
105
|
-
* {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
106
|
-
* ```
|
|
107
|
-
*
|
|
108
|
-
* @alpha
|
|
109
|
-
*
|
|
110
|
-
* Required Scopes: [api:functions-execute]
|
|
111
|
-
* URL: /v2/functions/queries/{queryApiName}/streamingExecute
|
|
112
|
-
*/
|
|
113
|
-
export declare function streamingExecute($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
114
|
-
queryApiName: _Functions.QueryApiName,
|
|
115
|
-
$body: _Functions.StreamingExecuteQueryRequest,
|
|
116
|
-
$queryParams?: {
|
|
117
|
-
transactionId?: _Functions.TransactionId | undefined;
|
|
118
|
-
preview?: _Core.PreviewMode | undefined;
|
|
119
|
-
},
|
|
120
|
-
$headerParams?: {
|
|
121
|
-
attribution?: _Core.Attribution | undefined;
|
|
122
|
-
traceParent?: _Core.TraceParent | undefined;
|
|
123
|
-
traceState?: _Core.TraceState | undefined;
|
|
124
|
-
}
|
|
125
|
-
]): Promise<Response>;
|
|
126
83
|
/**
|
|
127
84
|
* Submits a Query for asynchronous execution. Returns either an execution ID
|
|
128
85
|
* for polling, or the complete result if execution finished immediately.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../src/public/Query.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAcrD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE,UAAU,CAAC,YAAY;IAErC,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,SAAS,CAAC;QACjD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAE3B;AAWD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE;QACZ,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC;QAC5B,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,SAAS,CAAC;QACjD,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QACxC,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAE3B;AASD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAC3D,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAElD;AAkBD
|
|
1
|
+
{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../src/public/Query.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAcrD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE,UAAU,CAAC,YAAY;IAErC,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,SAAS,CAAC;QACjD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAE3B;AAWD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE;QACZ,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC;QAC5B,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,GAAG,SAAS,CAAC;QACjD,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QACxC,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAE3B;AASD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAC3D,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAElD;AAkBD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE,UAAU,CAAC,YAAY;IACrC,KAAK,EAAE,UAAU,CAAC,mBAAmB;IACrC,YAAY,CAAC,EAAE;QACb,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;IACD,aAAa,CAAC,EAAE;QACd,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAC5C,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAC5C,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,SAAS,CAAC;KAC3C;CACF,GACA,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAE1C;AAkBD;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,YAAY,EAAE,UAAU,CAAC,YAAY;IACrC,KAAK,EAAE,UAAU,CAAC,wBAAwB;IAC1C,YAAY,CAAC,EAAE;QACb,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;IACD,aAAa,CAAC,EAAE;QACd,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAC5C,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAC5C,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,SAAS,CAAC;KAC3C;CACF,GACA,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAE/C"}
|
|
@@ -19,7 +19,7 @@ const _get = [0, "/v2/functions/queries/{0}", 2];
|
|
|
19
19
|
/**
|
|
20
20
|
* Gets a specific query type with the given API name. By default, this gets the latest version of the query.
|
|
21
21
|
*
|
|
22
|
-
* @
|
|
22
|
+
* @beta
|
|
23
23
|
*
|
|
24
24
|
* Required Scopes: [api:functions-read]
|
|
25
25
|
* URL: /v2/functions/queries/{queryApiName}
|
|
@@ -31,7 +31,7 @@ const _getByRid = [0, "/v2/functions/queries/getByRid", 2];
|
|
|
31
31
|
/**
|
|
32
32
|
* Gets a specific query type with the given RID. By default, this gets the latest version of the query.
|
|
33
33
|
*
|
|
34
|
-
* @
|
|
34
|
+
* @beta
|
|
35
35
|
*
|
|
36
36
|
* Required Scopes: [api:functions-read]
|
|
37
37
|
* URL: /v2/functions/queries/getByRid
|
|
@@ -48,7 +48,7 @@ const _getByRidBatch = [1, "/v2/functions/queries/getByRidBatch", 3];
|
|
|
48
48
|
*
|
|
49
49
|
* The maximum batch size for this endpoint is 100.
|
|
50
50
|
*
|
|
51
|
-
* @
|
|
51
|
+
* @beta
|
|
52
52
|
*
|
|
53
53
|
* Required Scopes: [api:functions-read]
|
|
54
54
|
* URL: /v2/functions/queries/getByRidBatch
|
|
@@ -58,14 +58,16 @@ export function getByRidBatch($ctx, ...args) {
|
|
|
58
58
|
}
|
|
59
59
|
const _execute = [1, "/v2/functions/queries/{0}/execute", 7];
|
|
60
60
|
/**
|
|
61
|
-
* Executes a Query
|
|
61
|
+
* Executes a Query and returns the result as a single JSON object. By default, this executes
|
|
62
|
+
* the latest version of the query. The latest version is the one that was most recently
|
|
63
|
+
* published, which may be a pre-release version.
|
|
62
64
|
*
|
|
63
|
-
* This endpoint
|
|
65
|
+
* This endpoint executes global (non-ontology-scoped) query functions. For ontology-scoped
|
|
66
|
+
* functions, use the equivalent endpoint under
|
|
67
|
+
* `/v2/ontologies/{ontology}/queries/{queryApiName}/execute`. For streaming or incremental
|
|
68
|
+
* result delivery, use `streamingExecute`.
|
|
64
69
|
*
|
|
65
|
-
*
|
|
66
|
-
* and provides enhanced functionality.
|
|
67
|
-
*
|
|
68
|
-
* @alpha
|
|
70
|
+
* @beta
|
|
69
71
|
*
|
|
70
72
|
* Required Scopes: [api:functions-execute]
|
|
71
73
|
* URL: /v2/functions/queries/{queryApiName}/execute
|
|
@@ -73,42 +75,6 @@ const _execute = [1, "/v2/functions/queries/{0}/execute", 7];
|
|
|
73
75
|
export function execute($ctx, ...args) {
|
|
74
76
|
return $foundryPlatformFetch($ctx, _execute, ...args);
|
|
75
77
|
}
|
|
76
|
-
const _streamingExecute = [1, "/v2/functions/queries/{0}/streamingExecute", 7,, "application/octet-stream"];
|
|
77
|
-
/**
|
|
78
|
-
* Executes a Query using the given parameters, returning results as an NDJSON stream. By default, this executes the latest version of the query.
|
|
79
|
-
*
|
|
80
|
-
* This endpoint supports all Query functions. The endpoint name 'streamingExecute' refers to the NDJSON
|
|
81
|
-
* streaming response format. Both streaming and non-streaming functions can use this endpoint.
|
|
82
|
-
* Non-streaming functions return a single-line NDJSON response, while streaming functions return multi-line NDJSON responses.
|
|
83
|
-
* This is the recommended endpoint for all query execution.
|
|
84
|
-
*
|
|
85
|
-
* The response is returned as a binary stream in NDJSON (Newline Delimited JSON) format, where each line
|
|
86
|
-
* is a StreamingExecuteQueryResponse containing either a data batch or an error.
|
|
87
|
-
*
|
|
88
|
-
* For a function returning a list of 5 records with a batch size of 3, the response stream would contain
|
|
89
|
-
* two lines. The first line contains the first 3 items, and the second line contains the remaining 2 items:
|
|
90
|
-
*
|
|
91
|
-
* ```
|
|
92
|
-
* {"type":"data","value":[{"productId":"SKU-001","price":29.99},{"productId":"SKU-002","price":49.99},{"productId":"SKU-003","price":19.99}]}
|
|
93
|
-
* {"type":"data","value":[{"productId":"SKU-004","price":39.99},{"productId":"SKU-005","price":59.99}]}
|
|
94
|
-
* ```
|
|
95
|
-
*
|
|
96
|
-
* Each line is a separate JSON object followed by a newline character. Clients should parse the stream
|
|
97
|
-
* line-by-line to process results as they arrive. If an error occurs during execution, the stream will
|
|
98
|
-
* contain an error line:
|
|
99
|
-
*
|
|
100
|
-
* ```
|
|
101
|
-
* {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
102
|
-
* ```
|
|
103
|
-
*
|
|
104
|
-
* @alpha
|
|
105
|
-
*
|
|
106
|
-
* Required Scopes: [api:functions-execute]
|
|
107
|
-
* URL: /v2/functions/queries/{queryApiName}/streamingExecute
|
|
108
|
-
*/
|
|
109
|
-
export function streamingExecute($ctx, ...args) {
|
|
110
|
-
return $foundryPlatformFetch($ctx, _streamingExecute, ...args);
|
|
111
|
-
}
|
|
112
78
|
const _executeAsync = [1, "/v2/functions/queries/{0}/executeAsync", 7];
|
|
113
79
|
/**
|
|
114
80
|
* Submits a Query for asynchronous execution. Returns either an execution ID
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Query.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args","_getByRid","getByRid","_getByRidBatch","getByRidBatch","_execute","execute","
|
|
1
|
+
{"version":3,"file":"Query.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args","_getByRid","getByRid","_getByRidBatch","getByRidBatch","_execute","execute","_executeAsync","executeAsync"],"sources":["Query.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _get = [0, \"/v2/functions/queries/{0}\", 2];\n/**\n * Gets a specific query type with the given API name. By default, this gets the latest version of the query.\n *\n * @beta\n *\n * Required Scopes: [api:functions-read]\n * URL: /v2/functions/queries/{queryApiName}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _getByRid = [0, \"/v2/functions/queries/getByRid\", 2];\n/**\n * Gets a specific query type with the given RID. By default, this gets the latest version of the query.\n *\n * @beta\n *\n * Required Scopes: [api:functions-read]\n * URL: /v2/functions/queries/getByRid\n */\nexport function getByRid($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getByRid, ...args);\n}\nconst _getByRidBatch = [1, \"/v2/functions/queries/getByRidBatch\", 3];\n/**\n * Gets a list of query types by RID in bulk. By default, this gets the latest version of each query.\n *\n * Queries are filtered from the response if they don't exist or the requesting token lacks the required\n * permissions.\n *\n * The maximum batch size for this endpoint is 100.\n *\n * @beta\n *\n * Required Scopes: [api:functions-read]\n * URL: /v2/functions/queries/getByRidBatch\n */\nexport function getByRidBatch($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getByRidBatch, ...args);\n}\nconst _execute = [1, \"/v2/functions/queries/{0}/execute\", 7];\n/**\n * Executes a Query and returns the result as a single JSON object. By default, this executes\n * the latest version of the query. The latest version is the one that was most recently\n * published, which may be a pre-release version.\n *\n * This endpoint executes global (non-ontology-scoped) query functions. For ontology-scoped\n * functions, use the equivalent endpoint under\n * `/v2/ontologies/{ontology}/queries/{queryApiName}/execute`. For streaming or incremental\n * result delivery, use `streamingExecute`.\n *\n * @beta\n *\n * Required Scopes: [api:functions-execute]\n * URL: /v2/functions/queries/{queryApiName}/execute\n */\nexport function execute($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _execute, ...args);\n}\nconst _executeAsync = [1, \"/v2/functions/queries/{0}/executeAsync\", 7];\n/**\n * Submits a Query for asynchronous execution. Returns either an execution ID\n * for polling, or the complete result if execution finished immediately.\n *\n * Use the Execution resource's getResult endpoint to poll for the\n * result of a submitted execution.\n *\n * @alpha\n *\n * Required Scopes: [api:functions-execute]\n * URL: /v2/functions/queries/{queryApiName}/executeAsync\n */\nexport function executeAsync($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _executeAsync, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,2BAA2B,EAAE,CAAC,CAAC;AAChD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,IAAI,EAAE,GAAGG,IAAI,CAAC;AACrD;AACA,MAAMC,SAAS,GAAG,CAAC,CAAC,EAAE,gCAAgC,EAAE,CAAC,CAAC;AAC1D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EACpC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,SAAS,EAAE,GAAGD,IAAI,CAAC;AAC1D;AACA,MAAMG,cAAc,GAAG,CAAC,CAAC,EAAE,qCAAqC,EAAE,CAAC,CAAC;AACpE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EACzC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,cAAc,EAAE,GAAGH,IAAI,CAAC;AAC/D;AACA,MAAMK,QAAQ,GAAG,CAAC,CAAC,EAAE,mCAAmC,EAAE,CAAC,CAAC;AAC5D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,OAAOA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACnC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,QAAQ,EAAE,GAAGL,IAAI,CAAC;AACzD;AACA,MAAMO,aAAa,GAAG,CAAC,CAAC,EAAE,wCAAwC,EAAE,CAAC,CAAC;AACtE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EACxC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,aAAa,EAAE,GAAGP,IAAI,CAAC;AAC9D","ignoreList":[]}
|
|
@@ -3,7 +3,7 @@ import type { SharedClient as $OldClient, SharedClientContext as $OldClientConte
|
|
|
3
3
|
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
|
|
4
4
|
import type * as _Functions from "../_components.js";
|
|
5
5
|
/**
|
|
6
|
-
* Gets a specific value type with the given RID
|
|
6
|
+
* Gets a specific version of a value type with the given RID and version ID.
|
|
7
7
|
*
|
|
8
8
|
* @alpha
|
|
9
9
|
*
|
|
@@ -17,7 +17,7 @@ import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.
|
|
|
17
17
|
//
|
|
18
18
|
const _get = [0, "/v2/functions/valueTypes/{0}/versionIds/{1}", 2];
|
|
19
19
|
/**
|
|
20
|
-
* Gets a specific value type with the given RID
|
|
20
|
+
* Gets a specific version of a value type with the given RID and version ID.
|
|
21
21
|
*
|
|
22
22
|
* @alpha
|
|
23
23
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VersionId.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args"],"sources":["VersionId.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _get = [0, \"/v2/functions/valueTypes/{0}/versionIds/{1}\", 2];\n/**\n * Gets a specific value type with the given RID
|
|
1
|
+
{"version":3,"file":"VersionId.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args"],"sources":["VersionId.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _get = [0, \"/v2/functions/valueTypes/{0}/versionIds/{1}\", 2];\n/**\n * Gets a specific version of a value type with the given RID and version ID.\n *\n * @alpha\n *\n * Required Scopes: [api:functions-read]\n * URL: /v2/functions/valueTypes/{valueTypeRid}/versionIds/{versionIdVersionId}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,6CAA6C,EAAE,CAAC,CAAC;AAClE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,IAAI,EAAE,GAAGG,IAAI,CAAC;AACrD","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdk/foundry.functions",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.68.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@osdk/shared.client": "^1.0.1",
|
|
23
23
|
"@osdk/shared.client2": "^1.0.0",
|
|
24
|
-
"@osdk/foundry.core": "2.
|
|
25
|
-
"@osdk/
|
|
26
|
-
"@osdk/
|
|
24
|
+
"@osdk/foundry.core": "2.68.0",
|
|
25
|
+
"@osdk/foundry.ontologies": "2.68.0",
|
|
26
|
+
"@osdk/shared.net.platformapi": "~1.7.0"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"typescript": "^5.5.4",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"sls": {
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"com.palantir.foundry.api:api-gateway": {
|
|
49
|
-
"minVersion": "1.
|
|
49
|
+
"minVersion": "1.1695.1",
|
|
50
50
|
"maxVersion": "1.x.x",
|
|
51
51
|
"optional": false
|
|
52
52
|
}
|