@tinybirdco/sdk 0.0.6 → 0.0.8

package/src/codegen/index.test.ts

@@ -74,6 +74,18 @@ describe("generateDatasourceCode", () => {
     expect(code).toContain(" * Event tracking data");
     expect(code).toContain(" */");
   });
+
+  it("includes forward query when present", () => {
+    const ds: DatasourceInfo = {
+      name: "events",
+      columns: [{ name: "id", type: "String" }],
+      engine: { type: "MergeTree", sorting_key: "id" },
+      forward_query: "SELECT id",
+    };
+
+    const code = generateDatasourceCode(ds);
+    expect(code).toContain("forwardQuery: `SELECT id`");
+  });
 });
 
 describe("generatePipeCode", () => {

package/src/codegen/index.ts

@@ -45,6 +45,11 @@ export function generateDatasourceCode(ds: DatasourceInfo): string {
   const engineCode = generateEngineCode(ds.engine);
   lines.push(`  engine: ${engineCode},`);
 
+  if (ds.forward_query) {
+    const formattedQuery = formatSqlForTemplate(ds.forward_query);
+    lines.push(`  forwardQuery: \`${formattedQuery}\`,`);
+  }
+
   lines.push("});");
   lines.push("");
   lines.push(`export type ${typeName}Row = InferRow<typeof ${varName}>;`);

package/src/generator/datasource.test.ts

@@ -81,6 +81,19 @@ describe('Datasource Generator', () => {
       const result = generateDatasource(ds);
       expect(result.content).toContain('ENGINE_TTL "timestamp + INTERVAL 90 DAY"');
     });
+
+    it('includes forward query when provided', () => {
+      const ds = defineDatasource('test_ds', {
+        schema: {
+          id: t.string(),
+        },
+        forwardQuery: 'SELECT id',
+      });
+
+      const result = generateDatasource(ds);
+      expect(result.content).toContain('FORWARD_QUERY >');
+      expect(result.content).toContain('    SELECT id');
+    });
   });
 
   describe('Column formatting', () => {

package/src/generator/datasource.ts

@@ -163,6 +163,23 @@ function generateKafkaConfig(kafka: KafkaConfig): string {
   return parts.join("\n");
 }
 
+/**
+ * Generate forward query section
+ */
+function generateForwardQuery(forwardQuery?: string): string | null {
+  if (!forwardQuery) {
+    return null;
+  }
+
+  const trimmed = forwardQuery.trim();
+  if (!trimmed) {
+    return null;
+  }
+
+  const lines = trimmed.split(/\r?\n/);
+  return ["FORWARD_QUERY >", ...lines.map((line) => `    ${line}`)].join("\n");
+}
+
 /**
  * Generate a .datasource file content from a DatasourceDefinition
  *
@@ -224,6 +241,13 @@ export function generateDatasource(
     parts.push(generateKafkaConfig(datasource.options.kafka));
   }
 
+  // Add forward query if present
+  const forwardQuery = generateForwardQuery(datasource.options.forwardQuery);
+  if (forwardQuery) {
+    parts.push("");
+    parts.push(forwardQuery);
+  }
+
   return {
     name: datasource._name,
     content: parts.join("\n"),

package/src/schema/connection.ts

@@ -3,8 +3,9 @@
  * Define external connections (Kafka, etc.) as TypeScript with full type safety
  */
 
-// Symbol for brand typing
-const CONNECTION_BRAND = Symbol("tinybird.connection");
+// Symbol for brand typing - use Symbol.for() for global registry
+// This ensures the same symbol is used across module instances
+const CONNECTION_BRAND = Symbol.for("tinybird.connection");
 
 /**
  * Kafka security protocol options

package/src/schema/datasource.ts

@@ -7,8 +7,9 @@ import type { AnyTypeValidator } from "./types.js";
 import type { EngineConfig } from "./engines.js";
 import type { KafkaConnectionDefinition } from "./connection.js";
 
-// Symbol for brand typing
-const DATASOURCE_BRAND = Symbol("tinybird.datasource");
+// Symbol for brand typing - use Symbol.for() for global registry
+// This ensures the same symbol is used across module instances
+const DATASOURCE_BRAND = Symbol.for("tinybird.datasource");
 
 /**
  * A column can be defined as just a type validator,
@@ -70,6 +71,11 @@ export interface DatasourceOptions<TSchema extends SchemaDefinition> {
    * Defaults to true.
    */
   jsonPaths?: boolean;
+  /**
+   * Forward query used to evolve a datasource with incompatible schema changes.
+   * This should be the SELECT clause only (no FROM/WHERE).
+   */
+  forwardQuery?: string;
   /** Kafka ingestion configuration */
   kafka?: KafkaConfig;
 }

package/src/schema/params.ts

@@ -3,8 +3,9 @@
  * Similar to the column type validators but for query parameters
  */
 
-// Symbol for brand typing
-const PARAM_BRAND = Symbol("tinybird.param");
+// Symbol for brand typing - use Symbol.for() for global registry
+// This ensures the same symbol is used across module instances
+const PARAM_BRAND = Symbol.for("tinybird.param");
 
 /**
  * Base interface for parameter validators

package/src/schema/pipe.ts

@@ -9,10 +9,10 @@ import type { DatasourceDefinition, SchemaDefinition, ColumnDefinition } from ".
 import { getColumnType } from "./datasource.js";
 import { getTinybirdType } from "./types.js";
 
-/** Symbol for brand typing pipes */
-export const PIPE_BRAND: unique symbol = Symbol("tinybird.pipe");
-/** Symbol for brand typing nodes */
-export const NODE_BRAND: unique symbol = Symbol("tinybird.node");
+/** Symbol for brand typing pipes - use Symbol.for() for global registry */
+export const PIPE_BRAND = Symbol.for("tinybird.pipe");
+/** Symbol for brand typing nodes - use Symbol.for() for global registry */
+export const NODE_BRAND = Symbol.for("tinybird.node");
 
 /**
  * Parameter definition for a pipe

package/src/schema/project.ts

@@ -11,8 +11,9 @@ import type { TinybirdClient } from "../client/base.js";
 import type { QueryResult } from "../client/types.js";
 import type { InferRow, InferParams, InferOutputRow } from "../infer/index.js";
 
-// Symbol for brand typing
-const PROJECT_BRAND = Symbol("tinybird.project");
+// Symbol for brand typing - use Symbol.for() for global registry
+// This ensures the same symbol is used across module instances
+const PROJECT_BRAND = Symbol.for("tinybird.project");
 
 /**
  * Collection of datasource definitions

package/src/schema/types.ts

@@ -3,8 +3,9 @@
  * Similar to Convex's `v.*` pattern, but for ClickHouse types
  */
 
-// Symbol for brand typing
-const VALIDATOR_BRAND = Symbol("tinybird.validator");
+// Symbol for brand typing - use Symbol.for() for global registry
+// This ensures the same symbol is used across module instances
+const VALIDATOR_BRAND = Symbol.for("tinybird.validator");
 
 /**
  * Base interface for all type validators