starred/windmill
1
0
Fork 0
mirror of https://github.com/windmill-labs/windmill.git synced 2026-10-21 08:03:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

sqk function for ducklake

Browse Source
This commit is contained in:
Diego Imbert
2025-11-26 17:01:27 +01:00
parent 1f66aeac33
commit fdd3eb3ab3
6 changed files with 117 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
typescript-client/build.jsr.sh
+1 -1
View File
@@ -15,6 +15,6 @@ cp "${script_dirpath}/sqlUtils.ts" "${script_dirpath}/src/"
echo "" >> "${script_dirpath}/src/index.ts"
echo 'export type { S3Object, DenoS3LightClientSettings } from "./s3Types";' >> "${script_dirpath}/src/index.ts"
echo "" >> "${script_dirpath}/src/index.ts"
echo 'export { type Base64, setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, setProgress, getProgress, getState, getIdToken, denoS3LightClientSettings, loadS3FileStream, loadS3File, writeS3File, signS3Objects, signS3Object, task, runScript, runScriptAsync, runScriptByPath, runScriptByHash, runScriptByPathAsync, runScriptByHashAsync, runFlow, runFlowAsync, waitJob, getRootJobId, setFlowUserState, getFlowUserState, usernameToEmail, requestInteractiveSlackApproval, Sql, requestInteractiveTeamsApproval, appendToResultStream, streamResult, datatable } from "./client";' >> "${script_dirpath}/src/index.ts"
echo 'export { type Base64, setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, setProgress, getProgress, getState, getIdToken, denoS3LightClientSettings, loadS3FileStream, loadS3File, writeS3File, signS3Objects, signS3Object, task, runScript, runScriptAsync, runScriptByPath, runScriptByHash, runScriptByPathAsync, runScriptByHashAsync, runFlow, runFlowAsync, waitJob, getRootJobId, setFlowUserState, getFlowUserState, usernameToEmail, requestInteractiveSlackApproval, Sql, requestInteractiveTeamsApproval, appendToResultStream, streamResult, datatable, ducklake } from "./client";' >> "${script_dirpath}/src/index.ts"
typescript-client/build.sh
+1 -1
View File
@@ -40,4 +40,4 @@ cp "${script_dirpath}/sqlUtils.ts" "${script_dirpath}/src/"
echo "" >> "${script_dirpath}/src/index.ts"
echo 'export type { S3Object, DenoS3LightClientSettings } from "./s3Types";' >> "${script_dirpath}/src/index.ts"
echo "" >> "${script_dirpath}/src/index.ts"
echo 'export { type Base64, setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, setProgress, getProgress, getState, getIdToken, denoS3LightClientSettings, loadS3FileStream, loadS3File, writeS3File, signS3Objects, signS3Object, task, runScript, runScriptAsync, runScriptByPath, runScriptByHash, runScriptByPathAsync, runScriptByHashAsync, runFlow, runFlowAsync, waitJob, getRootJobId, setFlowUserState, getFlowUserState, usernameToEmail, requestInteractiveSlackApproval, Sql, requestInteractiveTeamsApproval, appendToResultStream, streamResult, datatable } from "./client";' >> "${script_dirpath}/src/index.ts"
echo 'export { type Base64, setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, setProgress, getProgress, getState, getIdToken, denoS3LightClientSettings, loadS3FileStream, loadS3File, writeS3File, signS3Objects, signS3Object, task, runScript, runScriptAsync, runScriptByPath, runScriptByHash, runScriptByPathAsync, runScriptByHashAsync, runFlow, runFlowAsync, waitJob, getRootJobId, setFlowUserState, getFlowUserState, usernameToEmail, requestInteractiveSlackApproval, Sql, requestInteractiveTeamsApproval, appendToResultStream, streamResult, datatable, ducklake } from "./client";' >> "${script_dirpath}/src/index.ts"
typescript-client/client.d.ts
Vendored
+74 -18
View File
@@ -1,5 +1,20 @@
import { DenoS3LightClientSettings, type S3Object } from "./s3Types";
export { AdminService, AuditService, FlowService, GranularAclService, GroupService, JobService, ResourceService, VariableService, ScriptService, ScheduleService, SettingsService, UserService, WorkspaceService, } from "./index";
export {
AdminService,
AuditService,
FlowService,
GranularAclService,
GroupService,
JobService,
ResourceService,
VariableService,
ScriptService,
ScheduleService,
SettingsService,
UserService,
WorkspaceService,
} from "./index";
export { datatable, ducklake } from "./sqlUtils";
export type Sql = string;
export type Email = string;
export type Base64 = string;
@@ -17,19 +32,32 @@ export declare function getWorkspace(): string;
* @param undefinedIfEmpty if the resource does not exist, return undefined instead of throwing an error
* @returns resource value
*/
export declare function getResource(path?: string, undefinedIfEmpty?: boolean): Promise<any>;
export declare function getResource(
path?: string,
undefinedIfEmpty?: boolean
): Promise<any>;
/**
* Get a resource value by path
* @param jobId job id to get the root job id from (default to current job)
* @returns root job id
*/
export declare function getRootJobId(jobId?: string): Promise<string>;
export declare function runScript(path?: string | null, hash_?: string | null, args?: Record<string, any> | null, verbose?: boolean): Promise<any>;
export declare function runScript(
path?: string | null,
hash_?: string | null,
args?: Record<string, any> | null,
verbose?: boolean
): Promise<any>;
export declare function waitJob(jobId: string, verbose?: boolean): Promise<any>;
export declare function getResult(jobId: string): Promise<any>;
export declare function getResultMaybe(jobId: string): Promise<any>;
export declare function task<P, T>(f: (_: P) => T): (_: P) => Promise<T>;
export declare function runScriptAsync(path: string | null, hash_: string | null, args: Record<string, any> | null, scheduledInSeconds?: number | null): Promise<string>;
export declare function runScriptAsync(
path: string | null,
hash_: string | null,
args: Record<string, any> | null,
scheduledInSeconds?: number | null
): Promise<string>;
/**
* Resolve a resource value in case the default value was picked because the input payload was undefined
* @param obj resource value or path of the resource under the format `$res:path`
@@ -43,7 +71,11 @@ export declare function getStatePath(): string;
* @param value new value of the resource to set
* @param initializeToTypeIfNotExist if the resource does not exist, initialize it with this type
*/
export declare function setResource(value: any, path?: string, initializeToTypeIfNotExist?: string): Promise<void>;
export declare function setResource(
value: any,
path?: string,
initializeToTypeIfNotExist?: string
): Promise<void>;
/**
* Set the state
* @param state state to set
@@ -61,13 +93,20 @@ export declare function setState(state: any): Promise<void>;
* @param value value of the state
*/
export declare function setFlowUserState(key: string, value: any, errorIfNotPossible?: boolean): Promise<void>;
export declare function setFlowUserState(
key: string,
value: any,
errorIfNotPossible?: boolean
): Promise<void>;
/**
* Get a flow user state
* @param path path of the variable
*/
export declare function getFlowUserState(key: string, errorIfNotPossible?: boolean): Promise<any>;
export declare function getFlowUserState(
key: string,
errorIfNotPossible?: boolean
): Promise<any>;
/**
* Get the internal state
* @deprecated use getState instead
@@ -90,9 +129,16 @@ export declare function getVariable(path: string): Promise<string>;
* @param isSecretIfNotExist if the variable does not exist, create it as secret or not (default: false)
* @param descriptionIfNotExist if the variable does not exist, create it with this description (default: "")
*/
export declare function setVariable(path: string, value: string, isSecretIfNotExist?: boolean, descriptionIfNotExist?: string): Promise<void>;
export declare function setVariable(
path: string,
value: string,
isSecretIfNotExist?: boolean,
descriptionIfNotExist?: string
): Promise<void>;
export declare function databaseUrlFromResource(path: string): Promise<string>;
export declare function denoS3LightClientSettings(s3_resource_path: string | undefined): Promise<DenoS3LightClientSettings>;
export declare function denoS3LightClientSettings(
s3_resource_path: string | undefined
): Promise<DenoS3LightClientSettings>;
/**
* Load the content of a file stored in S3. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
*
@@ -103,7 +149,10 @@ export declare function denoS3LightClientSettings(s3_resource_path: string | und
* console.log(text);
* ```
*/
export declare function loadS3File(s3object: S3Object, s3ResourcePath?: string | undefined): Promise<Uint8Array | undefined>;
export declare function loadS3File(
s3object: S3Object,
s3ResourcePath?: string | undefined
): Promise<Uint8Array | undefined>;
/**
* Load the content of a file stored in S3 as a stream. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
*
@@ -113,7 +162,10 @@ export declare function loadS3File(s3object: S3Object, s3ResourcePath?: string |
* console.log(await fileContentBlob.text());
* ```
*/
export declare function loadS3FileStream(s3object: S3Object, s3ResourcePath?: string | undefined): Promise<Blob | undefined>;
export declare function loadS3FileStream(
s3object: S3Object,
s3ResourcePath?: string | undefined
): Promise<Blob | undefined>;
/**
* Persist a file to the S3 bucket. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
*
@@ -123,24 +175,28 @@ export declare function loadS3FileStream(s3object: S3Object, s3ResourcePath?: st
* console.log(fileContentAsUtf8Str)
* ```
*/
export declare function writeS3File(s3object: S3Object | undefined, fileContent: string | Blob, s3ResourcePath?: string | undefined): Promise<S3Object>;
export declare function writeS3File(
s3object: S3Object | undefined,
fileContent: string | Blob,
s3ResourcePath?: string | undefined
): Promise<S3Object>;
/**
* Get URLs needed for resuming a flow after this step
* @param approver approver name
* @returns approval page UI URL, resume and cancel API URLs for resuming the flow
*/
export declare function getResumeUrls(approver?: string): Promise<{
approvalPage: string;
resume: string;
cancel: string;
approvalPage: string;
resume: string;
cancel: string;
}>;
/**
* @deprecated use getResumeUrls instead
*/
export declare function getResumeEndpoints(approver?: string): Promise<{
approvalPage: string;
resume: string;
cancel: string;
approvalPage: string;
resume: string;
cancel: string;
}>;
/**
* Get an OIDC jwt token for auth to external services (e.g: Vault, AWS) (ee only)
typescript-client/client.ts
+1 -1
View File
@@ -17,7 +17,7 @@ import {
type S3Object,
} from "./s3Types";
export { datatable } from "./sqlUtils";
export { datatable, ducklake } from "./sqlUtils";
export {
AdminService,
typescript-client/sqlUtils.d.ts
Vendored
+1 -2
View File
@@ -1,9 +1,8 @@
export type SqlStatement = {
query(): Promise<any>;
};
export interface SqlTemplateFunction {
(strings: TemplateStringsArray, ...values: any[]): SqlStatement;
}
export declare function datatable(name: string): SqlTemplateFunction;
export declare function ducklake(name: string): SqlTemplateFunction;
typescript-client/sqlUtils.ts
+39 -7
View File
@@ -17,8 +17,7 @@ export interface SqlTemplateFunction {
* let age = 21
* await sql`
* SELECT * FROM friends
* WHERE name = ${name}
* AND age = ${age}::int
* WHERE name = ${name} AND age = ${age}::int
* `.query()
*/
export function datatable(name: string = "main"): SqlTemplateFunction {
@@ -43,11 +42,44 @@ export function datatable(name: string = "main"): SqlTemplateFunction {
query: async () => {
let result = await JobService.runScriptPreviewInline({
workspace: getWorkspace(),
requestBody: {
args,
content: queryStr,
language: "postgresql",
},
requestBody: { args, content: queryStr, language: "postgresql" },
});
return result;
},
} satisfies SqlStatement;
};
return sql;
}
/**
* @example
* let sql = wmill.ducklake()
* let name = 'Robin'
* let age = 21
* await sql`
* SELECT * FROM friends
* WHERE name = ${name} AND age = ${age}
* `.query()
*/
export function ducklake(name: string = "main"): SqlTemplateFunction {
let sql: SqlTemplateFunction = (
strings: TemplateStringsArray,
...values: any[]
) => {
let queryStr = values.map((_, i) => `-- $arg${i + 1}`).join("\n") + "\n";
for (let i = 0; i < strings.length; i++) {
queryStr += strings[i];
if (i !== strings.length - 1) queryStr += `$${i + 1}`;
}
queryStr += `ATTACH 'ducklake://${name}' AS dl;USE dl;\n`;
const args = Object.fromEntries(values.map((v, i) => [`arg${i + 1}`, v]));
return {
queryStr,
args,
query: async () => {
let result = await JobService.runScriptPreviewInline({
workspace: getWorkspace(),
requestBody: { args, content: queryStr, language: "duckdb" },
});
return result;
},