@sqlanvil/core 0.0.1 → 1.0.1

package/jit.proto

@@ -0,0 +1,186 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package sqlanvil;
+
+import "google/protobuf/empty.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
+import "core.proto";
+import "db_adapter.proto";
+
+// Database adapter, available in JiT compilation context.
+service DbAdapter {
+  // Executes a query.
+  rpc Execute(ExecuteRequest) returns (ExecuteResponse) {}
+
+  // Lists table in schema.
+  rpc ListTables(ListTablesRequest) returns (ListTablesResponse) {}
+
+  // Gets table for target.
+  rpc GetTable(GetTableRequest) returns (TableMetadata) {}
+
+  // Drops table of specified target.
+  rpc DeleteTable(DeleteTableRequest) returns (google.protobuf.Empty) {}
+}
+
+// Request to execute synchronous SQL query.
+message ExecuteRequest {
+  // SQL statement query.
+  string statement = 1;
+  // Max rows to return in the job.
+  int64 row_limit = 2;
+  // Max bytes to process.
+  int64 byte_limit = 3;
+  // Whether or not fetch result rows.
+  bool fetch_results = 4;
+
+  BigQueryExecuteOptions big_query_options = 5;
+  // Query parameters for parameterized queries.
+  google.protobuf.Struct params = 6;
+}
+
+message BigQueryExecuteOptions {
+  // Priority - interactive if true or batch if false (default).
+  bool interactive = 1;
+  // See https://docs.cloud.google.com/bigquery/docs/reference/legacy-sql.
+  bool use_legacy_sql = 2;
+  // Labels to add to the job.
+  map<string, string> labels = 3;
+  // Location to execute the job at.
+  string location = 4;
+  // Job prefix to add.
+  string job_prefix = 5;
+  // Is dry run job.
+  bool dry_run = 6;
+  // BigQuery reservation to use for the job.
+  string reservation = 7;
+}
+
+// Synchronous execution response result.
+message ExecuteResponse {
+  // Job metadata.
+  ExecutionMetadata execution_metadata = 1;
+  // Rows. For BigQuery, see
+  // https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults.
+  repeated google.protobuf.Struct rows = 2;
+  repeated string errors = 3;
+  repeated Field schema_fields = 4;
+}
+
+// Request to list tables in schema.
+message ListTablesRequest {
+  string database = 1;
+  string schema = 2;
+}
+
+// Tables metadata in schema.
+message ListTablesResponse {
+  repeated TableMetadata tables = 1;
+}
+
+// Request to get table metadata for target.
+message GetTableRequest {
+  Target target = 1;
+}
+
+// Request to drop the table for target.
+message DeleteTableRequest {
+  Target target = 1;
+}
+
+// Execution information for introspection.
+message RunningExecutionData {
+  // Targets that are being run in the current execution.
+  repeated Target run_targets = 1;
+  // ID of the current execution.
+  string execution_id = 2;
+  // Start time of the current execution.
+  google.protobuf.Timestamp execution_start_time = 3;
+}
+
+// JiT compilation target type.
+enum JitCompilationTargetType {
+  // Unspecified - will result in error.
+  JIT_COMPILATION_TARGET_TYPE_UNSPECIFIED = 0;
+  // Table/view target.
+  JIT_COMPILATION_TARGET_TYPE_TABLE = 1;
+  // Operation target.
+  JIT_COMPILATION_TARGET_TYPE_OPERATION = 2;
+  // Incremental table target.
+  JIT_COMPILATION_TARGET_TYPE_INCREMENTAL_TABLE = 3;
+  // Assertion target.
+  JIT_COMPILATION_TARGET_TYPE_ASSERTION = 4;
+}
+
+// JiT compilation request.
+message JitCompilationRequest {
+  // Canonical target being compiled.
+  Target target = 1;
+  // Canonical target dependencies.
+  repeated Target dependencies = 2;
+  // JiT code to compile.
+  string jit_code = 3;
+  // JiT data, exposed to code in context.
+  google.protobuf.Struct jit_data = 4;
+  // JiT compilation target type.
+  JitCompilationTargetType compilation_target_type = 5;
+  // List of additional file paths accessible at compilation.
+  repeated string file_paths = 6;
+  // Current execution information for introspection.
+  RunningExecutionData execution_data = 7;
+}
+
+// JiT compilation response.
+message JitCompilationResponse {
+  oneof response {
+    JitTableResult table = 1;
+    JitOperationResult operation = 2;
+    JitIncrementalTableResult incremental_table = 3;
+    JitAssertionResult assertion = 4;
+  }
+}
+
+// JiT compilation result for table actions (including views).
+// Fields match the Table message.
+message JitTableResult {
+  // SQL Select query of the table.
+  string query = 1;
+  // Optional pre-operation statements.
+  repeated string pre_ops = 3;
+  // Optional post-operation statements.
+  repeated string post_ops = 4;
+}
+
+// JiT compilation result for incremental table actions.
+message JitIncrementalTableResult {
+  // Fields match the Table message.
+  JitTableResult regular = 1;
+  // Fields match incremental_ fields in the Table message.
+  JitTableResult incremental = 2;
+}
+
+// JiT compilation result for operation actions.
+message JitOperationResult {
+  // Sequence of SQL operations.
+  repeated string queries = 1;
+}
+
+// JiT compilation result for assertion actions.
+message JitAssertionResult {
+  // SQL Select query that returns rows iff the assertion fails.
+  string query = 1;
+}

