@sqlanvil/core 1.7.0 → 1.8.0

package/configs.proto

@@ -657,6 +657,54 @@ message ActionConfig {
     string reservation = 13;
   }
 
+  // The user-facing `export: {}` block on a `type: "export"` action.
+  message ExportOptions {
+    // Destination folder/prefix URI: gs:// | s3:// | local:// | relative/absolute path.
+    string location = 1;
+    // "parquet" | "csv" | "json" (json = JSONL).
+    string format = 2;
+    // Overwrite an existing object/file. Defaults to true (defaulted in core when absent).
+    bool overwrite = 3;
+    // Output base filename; defaults to the action name.
+    string filename = 4;
+    // Format-specific passthrough options (e.g. compression, csv header/delimiter).
+    map<string, string> options = 5;
+  }
+
+  // Configuration for a `type: "export"` action: writes a SELECT result to a
+  // Parquet/CSV/JSON file at a cloud or local location.
+  message ExportConfig {
+    // The name of the export.
+    string name = 1;
+
+    // The dataset (schema) used to qualify the export's target name.
+    string dataset = 2;
+
+    // The Google Cloud project (database) of the export.
+    string project = 3;
+
+    // Targets of actions that this action is dependent on.
+    repeated Target dependency_targets = 4;
+
+    // Path to the source file that the contents of the action is loaded from.
+    string filename = 5;
+
+    // A list of user-defined tags with which the action should be labeled.
+    repeated string tags = 6;
+
+    // If set to true, this action will not be executed.
+    bool disabled = 7;
+
+    // Description of the export.
+    string description = 8;
+
+    // If true, this action only depends on data from explicitly-declared dependencies.
+    bool hermetic = 9;
+
+    // The export destination + format options (the `export: {}` block).
+    ExportOptions export = 10;
+  }
+
   message DeclarationConfig {
     // The name of the declaration.
     string name = 1;
@@ -781,6 +829,7 @@ message ActionConfig {
     RealtimePublicationConfig realtime_publication = 10;
     ForeignWrapperConfig foreign_wrapper = 11;
     VectorIndexConfig vector_index = 12;
+    ExportConfig export = 13;
   }
 
   message RlsPolicyConfig {

package/core.proto

@@ -263,6 +263,30 @@ message Operation {
   reserved 1, 2, 4, 5;
 }
 
+// A compiled file export: writes `query` to a Parquet/CSV/JSON file at `location`.
+message Export {
+  Target target = 1;
+  Target canonical_target = 2;
+  repeated Target dependency_targets = 3;
+  ActionHermeticity hermeticity = 4;
+  bool disabled = 5;
+  repeated string tags = 6;
+  ActionDescriptor action_descriptor = 7;
+  // The SELECT to export (refs already resolved to warehouse identifiers).
+  string query = 8;
+  // Destination folder/prefix URI.
+  string location = 9;
+  // "parquet" | "csv" | "json".
+  string format = 10;
+  bool overwrite = 11;
+  // Output base filename; defaults to the action name.
+  string filename = 12;
+  map<string, string> options = 13;
+  // Source file path (generated).
+  string file_name = 14;
+  string jit_code = 15;
+}
+
 message Assertion {
   Target target = 8;
   Target canonical_target = 13;
@@ -431,6 +455,7 @@ message CompiledGraph {
   repeated Test tests = 8;
   repeated Notebook notebooks = 12;
   repeated DataPreparation data_preparations = 13;
+  repeated Export exports = 14;
 
   GraphErrors graph_errors = 7;
 

package/package.json

@@ -34,7 +34,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "1.7.0",
+    "version": "1.8.0",
     "name": "@sqlanvil/core",
     "description": "sqlanvil core API.",
     "main": "bundle.js"