@ronin/compiler 0.10.1-leo-ron-1083-experimental-210 → 0.10.2-leo-ron-1083-experimental-211

package/README.md

@@ -103,7 +103,24 @@ new Transaction(queries, {
   // Instead of returning an array of parameters for every statement (which allows for
   // preventing SQL injections), all parameters are inlined directly into the SQL strings.
   // This option should only be used if the generated SQL will be manually verified.
-  inlineParams: true
+  inlineParams: true,
+
+  // By default, in the generated SQL statements, the compiler does not alias columns if
+  // multiple different tables with the same column names are being joined. Only the table
+  // names themselves are aliased.
+  //
+  // This ensures the cleanest possible SQL statements in conjunction with the default
+  // behavior of SQLite (and all other SQL databases), where the result of a statement is
+  // a list (array) of values, which are inherently not prone to conflicts.
+  //
+  // If the driver being used instead returns an object for every row, the driver must
+  // ensure the uniqueness of every key in that object, which means prefixing duplicated
+  // column names with the name of the respective table, if multiple tables are joined.
+  // Drivers that return objects for rows offer this behavior as an option that is
+  // usually called "expand columns". If the driver being used does not offer such an
+  // option, you can instead activate the option in the compiler, which results in longer
+  // SQL statements because any duplicated column name is aliased.
+  expandColumns: true
 });
 ```
 

package/dist/index.d.ts

@@ -6005,13 +6005,22 @@ type AmountResult = {
 };
 type Result = SingleRecordResult | MultipleRecordResult | AmountResult;
 
+interface TransactionOptions {
+    /** A list of models that already exist in the database. */
+    models?: Array<PublicModel>;
+    /**
+     * Place statement parameters directly inside the statement strings instead of
+     * separating them out into a dedicated `params` array.
+     */
+    inlineParams?: boolean;
+    /** Alias column names that are duplicated when joining multiple tables. */
+    expandColumns?: boolean;
+}
 declare class Transaction {
     statements: Array<Statement>;
     models: Array<Model>;
     private queries;
-    constructor(queries: Array<Query>, options?: Parameters<typeof this.compileQueries>[2] & {
-        models?: Array<PublicModel>;
-    });
+    constructor(queries: Array<Query>, options?: TransactionOptions);
     /**
      * Composes SQL statements for the provided RONIN queries.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronin/compiler",
-  "version": "0.10.1-leo-ron-1083-experimental-210",
+  "version": "0.10.2-leo-ron-1083-experimental-211",
   "type": "module",
   "description": "Compiles RONIN queries to SQL statements.",
   "publishConfig": {