feat: add pre run scripts

quarylabs · Jul 31, 2024 · bdc9d5c · bdc9d5c
1 parent 02926e0
commit bdc9d5c
Show file tree

Hide file tree

Showing 28 changed files with 4,378 additions and 4,009 deletions.
diff --git a/js/packages/proto/src/generated/quary/service/v1/connection_config.ts b/js/packages/proto/src/generated/quary/service/v1/connection_config.ts
@@ -28,6 +28,13 @@ export interface ConnectionConfig {
     | { $case: "clickhouse"; clickhouse: ConnectionConfig_ConnectionConfigClickHouse }
     | undefined;
   vars: Var[];
+  /**
+   * pre_run_scripts is a list of scripts that should be run before a run job against the database. This is useful for
+   * setting up the database for the run job. For example creating UDFs or installing plugins ...
+   * The scripts are run in order and should be idempotent.
+   * The list points to the location of the script in the project.
+   */
+  preRunScripts: string[];
 }
 
 export interface ConnectionConfig_ConnectionConfigSqLite {
@@ -149,7 +156,7 @@ export const Var = {
 };
 
 function createBaseConnectionConfig(): ConnectionConfig {
-  return { config: undefined, vars: [] };
+  return { config: undefined, vars: [], preRunScripts: [] };
 }
 
 export const ConnectionConfig = {
@@ -189,6 +196,9 @@ export const ConnectionConfig = {
     for (const v of message.vars) {
       Var.encode(v!, writer.uint32(66).fork()).ldelim();
     }
+    for (const v of message.preRunScripts) {
+      writer.uint32(90).string(v!);
+    }
     return writer;
   },
 
@@ -296,6 +306,13 @@ export const ConnectionConfig = {
 
           message.vars.push(Var.decode(reader, reader.uint32()));
           continue;
+        case 11:
+          if (tag !== 90) {
+            break;
+          }
+
+          message.preRunScripts.push(reader.string());
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -333,6 +350,7 @@ export const ConnectionConfig = {
         ? { $case: "clickhouse", clickhouse: ConnectionConfig_ConnectionConfigClickHouse.fromJSON(object.clickhouse) }
         : undefined,
       vars: gt.Array.isArray(object?.vars) ? object.vars.map((e: any) => Var.fromJSON(e)) : [],
+      preRunScripts: gt.Array.isArray(object?.preRunScripts) ? object.preRunScripts.map((e: any) => gt.String(e)) : [],
     };
   },
 
@@ -368,6 +386,9 @@ export const ConnectionConfig = {
     if (message.vars?.length) {
       obj.vars = message.vars.map((e) => Var.toJSON(e));
     }
+    if (message.preRunScripts?.length) {
+      obj.preRunScripts = message.preRunScripts;
+    }
     return obj;
   },
 
@@ -453,6 +474,7 @@ export const ConnectionConfig = {
       };
     }
     message.vars = object.vars?.map((e) => Var.fromPartial(e)) || [];
+    message.preRunScripts = object.preRunScripts?.map((e) => e) || [];
     return message;
   },
 };

diff --git a/js/packages/quary-extension-ui/src/views/OnboardingView.tsx b/js/packages/quary-extension-ui/src/views/OnboardingView.tsx
@@ -267,6 +267,7 @@ const DatabaseSelection: React.FC<{
                     sqliteInMemory: {},
                   },
                   vars: [],
+                  preRunScripts: [],
                 })
                 break
               }
@@ -329,6 +330,7 @@ const ConfigurationDetails: React.FC<ConfigurationDetailsProps> = ({
             },
           },
           vars: [],
