@osdk/foundry.functions 2.74.0 → 2.76.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 +25 -0
- package/build/browser/public/Query.d.ts +78 -0
- package/build/browser/public/Query.d.ts.map +1 -1
- package/build/browser/public/Query.js +60 -0
- package/build/browser/public/Query.js.map +1 -1
- package/build/esm/public/Query.d.ts +78 -0
- package/build/esm/public/Query.d.ts.map +1 -1
- package/build/esm/public/Query.js +60 -0
- package/build/esm/public/Query.js.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,30 @@
|
|
|
1
1
|
# @osdk/foundry.functions
|
|
2
2
|
|
|
3
|
+
## 2.76.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 57ef640: Regenerate SDKs with API version 1.1763.1
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies [57ef640]
|
|
12
|
+
- @osdk/foundry.core@2.76.0
|
|
13
|
+
- @osdk/foundry.ontologies@2.76.0
|
|
14
|
+
|
|
15
|
+
## 2.75.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- 36f7fa2: add sse support
|
|
20
|
+
|
|
21
|
+
### Patch Changes
|
|
22
|
+
|
|
23
|
+
- Updated dependencies [36f7fa2]
|
|
24
|
+
- @osdk/shared.net.platformapi@1.8.0
|
|
25
|
+
- @osdk/foundry.ontologies@2.75.0
|
|
26
|
+
- @osdk/foundry.core@2.75.0
|
|
27
|
+
|
|
3
28
|
## 2.74.0
|
|
4
29
|
|
|
5
30
|
### Minor Changes
|
|
@@ -85,6 +85,84 @@ export declare function execute($ctx: $Client | $ClientContext | $OldClient | $O
|
|
|
85
85
|
traceState?: _Core.TraceState | undefined;
|
|
86
86
|
}
|
|
87
87
|
]): Promise<_Functions.ExecuteQueryResponse>;
|
|
88
|
+
/**
|
|
89
|
+
* Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
|
|
90
|
+
* By default, this executes the highest semantic version of the query, excluding pre-release
|
|
91
|
+
* versions. To resolve the most recently published version instead, including pre-release
|
|
92
|
+
* versions, set `latestVersionResolution` to `PUBLISH_TIME`.
|
|
93
|
+
*
|
|
94
|
+
* This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded
|
|
95
|
+
* `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more
|
|
96
|
+
* result values, or an error (`type: error`) emitted before stream termination if execution
|
|
97
|
+
* fails. Non-streaming functions emit a single data event containing the entire result;
|
|
98
|
+
* streaming functions emit a data event per batch as results become available.
|
|
99
|
+
*
|
|
100
|
+
* Per the Server-Sent Events specification, each event is terminated by a blank line:
|
|
101
|
+
*
|
|
102
|
+
* ```
|
|
103
|
+
* data: {"type":"data","value":[{"productId":"SKU-001","price":29.99}]}
|
|
104
|
+
*
|
|
105
|
+
* data: {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
106
|
+
*
|
|
107
|
+
* ```
|
|
108
|
+
*
|
|
109
|
+
* @beta
|
|
110
|
+
*
|
|
111
|
+
* Required Scopes: [api:functions-execute]
|
|
112
|
+
* URL: /v2/functions/queries/{queryApiName}/streamingExecute
|
|
113
|
+
*/
|
|
114
|
+
export declare function streamingExecute($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
115
|
+
queryApiName: _Functions.QueryApiName,
|
|
116
|
+
$body: _Functions.StreamingExecuteQueryRequest,
|
|
117
|
+
$queryParams?: {
|
|
118
|
+
transactionId?: _Functions.TransactionId | undefined;
|
|
119
|
+
preview?: _Core.PreviewMode | undefined;
|
|
120
|
+
},
|
|
121
|
+
$headerParams?: {
|
|
122
|
+
attribution?: _Core.Attribution | undefined;
|
|
123
|
+
traceParent?: _Core.TraceParent | undefined;
|
|
124
|
+
traceState?: _Core.TraceState | undefined;
|
|
125
|
+
}
|
|
126
|
+
]): Promise<AsyncGenerator<_Functions.StreamingExecuteQueryResponse, void, void>>;
|
|
127
|
+
/**
|
|
128
|
+
* Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
|
|
129
|
+
* By default, this executes the highest semantic version of the query, excluding pre-release
|
|
130
|
+
* versions. To resolve the most recently published version instead, including pre-release
|
|
131
|
+
* versions, set `latestVersionResolution` to `PUBLISH_TIME`.
|
|
132
|
+
*
|
|
133
|
+
* This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded
|
|
134
|
+
* `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more
|
|
135
|
+
* result values, or an error (`type: error`) emitted before stream termination if execution
|
|
136
|
+
* fails. Non-streaming functions emit a single data event containing the entire result;
|
|
137
|
+
* streaming functions emit a data event per batch as results become available.
|
|
138
|
+
*
|
|
139
|
+
* Per the Server-Sent Events specification, each event is terminated by a blank line:
|
|
140
|
+
*
|
|
141
|
+
* ```
|
|
142
|
+
* data: {"type":"data","value":[{"productId":"SKU-001","price":29.99}]}
|
|
143
|
+
*
|
|
144
|
+
* data: {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
145
|
+
*
|
|
146
|
+
* ```
|
|
147
|
+
*
|
|
148
|
+
* @alpha
|
|
149
|
+
*
|
|
150
|
+
* Required Scopes: [api:functions-execute]
|
|
151
|
+
* URL: /v2/functions/queries/{queryApiName}/streamingExecuteEvents
|
|
152
|
+
*/
|
|
153
|
+
export declare function streamingExecuteEvents($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
154
|
+
queryApiName: _Functions.QueryApiName,
|
|
155
|
+
$body: _Functions.StreamingExecuteEventsQueryRequest,
|
|
156
|
+
$queryParams?: {
|
|
157
|
+
transactionId?: _Functions.TransactionId | undefined;
|
|
158
|
+
preview?: _Core.PreviewMode | undefined;
|
|
159
|
+
},
|
|
160
|
+
$headerParams?: {
|
|
161
|
+
attribution?: _Core.Attribution | undefined;
|
|
162
|
+
traceParent?: _Core.TraceParent | undefined;
|
|
163
|
+
traceState?: _Core.TraceState | undefined;
|
|
164
|
+
}
|
|
165
|
+
]): Promise<AsyncGenerator<_Functions.StreamingExecuteQueryResponse, void, void>>;
|
|
88
166
|
/**
|
|
89
167
|
* Submits a Query for asynchronous execution. Returns either an execution ID
|
|
90
168
|
* 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;AAgBrD;;;;;;;;;GASG;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,uBAAuB,CAAC,EAAE,UAAU,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzE,iBAAiB,CAAC,EAAE,UAAU,CAAC,iBAAiB,GAAG,SAAS,CAAC;QAC7D,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;;;;;;;;;;;;;;;GAeG;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"}
|
|
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;AAgBrD;;;;;;;;;GASG;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,uBAAuB,CAAC,EAAE,UAAU,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzE,iBAAiB,CAAC,EAAE,UAAU,CAAC,iBAAiB,GAAG,SAAS,CAAC;QAC7D,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;;;;;;;;;;;;;;;GAeG;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;AAoBD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,gBAAgB,CAC9B,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,4BAA4B;IAC9C,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,CACR,cAAc,CAAC,UAAU,CAAC,6BAA6B,EAAE,IAAI,EAAE,IAAI,CAAC,CACrE,CAEA;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,sBAAsB,CACpC,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,kCAAkC;IACpD,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,CACR,cAAc,CAAC,UAAU,CAAC,6BAA6B,EAAE,IAAI,EAAE,IAAI,CAAC,CACrE,CAEA;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"}
|
|
@@ -78,6 +78,66 @@ const _execute = [1, "/v2/functions/queries/{0}/execute", 7];
|
|
|
78
78
|
export function execute($ctx, ...args) {
|
|
79
79
|
return $foundryPlatformFetch($ctx, _execute, ...args);
|
|
80
80
|
}
|
|
81
|
+
const _streamingExecute = [1, "/v2/functions/queries/{0}/streamingExecute", 7,, "text/event-stream"];
|
|
82
|
+
/**
|
|
83
|
+
* Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
|
|
84
|
+
* By default, this executes the highest semantic version of the query, excluding pre-release
|
|
85
|
+
* versions. To resolve the most recently published version instead, including pre-release
|
|
86
|
+
* versions, set `latestVersionResolution` to `PUBLISH_TIME`.
|
|
87
|
+
*
|
|
88
|
+
* This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded
|
|
89
|
+
* `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more
|
|
90
|
+
* result values, or an error (`type: error`) emitted before stream termination if execution
|
|
91
|
+
* fails. Non-streaming functions emit a single data event containing the entire result;
|
|
92
|
+
* streaming functions emit a data event per batch as results become available.
|
|
93
|
+
*
|
|
94
|
+
* Per the Server-Sent Events specification, each event is terminated by a blank line:
|
|
95
|
+
*
|
|
96
|
+
* ```
|
|
97
|
+
* data: {"type":"data","value":[{"productId":"SKU-001","price":29.99}]}
|
|
98
|
+
*
|
|
99
|
+
* data: {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
100
|
+
*
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
103
|
+
* @beta
|
|
104
|
+
*
|
|
105
|
+
* Required Scopes: [api:functions-execute]
|
|
106
|
+
* URL: /v2/functions/queries/{queryApiName}/streamingExecute
|
|
107
|
+
*/
|
|
108
|
+
export function streamingExecute($ctx, ...args) {
|
|
109
|
+
return $foundryPlatformFetch($ctx, _streamingExecute, ...args);
|
|
110
|
+
}
|
|
111
|
+
const _streamingExecuteEvents = [1, "/v2/functions/queries/{0}/streamingExecuteEvents", 7,, "text/event-stream"];
|
|
112
|
+
/**
|
|
113
|
+
* Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
|
|
114
|
+
* By default, this executes the highest semantic version of the query, excluding pre-release
|
|
115
|
+
* versions. To resolve the most recently published version instead, including pre-release
|
|
116
|
+
* versions, set `latestVersionResolution` to `PUBLISH_TIME`.
|
|
117
|
+
*
|
|
118
|
+
* This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded
|
|
119
|
+
* `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more
|
|
120
|
+
* result values, or an error (`type: error`) emitted before stream termination if execution
|
|
121
|
+
* fails. Non-streaming functions emit a single data event containing the entire result;
|
|
122
|
+
* streaming functions emit a data event per batch as results become available.
|
|
123
|
+
*
|
|
124
|
+
* Per the Server-Sent Events specification, each event is terminated by a blank line:
|
|
125
|
+
*
|
|
126
|
+
* ```
|
|
127
|
+
* data: {"type":"data","value":[{"productId":"SKU-001","price":29.99}]}
|
|
128
|
+
*
|
|
129
|
+
* data: {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
130
|
+
*
|
|
131
|
+
* ```
|
|
132
|
+
*
|
|
133
|
+
* @alpha
|
|
134
|
+
*
|
|
135
|
+
* Required Scopes: [api:functions-execute]
|
|
136
|
+
* URL: /v2/functions/queries/{queryApiName}/streamingExecuteEvents
|
|
137
|
+
*/
|
|
138
|
+
export function streamingExecuteEvents($ctx, ...args) {
|
|
139
|
+
return $foundryPlatformFetch($ctx, _streamingExecuteEvents, ...args);
|
|
140
|
+
}
|
|
81
141
|
const _executeAsync = [1, "/v2/functions/queries/{0}/executeAsync", 7];
|
|
82
142
|
/**
|
|
83
143
|
* 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","_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 returns the highest semantic\n * version of the query, excluding pre-release versions. To resolve the most recently published version\n * instead, including pre-release versions, set `latestVersionResolution` to `PUBLISH_TIME`.\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 highest semantic version of the query, excluding pre-release versions. To resolve the\n * most recently published version instead, including pre-release versions, set\n * `latestVersionResolution` to `PUBLISH_TIME`.\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;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;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,
|
|
1
|
+
{"version":3,"file":"Query.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args","_getByRid","getByRid","_getByRidBatch","getByRidBatch","_execute","execute","_streamingExecute","streamingExecute","_streamingExecuteEvents","streamingExecuteEvents","_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 returns the highest semantic\n * version of the query, excluding pre-release versions. To resolve the most recently published version\n * instead, including pre-release versions, set `latestVersionResolution` to `PUBLISH_TIME`.\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 highest semantic version of the query, excluding pre-release versions. To resolve the\n * most recently published version instead, including pre-release versions, set\n * `latestVersionResolution` to `PUBLISH_TIME`.\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 _streamingExecute = [1, \"/v2/functions/queries/{0}/streamingExecute\", 7, , \"text/event-stream\"];\n/**\n * Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.\n * By default, this executes the highest semantic version of the query, excluding pre-release\n * versions. To resolve the most recently published version instead, including pre-release\n * versions, set `latestVersionResolution` to `PUBLISH_TIME`.\n *\n * This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded\n * `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more\n * result values, or an error (`type: error`) emitted before stream termination if execution\n * fails. Non-streaming functions emit a single data event containing the entire result;\n * streaming functions emit a data event per batch as results become available.\n *\n * Per the Server-Sent Events specification, each event is terminated by a blank line:\n *\n * ```\n * data: {\"type\":\"data\",\"value\":[{\"productId\":\"SKU-001\",\"price\":29.99}]}\n *\n * data: {\"type\":\"error\",\"errorCode\":\"INVALID_ARGUMENT\",\"errorName\":\"QueryRuntimeError\",\"errorInstanceId\":\"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c\",\"errorDescription\":\"Division by zero\",\"parameters\":{}}\n *\n * ```\n *\n * @beta\n *\n * Required Scopes: [api:functions-execute]\n * URL: /v2/functions/queries/{queryApiName}/streamingExecute\n */\nexport function streamingExecute($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _streamingExecute, ...args);\n}\nconst _streamingExecuteEvents = [\n 1,\n \"/v2/functions/queries/{0}/streamingExecuteEvents\",\n 7,\n ,\n \"text/event-stream\",\n];\n/**\n * Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.\n * By default, this executes the highest semantic version of the query, excluding pre-release\n * versions. To resolve the most recently published version instead, including pre-release\n * versions, set `latestVersionResolution` to `PUBLISH_TIME`.\n *\n * This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded\n * `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more\n * result values, or an error (`type: error`) emitted before stream termination if execution\n * fails. Non-streaming functions emit a single data event containing the entire result;\n * streaming functions emit a data event per batch as results become available.\n *\n * Per the Server-Sent Events specification, each event is terminated by a blank line:\n *\n * ```\n * data: {\"type\":\"data\",\"value\":[{\"productId\":\"SKU-001\",\"price\":29.99}]}\n *\n * data: {\"type\":\"error\",\"errorCode\":\"INVALID_ARGUMENT\",\"errorName\":\"QueryRuntimeError\",\"errorInstanceId\":\"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c\",\"errorDescription\":\"Division by zero\",\"parameters\":{}}\n *\n * ```\n *\n * @alpha\n *\n * Required Scopes: [api:functions-execute]\n * URL: /v2/functions/queries/{queryApiName}/streamingExecuteEvents\n */\nexport function streamingExecuteEvents($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _streamingExecuteEvents, ...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;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;AACA,OAAO,SAASC,OAAOA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACnC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,QAAQ,EAAE,GAAGL,IAAI,CAAC;AACzD;AACA,MAAMO,iBAAiB,GAAG,CAAC,CAAC,EAAE,4CAA4C,EAAE,CAAC,GAAI,mBAAmB,CAAC;AACrG;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC5C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,iBAAiB,EAAE,GAAGP,IAAI,CAAC;AAClE;AACA,MAAMS,uBAAuB,GAAG,CAC5B,CAAC,EACD,kDAAkD,EAClD,CAAC,GAED,mBAAmB,CACtB;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsBA,CAACX,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClD,OAAOJ,qBAAqB,CAACG,IAAI,EAAEU,uBAAuB,EAAE,GAAGT,IAAI,CAAC;AACxE;AACA,MAAMW,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,CAACb,IAAI,EAAE,GAAGC,IAAI,EAAE;EACxC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEY,aAAa,EAAE,GAAGX,IAAI,CAAC;AAC9D","ignoreList":[]}
|
|
@@ -85,6 +85,84 @@ export declare function execute($ctx: $Client | $ClientContext | $OldClient | $O
|
|
|
85
85
|
traceState?: _Core.TraceState | undefined;
|
|
86
86
|
}
|
|
87
87
|
]): Promise<_Functions.ExecuteQueryResponse>;
|
|
88
|
+
/**
|
|
89
|
+
* Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
|
|
90
|
+
* By default, this executes the highest semantic version of the query, excluding pre-release
|
|
91
|
+
* versions. To resolve the most recently published version instead, including pre-release
|
|
92
|
+
* versions, set `latestVersionResolution` to `PUBLISH_TIME`.
|
|
93
|
+
*
|
|
94
|
+
* This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded
|
|
95
|
+
* `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more
|
|
96
|
+
* result values, or an error (`type: error`) emitted before stream termination if execution
|
|
97
|
+
* fails. Non-streaming functions emit a single data event containing the entire result;
|
|
98
|
+
* streaming functions emit a data event per batch as results become available.
|
|
99
|
+
*
|
|
100
|
+
* Per the Server-Sent Events specification, each event is terminated by a blank line:
|
|
101
|
+
*
|
|
102
|
+
* ```
|
|
103
|
+
* data: {"type":"data","value":[{"productId":"SKU-001","price":29.99}]}
|
|
104
|
+
*
|
|
105
|
+
* data: {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
106
|
+
*
|
|
107
|
+
* ```
|
|
108
|
+
*
|
|
109
|
+
* @beta
|
|
110
|
+
*
|
|
111
|
+
* Required Scopes: [api:functions-execute]
|
|
112
|
+
* URL: /v2/functions/queries/{queryApiName}/streamingExecute
|
|
113
|
+
*/
|
|
114
|
+
export declare function streamingExecute($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
115
|
+
queryApiName: _Functions.QueryApiName,
|
|
116
|
+
$body: _Functions.StreamingExecuteQueryRequest,
|
|
117
|
+
$queryParams?: {
|
|
118
|
+
transactionId?: _Functions.TransactionId | undefined;
|
|
119
|
+
preview?: _Core.PreviewMode | undefined;
|
|
120
|
+
},
|
|
121
|
+
$headerParams?: {
|
|
122
|
+
attribution?: _Core.Attribution | undefined;
|
|
123
|
+
traceParent?: _Core.TraceParent | undefined;
|
|
124
|
+
traceState?: _Core.TraceState | undefined;
|
|
125
|
+
}
|
|
126
|
+
]): Promise<AsyncGenerator<_Functions.StreamingExecuteQueryResponse, void, void>>;
|
|
127
|
+
/**
|
|
128
|
+
* Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
|
|
129
|
+
* By default, this executes the highest semantic version of the query, excluding pre-release
|
|
130
|
+
* versions. To resolve the most recently published version instead, including pre-release
|
|
131
|
+
* versions, set `latestVersionResolution` to `PUBLISH_TIME`.
|
|
132
|
+
*
|
|
133
|
+
* This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded
|
|
134
|
+
* `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more
|
|
135
|
+
* result values, or an error (`type: error`) emitted before stream termination if execution
|
|
136
|
+
* fails. Non-streaming functions emit a single data event containing the entire result;
|
|
137
|
+
* streaming functions emit a data event per batch as results become available.
|
|
138
|
+
*
|
|
139
|
+
* Per the Server-Sent Events specification, each event is terminated by a blank line:
|
|
140
|
+
*
|
|
141
|
+
* ```
|
|
142
|
+
* data: {"type":"data","value":[{"productId":"SKU-001","price":29.99}]}
|
|
143
|
+
*
|
|
144
|
+
* data: {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
145
|
+
*
|
|
146
|
+
* ```
|
|
147
|
+
*
|
|
148
|
+
* @alpha
|
|
149
|
+
*
|
|
150
|
+
* Required Scopes: [api:functions-execute]
|
|
151
|
+
* URL: /v2/functions/queries/{queryApiName}/streamingExecuteEvents
|
|
152
|
+
*/
|
|
153
|
+
export declare function streamingExecuteEvents($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
154
|
+
queryApiName: _Functions.QueryApiName,
|
|
155
|
+
$body: _Functions.StreamingExecuteEventsQueryRequest,
|
|
156
|
+
$queryParams?: {
|
|
157
|
+
transactionId?: _Functions.TransactionId | undefined;
|
|
158
|
+
preview?: _Core.PreviewMode | undefined;
|
|
159
|
+
},
|
|
160
|
+
$headerParams?: {
|
|
161
|
+
attribution?: _Core.Attribution | undefined;
|
|
162
|
+
traceParent?: _Core.TraceParent | undefined;
|
|
163
|
+
traceState?: _Core.TraceState | undefined;
|
|
164
|
+
}
|
|
165
|
+
]): Promise<AsyncGenerator<_Functions.StreamingExecuteQueryResponse, void, void>>;
|
|
88
166
|
/**
|
|
89
167
|
* Submits a Query for asynchronous execution. Returns either an execution ID
|
|
90
168
|
* 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;AAgBrD;;;;;;;;;GASG;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,uBAAuB,CAAC,EAAE,UAAU,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzE,iBAAiB,CAAC,EAAE,UAAU,CAAC,iBAAiB,GAAG,SAAS,CAAC;QAC7D,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;;;;;;;;;;;;;;;GAeG;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"}
|
|
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;AAgBrD;;;;;;;;;GASG;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,uBAAuB,CAAC,EAAE,UAAU,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzE,iBAAiB,CAAC,EAAE,UAAU,CAAC,iBAAiB,GAAG,SAAS,CAAC;QAC7D,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;;;;;;;;;;;;;;;GAeG;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;AAoBD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,gBAAgB,CAC9B,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,4BAA4B;IAC9C,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,CACR,cAAc,CAAC,UAAU,CAAC,6BAA6B,EAAE,IAAI,EAAE,IAAI,CAAC,CACrE,CAEA;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,sBAAsB,CACpC,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,kCAAkC;IACpD,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,CACR,cAAc,CAAC,UAAU,CAAC,6BAA6B,EAAE,IAAI,EAAE,IAAI,CAAC,CACrE,CAEA;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"}
|
|
@@ -78,6 +78,66 @@ const _execute = [1, "/v2/functions/queries/{0}/execute", 7];
|
|
|
78
78
|
export function execute($ctx, ...args) {
|
|
79
79
|
return $foundryPlatformFetch($ctx, _execute, ...args);
|
|
80
80
|
}
|
|
81
|
+
const _streamingExecute = [1, "/v2/functions/queries/{0}/streamingExecute", 7,, "text/event-stream"];
|
|
82
|
+
/**
|
|
83
|
+
* Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
|
|
84
|
+
* By default, this executes the highest semantic version of the query, excluding pre-release
|
|
85
|
+
* versions. To resolve the most recently published version instead, including pre-release
|
|
86
|
+
* versions, set `latestVersionResolution` to `PUBLISH_TIME`.
|
|
87
|
+
*
|
|
88
|
+
* This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded
|
|
89
|
+
* `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more
|
|
90
|
+
* result values, or an error (`type: error`) emitted before stream termination if execution
|
|
91
|
+
* fails. Non-streaming functions emit a single data event containing the entire result;
|
|
92
|
+
* streaming functions emit a data event per batch as results become available.
|
|
93
|
+
*
|
|
94
|
+
* Per the Server-Sent Events specification, each event is terminated by a blank line:
|
|
95
|
+
*
|
|
96
|
+
* ```
|
|
97
|
+
* data: {"type":"data","value":[{"productId":"SKU-001","price":29.99}]}
|
|
98
|
+
*
|
|
99
|
+
* data: {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
100
|
+
*
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
103
|
+
* @beta
|
|
104
|
+
*
|
|
105
|
+
* Required Scopes: [api:functions-execute]
|
|
106
|
+
* URL: /v2/functions/queries/{queryApiName}/streamingExecute
|
|
107
|
+
*/
|
|
108
|
+
export function streamingExecute($ctx, ...args) {
|
|
109
|
+
return $foundryPlatformFetch($ctx, _streamingExecute, ...args);
|
|
110
|
+
}
|
|
111
|
+
const _streamingExecuteEvents = [1, "/v2/functions/queries/{0}/streamingExecuteEvents", 7,, "text/event-stream"];
|
|
112
|
+
/**
|
|
113
|
+
* Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.
|
|
114
|
+
* By default, this executes the highest semantic version of the query, excluding pre-release
|
|
115
|
+
* versions. To resolve the most recently published version instead, including pre-release
|
|
116
|
+
* versions, set `latestVersionResolution` to `PUBLISH_TIME`.
|
|
117
|
+
*
|
|
118
|
+
* This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded
|
|
119
|
+
* `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more
|
|
120
|
+
* result values, or an error (`type: error`) emitted before stream termination if execution
|
|
121
|
+
* fails. Non-streaming functions emit a single data event containing the entire result;
|
|
122
|
+
* streaming functions emit a data event per batch as results become available.
|
|
123
|
+
*
|
|
124
|
+
* Per the Server-Sent Events specification, each event is terminated by a blank line:
|
|
125
|
+
*
|
|
126
|
+
* ```
|
|
127
|
+
* data: {"type":"data","value":[{"productId":"SKU-001","price":29.99}]}
|
|
128
|
+
*
|
|
129
|
+
* data: {"type":"error","errorCode":"INVALID_ARGUMENT","errorName":"QueryRuntimeError","errorInstanceId":"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c","errorDescription":"Division by zero","parameters":{}}
|
|
130
|
+
*
|
|
131
|
+
* ```
|
|
132
|
+
*
|
|
133
|
+
* @alpha
|
|
134
|
+
*
|
|
135
|
+
* Required Scopes: [api:functions-execute]
|
|
136
|
+
* URL: /v2/functions/queries/{queryApiName}/streamingExecuteEvents
|
|
137
|
+
*/
|
|
138
|
+
export function streamingExecuteEvents($ctx, ...args) {
|
|
139
|
+
return $foundryPlatformFetch($ctx, _streamingExecuteEvents, ...args);
|
|
140
|
+
}
|
|
81
141
|
const _executeAsync = [1, "/v2/functions/queries/{0}/executeAsync", 7];
|
|
82
142
|
/**
|
|
83
143
|
* 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","_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 returns the highest semantic\n * version of the query, excluding pre-release versions. To resolve the most recently published version\n * instead, including pre-release versions, set `latestVersionResolution` to `PUBLISH_TIME`.\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 highest semantic version of the query, excluding pre-release versions. To resolve the\n * most recently published version instead, including pre-release versions, set\n * `latestVersionResolution` to `PUBLISH_TIME`.\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;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;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,
|
|
1
|
+
{"version":3,"file":"Query.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_get","get","$ctx","args","_getByRid","getByRid","_getByRidBatch","getByRidBatch","_execute","execute","_streamingExecute","streamingExecute","_streamingExecuteEvents","streamingExecuteEvents","_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 returns the highest semantic\n * version of the query, excluding pre-release versions. To resolve the most recently published version\n * instead, including pre-release versions, set `latestVersionResolution` to `PUBLISH_TIME`.\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 highest semantic version of the query, excluding pre-release versions. To resolve the\n * most recently published version instead, including pre-release versions, set\n * `latestVersionResolution` to `PUBLISH_TIME`.\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 _streamingExecute = [1, \"/v2/functions/queries/{0}/streamingExecute\", 7, , \"text/event-stream\"];\n/**\n * Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.\n * By default, this executes the highest semantic version of the query, excluding pre-release\n * versions. To resolve the most recently published version instead, including pre-release\n * versions, set `latestVersionResolution` to `PUBLISH_TIME`.\n *\n * This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded\n * `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more\n * result values, or an error (`type: error`) emitted before stream termination if execution\n * fails. Non-streaming functions emit a single data event containing the entire result;\n * streaming functions emit a data event per batch as results become available.\n *\n * Per the Server-Sent Events specification, each event is terminated by a blank line:\n *\n * ```\n * data: {\"type\":\"data\",\"value\":[{\"productId\":\"SKU-001\",\"price\":29.99}]}\n *\n * data: {\"type\":\"error\",\"errorCode\":\"INVALID_ARGUMENT\",\"errorName\":\"QueryRuntimeError\",\"errorInstanceId\":\"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c\",\"errorDescription\":\"Division by zero\",\"parameters\":{}}\n *\n * ```\n *\n * @beta\n *\n * Required Scopes: [api:functions-execute]\n * URL: /v2/functions/queries/{queryApiName}/streamingExecute\n */\nexport function streamingExecute($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _streamingExecute, ...args);\n}\nconst _streamingExecuteEvents = [\n 1,\n \"/v2/functions/queries/{0}/streamingExecuteEvents\",\n 7,\n ,\n \"text/event-stream\",\n];\n/**\n * Executes a Query and returns results as a Server-Sent Events (`text/event-stream`) stream.\n * By default, this executes the highest semantic version of the query, excluding pre-release\n * versions. To resolve the most recently published version instead, including pre-release\n * versions, set `latestVersionResolution` to `PUBLISH_TIME`.\n *\n * This endpoint supports all Query functions. Each SSE event's `data` field is a JSON-encoded\n * `StreamingExecuteQueryResponse` – either a data batch (`type: data`) carrying one or more\n * result values, or an error (`type: error`) emitted before stream termination if execution\n * fails. Non-streaming functions emit a single data event containing the entire result;\n * streaming functions emit a data event per batch as results become available.\n *\n * Per the Server-Sent Events specification, each event is terminated by a blank line:\n *\n * ```\n * data: {\"type\":\"data\",\"value\":[{\"productId\":\"SKU-001\",\"price\":29.99}]}\n *\n * data: {\"type\":\"error\",\"errorCode\":\"INVALID_ARGUMENT\",\"errorName\":\"QueryRuntimeError\",\"errorInstanceId\":\"3f8a9c7b-2e4d-4a1f-9b8c-7d6e5f4a3b2c\",\"errorDescription\":\"Division by zero\",\"parameters\":{}}\n *\n * ```\n *\n * @alpha\n *\n * Required Scopes: [api:functions-execute]\n * URL: /v2/functions/queries/{queryApiName}/streamingExecuteEvents\n */\nexport function streamingExecuteEvents($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _streamingExecuteEvents, ...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;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;AACA,OAAO,SAASC,OAAOA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACnC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,QAAQ,EAAE,GAAGL,IAAI,CAAC;AACzD;AACA,MAAMO,iBAAiB,GAAG,CAAC,CAAC,EAAE,4CAA4C,EAAE,CAAC,GAAI,mBAAmB,CAAC;AACrG;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC5C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,iBAAiB,EAAE,GAAGP,IAAI,CAAC;AAClE;AACA,MAAMS,uBAAuB,GAAG,CAC5B,CAAC,EACD,kDAAkD,EAClD,CAAC,GAED,mBAAmB,CACtB;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsBA,CAACX,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClD,OAAOJ,qBAAqB,CAACG,IAAI,EAAEU,uBAAuB,EAAE,GAAGT,IAAI,CAAC;AACxE;AACA,MAAMW,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,CAACb,IAAI,EAAE,GAAGC,IAAI,EAAE;EACxC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEY,aAAa,EAAE,GAAGX,IAAI,CAAC;AAC9D","ignoreList":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osdk/foundry.functions",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.76.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.76.0",
|
|
25
|
+
"@osdk/shared.net.platformapi": "~1.8.0",
|
|
26
|
+
"@osdk/foundry.ontologies": "2.76.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.1763.1",
|
|
50
50
|
"maxVersion": "1.x.x",
|
|
51
51
|
"optional": false
|
|
52
52
|
}
|