feat: allow sql tokens as values of valueList, tuple and tupleList

gajus · Apr 12, 2019 · 405ac65 · 405ac65
1 parent cef16e1
commit 405ac65
Show file tree

Hide file tree

Showing 13 changed files with 336 additions and 65 deletions.
diff --git a/.README/QUERY_BUILDING.md b/.README/QUERY_BUILDING.md
@@ -32,6 +32,29 @@ Produces:
 
 ```
 
+Value list can describe other SQL tokens, e.g.
+
+```js
+await connection.query(sql`
+  SELECT (${sql.valueList([1, sql.raw('to_timestamp($1)', [2]), 3])})
+`);
+
+```
+
+Produces:
+
+```js
+{
+  sql: 'SELECT ($1, to_timestamp($2), $3)',
+  values: [
+    1,
+    2,
+    3
+  ]
+}
+
+```
+
 ### `sql.array`
 
 ```js
@@ -121,6 +144,30 @@ Produces:
 
 ```
 
+Tuple can describe other SQL tokens, e.g.
+
+```js
+await connection.query(sql`
+  INSERT INTO (foo, bar, baz)
+  VALUES ${sql.tuple([1, sql.raw('to_timestamp($1)', [2]), 3])}
+`);
+
+```
+
+Produces:
+
+```js
+{
+  sql: 'INSERT INTO (foo, bar, baz) VALUES ($1, to_timestamp($2), $3)',
+  values: [
+    1,
+    2,
+    3
+  ]
+}
+
+```
+
 ### `sql.tupleList`
 
 ```js
@@ -158,6 +205,36 @@ Produces:
 
 ```
 
+Tuple list can describe other SQL tokens, e.g.
+
+```js
+await connection.query(sql`
+  INSERT INTO (foo, bar, baz)
+  VALUES ${sql.tupleList([
+    [1, sql.raw('to_timestamp($1)', [2]), 3],
+    [4, sql.raw('to_timestamp($1)', [5]), 6]
+  ])}
+`);
+
+```
+
+Produces:
+
+```js
+{
+  sql: 'INSERT INTO (foo, bar, baz) VALUES ($1, to_timestamp($2), $3), ($4, to_timestamp($5), $6)',
+  values: [
+    1,
+    2,
+    3,
+    4,
+    5,
+    6
+  ]
+}
+
+```
+
 ### `sql.unnest`
 
 ```js

diff --git a/src/factories/createSqlTokenSqlFragment.js b/src/factories/createSqlTokenSqlFragment.js
@@ -0,0 +1,65 @@
+// @flow
+
+import {
+  ArrayTokenSymbol,
+  SqlTokenSymbol,
+  RawSqlTokenSymbol,
+  IdentifierTokenSymbol,
+  IdentifierListTokenSymbol,
+  ValueListTokenSymbol,
+  TupleTokenSymbol,
+  TupleListTokenSymbol,
+  UnnestTokenSymbol
+} from '../symbols';
+import {
+  createArraySqlFragment,
+  createIdentifierSqlFragment,
+  createIdentifierListSqlFragment,
+  createRawSqlSqlFragment,
+  createSqlSqlFragment,
+  createTupleListSqlFragment,
+  createTupleSqlFragment,
+  createUnnestSqlFragment,
+  createValueListSqlFragment
+} from '../sqlFragmentFactories';
+import {
+  UnexpectedStateError
+} from '../errors';
+import type {
+  SqlTokenType,
+  SqlFragmentType
+} from '../types';
+
+export default (token: SqlTokenType, greatestParameterPosition: number): SqlFragmentType => {
+  if (token.type === SqlTokenSymbol) {
+    // @see https://github.com/gajus/slonik/issues/36 regarding FlowFixMe use.
+    // $FlowFixMe
+    return createSqlSqlFragment(token, greatestParameterPosition);
+  } else if (token.type === RawSqlTokenSymbol) {
+    // $FlowFixMe
+    return createRawSqlSqlFragment(token, greatestParameterPosition);
+  } else if (token.type === IdentifierTokenSymbol) {
+    // $FlowFixMe
+    return createIdentifierSqlFragment(token);
+  } else if (token.type === IdentifierListTokenSymbol) {
+    // $FlowFixMe
+    return createIdentifierListSqlFragment(token);
+  } else if (token.type === ArrayTokenSymbol) {
+    // $FlowFixMe
+    return createArraySqlFragment(token, greatestParameterPosition);
+  } else if (token.type === ValueListTokenSymbol) {
+    // $FlowFixMe
+    return createValueListSqlFragment(token, greatestParameterPosition);
+  } else if (token.type === TupleTokenSymbol) {
+    // $FlowFixMe
+    return createTupleSqlFragment(token, greatestParameterPosition);
+  } else if (token.type === TupleListTokenSymbol) {
+    // $FlowFixMe
+    return createTupleListSqlFragment(token, greatestParameterPosition);
+  } else if (token.type === UnnestTokenSymbol) {
+    // $FlowFixMe
+    return createUnnestSqlFragment(token, greatestParameterPosition);
+  }
+
+  throw new UnexpectedStateError();
+};
diff --git a/src/factories/index.js b/src/factories/index.js
@@ -2,4 +2,5 @@
 
 export {default as createConnection} from './createConnection';
 export {default as createPool} from './createPool';