package/package.json

@@ -1,16 +1,41 @@
 {
-  "name": "@sqlanvil/core",
-  "version": "0.0.1",
-  "description": "Placeholder for sqlanvil core — active development at https://github.com/ihistand/sqlanvil",
-  "main": "index.js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ihistand/sqlanvil.git"
-  },
-  "homepage": "https://github.com/ihistand/sqlanvil",
-  "author": "Ivan Histand",
-  "license": "Apache-2.0",
-  "publishConfig": {
-    "access": "public"
-  }
-}
+    "dependencies": {},
+    "resolutions": {
+        "**/object-path": "^0.11.5",
+        "**/http-proxy": "^1.18.1",
+        "**/serialize-javascript": "^3.1.0",
+        "**/ssri": "^7.1.1",
+        "**/glob-parent": "^5.1.2",
+        "**/node-forge": "^1.0.0",
+        "**/json-bigint": "^1.0.0",
+        "**/y18n": "^5.0.5",
+        "**/underscore": "^1.12.1",
+        "**/protobufjs": "^7.0.0",
+        "**/ansi-regex": "^3.0.1",
+        "**/json-schema": "^0.4.0",
+        "**/nth-check": "^2.0.1",
+        "**/node-fetch": "^2.6.7",
+        "**/markdown-it": "^12.3.2",
+        "**/wrap-ansi": "7.0.0",
+        "**/string-width": "4.1.0"
+    },
+    "homepage": "https://github.com/sqlanvil/sqlanvil",
+    "license": "Apache-2.0",
+    "keywords": [
+        "sqlanvil",
+        "etl",
+        "data-pipeline",
+        "big-data",
+        "data-modelling",
+        "sql",
+        "bigquery",
+        "dataops"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "version": "1.0.1",
+    "name": "@sqlanvil/core",
+    "description": "sqlanvil core API.",
+    "main": "bundle.js"
+}

package/README.md

@@ -1,12 +0,0 @@
-# @sqlanvil/core
-
-**Status: placeholder. Not usable yet.**
-
-Core compiler library for [sqlanvil](https://github.com/ihistand/sqlanvil)
-— an open-source SQL workflow tool for BigQuery + PostgreSQL + Supabase,
-forked from Dataform's OSS core.
-
-This npm package name is reserved while the implementation matures.
-Watch the GitHub repo for the first usable release.
-
-License: Apache-2.0

package/index.js

@@ -1,4 +0,0 @@
-console.error(
-  "@sqlanvil/core is a placeholder. The library is not yet published.\n" +
-  "Follow progress at https://github.com/ihistand/sqlanvil"
-);