ReferenceBuilder.js 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. const jsonFieldExpressionParser = require('./parsers/jsonFieldExpressionParser');
  2. const { isObject } = require('../utils/objectUtils');
  3. class ReferenceBuilder {
  4. constructor(expr) {
  5. this._expr = expr;
  6. this._reference = null;
  7. this._column = null;
  8. this._table = null;
  9. this._cast = null;
  10. this._toJson = false;
  11. this._table = null;
  12. this._as = null;
  13. if (expr !== null) {
  14. const reference = jsonFieldExpressionParser.parse(expr);
  15. const colParts = reference.columnName.split('.');
  16. this._reference = reference;
  17. this._column = colParts[colParts.length - 1];
  18. if (colParts.length >= 2) {
  19. this._table = colParts.slice(0, colParts.length - 1).join('.');
  20. }
  21. }
  22. }
  23. get reference() {
  24. return this._reference;
  25. }
  26. get column() {
  27. return this._column;
  28. }
  29. get tableName() {
  30. return this._table;
  31. }
  32. get isPlainColumnRef() {
  33. return this._reference.access.length === 0 && !this._cast && !this._toJson && !this._as;
  34. }
  35. get fullColumn() {
  36. if (this.tableName) {
  37. return `${this.tableName}.${this.column}`;
  38. } else {
  39. return this.column;
  40. }
  41. }
  42. get expression() {
  43. return this._expr;
  44. }
  45. get cast() {
  46. return this._cast;
  47. }
  48. castText() {
  49. return this.castTo('text');
  50. }
  51. castInt() {
  52. return this.castTo('integer');
  53. }
  54. castBigInt() {
  55. return this.castTo('bigint');
  56. }
  57. castFloat() {
  58. return this.castTo('float');
  59. }
  60. castDecimal() {
  61. return this.castTo('decimal');
  62. }
  63. castReal() {
  64. return this.castTo('real');
  65. }
  66. castBool() {
  67. return this.castTo('boolean');
  68. }
  69. castJson() {
  70. this._toJson = true;
  71. return this;
  72. }
  73. castType(sqlType) {
  74. console.log(
  75. 'castType(type) is deprecated. Use castTo(type) instead. castType(type) will be removed in 2.0'
  76. );
  77. return this.castTo(sqlType);
  78. }
  79. castTo(sqlType) {
  80. this._cast = sqlType;
  81. return this;
  82. }
  83. from(table) {
  84. this._table = table;
  85. return this;
  86. }
  87. table(table) {
  88. this._table = table;
  89. return this;
  90. }
  91. as(as) {
  92. this._as = as;
  93. return this;
  94. }
  95. clone() {
  96. const clone = new this.constructor(null);
  97. clone._expr = this._expr;
  98. clone._reference = this._reference;
  99. clone._column = this._column;
  100. clone._table = this._table;
  101. clone._cast = this._cast;
  102. clone._toJson = this._toJson;
  103. clone._table = this._table;
  104. clone._as = this._as;
  105. return clone;
  106. }
  107. toRawArgs() {
  108. let referenceSql = `??`;
  109. if (this._reference.access.length > 0) {
  110. let extractor = this._cast ? '#>>' : '#>';
  111. let jsonFieldRef = this._reference.access.map(field => field.ref).join(',');
  112. referenceSql = `??${extractor}'{${jsonFieldRef}}'`;
  113. }
  114. let castedRefQuery = this._cast ? `CAST(${referenceSql} AS ${this._cast})` : referenceSql;
  115. let toJsonQuery = this._toJson ? `to_jsonb(${castedRefQuery})` : castedRefQuery;
  116. if (this._as) {
  117. return [`${toJsonQuery} as ??`, [this.fullColumn, this._as]];
  118. } else {
  119. return [toJsonQuery, [this.fullColumn]];
  120. }
  121. }
  122. toKnexRaw(knex) {
  123. if (this.isPlainColumnRef) {
  124. // Fast path for the most common case.
  125. return knex.raw('??', this.fullColumn);
  126. } else {
  127. return knex.raw.apply(knex, this.toRawArgs());
  128. }
  129. }
  130. }
  131. Object.defineProperties(ReferenceBuilder.prototype, {
  132. isObjectionReferenceBuilder: {
  133. enumerable: false,
  134. writable: false,
  135. value: true
  136. }
  137. });
  138. const ref = reference => {
  139. if (isObject(reference) && reference.isObjectionReferenceBuilder) {
  140. return reference;
  141. } else {
  142. return new ReferenceBuilder(reference);
  143. }
  144. };
  145. module.exports = {
  146. ReferenceBuilder,
  147. ref
  148. };