+          preRunScripts: [],
         }
       case DatabaseOnboardingOptions.SQLite:
         return {
@@ -339,6 +341,7 @@ const ConfigurationDetails: React.FC<ConfigurationDetailsProps> = ({
             },
           },
           vars: [],
+          preRunScripts: [],
         }
       case DatabaseOnboardingOptions.Snowflake:
         return {
@@ -351,6 +354,7 @@ const ConfigurationDetails: React.FC<ConfigurationDetailsProps> = ({
             },
           },
           vars: [],
+          preRunScripts: [],
         }
       default: {
         throw new Error(`invalid database type ${states.sourceDetails.type}`)

diff --git a/proto/gen/es/quary/service/v1/connection_config_pb.ts b/proto/gen/es/quary/service/v1/connection_config_pb.ts
@@ -119,6 +119,16 @@ export class ConnectionConfig extends Message<ConnectionConfig> {
    */
   vars: Var[] = [];
 
+  /**
+   * pre_run_scripts is a list of scripts that should be run before a run job against the database. This is useful for
+   * setting up the database for the run job. For example creating UDFs or installing plugins ...
+   * The scripts are run in order and should be idempotent.
+   * The list points to the location of the script in the project.
+   *
+   * @generated from field: repeated string pre_run_scripts = 11;
+   */
+  preRunScripts: string[] = [];
+
   constructor(data?: PartialMessage<ConnectionConfig>) {
     super();
     proto3.util.initPartial(data, this);
@@ -137,6 +147,7 @@ export class ConnectionConfig extends Message<ConnectionConfig> {
     { no: 9, name: "redshift", kind: "message", T: ConnectionConfig_ConnectionConfigRedshift, oneof: "config" },
     { no: 10, name: "clickhouse", kind: "message", T: ConnectionConfig_ConnectionConfigClickHouse, oneof: "config" },
     { no: 8, name: "vars", kind: "message", T: Var, repeated: true },
+    { no: 11, name: "pre_run_scripts", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ConnectionConfig {

diff --git a/proto/gen/json_schema/ConnectionConfig.json b/proto/gen/json_schema/ConnectionConfig.json
@@ -46,6 +46,13 @@
                     },
                     "additionalProperties": false,
                     "type": "array"
+                },
+                "pre_run_scripts": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array",
+                    "description": "pre_run_scripts is a list of scripts that should be run before a run job against the database. This is useful for setting up the database for the run job. For example creating UDFs or installing plugins ... The scripts are run in order and should be idempotent. The list points to the location of the script in the project."
                 }
             },
             "additionalProperties": false,

diff --git a/proto/gen/json_schema/GenerateProjectFilesRequest.json b/proto/gen/json_schema/GenerateProjectFilesRequest.json
@@ -57,6 +57,13 @@
                     },
                     "additionalProperties": false,
                     "type": "array"
+                },
+                "pre_run_scripts": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array",
+                    "description": "pre_run_scripts is a list of scripts that should be run before a run job against the database. This is useful for setting up the database for the run job. For example creating UDFs or installing plugins ... The scripts are run in order and should be idempotent. The list points to the location of the script in the project."
                 }
             },
             "additionalProperties": false,

diff --git a/proto/gen/json_schema/GetProjectConfigResponse.json b/proto/gen/json_schema/GetProjectConfigResponse.json
@@ -57,6 +57,13 @@
                     },
                     "additionalProperties": false,
                     "type": "array"
+                },
+                "pre_run_scripts": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array",
+                    "description": "pre_run_scripts is a list of scripts that should be run before a run job against the database. This is useful for setting up the database for the run job. For example creating UDFs or installing plugins ... The scripts are run in order and should be idempotent. The list points to the location of the script in the project."
                 }
             },
             "additionalProperties": false,

diff --git a/proto/gen/json_schema/ParseProjectResponse.json b/proto/gen/json_schema/ParseProjectResponse.json
@@ -135,6 +135,13 @@
                     },
                     "additionalProperties": false,
                     "type": "array"
+                },
+                "pre_run_scripts": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array",
+                    "description": "pre_run_scripts is a list of scripts that should be run before a run job against the database. This is useful for setting up the database for the run job. For example creating UDFs or installing plugins ... The scripts are run in order and should be idempotent. The list points to the location of the script in the project."
                 }
             },
             "additionalProperties": false,

diff --git a/proto/gen/json_schema/Project.json b/proto/gen/json_schema/Project.json
@@ -191,6 +191,13 @@
                     },
                     "additionalProperties": false,
                     "type": "array"
+                },
+                "pre_run_scripts": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array",
+                    "description": "pre_run_scripts is a list of scripts that should be run before a run job against the database. This is useful for setting up the database for the run job. For example creating UDFs or installing plugins ... The scripts are run in order and should be idempotent. The list points to the location of the script in the project."
                 }
             },
             "additionalProperties": false,

diff --git a/proto/gen/json_schema/ReturnSQLForSeedsAndModelsResponse.json b/proto/gen/json_schema/ReturnSQLForSeedsAndModelsResponse.json
@@ -141,6 +141,13 @@
                     },
                     "additionalProperties": false,
                     "type": "array"
+                },
+                "pre_run_scripts": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array",
+                    "description": "pre_run_scripts is a list of scripts that should be run before a run job against the database. This is useful for setting up the database for the run job. For example creating UDFs or installing plugins ... The scripts are run in order and should be idempotent. The list points to the location of the script in the project."
                 }
             },
             "additionalProperties": false,