+export {default as createSqlTokenSqlFragment} from './createSqlTokenSqlFragment';
 export {default as createTypeParserPreset} from './createTypeParserPreset';
diff --git a/src/sqlFragmentFactories/createTupleListSqlFragment.js b/src/sqlFragmentFactories/createTupleListSqlFragment.js
@@ -7,6 +7,12 @@ import type {
 import {
   UnexpectedStateError
 } from '../errors';
+import {
+  isSqlToken
+} from '../utilities';
+import {
+  createSqlTokenSqlFragment
+} from '../factories';
 
 export default (token: TupleListSqlTokenType, greatestParameterPosition: number): SqlFragmentType => {
   const values = [];
@@ -31,9 +37,18 @@ export default (token: TupleListSqlTokenType, greatestParameterPosition: number)
     lastTupleSize = tuple.length;
 
     for (const member of tuple) {
-      placeholders.push('$' + ++placeholderIndex);
-
-      values.push(member);
+      if (isSqlToken(member)) {
+        // $FlowFixMe
+        const sqlFragment = createSqlTokenSqlFragment(member, placeholderIndex);
+
+        placeholders.push(sqlFragment.sql);
+        placeholderIndex += sqlFragment.values.length;
+        values.push(...sqlFragment.values);
+      } else {
+        placeholders.push('$' + ++placeholderIndex);
+
+        values.push(member);
+      }
     }
 
     tupleListMemberSql.push('(' + placeholders.join(', ') + ')');

diff --git a/src/sqlFragmentFactories/createTupleSqlFragment.js b/src/sqlFragmentFactories/createTupleSqlFragment.js
@@ -7,6 +7,12 @@ import type {
 import {
   UnexpectedStateError
 } from '../errors';
+import {
+  isSqlToken
+} from '../utilities';
+import {
+  createSqlTokenSqlFragment
+} from '../factories';
 
 export default (token: TupleSqlTokenType, greatestParameterPosition: number): SqlFragmentType => {
   const values = [];
@@ -19,9 +25,18 @@ export default (token: TupleSqlTokenType, greatestParameterPosition: number): Sq
   }
 
   for (const tupleValue of token.values) {
-    placeholders.push('$' + ++placeholderIndex);
-
-    values.push(tupleValue);
+    if (isSqlToken(tupleValue)) {
+      // $FlowFixMe
+      const sqlFragment = createSqlTokenSqlFragment(tupleValue, placeholderIndex);
+
+      placeholders.push(sqlFragment.sql);
+      placeholderIndex += sqlFragment.values.length;
+      values.push(...sqlFragment.values);
+    } else {
+      placeholders.push('$' + ++placeholderIndex);
+
+      values.push(tupleValue);
+    }
   }
 
   const sql = '(' + placeholders.join(', ') + ')';

diff --git a/src/sqlFragmentFactories/createValueListSqlFragment.js b/src/sqlFragmentFactories/createValueListSqlFragment.js
@@ -7,6 +7,12 @@ import type {
 import {
   UnexpectedStateError
 } from '../errors';
+import {
+  isSqlToken
+} from '../utilities';
+import {
+  createSqlTokenSqlFragment
+} from '../factories';
 
 export default (token: ValueListSqlTokenType, greatestParameterPosition: number): SqlFragmentType => {
   const values = [];
@@ -19,15 +25,22 @@ export default (token: ValueListSqlTokenType, greatestParameterPosition: number)
   }
 
   for (const listValue of token.values) {
-    placeholders.push('$' + ++placeholderIndex);
-
-    values.push(listValue);
+    if (isSqlToken(listValue)) {
+      // $FlowFixMe
+      const sqlFragment = createSqlTokenSqlFragment(listValue, placeholderIndex);
+
+      placeholders.push(sqlFragment.sql);
+      placeholderIndex += sqlFragment.values.length;
+      values.push(...sqlFragment.values);
+    } else {
+      placeholders.push('$' + ++placeholderIndex);
+
+      values.push(listValue);
+    }
   }
 
-  const sql = placeholders.join(', ');
-
   return {
-    sql,
+    sql: placeholders.join(', '),
     values
   };
 };
diff --git a/src/templateTags/sql.js b/src/templateTags/sql.js
@@ -7,7 +7,6 @@ import type {
   IdentifierTokenType,
   PrimitiveValueExpressionType,
   RawSqlTokenType,
-  SqlFragmentType,
   SqlSqlTokenType,
   SqlTaggedTemplateType,
   TupleListSqlTokenType,
@@ -18,20 +17,13 @@ import type {
 } from '../types';
 import {
   deepFreeze,
-  isPrimitiveValueExpression
+  isPrimitiveValueExpression,
+  isSqlToken
 } from '../utilities';
 import Logger from '../Logger';
 import {
-  createArraySqlFragment,
-  createIdentifierSqlFragment,
-  createIdentifierListSqlFragment,
-  createRawSqlSqlFragment,
-  createSqlSqlFragment,
-  createTupleListSqlFragment,
-  createTupleSqlFragment,
-  createUnnestSqlFragment,
-  createValueListSqlFragment
-} from '../sqlFragmentFactories';
+  createSqlTokenSqlFragment
+} from '../factories';
 import {
   ArrayTokenSymbol,
   SqlTokenSymbol,
@@ -60,11 +52,6 @@ const sql: SqlTaggedTemplateType = (
 
   let index = 0;
 
-  const appendSqlFragment = (sqlFragment: SqlFragmentType) => {
-    rawSql += sqlFragment.sql;
-    parameterValues.push(...sqlFragment.values);
-  };
-
   for (const part of parts) {
     const token = values[index++];
 
@@ -78,34 +65,11 @@ const sql: SqlTaggedTemplateType = (
       rawSql += '$' + (parameterValues.length + 1);
 
       parameterValues.push(token);
-    } else if (token && token.type === SqlTokenSymbol) {
-      // @see https://github.com/gajus/slonik/issues/36 regarding FlowFixMe use.
-      // $FlowFixMe
-      appendSqlFragment(createSqlSqlFragment(token, parameterValues.length));
-    } else if (token && token.type === RawSqlTokenSymbol) {
-      // $FlowFixMe
-      appendSqlFragment(createRawSqlSqlFragment(token, parameterValues.length));
-    } else if (token && token.type === IdentifierTokenSymbol) {
-      // $FlowFixMe
-      appendSqlFragment(createIdentifierSqlFragment(token));
-    } else if (token && token.type === IdentifierListTokenSymbol) {
-      // $FlowFixMe
-      appendSqlFragment(createIdentifierListSqlFragment(token));
-    } else if (token && token.type === ArrayTokenSymbol) {
-      // $FlowFixMe
-      appendSqlFragment(createArraySqlFragment(token, parameterValues.length));
-    } else if (token && token.type === ValueListTokenSymbol) {
-      // $FlowFixMe
-      appendSqlFragment(createValueListSqlFragment(token, parameterValues.length));
-    } else if (token && token.type === TupleTokenSymbol) {
-      // $FlowFixMe
-      appendSqlFragment(createTupleSqlFragment(token, parameterValues.length));
-    } else if (token && token.type === TupleListTokenSymbol) {
-      // $FlowFixMe
-      appendSqlFragment(createTupleListSqlFragment(token, parameterValues.length));
-    } else if (token && token.type === UnnestTokenSymbol) {
-      // $FlowFixMe
-      appendSqlFragment(createUnnestSqlFragment(token, parameterValues.length));
+    } else if (isSqlToken(token)) {
+      const sqlFragment = createSqlTokenSqlFragment(token, parameterValues.length);
+
+      rawSql += sqlFragment.sql;
+      parameterValues.push(...sqlFragment.values);
     } else {
       log.error({
         constructedSql: rawSql,
@@ -157,7 +121,7 @@ sql.raw = (
 };
 
 sql.valueList = (
-  values: $ReadOnlyArray<PrimitiveValueExpressionType>
+  values: $ReadOnlyArray<ValueExpressionType>
 ): ValueListSqlTokenType => {
   return deepFreeze({
     type: ValueListTokenSymbol,
@@ -177,7 +141,7 @@ sql.array = (
 };
 
 sql.tuple = (
-  values: $ReadOnlyArray<PrimitiveValueExpressionType>
+  values: $ReadOnlyArray<ValueExpressionType>
 ): TupleSqlTokenType => {
   return deepFreeze({
     type: TupleTokenSymbol,
@@ -186,7 +150,7 @@ sql.tuple = (
 };
 
 sql.tupleList = (
-  tuples: $ReadOnlyArray<$ReadOnlyArray<PrimitiveValueExpressionType>>
+  tuples: $ReadOnlyArray<$ReadOnlyArray<ValueExpressionType>>
 ): TupleListSqlTokenType => {
   return deepFreeze({
     tuples,