@rvoh/dream 1.13.0-beta.5 → 1.13.0-beta.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/dist/types/src/Dream.d.ts +2 -2
  2. package/dist/types/src/dream/Query.d.ts +2 -2
  3. package/dist/types/src/types/query.d.ts +2 -2
  4. package/dist/types/src/types/query.ts +2 -2
  5. package/docs/classes/Benchmark.html +2 -2
  6. package/docs/classes/CalendarDate.html +2 -2
  7. package/docs/classes/CheckConstraintViolation.html +3 -3
  8. package/docs/classes/CliFileWriter.html +2 -2
  9. package/docs/classes/ColumnOverflow.html +3 -3
  10. package/docs/classes/CreateOrFindByFailedToCreateAndFind.html +3 -3
  11. package/docs/classes/DataIncompatibleWithDatabaseField.html +3 -3
  12. package/docs/classes/DataTypeColumnTypeMismatch.html +3 -3
  13. package/docs/classes/Decorators.html +19 -19
  14. package/docs/classes/Dream.html +117 -117
  15. package/docs/classes/DreamApp.html +4 -4
  16. package/docs/classes/DreamBin.html +2 -2
  17. package/docs/classes/DreamCLI.html +4 -4
  18. package/docs/classes/DreamImporter.html +2 -2
  19. package/docs/classes/DreamLogos.html +2 -2
  20. package/docs/classes/DreamMigrationHelpers.html +9 -9
  21. package/docs/classes/DreamSerializerBuilder.html +8 -8
  22. package/docs/classes/DreamTransaction.html +2 -2
  23. package/docs/classes/Encrypt.html +2 -2
  24. package/docs/classes/Env.html +2 -2
  25. package/docs/classes/GlobalNameNotSet.html +3 -3
  26. package/docs/classes/InvalidCalendarDate.html +2 -2
  27. package/docs/classes/KyselyQueryDriver.html +30 -30
  28. package/docs/classes/MissingSerializersDefinition.html +3 -3
  29. package/docs/classes/NonLoadedAssociation.html +3 -3
  30. package/docs/classes/NotNullViolation.html +3 -3
  31. package/docs/classes/ObjectSerializerBuilder.html +8 -8
  32. package/docs/classes/PostgresQueryDriver.html +31 -31
  33. package/docs/classes/Query.html +56 -56
  34. package/docs/classes/QueryDriverBase.html +29 -29
  35. package/docs/classes/Range.html +2 -2
  36. package/docs/classes/RecordNotFound.html +3 -3
  37. package/docs/classes/ValidationError.html +3 -3
  38. package/docs/functions/DreamSerializer.html +1 -1
  39. package/docs/functions/ObjectSerializer.html +1 -1
  40. package/docs/functions/ReplicaSafe.html +1 -1
  41. package/docs/functions/STI.html +1 -1
  42. package/docs/functions/SoftDelete.html +1 -1
  43. package/docs/functions/absoluteDreamPath.html +1 -1
  44. package/docs/functions/camelize.html +1 -1
  45. package/docs/functions/capitalize.html +1 -1
  46. package/docs/functions/cloneDeepSafe.html +1 -1
  47. package/docs/functions/closeAllDbConnections.html +1 -1
  48. package/docs/functions/compact.html +1 -1
  49. package/docs/functions/dreamDbConnections.html +1 -1
  50. package/docs/functions/dreamPath.html +1 -1
  51. package/docs/functions/expandStiClasses.html +1 -1
  52. package/docs/functions/generateDream.html +1 -1
  53. package/docs/functions/globalClassNameFromFullyQualifiedModelName.html +1 -1
  54. package/docs/functions/groupBy.html +1 -1
  55. package/docs/functions/hyphenize.html +1 -1
  56. package/docs/functions/inferSerializerFromDreamOrViewModel.html +1 -1
  57. package/docs/functions/inferSerializersFromDreamClassOrViewModelClass.html +1 -1
  58. package/docs/functions/intersection.html +1 -1
  59. package/docs/functions/isDreamSerializer.html +1 -1
  60. package/docs/functions/isEmpty.html +1 -1
  61. package/docs/functions/loadRepl.html +1 -1
  62. package/docs/functions/lookupClassByGlobalName.html +1 -1
  63. package/docs/functions/normalizeUnicode.html +1 -1
  64. package/docs/functions/pascalize.html +1 -1
  65. package/docs/functions/percent.html +1 -1
  66. package/docs/functions/pgErrorType.html +1 -1
  67. package/docs/functions/range-1.html +1 -1
  68. package/docs/functions/round.html +1 -1
  69. package/docs/functions/serializerNameFromFullyQualifiedModelName.html +1 -1
  70. package/docs/functions/sharedPathPrefix.html +1 -1
  71. package/docs/functions/snakeify.html +1 -1
  72. package/docs/functions/sort.html +1 -1
  73. package/docs/functions/sortBy.html +1 -1
  74. package/docs/functions/sortObjectByKey.html +1 -1
  75. package/docs/functions/sortObjectByValue.html +1 -1
  76. package/docs/functions/standardizeFullyQualifiedModelName.html +1 -1
  77. package/docs/functions/uncapitalize.html +1 -1
  78. package/docs/functions/uniq.html +1 -1
  79. package/docs/functions/untypedDb.html +1 -1
  80. package/docs/functions/validateColumn.html +1 -1
  81. package/docs/functions/validateTable.html +1 -1
  82. package/docs/interfaces/BelongsToStatement.html +2 -2
  83. package/docs/interfaces/DecoratorContext.html +2 -2
  84. package/docs/interfaces/DreamAppInitOptions.html +2 -2
  85. package/docs/interfaces/DreamAppOpts.html +2 -2
  86. package/docs/interfaces/EncryptOptions.html +2 -2
  87. package/docs/interfaces/InternalAnyTypedSerializerRendersMany.html +2 -2
  88. package/docs/interfaces/InternalAnyTypedSerializerRendersOne.html +2 -2
  89. package/docs/interfaces/OpenapiDescription.html +2 -2
  90. package/docs/interfaces/OpenapiSchemaProperties.html +1 -1
  91. package/docs/interfaces/OpenapiSchemaPropertiesShorthand.html +1 -1
  92. package/docs/interfaces/OpenapiTypeFieldObject.html +1 -1
  93. package/docs/interfaces/SerializerRendererOpts.html +2 -2
  94. package/docs/types/Camelized.html +1 -1
  95. package/docs/types/CommonOpenapiSchemaObjectFields.html +1 -1
  96. package/docs/types/DateTime.html +1 -1
  97. package/docs/types/DbConnectionType.html +1 -1
  98. package/docs/types/DbTypes.html +1 -1
  99. package/docs/types/DreamAppAllowedPackageManagersEnum.html +1 -1
  100. package/docs/types/DreamAssociationMetadata.html +1 -1
  101. package/docs/types/DreamAttributes.html +1 -1
  102. package/docs/types/DreamClassAssociationAndStatement.html +1 -1
  103. package/docs/types/DreamClassColumn.html +1 -1
  104. package/docs/types/DreamColumn.html +1 -1
  105. package/docs/types/DreamColumnNames.html +1 -1
  106. package/docs/types/DreamLogLevel.html +1 -1
  107. package/docs/types/DreamLogger.html +1 -1
  108. package/docs/types/DreamModelSerializerType.html +1 -1
  109. package/docs/types/DreamOrViewModelClassSerializerKey.html +1 -1
  110. package/docs/types/DreamOrViewModelSerializerKey.html +1 -1
  111. package/docs/types/DreamParamSafeAttributes.html +1 -1
  112. package/docs/types/DreamParamSafeColumnNames.html +1 -1
  113. package/docs/types/DreamSerializable.html +1 -1
  114. package/docs/types/DreamSerializableArray.html +1 -1
  115. package/docs/types/DreamSerializerKey.html +1 -1
  116. package/docs/types/DreamSerializers.html +1 -1
  117. package/docs/types/DreamVirtualColumns.html +1 -1
  118. package/docs/types/EncryptAlgorithm.html +1 -1
  119. package/docs/types/HasManyStatement.html +1 -1
  120. package/docs/types/HasOneStatement.html +1 -1
  121. package/docs/types/Hyphenized.html +1 -1
  122. package/docs/types/OpenapiAllTypes.html +1 -1
  123. package/docs/types/OpenapiFormats.html +1 -1
  124. package/docs/types/OpenapiNumberFormats.html +1 -1
  125. package/docs/types/OpenapiPrimitiveBaseTypes.html +1 -1
  126. package/docs/types/OpenapiPrimitiveTypes.html +1 -1
  127. package/docs/types/OpenapiSchemaArray.html +1 -1
  128. package/docs/types/OpenapiSchemaArrayShorthand.html +1 -1
  129. package/docs/types/OpenapiSchemaBase.html +1 -1
  130. package/docs/types/OpenapiSchemaBody.html +1 -1
  131. package/docs/types/OpenapiSchemaBodyShorthand.html +1 -1
  132. package/docs/types/OpenapiSchemaCommonFields.html +1 -1
  133. package/docs/types/OpenapiSchemaExpressionAllOf.html +1 -1
  134. package/docs/types/OpenapiSchemaExpressionAnyOf.html +1 -1
  135. package/docs/types/OpenapiSchemaExpressionOneOf.html +1 -1
  136. package/docs/types/OpenapiSchemaExpressionRef.html +1 -1
  137. package/docs/types/OpenapiSchemaExpressionRefSchemaShorthand.html +1 -1
  138. package/docs/types/OpenapiSchemaInteger.html +1 -1
  139. package/docs/types/OpenapiSchemaNull.html +1 -1
  140. package/docs/types/OpenapiSchemaNumber.html +1 -1
  141. package/docs/types/OpenapiSchemaObject.html +1 -1
  142. package/docs/types/OpenapiSchemaObjectAllOf.html +1 -1
  143. package/docs/types/OpenapiSchemaObjectAllOfShorthand.html +1 -1
  144. package/docs/types/OpenapiSchemaObjectAnyOf.html +1 -1
  145. package/docs/types/OpenapiSchemaObjectAnyOfShorthand.html +1 -1
  146. package/docs/types/OpenapiSchemaObjectBase.html +1 -1
  147. package/docs/types/OpenapiSchemaObjectBaseShorthand.html +1 -1
  148. package/docs/types/OpenapiSchemaObjectOneOf.html +1 -1
  149. package/docs/types/OpenapiSchemaObjectOneOfShorthand.html +1 -1
  150. package/docs/types/OpenapiSchemaObjectShorthand.html +1 -1
  151. package/docs/types/OpenapiSchemaPrimitiveGeneric.html +1 -1
  152. package/docs/types/OpenapiSchemaShorthandExpressionAllOf.html +1 -1
  153. package/docs/types/OpenapiSchemaShorthandExpressionAnyOf.html +1 -1
  154. package/docs/types/OpenapiSchemaShorthandExpressionOneOf.html +1 -1
  155. package/docs/types/OpenapiSchemaShorthandExpressionSerializableRef.html +1 -1
  156. package/docs/types/OpenapiSchemaShorthandExpressionSerializerRef.html +1 -1
  157. package/docs/types/OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
  158. package/docs/types/OpenapiSchemaString.html +1 -1
  159. package/docs/types/OpenapiShorthandAllTypes.html +1 -1
  160. package/docs/types/OpenapiShorthandPrimitiveBaseTypes.html +1 -1
  161. package/docs/types/OpenapiShorthandPrimitiveTypes.html +1 -1
  162. package/docs/types/OpenapiTypeField.html +1 -1
  163. package/docs/types/Pascalized.html +1 -1
  164. package/docs/types/RoundingPrecision.html +1 -1
  165. package/docs/types/SerializerCasing.html +1 -1
  166. package/docs/types/SimpleObjectSerializerType.html +1 -1
  167. package/docs/types/Snakeified.html +1 -1
  168. package/docs/types/UpdateableAssociationProperties.html +1 -1
  169. package/docs/types/UpdateableProperties.html +1 -1
  170. package/docs/types/ValidationType.html +1 -1
  171. package/docs/types/ViewModel.html +1 -1
  172. package/docs/types/ViewModelClass.html +1 -1
  173. package/docs/types/WhereStatementForDream.html +1 -1
  174. package/docs/types/WhereStatementForDreamClass.html +1 -1
  175. package/docs/variables/DateTime-1.html +1 -1
  176. package/docs/variables/DreamAppAllowedPackageManagersEnumValues.html +1 -1
  177. package/docs/variables/DreamConst.html +1 -1
  178. package/docs/variables/TRIGRAM_OPERATORS.html +1 -1
  179. package/docs/variables/openapiPrimitiveTypes-1.html +1 -1
  180. package/docs/variables/openapiShorthandPrimitiveTypes-1.html +1 -1
  181. package/docs/variables/ops.html +1 -1
  182. package/docs/variables/primaryKeyTypes.html +1 -1
  183. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Query | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="Query.html">Query</a></li></ul><h1>Class Query&lt;DreamInstance, QueryTypeOpts&gt;</h1></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="DreamInstance" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamInstance</span><span class="tsd-signature-keyword"> extends </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="QueryTypeOpts" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">QueryTypeOpts</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">QueryTypeOptions</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">DefaultQueryTypeOptions</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L79">src/dream/Query.ts:79</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Query.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Query | @rvoh/dream</title><meta name="description" content="Documentation for @rvoh/dream"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@rvoh/dream</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@rvoh/dream</a></li><li><a href="Query.html">Query</a></li></ul><h1>Class Query&lt;DreamInstance, QueryTypeOpts&gt;</h1></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="DreamInstance" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamInstance</span><span class="tsd-signature-keyword"> extends </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="QueryTypeOpts" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">QueryTypeOpts</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">QueryTypeOptions</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">DefaultQueryTypeOptions</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L79">src/dream/Query.ts:79</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Query.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
2
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Query.html#connectionOverride" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Override</span></a>
3
3
  <a href="Query.html#dreamClass" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dream<wbr/>Class</span></a>
4
4
  <a href="Query.html#dreamInstance-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dream<wbr/>Instance</span></a>
@@ -57,16 +57,16 @@
57
57
  <a href="Query.html#whereAny" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>where<wbr/>Any</span></a>
58
58
  <a href="Query.html#whereNot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>where<wbr/>Not</span></a>
59
59
  <a href="Query.html#dbDriverClass" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Driver<wbr/>Class</span></a>
60
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Query" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Query</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dreamInstance</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_Query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructor.new_Query.DreamInstance-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamInstance</span><span class="tsd-signature-keyword"> extends </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="constructor.new_Query.QueryTypeOpts-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">QueryTypeOpts</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">QueryTypeOptions</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-keyword"> extends </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><br/><span>        </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dreamInstance</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a></span></li><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">QueryOpts</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;schema&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;connectionTypeConfig&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;passthroughColumns&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;connectionTypeConfig&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L328">src/dream/Query.ts:328</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><a id="connectionOverride" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>connection<wbr/>Override</span><a href="#connectionOverride" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">connection<wbr/>Override</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L319">src/dream/Query.ts:319</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="dreamClass" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>dream<wbr/>Class</span><a href="#dreamClass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dream<wbr/>Class</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DreamConstructorType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L317">src/dream/Query.ts:317</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dreamInstance-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>dream<wbr/>Instance</span><a href="#dreamInstance-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dream<wbr/>Instance</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L318">src/dream/Query.ts:318</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dreamTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Internal</code><span>dream<wbr/>Transaction</span><a href="#dreamTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dream<wbr/>Transaction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = null</span></div><div class="tsd-comment tsd-typography"><p>stores the dream transaction applied to the
60
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Query" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Query</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dreamInstance</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_Query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructor.new_Query.DreamInstance-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamInstance</span><span class="tsd-signature-keyword"> extends </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="constructor.new_Query.QueryTypeOpts-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">QueryTypeOpts</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">QueryTypeOptions</span><span class="tsd-signature-symbol">&gt;</span> = <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-keyword"> extends </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><br/><span>        </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dreamInstance</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a></span></li><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">QueryOpts</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;schema&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;connectionTypeConfig&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;passthroughColumns&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;connectionTypeConfig&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L328">src/dream/Query.ts:328</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><a id="connectionOverride" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>connection<wbr/>Override</span><a href="#connectionOverride" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">connection<wbr/>Override</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L319">src/dream/Query.ts:319</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="dreamClass" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>dream<wbr/>Class</span><a href="#dreamClass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dream<wbr/>Class</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DreamConstructorType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L317">src/dream/Query.ts:317</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dreamInstance-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>dream<wbr/>Instance</span><a href="#dreamInstance-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dream<wbr/>Instance</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L318">src/dream/Query.ts:318</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dreamTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Internal</code><span>dream<wbr/>Transaction</span><a href="#dreamTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dream<wbr/>Transaction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = null</span></div><div class="tsd-comment tsd-typography"><p>stores the dream transaction applied to the
61
61
  current Query instance</p>
62
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L107">src/dream/Query.ts:107</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="innerJoinDreamClasses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code> <code class="tsd-tag">Internal</code><span>inner<wbr/>Join<wbr/>Dream<wbr/>Classes</span><a href="#innerJoinDreamClasses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inner<wbr/>Join<wbr/>Dream<wbr/>Classes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-keyword">typeof </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>stores the Dream models joined in this Query instance</p>
63
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L326">src/dream/Query.ts:326</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="queryTypeOpts-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Internal</code><span>query<wbr/>Type<wbr/>Opts</span><a href="#queryTypeOpts-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">query<wbr/>Type<wbr/>Opts</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a></div><div class="tsd-comment tsd-typography"><p>purely for typing</p>
64
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L99">src/dream/Query.ts:99</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="BATCH_SIZES" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code> <code class="tsd-tag">Internal</code><span>BATCH_<wbr/>SIZES</span><a href="#BATCH_SIZES" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">BATCH_<wbr/>SIZES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">FIND_EACH</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">PLUCK_EACH</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">PLUCK_EACH_THROUGH</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>stores the default batch sizes for various
62
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L107">src/dream/Query.ts:107</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="innerJoinDreamClasses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code> <code class="tsd-tag">Internal</code><span>inner<wbr/>Join<wbr/>Dream<wbr/>Classes</span><a href="#innerJoinDreamClasses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inner<wbr/>Join<wbr/>Dream<wbr/>Classes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-keyword">typeof </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>stores the Dream models joined in this Query instance</p>
63
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L326">src/dream/Query.ts:326</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="queryTypeOpts-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Internal</code><span>query<wbr/>Type<wbr/>Opts</span><a href="#queryTypeOpts-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">query<wbr/>Type<wbr/>Opts</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a></div><div class="tsd-comment tsd-typography"><p>purely for typing</p>
64
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L99">src/dream/Query.ts:99</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="BATCH_SIZES" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code> <code class="tsd-tag">Internal</code><span>BATCH_<wbr/>SIZES</span><a href="#BATCH_SIZES" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">BATCH_<wbr/>SIZES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">FIND_EACH</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">PLUCK_EACH</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">PLUCK_EACH_THROUGH</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>stores the default batch sizes for various
65
65
  provided batching methods</p>
66
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L89">src/dream/Query.ts:89</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="connectionName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connection<wbr/>Name</span><a href="#connectionName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="connectionName.connectionName-1"><span class="tsd-signature-keyword">get</span> connectionName<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1785">src/dream/Query.ts:1785</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isDreamQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Dream<wbr/>Query</span><a href="#isDreamQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="isDreamQuery.isDreamQuery-1"><span class="tsd-signature-keyword">get</span> isDreamQuery<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true. Useful for distinguishing Query instances
66
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L89">src/dream/Query.ts:89</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="connectionName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connection<wbr/>Name</span><a href="#connectionName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="connectionName.connectionName-1"><span class="tsd-signature-keyword">get</span> connectionName<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1785">src/dream/Query.ts:1785</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isDreamQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Dream<wbr/>Query</span><a href="#isDreamQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="isDreamQuery.isDreamQuery-1"><span class="tsd-signature-keyword">get</span> isDreamQuery<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true. Useful for distinguishing Query instances
67
67
  from other objects.</p>
68
68
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true</p>
69
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L370">src/dream/Query.ts:370</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="all" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>all</span><a href="#all" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="all.all-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">all</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#all.all-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves an array containing all records matching the Query.
69
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L370">src/dream/Query.ts:370</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="all" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>all</span><a href="#all" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="all.all-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">all</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#all.all-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves an array containing all records matching the Query.
70
70
  Be careful using this, since it will attempt to pull every
71
71
  record into memory at once. When querying might return a large
72
72
  number of records, consider using <code>.findEach</code>, which will pull
@@ -77,23 +77,23 @@ the records in batches.</p>
77
77
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">columns</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Query options</p>
78
78
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">columns</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Array of column names to select. The primary key is always included automatically.</p>
79
79
  </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>an array of dreams</p>
80
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1767">src/dream/Query.ts:1767</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clone</span><a href="#clone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="clone.clone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clone</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#clone.clone-1.Q">Q</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#clone.clone-1.Q">Q</a><a href="#clone.clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Internal</code><div class="tsd-comment tsd-typography"><p>Returns a cloned version of the Query</p>
80
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1767">src/dream/Query.ts:1767</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clone</span><a href="#clone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="clone.clone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clone</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#clone.clone-1.Q">Q</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#clone.clone-1.Q">Q</a><a href="#clone.clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Internal</code><div class="tsd-comment tsd-typography"><p>Returns a cloned version of the Query</p>
81
81
  <pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">clonedQuery</span><span class="hl-1"> = </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">clone</span><span class="hl-1">()</span>
82
82
  </code><button type="button">Copy</button></pre>
83
83
 
84
84
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="clone.clone-1.Q" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#clone.clone-1.Q">Q</a></span></li><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">QueryOpts</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;schema&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;connectionTypeConfig&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;passthroughColumns&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;connectionTypeConfig&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Statements to override when cloning the Query</p>
85
85
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#clone.clone-1.Q">Q</a></h4><p>A cloned Query with the provided overrides clause applied</p>
86
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L386">src/dream/Query.ts:386</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="connection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connection</span><a href="#connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="connection.connection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connection</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#connection.connection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Forces use of a database connection (e.g. 'primary') during the query.</p>
86
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L386">src/dream/Query.ts:386</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="connection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connection</span><a href="#connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="connection.connection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connection</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#connection.connection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Forces use of a database connection (e.g. 'primary') during the query.</p>
87
87
  <p>NOTE: all queries within a transaction always use the 'primary' replica, so
88
88
  explicitly setting connection within a transaction has no effect.</p>
89
89
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connection</span>: <a href="../types/DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></span><div class="tsd-comment tsd-typography"><p>The connection you wish to access ('primary' or 'replica')</p>
90
90
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A Query with the requested connection</p>
91
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1982">src/dream/Query.ts:1982</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>count</span><a href="#count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="count.count-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">count</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#count.count-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the number of records matching the Query</p>
91
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1982">src/dream/Query.ts:1982</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="count" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>count</span><a href="#count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="count.count-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">count</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#count.count-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the number of records matching the Query</p>
92
92
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">count</span><span class="hl-1">()</span><br/><span class="hl-7">// 42</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">ilike</span><span class="hl-1">(</span><span class="hl-6">&#39;%gmail.com&#39;</span><span class="hl-1">) }).</span><span class="hl-5">count</span><span class="hl-1">()</span><br/><span class="hl-7">// 15</span>
93
93
  </code><button type="button">Copy</button></pre>
94
94
 
95
95
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The number of records matching the Query</p>
96
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1533">src/dream/Query.ts:1533</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbDriverInstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db<wbr/>Driver<wbr/>Instance</span><a href="#dbDriverInstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dbDriverInstance.dbDriverInstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Driver<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="QueryDriverBase.html" class="tsd-signature-type tsd-kind-class">QueryDriverBase</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#dbDriverInstance.dbDriverInstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="QueryDriverBase.html" class="tsd-signature-type tsd-kind-class">QueryDriverBase</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1780">src/dream/Query.ts:1780</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="delete.delete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#delete.delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes all records matching query using a single
96
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1533">src/dream/Query.ts:1533</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbDriverInstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db<wbr/>Driver<wbr/>Instance</span><a href="#dbDriverInstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dbDriverInstance.dbDriverInstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Driver<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="QueryDriverBase.html" class="tsd-signature-type tsd-kind-class">QueryDriverBase</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#dbDriverInstance.dbDriverInstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="QueryDriverBase.html" class="tsd-signature-type tsd-kind-class">QueryDriverBase</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1780">src/dream/Query.ts:1780</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="delete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="delete.delete-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#delete.delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes all records matching query using a single
97
97
  database query, but does not call underlying callbacks.
98
98
  Ignores association dependent destroy declarations,
99
99
  though cascading may still happen at the database level.</p>
@@ -103,7 +103,7 @@ use <a href="Query.html#destroy" class="tsd-kind-method">Query.destroy</a> inste
103
103
  </code><button type="button">Copy</button></pre>
104
104
 
105
105
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The number of records that were removed</p>
106
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2259">src/dream/Query.ts:2259</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="destroy.destroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Destroys all records matching the Query,
106
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2259">src/dream/Query.ts:2259</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="destroy.destroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Destroys all records matching the Query,
107
107
  calling model hooks and cascading destroy
108
108
  to associations with <code>dependent: 'destroy'</code>,
109
109
  and returns the number of records that
@@ -119,7 +119,7 @@ dependent-destroy declarations, use
119
119
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">cascade</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If false, skips destroying associations marked <code>dependent: 'destroy'</code>. Defaults to true</p>
120
120
  </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">skip<wbr/>Hooks</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true, skips applying model hooks during the destroy operation. Defaults to false</p>
121
121
  </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The number of records that were removed</p>
122
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2131">src/dream/Query.ts:2131</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="distinct" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>distinct</span><a href="#distinct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="distinct.distinct-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">distinct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">column</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#distinct.distinct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns new Query with distinct clause applied.
122
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2131">src/dream/Query.ts:2131</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="distinct" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>distinct</span><a href="#distinct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="distinct.distinct-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">distinct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">column</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#distinct.distinct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns new Query with distinct clause applied.
123
123
  If no column is specified, applies distinct to the primary key.
124
124
  Pass true to apply distinct to primary key, false to disable distinct.</p>
125
125
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">distinct</span><span class="hl-1">(</span><span class="hl-6">&#39;name&#39;</span><span class="hl-1">).</span><span class="hl-5">pluck</span><span class="hl-1">(</span><span class="hl-6">&#39;name&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// Returns unique names</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">distinct</span><span class="hl-1">(</span><span class="hl-0">true</span><span class="hl-1">).</span><span class="hl-5">pluck</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// Returns unique primary keys</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">distinct</span><span class="hl-1">(</span><span class="hl-0">false</span><span class="hl-1">).</span><span class="hl-5">pluck</span><span class="hl-1">(</span><span class="hl-6">&#39;name&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// Disables distinct, returns all names including duplicates</span>
@@ -127,19 +127,19 @@ Pass true to apply distinct to primary key, false to disable distinct.</p>
127
127
 
128
128
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">column</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TableColumnNames</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>The column name to apply distinct to, <code>true</code> to enable distinct on primary key, or <code>false</code> to disable a previously applied distinct call</p>
129
129
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A cloned Query with the distinct clause applied</p>
130
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1556">src/dream/Query.ts:1556</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="exists" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exists</span><a href="#exists" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="exists.exists-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exists</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#exists.exists-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if a record exists for the given Query, false otherwise.</p>
130
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1556">src/dream/Query.ts:1556</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="exists" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exists</span><a href="#exists" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="exists.exists-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exists</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#exists.exists-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if a record exists for the given Query, false otherwise.</p>
131
131
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">exists</span><span class="hl-1">()</span><br/><span class="hl-7">// false</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">create</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1"> })</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">exists</span><span class="hl-1">()</span><br/><span class="hl-7">// true</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;nonexistent@example.com&#39;</span><span class="hl-1"> }).</span><span class="hl-5">exists</span><span class="hl-1">()</span><br/><span class="hl-7">// false</span>
132
132
  </code><button type="button">Copy</button></pre>
133
133
 
134
134
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>boolean - true if any records match the query, false otherwise</p>
135
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2009">src/dream/Query.ts:2009</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="find" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find</span><a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="find.find-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">primaryKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#find.find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a record matching the Query with the
135
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2009">src/dream/Query.ts:2009</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="find" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find</span><a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="find.find-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">primaryKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#find.find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a record matching the Query with the
136
136
  specified primary key. Returns null if not found.</p>
137
137
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">find</span><span class="hl-1">(</span><span class="hl-8">123</span><span class="hl-1">)</span><br/><span class="hl-7">// User{id: 123}</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">find</span><span class="hl-1">(</span><span class="hl-0">null</span><span class="hl-1">)</span><br/><span class="hl-7">// null</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">find</span><span class="hl-1">(</span><span class="hl-0">undefined</span><span class="hl-1">)</span><br/><span class="hl-7">// null</span>
138
138
  </code><button type="button">Copy</button></pre>
139
139
 
140
140
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">primaryKey</span>: <span class="tsd-signature-type">PrimaryKeyForFind</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The primary key of the record to look up.</p>
141
141
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Either the found record, or else null</p>
142
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L463">src/dream/Query.ts:463</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findBy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>By</span><a href="#findBy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findBy.findBy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>By</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.DB">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.Schema">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#findBy.findBy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a record matching the Query and the
142
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L463">src/dream/Query.ts:463</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findBy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>By</span><a href="#findBy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findBy.findBy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>By</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.DB">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.Schema">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#findBy.findBy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a record matching the Query and the
143
143
  specified where statement. If not found, null
144
144
  is returned.</p>
145
145
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">findBy</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1"> })</span><br/><span class="hl-7">// User{email: &#39;how@yadoin&#39;}</span>
@@ -147,7 +147,7 @@ is returned.</p>
147
147
 
148
148
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="findBy.findBy-1.DB" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="findBy.findBy-1.Schema" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">whereStatement</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MergeUnionOfRecordTypes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Whereable</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.DB">DB</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{</span><br/><span>    </span><span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-keyword"> in </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NonKyselySupportedSupplementalWhereClauseValues</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.DB">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.Schema">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.Schema">Schema</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;columns&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;coercedType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findBy.findBy-1.Schema">Schema</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;columns&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;dbType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;enumArrayType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;enumArrayType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">]</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;enumArrayType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">]</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;dbType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;bigint&quot;</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TypesAllowedForBigintAgainstTheDb</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><a href="../types/DateTime.html" class="tsd-signature-type tsd-kind-type-alias">DateTime</a><span class="tsd-signature-symbol"> | </span><a href="CalendarDate.html" class="tsd-signature-type tsd-kind-class">CalendarDate</a><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../types/DateTime.html" class="tsd-signature-type tsd-kind-type-alias">DateTime</a><span class="tsd-signature-symbol"> | </span><a href="CalendarDate.html" class="tsd-signature-type tsd-kind-class">CalendarDate</a><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;enumArrayType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">]</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;coercedType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><a href="../types/DateTime.html" class="tsd-signature-type tsd-kind-type-alias">DateTime</a><br/><span>            </span><span class="tsd-signature-symbol">? </span><br/><span>                </span><span class="tsd-signature-symbol">| </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                </span><span class="tsd-signature-symbol">| </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">OpsStatement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ComparisonOperatorExpression</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><a href="CalendarDate.html" class="tsd-signature-type tsd-kind-class">CalendarDate</a><br/><span>                </span><span class="tsd-signature-symbol">? </span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">OpsStatement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;bigint&quot;</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OpsStatement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ComparisonOperatorExpression</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The where statement used to locate the record</p>
149
149
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Either the first record found matching the attributes, or else null</p>
150
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L503">src/dream/Query.ts:503</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findEach" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Each</span><a href="#findEach" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findEach.findEach-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Each</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">cb</span>, <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#findEach.findEach-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds all records matching the Query in batches,
150
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L503">src/dream/Query.ts:503</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findEach" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Each</span><a href="#findEach" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findEach.findEach-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Each</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">cb</span>, <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#findEach.findEach-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds all records matching the Query in batches,
151
151
  and then calls the provided callback for each found record.
152
152
  Once all records have been passed for a given batch, the next set of
153
153
  records will be fetched and passed to your callback, until all
@@ -159,7 +159,7 @@ records matching the Query have been fetched.</p>
159
159
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">instance</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">batchSize</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Options for batch processing</p>
160
160
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">batch<wbr/>Size</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The batch size you wish to collect records in. If not provided, it will default to 1000</p>
161
161
  </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
162
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L550">src/dream/Query.ts:550</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findOrFail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Or<wbr/>Fail</span><a href="#findOrFail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findOrFail.findOrFail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Or<wbr/>Fail</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">primaryKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#findOrFail.findOrFail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a record matching the Query with the
162
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L550">src/dream/Query.ts:550</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findOrFail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Or<wbr/>Fail</span><a href="#findOrFail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findOrFail.findOrFail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Or<wbr/>Fail</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">primaryKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#findOrFail.findOrFail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a record matching the Query with the
163
163
  specified primary key. If not found, an exception
164
164
  is raised.</p>
165
165
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">findOrFail</span><span class="hl-1">(</span><span class="hl-8">123</span><span class="hl-1">)</span><br/><span class="hl-7">// User{id: 123}</span>
@@ -167,7 +167,7 @@ is raised.</p>
167
167
 
168
168
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">primaryKey</span>: <span class="tsd-signature-type">PrimaryKeyForFind</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The primary key of the record to look up</p>
169
169
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The found record</p>
170
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L484">src/dream/Query.ts:484</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findOrFailBy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Or<wbr/>Fail<wbr/>By</span><a href="#findOrFailBy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findOrFailBy.findOrFailBy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Or<wbr/>Fail<wbr/>By</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.DB-1">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.Schema-1">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#findOrFailBy.findOrFailBy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a record matching the Query and the
170
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L484">src/dream/Query.ts:484</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findOrFailBy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Or<wbr/>Fail<wbr/>By</span><a href="#findOrFailBy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findOrFailBy.findOrFailBy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Or<wbr/>Fail<wbr/>By</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.DB-1">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.Schema-1">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#findOrFailBy.findOrFailBy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a record matching the Query and the
171
171
  specified where statement. If not found, an exception
172
172
  is raised.</p>
173
173
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">findOrFailBy</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1"> })</span><br/><span class="hl-7">// User{email: &#39;how@yadoin&#39;}</span>
@@ -175,7 +175,7 @@ is raised.</p>
175
175
 
176
176
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="findOrFailBy.findOrFailBy-1.DB-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="findOrFailBy.findOrFailBy-1.Schema-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">whereStatement</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">MergeUnionOfRecordTypes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Whereable</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.DB-1">DB</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{</span><br/><span>    </span><span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-keyword"> in </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NonKyselySupportedSupplementalWhereClauseValues</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.DB-1">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.Schema-1">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.Schema-1">Schema</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;columns&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;coercedType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#findOrFailBy.findOrFailBy-1.Schema-1">Schema</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;columns&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;dbType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">ColumnName</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;enumArrayType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;enumArrayType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">]</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;enumArrayType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">]</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;dbType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;bigint&quot;</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TypesAllowedForBigintAgainstTheDb</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><a href="../types/DateTime.html" class="tsd-signature-type tsd-kind-type-alias">DateTime</a><span class="tsd-signature-symbol"> | </span><a href="CalendarDate.html" class="tsd-signature-type tsd-kind-class">CalendarDate</a><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../types/DateTime.html" class="tsd-signature-type tsd-kind-type-alias">DateTime</a><span class="tsd-signature-symbol"> | </span><a href="CalendarDate.html" class="tsd-signature-type tsd-kind-class">CalendarDate</a><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;enumArrayType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">]</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;coercedType&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><a href="../types/DateTime.html" class="tsd-signature-type tsd-kind-type-alias">DateTime</a><br/><span>            </span><span class="tsd-signature-symbol">? </span><br/><span>                </span><span class="tsd-signature-symbol">| </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                </span><span class="tsd-signature-symbol">| </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">OpsStatement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ComparisonOperatorExpression</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><a href="CalendarDate.html" class="tsd-signature-type tsd-kind-class">CalendarDate</a><br/><span>                </span><span class="tsd-signature-symbol">? </span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><a href="Range.html" class="tsd-signature-type tsd-kind-class">Range</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">OpsStatement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;bigint&quot;</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>                    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">null</span><br/><span>                    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OpsStatement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ComparisonOperatorExpression</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><br/><span>                </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>...<span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The where statement used to locate the record</p>
177
177
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The first record found matching the attributes</p>
178
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L522">src/dream/Query.ts:522</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="first" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>first</span><a href="#first" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="first.first-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">first</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#first.first-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the first record in the database
178
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L522">src/dream/Query.ts:522</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="first" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>first</span><a href="#first" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="first.first-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">first</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#first.first-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the first record in the database
179
179
  matching the Query. If the Query is not
180
180
  ordered, it will automatically order
181
181
  by primary key.</p>
@@ -183,7 +183,7 @@ by primary key.</p>
183
183
  </code><button type="button">Copy</button></pre>
184
184
 
185
185
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>First record in the database, or null if no record exists</p>
186
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2032">src/dream/Query.ts:2032</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="firstOrFail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>first<wbr/>Or<wbr/>Fail</span><a href="#firstOrFail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="firstOrFail.firstOrFail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">first<wbr/>Or<wbr/>Fail</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#firstOrFail.firstOrFail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the first record in the database
186
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2032">src/dream/Query.ts:2032</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="firstOrFail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>first<wbr/>Or<wbr/>Fail</span><a href="#firstOrFail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="firstOrFail.firstOrFail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">first<wbr/>Or<wbr/>Fail</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#firstOrFail.firstOrFail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the first record in the database
187
187
  matching the Query. If the Query is not
188
188
  ordered, it will automatically order
189
189
  by primary key. If no record is found,
@@ -193,14 +193,14 @@ an exception is raised.</p>
193
193
 
194
194
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>First record in the database</p>
195
195
  <div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Throws" class="tsd-anchor"></a>Throws<a href="#Throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>RecordNotFound if no record exists</p>
196
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2055">src/dream/Query.ts:2055</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="innerJoin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>inner<wbr/>Join</span><a href="#innerJoin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="innerJoin.innerJoin-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">inner<wbr/>Join</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.DB-2">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.Schema-2">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.TableName">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.Arr">Arr</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.LastArg">LastArg</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociationsCandidate">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociations">JoinedAssociations</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.RetQuery">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.RetQuery">RetQuery</a><a href="#innerJoin.innerJoin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Query instance, with the provided
196
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2055">src/dream/Query.ts:2055</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="innerJoin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>inner<wbr/>Join</span><a href="#innerJoin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="innerJoin.innerJoin-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">inner<wbr/>Join</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.DB-2">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.Schema-2">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.TableName">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.Arr">Arr</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.LastArg">LastArg</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociationsCandidate">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociations">JoinedAssociations</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.RetQuery">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.RetQuery">RetQuery</a><a href="#innerJoin.innerJoin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Query instance, with the provided
197
197
  joins statement attached</p>
198
198
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">innerJoin</span><span class="hl-1">(</span><span class="hl-6">&#39;posts&#39;</span><span class="hl-1">).</span><span class="hl-5">first</span><span class="hl-1">()</span>
199
199
  </code><button type="button">Copy</button></pre>
200
200
 
201
201
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="innerJoin.innerJoin-1.DB-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="innerJoin.innerJoin-1.Schema-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="innerJoin.innerJoin-1.TableName" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TableName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span></span></li><li><span><a id="innerJoin.innerJoin-1.Arr" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">Arr</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><a id="innerJoin.innerJoin-1.LastArg" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">LastArg</span></span></li><li><span><a id="innerJoin.innerJoin-1.JoinedAssociationsCandidate" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">JoinedAssociationsCandidate</span> = <span class="tsd-signature-type">JoinedAssociationsTypeFromAssociations</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.DB-2">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.Schema-2">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.TableName">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.Arr">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.LastArg">LastArg</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="innerJoin.innerJoin-1.JoinedAssociations" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">JoinedAssociations</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociationsCandidate">JoinedAssociationsCandidate</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociationsCandidate">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociationsCandidate">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span></span></li><li><span><a id="innerJoin.innerJoin-1.RetQuery" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLeftJoinPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLimit&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowOffset&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPaginate&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociations">JoinedAssociations</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociations">JoinedAssociations</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.JoinedAssociations">JoinedAssociations</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.Arr">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.LastArg">LastArg</a><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>A chain of association names and and/andNot/andAny clauses</p>
202
202
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#innerJoin.innerJoin-1.RetQuery">RetQuery</a></h4><p>A cloned Query with the joins clause applied</p>
203
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L857">src/dream/Query.ts:857</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="last" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last</span><a href="#last" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="last.last-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">last</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#last.last-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the last record in the database
203
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L857">src/dream/Query.ts:857</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="last" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last</span><a href="#last" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="last.last-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">last</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#last.last-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the last record in the database
204
204
  matching the Query. If the Query is not
205
205
  ordered, it will automatically order
206
206
  by primary key.</p>
@@ -208,7 +208,7 @@ by primary key.</p>
208
208
  </code><button type="button">Copy</button></pre>
209
209
 
210
210
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Last record in the database, or null if no record exists</p>
211
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2077">src/dream/Query.ts:2077</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="lastOrFail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last<wbr/>Or<wbr/>Fail</span><a href="#lastOrFail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="lastOrFail.lastOrFail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">last<wbr/>Or<wbr/>Fail</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#lastOrFail.lastOrFail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the last record in the database
211
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2077">src/dream/Query.ts:2077</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="lastOrFail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>last<wbr/>Or<wbr/>Fail</span><a href="#lastOrFail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="lastOrFail.lastOrFail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">last<wbr/>Or<wbr/>Fail</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#lastOrFail.lastOrFail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the last record in the database
212
212
  matching the Query. If the Query is not
213
213
  ordered, it will automatically order
214
214
  by primary key. If no record is found,
@@ -218,9 +218,9 @@ it will raise an exception.</p>
218
218
 
219
219
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Last record in the database</p>
220
220
  <div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Throws-1" class="tsd-anchor"></a>Throws<a href="#Throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>RecordNotFound if no record exists</p>
221
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2101">src/dream/Query.ts:2101</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leftJoin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>left<wbr/>Join</span><a href="#leftJoin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="leftJoin.leftJoin-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">left<wbr/>Join</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.DB-3">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Schema-3">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.TableName-1">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Arr-1">Arr</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.LastArg-1">LastArg</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociationsCandidate-1">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociations-1">JoinedAssociations</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.RetQuery-1">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.RetQuery-1">RetQuery</a><a href="#leftJoin.leftJoin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Internal</code><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="leftJoin.leftJoin-1.DB-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="leftJoin.leftJoin-1.Schema-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="leftJoin.leftJoin-1.TableName-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TableName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span></span></li><li><span><a id="leftJoin.leftJoin-1.Arr-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">Arr</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><a id="leftJoin.leftJoin-1.LastArg-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">LastArg</span></span></li><li><span><a id="leftJoin.leftJoin-1.JoinedAssociationsCandidate-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">JoinedAssociationsCandidate</span> = <span class="tsd-signature-type">JoinedAssociationsTypeFromAssociations</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.DB-3">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Schema-3">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.TableName-1">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Arr-1">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.LastArg-1">LastArg</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="leftJoin.leftJoin-1.JoinedAssociations-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">JoinedAssociations</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociationsCandidate-1">JoinedAssociationsCandidate</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociationsCandidate-1">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociationsCandidate-1">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span></span></li><li><span><a id="leftJoin.leftJoin-1.RetQuery-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLeftJoinPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLimit&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowOffset&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPaginate&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociations-1">JoinedAssociations</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociations-1">JoinedAssociations</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociations-1">JoinedAssociations</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Arr-1">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.LastArg-1">LastArg</a><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>A chain of association names and and/andNot/andAny clauses</p>
221
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2101">src/dream/Query.ts:2101</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leftJoin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>left<wbr/>Join</span><a href="#leftJoin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="leftJoin.leftJoin-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">left<wbr/>Join</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.DB-3">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Schema-3">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.TableName-1">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Arr-1">Arr</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.LastArg-1">LastArg</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociationsCandidate-1">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociations-1">JoinedAssociations</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.RetQuery-1">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.RetQuery-1">RetQuery</a><a href="#leftJoin.leftJoin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag">Internal</code><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="leftJoin.leftJoin-1.DB-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="leftJoin.leftJoin-1.Schema-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="leftJoin.leftJoin-1.TableName-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TableName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span></span></li><li><span><a id="leftJoin.leftJoin-1.Arr-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">Arr</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><a id="leftJoin.leftJoin-1.LastArg-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">LastArg</span></span></li><li><span><a id="leftJoin.leftJoin-1.JoinedAssociationsCandidate-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">JoinedAssociationsCandidate</span> = <span class="tsd-signature-type">JoinedAssociationsTypeFromAssociations</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.DB-3">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Schema-3">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.TableName-1">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Arr-1">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.LastArg-1">LastArg</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="leftJoin.leftJoin-1.JoinedAssociations-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">JoinedAssociations</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociationsCandidate-1">JoinedAssociationsCandidate</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociationsCandidate-1">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociationsCandidate-1">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span></span></li><li><span><a id="leftJoin.leftJoin-1.RetQuery-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLeftJoinPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLimit&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowOffset&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPaginate&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociations-1">JoinedAssociations</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociations-1">JoinedAssociations</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.JoinedAssociations-1">JoinedAssociations</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.Arr-1">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.LastArg-1">LastArg</a><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>A chain of association names and and/andNot/andAny clauses</p>
222
222
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoin.leftJoin-1.RetQuery-1">RetQuery</a></h4><p>A cloned Query with the joins clause applied</p>
223
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L911">src/dream/Query.ts:911</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leftJoinPreload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>left<wbr/>Join<wbr/>Preload</span><a href="#leftJoinPreload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="leftJoinPreload.leftJoinPreload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">left<wbr/>Join<wbr/>Preload</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Q-1">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.DB-4">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Schema-4">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.TableName-2">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Arr-2">Arr</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.LastArg-2">LastArg</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Incompatible">Incompatible</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociationsCandidate-2">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociations-2">JoinedAssociations</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.RetQuery-2">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.RetQuery-2">RetQuery</a><a href="#leftJoinPreload.leftJoinPreload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load each specified association using a single SQL query.
223
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L911">src/dream/Query.ts:911</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leftJoinPreload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>left<wbr/>Join<wbr/>Preload</span><a href="#leftJoinPreload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="leftJoinPreload.leftJoinPreload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">left<wbr/>Join<wbr/>Preload</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Q-1">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.DB-4">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Schema-4">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.TableName-2">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Arr-2">Arr</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.LastArg-2">LastArg</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Incompatible">Incompatible</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociationsCandidate-2">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociations-2">JoinedAssociations</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.RetQuery-2">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.RetQuery-2">RetQuery</a><a href="#leftJoinPreload.leftJoinPreload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load each specified association using a single SQL query.
224
224
  See <a href="Query.html#preload" class="tsd-kind-method">Query.preload</a> for preloading in separate queries.</p>
225
225
  <p>Note: since leftJoinPreload loads via single query, it has
226
226
  some downsides and that may be avoided using <a href="Query.html#preload" class="tsd-kind-method">Query.preload</a>:</p>
@@ -236,7 +236,7 @@ some downsides and that may be avoided using <a href="Query.html#preload" class=
236
236
 
237
237
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="leftJoinPreload.leftJoinPreload-1.Q-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.DB-4" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.Schema-4" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.TableName-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TableName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.Arr-2" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">Arr</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.LastArg-2" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">LastArg</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.Incompatible" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Incompatible</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">boolean</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.JoinedAssociationsCandidate-2" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">JoinedAssociationsCandidate</span> = <span class="tsd-signature-type">JoinedAssociationsTypeFromAssociations</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.DB-4">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Schema-4">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.TableName-2">TableName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Incompatible">Incompatible</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Arr-2">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.LastArg-2">LastArg</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.JoinedAssociations-2" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">JoinedAssociations</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociationsCandidate-2">JoinedAssociationsCandidate</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociationsCandidate-2">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociationsCandidate-2">JoinedAssociationsCandidate</a><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span></span></li><li><span><a id="leftJoinPreload.leftJoinPreload-1.RetQuery-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLeftJoinPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociations-2">JoinedAssociations</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">JoinedAssociation</span><span class="tsd-signature-symbol">[]</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociations-2">JoinedAssociations</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.JoinedAssociations-2">JoinedAssociations</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Q-1">Q</a></span></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Incompatible">Incompatible</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">&quot;leftJoinPreload is incompatible with preload, limit, offset, and paginate&quot;</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.Arr-2">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.LastArg-2">LastArg</a><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>A chain of association names and and/andNot/andAny clauses</p>
238
238
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreload.leftJoinPreload-1.RetQuery-2">RetQuery</a></h4><p>A cloned Query with the joinLoad statement applied</p>
239
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L599">src/dream/Query.ts:599</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leftJoinPreloadFor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>left<wbr/>Join<wbr/>Preload<wbr/>For</span><a href="#leftJoinPreloadFor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="leftJoinPreloadFor.leftJoinPreloadFor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">left<wbr/>Join<wbr/>Preload<wbr/>For</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.Q-2">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.SerializerKey">SerializerKey</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.RetQuery-3">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">serializerKey</span>, <span class="tsd-kind-parameter">modifierFn</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.RetQuery-3">RetQuery</a><a href="#leftJoinPreloadFor.leftJoinPreloadFor-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Recursively preloads all Dream associations referenced by <code>rendersOne</code> and <code>rendersMany</code>
239
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L599">src/dream/Query.ts:599</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leftJoinPreloadFor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>left<wbr/>Join<wbr/>Preload<wbr/>For</span><a href="#leftJoinPreloadFor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="leftJoinPreloadFor.leftJoinPreloadFor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">left<wbr/>Join<wbr/>Preload<wbr/>For</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.Q-2">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.SerializerKey">SerializerKey</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.RetQuery-3">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">serializerKey</span>, <span class="tsd-kind-parameter">modifierFn</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.RetQuery-3">RetQuery</a><a href="#leftJoinPreloadFor.leftJoinPreloadFor-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Recursively preloads all Dream associations referenced by <code>rendersOne</code> and <code>rendersMany</code>
240
240
  in a DreamSerializer using left join preloading. This traverses the entire content tree
241
241
  of serializers to automatically load all necessary associations in a single query,
242
242
  eliminating N+1 query problems and removing the need to manually remember which
@@ -256,38 +256,38 @@ to regular preloading. See <a href="Dream.html#leftJoinPreload" class="tsd-kind-
256
256
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="leftJoinPreloadFor.leftJoinPreloadFor-1.Q-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="leftJoinPreloadFor.leftJoinPreloadFor-1.SerializerKey" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">SerializerKey</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="leftJoinPreloadFor.leftJoinPreloadFor-1.RetQuery-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLeftJoinPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.Q-2">Q</a></span></li><li><span><span class="tsd-kind-parameter">serializerKey</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.SerializerKey">SerializerKey</a></span><div class="tsd-comment tsd-typography"><p>The serializer key to use for determining which associations to preload.</p>
257
257
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">modifierFn</span>: <span class="tsd-signature-type">LoadForModifierFn</span></span><div class="tsd-comment tsd-typography"><p>Optional callback function to modify or omit specific associations during preloading. Called for each association with the Dream class and association name. Return an object with <code>and</code>, <code>andAny</code>, or <code>andNot</code> properties to add where conditions, return 'omit' to skip preloading that association (useful when you want to handle it manually), or return undefined to use default preloading</p>
258
258
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#leftJoinPreloadFor.leftJoinPreloadFor-1.RetQuery-3">RetQuery</a></h4><p>A Query with all serialization associations left join preloaded</p>
259
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L812">src/dream/Query.ts:812</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="limit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>limit</span><a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="limit.limit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">limit</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.Q-3">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.Incompatible-1">Incompatible</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.RetQuery-4">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.RetQuery-4">RetQuery</a><a href="#limit.limit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Query instance, specifying a limit</p>
259
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L812">src/dream/Query.ts:812</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="limit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>limit</span><a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="limit.limit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">limit</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.Q-3">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.Incompatible-1">Incompatible</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.RetQuery-4">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.RetQuery-4">RetQuery</a><a href="#limit.limit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Query instance, specifying a limit</p>
260
260
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">).</span><span class="hl-5">limit</span><span class="hl-1">(</span><span class="hl-8">2</span><span class="hl-1">).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><span class="hl-7">// [User{id: 1}, User{id: 2}]</span>
261
261
  </code><button type="button">Copy</button></pre>
262
262
 
263
263
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="limit.limit-1.Q-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="limit.limit-1.Incompatible-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Incompatible</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">boolean</span></span></li><li><span><a id="limit.limit-1.RetQuery-4" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLimit&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowOffset&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.Q-3">Q</a></span></li><li><span><span class="tsd-kind-parameter">limit</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.Incompatible-1">Incompatible</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">&quot;limit is incompatible with paginate and leftJoinPreload&quot;</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#limit.limit-1.RetQuery-4">RetQuery</a></h4><p>A cloned Query with the limit clause applied</p>
264
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1387">src/dream/Query.ts:1387</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="max" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max</span><a href="#max" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="max.max-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">max</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.Q-4">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.DB-5">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.ColumnName">ColumnName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.ReturnType">ReturnType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">columnName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.ReturnType">ReturnType</a><span class="tsd-signature-symbol">&gt;</span><a href="#max.max-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the max value of the specified column
264
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1387">src/dream/Query.ts:1387</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="max" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max</span><a href="#max" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="max.max-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">max</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.Q-4">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.DB-5">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.ColumnName">ColumnName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.ReturnType">ReturnType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">columnName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.ReturnType">ReturnType</a><span class="tsd-signature-symbol">&gt;</span><a href="#max.max-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the max value of the specified column
265
265
  for this Query</p>
266
266
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">max</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// 99</span>
267
267
  </code><button type="button">Copy</button></pre>
268
268
 
269
269
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="max.max-1.Q-4" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="max.max-1.DB-5" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="max.max-1.ColumnName" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ColumnName</span></span></li><li><span><a id="max.max-1.ReturnType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ReturnType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">columnName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.ColumnName">ColumnName</a></span><div class="tsd-comment tsd-typography"><p>a column name on the model</p>
270
270
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#max.max-1.ReturnType">ReturnType</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the max value of the specified column for this Query</p>
271
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1594">src/dream/Query.ts:1594</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="min" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>min</span><a href="#min" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="min.min-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">min</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.Q-5">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.DB-6">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.ColumnName-1">ColumnName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.ReturnType-1">ReturnType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">columnName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.ReturnType-1">ReturnType</a><span class="tsd-signature-symbol">&gt;</span><a href="#min.min-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the min value of the specified column
271
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1594">src/dream/Query.ts:1594</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="min" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>min</span><a href="#min" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="min.min-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">min</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.Q-5">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.DB-6">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.ColumnName-1">ColumnName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.ReturnType-1">ReturnType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">columnName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.ReturnType-1">ReturnType</a><span class="tsd-signature-symbol">&gt;</span><a href="#min.min-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the min value of the specified column
272
272
  for this Query</p>
273
273
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">min</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// 1</span>
274
274
  </code><button type="button">Copy</button></pre>
275
275
 
276
276
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="min.min-1.Q-5" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="min.min-1.DB-6" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="min.min-1.ColumnName-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ColumnName</span></span></li><li><span><a id="min.min-1.ReturnType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ReturnType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">columnName</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.ColumnName-1">ColumnName</a></span><div class="tsd-comment tsd-typography"><p>a column name on the model</p>
277
277
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#min.min-1.ReturnType-1">ReturnType</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the min value of the specified column for this Query</p>
278
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1620">src/dream/Query.ts:1620</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="nestedSelect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>nested<wbr/>Select</span><a href="#nestedSelect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="nestedSelect.nestedSelect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">nested<wbr/>Select</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#nestedSelect.nestedSelect-1.SimpleFieldType">SimpleFieldType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#nestedSelect.nestedSelect-1.PluckThroughFieldType">PluckThroughFieldType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">selection</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SelectQueryBuilder</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#nestedSelect.nestedSelect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Kysely SelectQueryBuilder instance to be used
278
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1620">src/dream/Query.ts:1620</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="nestedSelect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>nested<wbr/>Select</span><a href="#nestedSelect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="nestedSelect.nestedSelect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">nested<wbr/>Select</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#nestedSelect.nestedSelect-1.SimpleFieldType">SimpleFieldType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#nestedSelect.nestedSelect-1.PluckThroughFieldType">PluckThroughFieldType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">selection</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SelectQueryBuilder</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#nestedSelect.nestedSelect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Kysely SelectQueryBuilder instance to be used
279
279
  in a sub Query</p>
280
280
  <pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">records</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">id:</span><span class="hl-1"> </span><span class="hl-4">Post</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">nestedSelect</span><span class="hl-1">(</span><span class="hl-6">&#39;userId&#39;</span><span class="hl-1">),</span><br/><span class="hl-1">}).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><span class="hl-7">// [User{id: 1}, ...]</span>
281
281
  </code><button type="button">Copy</button></pre>
282
282
 
283
283
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="nestedSelect.nestedSelect-1.SimpleFieldType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">SimpleFieldType</span><span class="tsd-signature-keyword"> extends </span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">number</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-keyword">typeof </span><span class="tsd-signature-type">iterator</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;match&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;charAt&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;charCodeAt&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;concat&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;indexOf&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;lastIndexOf&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;localeCompare&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;replace&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;search&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;slice&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;split&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;substring&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;toLowerCase&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;toLocaleLowerCase&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;toUpperCase&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;toLocaleUpperCase&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;trim&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;length&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;substr&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;codePointAt&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;includes&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;endsWith&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;normalize&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;repeat&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;startsWith&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;anchor&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;big&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;blink&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;bold&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;fixed&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;fontcolor&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;fontsize&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;italics&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;link&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;small&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;strike&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;sub&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;sup&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;padStart&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;padEnd&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;trimEnd&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;trimStart&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;trimLeft&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;trimRight&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;matchAll&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;replaceAll&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;at&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;toLocaleString&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;toString&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">&quot;valueOf&quot;</span></span></li><li><span><a id="nestedSelect.nestedSelect-1.PluckThroughFieldType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">PluckThroughFieldType</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><span class="tsd-kind-parameter">selection</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#nestedSelect.nestedSelect-1.SimpleFieldType">SimpleFieldType</a><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#nestedSelect.nestedSelect-1.PluckThroughFieldType">PluckThroughFieldType</a></span><div class="tsd-comment tsd-typography"><p>the column to use for your nested Query</p>
284
284
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SelectQueryBuilder</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Kysely SelectQueryBuilder instance</p>
285
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1325">src/dream/Query.ts:1325</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="offset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>offset</span><a href="#offset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="offset.offset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">offset</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.Q-6">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.Incompatible-2">Incompatible</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.RetQuery-5">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">offset</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.RetQuery-5">RetQuery</a><a href="#offset.offset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Query instance, specifying an offset</p>
285
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1325">src/dream/Query.ts:1325</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="offset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>offset</span><a href="#offset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="offset.offset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">offset</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.Q-6">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.Incompatible-2">Incompatible</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.RetQuery-5">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">offset</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.RetQuery-5">RetQuery</a><a href="#offset.offset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Query instance, specifying an offset</p>
286
286
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">).</span><span class="hl-5">offset</span><span class="hl-1">(</span><span class="hl-8">2</span><span class="hl-1">).</span><span class="hl-5">limit</span><span class="hl-1">(</span><span class="hl-8">2</span><span class="hl-1">).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><span class="hl-7">// [User{id: 3}, User{id: 4}]</span>
287
287
  </code><button type="button">Copy</button></pre>
288
288
 
289
289
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="offset.offset-1.Q-6" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="offset.offset-1.Incompatible-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Incompatible</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">boolean</span></span></li><li><span><a id="offset.offset-1.RetQuery-5" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLimit&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowOffset&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.Q-6">Q</a></span></li><li><span><span class="tsd-kind-parameter">offset</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.Incompatible-2">Incompatible</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">&quot;offset is incompatible with paginate and leftJoinPreload&quot;</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#offset.offset-1.RetQuery-5">RetQuery</a></h4><p>A cloned Query with the offset clause applied</p>
290
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1419">src/dream/Query.ts:1419</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="order" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>order</span><a href="#order" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="order.order-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">order</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#order.order-1.Q-7">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#order.order-1.DB-7">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#order.order-1.ColumnName-2">ColumnName</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#order.order-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Query instance, attaching the provided
290
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1419">src/dream/Query.ts:1419</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="order" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>order</span><a href="#order" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="order.order-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">order</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#order.order-1.Q-7">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#order.order-1.DB-7">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#order.order-1.ColumnName-2">ColumnName</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#order.order-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a new Query instance, attaching the provided
291
291
  order statement</p>
292
292
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">).</span><span class="hl-5">all</span><span class="hl-1">()</span><br/><span class="hl-7">// [User{id: 1}, User{id: 2}, ...]</span>
293
293
  </code><button type="button">Copy</button></pre>
@@ -297,7 +297,7 @@ order statement</p>
297
297
 
298
298
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="order.order-1.Q-7" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="order.order-1.DB-7" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="order.order-1.ColumnName-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ColumnName</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">arg</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#order.order-1.ColumnName-2">ColumnName</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#order.order-1.ColumnName-2">ColumnName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">OrderDir</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Either a string or an object specifying order. If a string, the order is implicitly ascending. If the orderStatement is an object, statements will be provided in the order of the keys set in the object</p>
299
299
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A cloned Query with the order clause applied</p>
300
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1350">src/dream/Query.ts:1350</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="paginate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>paginate</span><a href="#paginate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="paginate.paginate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">paginate</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#paginate.paginate-1.Q-8">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#paginate.paginate-1.Incompatible-3">Incompatible</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PaginatedDreamQueryResult</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#paginate.paginate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Paginates the results of your query, accepting a pageSize and page argument,
300
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1350">src/dream/Query.ts:1350</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="paginate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>paginate</span><a href="#paginate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="paginate.paginate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">paginate</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#paginate.paginate-1.Q-8">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#paginate.paginate-1.Incompatible-3">Incompatible</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PaginatedDreamQueryResult</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#paginate.paginate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Paginates the results of your query, accepting a pageSize and page argument,
301
301
  which it uses to segment your query into pages, leveraging limit and offset
302
302
  to deliver your query to you in pages.</p>
303
303
  <pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">paginated</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;email&#39;</span><span class="hl-1">).</span><span class="hl-5">paginate</span><span class="hl-1">({ </span><span class="hl-4">pageSize:</span><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1">, </span><span class="hl-4">page:</span><span class="hl-1"> </span><span class="hl-8">2</span><span class="hl-1"> })</span><br/><span class="hl-4">paginated</span><span class="hl-1">.</span><span class="hl-4">results</span><br/><span class="hl-7">// [ { User{id: 101}, User{id: 102}, ...}]</span><br/><br/><span class="hl-4">paginated</span><span class="hl-1">.</span><span class="hl-4">recordCount</span><br/><span class="hl-7">// 350</span><br/><br/><span class="hl-4">paginated</span><span class="hl-1">.</span><span class="hl-4">pageCount</span><br/><span class="hl-7">// 4</span><br/><br/><span class="hl-4">paginated</span><span class="hl-1">.</span><span class="hl-4">currentPage</span><br/><span class="hl-7">// 2</span>
@@ -305,14 +305,14 @@ to deliver your query to you in pages.</p>
305
305
 
306
306
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="paginate.paginate-1.Q-8" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="paginate.paginate-1.Incompatible-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Incompatible</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">boolean</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#paginate.paginate-1.Q-8">Q</a></span></li><li><span><span class="tsd-kind-parameter">opts</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#paginate.paginate-1.Incompatible-3">Incompatible</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">&quot;paginate is incompatible with limit, offset, and leftJoinPreload&quot;</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PaginatedDreamQueryOptions</span></span><div class="tsd-comment tsd-typography"><p>Pagination options</p>
307
307
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PaginatedDreamQueryResult</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>results.recordCount - A number representing the total number of records matching your query</p>
308
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1817">src/dream/Query.ts:1817</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="passthrough" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>passthrough</span><a href="#passthrough" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="passthrough.passthrough-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">passthrough</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">passthroughOnStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#passthrough.passthrough-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends data through for use as passthrough data
308
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1817">src/dream/Query.ts:1817</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="passthrough" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>passthrough</span><a href="#passthrough" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="passthrough.passthrough-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">passthrough</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">passthroughOnStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#passthrough.passthrough-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends data through for use as passthrough data
309
309
  for the associations that require it.</p>
310
310
  <pre><code class="ts"><span class="hl-0">class</span><span class="hl-1"> </span><span class="hl-9">Post</span><span class="hl-1"> {</span><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">HasMany</span><span class="hl-1">(</span><span class="hl-6">&#39;LocalizedText&#39;</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">localizedTexts</span><span class="hl-1">: </span><span class="hl-9">LocalizedText</span><span class="hl-1">[]</span><br/><br/><span class="hl-1"> @</span><span class="hl-4">deco</span><span class="hl-1">.</span><span class="hl-5">HasOne</span><span class="hl-1">(</span><span class="hl-6">&#39;LocalizedText&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">and:</span><span class="hl-1"> { </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-4">DreamConst</span><span class="hl-1">.</span><span class="hl-4">passthrough</span><span class="hl-1"> },</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> </span><span class="hl-0">public</span><span class="hl-1"> </span><span class="hl-4">currentLocalizedText</span><span class="hl-1">: </span><span class="hl-9">LocalizedText</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">passthrough</span><span class="hl-1">({ </span><span class="hl-4">locale:</span><span class="hl-1"> </span><span class="hl-6">&#39;es-ES&#39;</span><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-5">preload</span><span class="hl-1">(</span><span class="hl-6">&#39;posts&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;currentLocalizedText&#39;</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-5">first</span><span class="hl-1">()</span>
311
311
  </code><button type="button">Copy</button></pre>
312
312
 
313
313
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">passthroughOnStatement</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;connectionTypeConfig&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;passthroughColumns&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;connectionTypeConfig&quot;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>where statement used for associations that require passthrough data</p>
314
314
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A cloned Query with the passthrough data</p>
315
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1220">src/dream/Query.ts:1220</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pluck" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pluck</span><a href="#pluck" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pluck.pluck-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pluck</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.Q-9">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.DB-8">DB</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ColumnNames">ColumnNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ReturnValue">ReturnValue</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">columnNames</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ReturnValue">ReturnValue</a><span class="tsd-signature-symbol">&gt;</span><a href="#pluck.pluck-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Plucks the provided fields from the given dream class table</p>
315
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1220">src/dream/Query.ts:1220</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pluck" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pluck</span><a href="#pluck" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pluck.pluck-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pluck</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.Q-9">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.DB-8">DB</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ColumnNames">ColumnNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ReturnValue">ReturnValue</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">columnNames</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ReturnValue">ReturnValue</a><span class="tsd-signature-symbol">&gt;</span><a href="#pluck.pluck-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Plucks the provided fields from the given dream class table</p>
316
316
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">).</span><span class="hl-5">pluck</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// [1, 2, 3]</span>
317
317
  </code><button type="button">Copy</button></pre>
318
318
 
@@ -323,7 +323,7 @@ array is returned:</p>
323
323
 
324
324
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pluck.pluck-1.Q-9" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="pluck.pluck-1.DB-8" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="pluck.pluck-1.ColumnNames" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ColumnNames</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">ColumnNamesAccountingForJoinedAssociations</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.Q-9">Q</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;queryTypeOpts&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.DB-8">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><a id="pluck.pluck-1.ReturnValue" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ReturnValue</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">NamespacedOrBaseModelColumnTypes</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ColumnNames">ColumnNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.Q-9">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NamespacedOrBaseModelColumnTypes</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ColumnNames">ColumnNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.Q-9">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.Q-9">Q</a></span></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">columnNames</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ColumnNames">ColumnNames</a></span><div class="tsd-comment tsd-typography"><p>The column or array of columns to pluck</p>
325
325
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluck.pluck-1.ReturnValue">ReturnValue</a><span class="tsd-signature-symbol">&gt;</span></h4><p>An array of pluck results</p>
326
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1653">src/dream/Query.ts:1653</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pluckEach" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pluck<wbr/>Each</span><a href="#pluckEach" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pluckEach.pluckEach-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pluck<wbr/>Each</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.Q-10">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.DB-9">DB</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.ColumnNames-1">ColumnNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.CbArgTypes">CbArgTypes</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#pluckEach.pluckEach-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Plucks the specified column names from the given dream class table
326
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1653">src/dream/Query.ts:1653</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pluckEach" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pluck<wbr/>Each</span><a href="#pluckEach" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pluckEach.pluckEach-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pluck<wbr/>Each</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.Q-10">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.DB-9">DB</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.ColumnNames-1">ColumnNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.CbArgTypes">CbArgTypes</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#pluckEach.pluckEach-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Plucks the specified column names from the given dream class table
327
327
  in batches, passing each found columns into the
328
328
  provided callback function</p>
329
329
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">).</span><span class="hl-5">pluckEach</span><span class="hl-1">(</span><span class="hl-6">&#39;id&#39;</span><span class="hl-1">, (</span><span class="hl-4">id</span><span class="hl-1">) </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-4">id</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><span class="hl-7">// 1</span><br/><span class="hl-7">// 2</span><br/><span class="hl-7">// 3</span>
@@ -331,14 +331,14 @@ provided callback function</p>
331
331
 
332
332
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pluckEach.pluckEach-1.Q-10" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="pluckEach.pluckEach-1.DB-9" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="pluckEach.pluckEach-1.ColumnNames-1" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">ColumnNames</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">ColumnNamesAccountingForJoinedAssociations</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.Q-10">Q</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;queryTypeOpts&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.DB-9">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><a id="pluckEach.pluckEach-1.CbArgTypes" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">CbArgTypes</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.Q-10">Q</a></span></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">PluckEachArgs</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.ColumnNames-1">ColumnNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#pluckEach.pluckEach-1.CbArgTypes">CbArgTypes</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>a list of column names to pluck, followed by a callback function to call for each set of found fields</p>
333
333
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
334
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1688">src/dream/Query.ts:1688</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="preload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>preload</span><a href="#preload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="preload.preload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">preload</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Q-11">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.DB-10">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Schema-5">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.TableName-3">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Arr-3">Arr</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Incompatible-4">Incompatible</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.RetQuery-6">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.RetQuery-6">RetQuery</a><a href="#preload.preload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load each specified association using a separate SQL query.
334
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1688">src/dream/Query.ts:1688</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="preload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>preload</span><a href="#preload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="preload.preload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">preload</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Q-11">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.DB-10">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Schema-5">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.TableName-3">TableName</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">const </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Arr-3">Arr</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Incompatible-4">Incompatible</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.RetQuery-6">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.RetQuery-6">RetQuery</a><a href="#preload.preload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load each specified association using a separate SQL query.
335
335
  See <a href="Query.html#leftJoinPreload" class="tsd-kind-method">Query.leftJoinPreload</a> for preloading in a single query.</p>
336
336
  <pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">user</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">preload</span><span class="hl-1">(</span><span class="hl-6">&#39;posts&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;comments&#39;</span><span class="hl-1">, { </span><span class="hl-4">visibilty:</span><span class="hl-1"> </span><span class="hl-6">&#39;public&#39;</span><span class="hl-1"> }, </span><span class="hl-6">&#39;replies&#39;</span><span class="hl-1">).</span><span class="hl-5">first</span><span class="hl-1">()</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-4">user</span><span class="hl-1">.</span><span class="hl-4">posts</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">].</span><span class="hl-4">comments</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">].</span><span class="hl-4">replies</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">])</span><br/><span class="hl-7">// [Reply{id: 1}, Reply{id: 2}]</span>
337
337
  </code><button type="button">Copy</button></pre>
338
338
 
339
339
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="preload.preload-1.Q-11" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="preload.preload-1.DB-10" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="preload.preload-1.Schema-5" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="preload.preload-1.TableName-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TableName</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span></span></li><li><span><a id="preload.preload-1.Arr-3" class="tsd-anchor"></a><span class="tsd-signature-keyword">const </span><span class="tsd-kind-type-parameter">Arr</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">readonly </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><a id="preload.preload-1.Incompatible-4" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Incompatible</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">boolean</span></span></li><li><span><a id="preload.preload-1.RetQuery-6" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLimit&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowOffset&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPaginate&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Q-11">Q</a></span></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Incompatible-4">Incompatible</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">&quot;preload is incompatible with leftJoinPreload&quot;</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">...</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Arr-3">Arr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">VariadicLoadArgs</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.DB-10">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Schema-5">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.TableName-3">TableName</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.Arr-3">Arr</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>A chain of association names and and/andNot/andAny clauses</p>
340
340
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preload.preload-1.RetQuery-6">RetQuery</a></h4><p>A cloned Query with the preload statement applied</p>
341
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L661">src/dream/Query.ts:661</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="preloadFor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>preload<wbr/>For</span><a href="#preloadFor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="preloadFor.preloadFor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">preload<wbr/>For</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.Q-12">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.SerializerKey-1">SerializerKey</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.RetQuery-7">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">serializerKey</span>, <span class="tsd-kind-parameter">modifierFn</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.RetQuery-7">RetQuery</a><a href="#preloadFor.preloadFor-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Recursively preloads all Dream associations referenced by <code>rendersOne</code> and <code>rendersMany</code>
341
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L661">src/dream/Query.ts:661</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="preloadFor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>preload<wbr/>For</span><a href="#preloadFor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="preloadFor.preloadFor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">preload<wbr/>For</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.Q-12">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.SerializerKey-1">SerializerKey</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.RetQuery-7">RetQuery</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">serializerKey</span>, <span class="tsd-kind-parameter">modifierFn</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.RetQuery-7">RetQuery</a><a href="#preloadFor.preloadFor-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Recursively preloads all Dream associations referenced by <code>rendersOne</code> and <code>rendersMany</code>
342
342
  in a DreamSerializer. This traverses the entire content tree of serializers to automatically
343
343
  load all necessary associations, eliminating N+1 query problems and removing the need to
344
344
  manually remember which associations to preload for serialization.</p>
@@ -355,7 +355,7 @@ automatically preloads all associations that will be needed during serialization
355
355
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="preloadFor.preloadFor-1.Q-12" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="preloadFor.preloadFor-1.SerializerKey-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">SerializerKey</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="preloadFor.preloadFor-1.RetQuery-7" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetQuery</span> = <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">allowLeftJoinPreload</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowLimit</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowLimit&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowOffset</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowOffset&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPaginate</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPaginate&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">allowPreload</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;allowPreload&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">joinedAssociations</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableAlias</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableAlias&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">rootTableName</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.Q-12">Q</a></span></li><li><span><span class="tsd-kind-parameter">serializerKey</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.SerializerKey-1">SerializerKey</a></span><div class="tsd-comment tsd-typography"><p>The serializer key to use for determining which associations to preload.</p>
356
356
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">modifierFn</span>: <span class="tsd-signature-type">LoadForModifierFn</span></span><div class="tsd-comment tsd-typography"><p>Optional callback function to modify or omit specific associations during preloading. Called for each association with the Dream class and association name. Return an object with <code>and</code>, <code>andAny</code>, or <code>andNot</code> properties to add where conditions, return 'omit' to skip preloading that association (useful when you want to handle it manually), or return undefined to use default preloading</p>
357
357
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#preloadFor.preloadFor-1.RetQuery-7">RetQuery</a></h4><p>A Query with all serialization associations preloaded</p>
358
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L735">src/dream/Query.ts:735</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reallyDestroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>really<wbr/>Destroy</span><a href="#reallyDestroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reallyDestroy.reallyDestroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">really<wbr/>Destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#reallyDestroy.reallyDestroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Destroys all records matching the Query,
358
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L735">src/dream/Query.ts:735</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reallyDestroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>really<wbr/>Destroy</span><a href="#reallyDestroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reallyDestroy.reallyDestroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">really<wbr/>Destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#reallyDestroy.reallyDestroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Destroys all records matching the Query,
359
359
  ignoring the SoftDelete decorator and
360
360
  permanently removing records from the database.</p>
361
361
  <p>Calls model hooks and applies cascade destroy
@@ -371,46 +371,46 @@ decorator, use <a href="Query.html#destroy" class="tsd-kind-method">Query.destro
371
371
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">cascade</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If false, skips destroying associations marked <code>dependent: 'destroy'</code>. Defaults to true</p>
372
372
  </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">skip<wbr/>Hooks</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true, skips applying model hooks during the destroy operation. Defaults to false</p>
373
373
  </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The number of records that were removed</p>
374
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2188">src/dream/Query.ts:2188</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeAllDefaultScopes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Default<wbr/>Scopes</span><a href="#removeAllDefaultScopes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeAllDefaultScopes.removeAllDefaultScopes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Default<wbr/>Scopes</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#removeAllDefaultScopes.removeAllDefaultScopes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents default scopes from applying when
374
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2188">src/dream/Query.ts:2188</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeAllDefaultScopes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Default<wbr/>Scopes</span><a href="#removeAllDefaultScopes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeAllDefaultScopes.removeAllDefaultScopes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Default<wbr/>Scopes</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#removeAllDefaultScopes.removeAllDefaultScopes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents default scopes from applying when
375
375
  the Query is executed</p>
376
376
  </div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A new Query which will prevent default scopes from applying</p>
377
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1144">src/dream/Query.ts:1144</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="removeAllDefaultScopesExceptOnAssociations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>remove<wbr/>All<wbr/>Default<wbr/>Scopes<wbr/>Except<wbr/>On<wbr/>Associations</span><a href="#removeAllDefaultScopesExceptOnAssociations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class="tsd-signature tsd-anchor-link"><a id="removeAllDefaultScopesExceptOnAssociations.removeAllDefaultScopesExceptOnAssociations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Default<wbr/>Scopes<wbr/>Except<wbr/>On<wbr/>Associations</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#removeAllDefaultScopesExceptOnAssociations.removeAllDefaultScopesExceptOnAssociations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents default scopes from applying when
377
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1144">src/dream/Query.ts:1144</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="removeAllDefaultScopesExceptOnAssociations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>remove<wbr/>All<wbr/>Default<wbr/>Scopes<wbr/>Except<wbr/>On<wbr/>Associations</span><a href="#removeAllDefaultScopesExceptOnAssociations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class="tsd-signature tsd-anchor-link"><a id="removeAllDefaultScopesExceptOnAssociations.removeAllDefaultScopesExceptOnAssociations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Default<wbr/>Scopes<wbr/>Except<wbr/>On<wbr/>Associations</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#removeAllDefaultScopesExceptOnAssociations.removeAllDefaultScopesExceptOnAssociations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents default scopes from applying when
378
378
  the Query is executed, but not when applying to associations</p>
379
379
  </div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A new Query which will prevent default scopes from applying, but not when applying to asociations</p>
380
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1157">src/dream/Query.ts:1157</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeDefaultScope" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Default<wbr/>Scope</span><a href="#removeDefaultScope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeDefaultScope.removeDefaultScope-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Default<wbr/>Scope</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scopeName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#removeDefaultScope.removeDefaultScope-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents a specific default scope from applying when
380
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1157">src/dream/Query.ts:1157</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeDefaultScope" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Default<wbr/>Scope</span><a href="#removeDefaultScope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="removeDefaultScope.removeDefaultScope-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Default<wbr/>Scope</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scopeName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#removeDefaultScope.removeDefaultScope-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents a specific default scope from applying when
381
381
  the Query is executed</p>
382
382
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scopeName</span>: <span class="tsd-signature-type">AllDefaultScopeNames</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A new Query which will prevent a specific default scope from applying</p>
383
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1170">src/dream/Query.ts:1170</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="removeDefaultScopeExceptOnAssociations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>remove<wbr/>Default<wbr/>Scope<wbr/>Except<wbr/>On<wbr/>Associations</span><a href="#removeDefaultScopeExceptOnAssociations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class="tsd-signature tsd-anchor-link"><a id="removeDefaultScopeExceptOnAssociations.removeDefaultScopeExceptOnAssociations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Default<wbr/>Scope<wbr/>Except<wbr/>On<wbr/>Associations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scopeName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#removeDefaultScopeExceptOnAssociations.removeDefaultScopeExceptOnAssociations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents a specific default scope from applying when
383
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1170">src/dream/Query.ts:1170</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="removeDefaultScopeExceptOnAssociations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>remove<wbr/>Default<wbr/>Scope<wbr/>Except<wbr/>On<wbr/>Associations</span><a href="#removeDefaultScopeExceptOnAssociations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class="tsd-signature tsd-anchor-link"><a id="removeDefaultScopeExceptOnAssociations.removeDefaultScopeExceptOnAssociations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Default<wbr/>Scope<wbr/>Except<wbr/>On<wbr/>Associations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scopeName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#removeDefaultScopeExceptOnAssociations.removeDefaultScopeExceptOnAssociations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prevents a specific default scope from applying when
384
384
  the Query is executed, but not when applying to asociations</p>
385
385
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scopeName</span>: <span class="tsd-signature-type">DefaultScopeName</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A new Query which will prevent a specific default scope from applying, but not when applying to asociations</p>
386
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1185">src/dream/Query.ts:1185</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="scrollPaginate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>scroll<wbr/>Paginate</span><a href="#scrollPaginate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="scrollPaginate.scrollPaginate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">scroll<wbr/>Paginate</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#scrollPaginate.scrollPaginate-1.Q-13">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#scrollPaginate.scrollPaginate-1.Incompatible-5">Incompatible</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FastPaginatedDreamQueryResult</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#scrollPaginate.scrollPaginate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fast paginates the results of your query using cursor-based pagination,
386
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1185">src/dream/Query.ts:1185</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="scrollPaginate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>scroll<wbr/>Paginate</span><a href="#scrollPaginate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="scrollPaginate.scrollPaginate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">scroll<wbr/>Paginate</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#scrollPaginate.scrollPaginate-1.Q-13">Q</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#scrollPaginate.scrollPaginate-1.Incompatible-5">Incompatible</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ScrollPaginatedDreamQueryResult</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#scrollPaginate.scrollPaginate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fast paginates the results of your query using cursor-based pagination,
387
387
  accepting a pageSize and cursor argument. This method
388
388
  provides better performance for large datasets by using cursor-based
389
389
  pagination instead of offset-based pagination.</p>
390
390
  <pre><code class="ts"><span class="hl-7">// First page (using undefined to start from beginning)</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">firstPage</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;email&#39;</span><span class="hl-1">).</span><span class="hl-5">scrollPaginate</span><span class="hl-1">({ </span><span class="hl-4">pageSize:</span><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1">, </span><span class="hl-4">cursor:</span><span class="hl-1"> </span><span class="hl-0">undefined</span><span class="hl-1"> })</span><br/><span class="hl-4">firstPage</span><span class="hl-1">.</span><span class="hl-4">results</span><br/><span class="hl-7">// [ { User{id: 1}, User{id: 2}, ...}]</span><br/><br/><span class="hl-4">firstPage</span><span class="hl-1">.</span><span class="hl-4">cursor</span><br/><span class="hl-7">// &quot;100&quot; (or null if no more pages)</span><br/><br/><span class="hl-7">// Next page using cursor from previous result</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">nextPage</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">order</span><span class="hl-1">(</span><span class="hl-6">&#39;email&#39;</span><span class="hl-1">).</span><span class="hl-5">scrollPaginate</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">pageSize:</span><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">cursor:</span><span class="hl-1"> </span><span class="hl-4">firstPage</span><span class="hl-1">.</span><span class="hl-4">cursor</span><br/><span class="hl-1">})</span>
391
391
  </code><button type="button">Copy</button></pre>
392
392
 
393
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="scrollPaginate.scrollPaginate-1.Q-13" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="scrollPaginate.scrollPaginate-1.Incompatible-5" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Incompatible</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">boolean</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#scrollPaginate.scrollPaginate-1.Q-13">Q</a></span></li><li><span><span class="tsd-kind-parameter">opts</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#scrollPaginate.scrollPaginate-1.Incompatible-5">Incompatible</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">&quot;scrollPaginate is incompatible with limit, offset, and leftJoinPreload&quot;</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FastPaginatedDreamQueryOptions</span></span><div class="tsd-comment tsd-typography"><p>Fast pagination options</p>
394
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FastPaginatedDreamQueryResult</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>results.cursor - identifier for the next page, or null if no more pages</p>
395
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1881">src/dream/Query.ts:1881</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sql" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sql</span><a href="#sql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sql.sql-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sql</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CompiledQuery</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><a href="#sql.sql-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the sql that would be executed by this Query</p>
393
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="scrollPaginate.scrollPaginate-1.Q-13" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Q</span><span class="tsd-signature-keyword"> extends </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><a id="scrollPaginate.scrollPaginate-1.Incompatible-5" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Incompatible</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">boolean</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#scrollPaginate.scrollPaginate-1.Q-13">Q</a></span></li><li><span><span class="tsd-kind-parameter">opts</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#scrollPaginate.scrollPaginate-1.Incompatible-5">Incompatible</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">&quot;scrollPaginate is incompatible with limit, offset, and leftJoinPreload&quot;</span><span class="tsd-signature-symbol">[]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ScrollPaginatedDreamQueryOptions</span></span><div class="tsd-comment tsd-typography"><p>Fast pagination options</p>
394
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ScrollPaginatedDreamQueryResult</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>results.cursor - identifier for the next page, or null if no more pages</p>
395
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1881">src/dream/Query.ts:1881</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sql" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sql</span><a href="#sql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sql.sql-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sql</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CompiledQuery</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><a href="#sql.sql-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the sql that would be executed by this Query</p>
396
396
  <pre><code class="ts"><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1"> }).</span><span class="hl-5">sql</span><span class="hl-1">()</span><br/><span class="hl-7">// {</span><br/><span class="hl-7">// query: {</span><br/><span class="hl-7">// kind: &#39;SelectQueryNode&#39;,</span><br/><span class="hl-7">// from: { kind: &#39;FromNode&#39;, froms: [Array] },</span><br/><span class="hl-7">// selections: [ [Object] ],</span><br/><span class="hl-7">// distinctOn: undefined,</span><br/><span class="hl-7">// joins: undefined,</span><br/><span class="hl-7">// groupBy: undefined,</span><br/><span class="hl-7">// orderBy: undefined,</span><br/><span class="hl-7">// where: { kind: &#39;WhereNode&#39;, where: [Object] },</span><br/><span class="hl-7">// frontModifiers: undefined,</span><br/><span class="hl-7">// endModifiers: undefined,</span><br/><span class="hl-7">// limit: undefined,</span><br/><span class="hl-7">// offset: undefined,</span><br/><span class="hl-7">// with: undefined,</span><br/><span class="hl-7">// having: undefined,</span><br/><span class="hl-7">// explain: undefined,</span><br/><span class="hl-7">// setOperations: undefined</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// sql: &#39;select &quot;users&quot;.* from &quot;users&quot; where (&quot;users&quot;.&quot;email&quot; = $1 and &quot;users&quot;.&quot;deleted_at&quot; is null)&#39;,</span><br/><span class="hl-7">// parameters: [ &#39;how@yadoin&#39; ]</span><br/><span class="hl-7">//}</span>
397
397
  </code><button type="button">Copy</button></pre>
398
398
 
399
399
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CompiledQuery</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4><p>An object representing the underlying sql statement</p>
400
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1473">src/dream/Query.ts:1473</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toKysely" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Kysely</span><a href="#toKysely" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toKysely.toKysely-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.QueryType">QueryType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.TableNames">TableNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.ToKyselyReturnType">ToKyselyReturnType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.ToKyselyReturnType">ToKyselyReturnType</a><a href="#toKysely.toKysely-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts the given dream class into a Kysely query, enabling
400
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1473">src/dream/Query.ts:1473</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toKysely" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Kysely</span><a href="#toKysely" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toKysely.toKysely-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.QueryType">QueryType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.TableNames">TableNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.ToKyselyReturnType">ToKyselyReturnType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.ToKyselyReturnType">ToKyselyReturnType</a><a href="#toKysely.toKysely-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Converts the given dream class into a Kysely query, enabling
401
401
  you to build custom queries using the Kysely API</p>
402
402
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">toKysely</span><span class="hl-1">(</span><span class="hl-6">&#39;select&#39;</span><span class="hl-1">).</span><span class="hl-5">where</span><span class="hl-1">(</span><span class="hl-6">&#39;email&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;=&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1">).</span><span class="hl-5">execute</span><span class="hl-1">()</span>
403
403
  </code><button type="button">Copy</button></pre>
404
404
 
405
405
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="toKysely.toKysely-1.QueryType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">QueryType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;update&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;select&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;delete&quot;</span></span></li><li><span><a id="toKysely.toKysely-1.DbType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DbType</span> = <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;length&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">0</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">false</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">{</span><br/><span>            </span><span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">Key</span><span class="tsd-signature-keyword"> in </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Extract</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span>                </span><span class="tsd-kind-property">alias</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">Key</span><span class="tsd-signature-symbol">; </span><br/><span>            </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><br/><span>        </span><span class="tsd-signature-symbol">}</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">null</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;length&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">0</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">false</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">{</span><br/><span>            </span><span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">Key</span><span class="tsd-signature-keyword"> in </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;DB&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Extract</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span>                </span><span class="tsd-kind-property">alias</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">Key</span><span class="tsd-signature-symbol">; </span><br/><span>            </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><br/><span>        </span><span class="tsd-signature-symbol">}</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span></span></li><li><span><a id="toKysely.toKysely-1.TableNames" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TableNames</span> = <span class="tsd-signature-symbol">(</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;length&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">0</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">false</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;length&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">0</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">false</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;length&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">0</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">false</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">true</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;alias&quot;</span><span class="tsd-signature-symbol">]</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;table&quot;</span><span class="tsd-signature-symbol">]</span></span></li><li><span><a id="toKysely.toKysely-1.ToKyselyReturnType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">ToKyselyReturnType</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.QueryType">QueryType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;select&quot;</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">SelectQueryBuilder</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.TableNames">TableNames</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.QueryType">QueryType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;delete&quot;</span><br/><span>        </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">DeleteQueryBuilder</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.TableNames">TableNames</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><br/><span>        </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.QueryType">QueryType</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;update&quot;</span><br/><span>            </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-type">UpdateQueryBuilder</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.TableNames">TableNames</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.TableNames">TableNames</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><br/><span>            </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.QueryType">QueryType</a></span><div class="tsd-comment tsd-typography"><p>the type of Kysely query builder instance you would like to obtain</p>
406
406
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#toKysely.toKysely-1.ToKyselyReturnType">ToKyselyReturnType</a></h4><p>A Kysely query. Depending on the type passed, it will return either a SelectQueryBuilder, DeleteQueryBuilder, or an UpdateQueryBuilder</p>
407
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1488">src/dream/Query.ts:1488</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="txn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>txn</span><a href="#txn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="txn.txn-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">txn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dreamTransaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#txn.txn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies transaction to the Query instance</p>
407
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1488">src/dream/Query.ts:1488</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="txn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>txn</span><a href="#txn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="txn.txn-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">txn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dreamTransaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#txn.txn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies transaction to the Query instance</p>
408
408
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">ApplicationModel</span><span class="hl-1">.</span><span class="hl-5">transaction</span><span class="hl-1">(</span><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-4">txn</span><span class="hl-1"> </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">txn</span><span class="hl-1">(</span><span class="hl-4">txn</span><span class="hl-1">).</span><span class="hl-5">create</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1"> })</span><br/><span class="hl-1">})</span>
409
409
  </code><button type="button">Copy</button></pre>
410
410
 
411
411
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dreamTransaction</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>A DreamTransaction instance (usually collected by calling <code>ApplicationModel.transaction</code>)</p>
412
412
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A cloned Query with the transaction applied</p>
413
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1516">src/dream/Query.ts:1516</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="undestroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>undestroy</span><a href="#undestroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="undestroy.undestroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">undestroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#undestroy.undestroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Undestroys a SoftDelete model, unsetting
413
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1516">src/dream/Query.ts:1516</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="undestroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>undestroy</span><a href="#undestroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="undestroy.undestroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">undestroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#undestroy.undestroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Undestroys a SoftDelete model, unsetting
414
414
  the <code>deletedAt</code> field in the database.</p>
415
415
  <p>If the model is not a SoftDelete model,
416
416
  this will raise an exception.</p>
@@ -421,7 +421,7 @@ this will raise an exception.</p>
421
421
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">cascade</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If false, skips undestroying associations marked <code>dependent: 'destroy'</code>. Defaults to true</p>
422
422
  </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">skip<wbr/>Hooks</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true, skips applying model hooks during the undestroy operation. Defaults to false</p>
423
423
  </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The number of records that were removed</p>
424
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2214">src/dream/Query.ts:2214</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="update" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="update.update-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attributes</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#update.update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates all records matching the Query</p>
424
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2214">src/dream/Query.ts:2214</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="update" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="update.update-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attributes</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#update.update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates all records matching the Query</p>
425
425
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-4">ops</span><span class="hl-1">.</span><span class="hl-5">ilike</span><span class="hl-1">(</span><span class="hl-6">&#39;%burpcollaborator%&#39;</span><span class="hl-1">) }).</span><span class="hl-5">updateAll</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-0">null</span><span class="hl-1"> })</span><br/><span class="hl-7">// 12</span>
426
426
  </code><button type="button">Copy</button></pre>
427
427
 
@@ -429,23 +429,23 @@ this will raise an exception.</p>
429
429
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">skipHooks</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>Options for updating the instance</p>
430
430
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">skip<wbr/>Hooks</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true, skips applying model hooks. Defaults to false</p>
431
431
  </div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The number of records that were updated</p>
432
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L2275">src/dream/Query.ts:2275</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="where" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>where</span><a href="#where" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="where.where-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">where</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#where.where-1.DB-11">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#where.where-1.Schema-6">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#where.where-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies a where statement to the Query instance</p>
432
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L2275">src/dream/Query.ts:2275</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="where" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>where</span><a href="#where" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="where.where-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">where</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#where.where-1.DB-11">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#where.where-1.Schema-6">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#where.where-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies a where statement to the Query instance</p>
433
433
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">where</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1"> }).</span><span class="hl-5">first</span><span class="hl-1">()</span><br/><span class="hl-7">// User{email: &#39;how@yadoin&#39;}</span>
434
434
  </code><button type="button">Copy</button></pre>
435
435
 
436
436
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="where.where-1.DB-11" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="where.where-1.Schema-6" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">whereStatement</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">WhereStatementForJoinedAssociation</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#where.where-1.DB-11">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#where.where-1.Schema-6">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Where statement to apply to the Query</p>
437
437
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A cloned Query with the where clause applied</p>
438
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1237">src/dream/Query.ts:1237</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="whereAny" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>where<wbr/>Any</span><a href="#whereAny" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="whereAny.whereAny-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">where<wbr/>Any</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereAny.whereAny-1.DB-12">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereAny.whereAny-1.Schema-7">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatements</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#whereAny.whereAny-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Accepts a list of where statements, each of
438
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1237">src/dream/Query.ts:1237</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="whereAny" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>where<wbr/>Any</span><a href="#whereAny" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="whereAny.whereAny-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">where<wbr/>Any</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereAny.whereAny-1.DB-12">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereAny.whereAny-1.Schema-7">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatements</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#whereAny.whereAny-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Accepts a list of where statements, each of
439
439
  which is combined via <code>OR</code></p>
440
440
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">whereAny</span><span class="hl-1">([{ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1"> }, { </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-6">&#39;fred&#39;</span><span class="hl-1"> }]).</span><span class="hl-5">first</span><span class="hl-1">()</span><br/><span class="hl-7">// [User{email: &#39;how@yadoin&#39;}, User{name: &#39;fred&#39;}, User{name: &#39;fred&#39;}]</span>
441
441
  </code><button type="button">Copy</button></pre>
442
442
 
443
443
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="whereAny.whereAny-1.DB-12" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="whereAny.whereAny-1.Schema-7" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">whereStatements</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">WhereStatementForJoinedAssociation</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereAny.whereAny-1.DB-12">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereAny.whereAny-1.Schema-7">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>a list of where statements to <code>OR</code> together</p>
444
444
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A cloned Query with the whereAny clause applied</p>
445
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1260">src/dream/Query.ts:1260</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="whereNot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>where<wbr/>Not</span><a href="#whereNot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="whereNot.whereNot-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">where<wbr/>Not</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereNot.whereNot-1.DB-13">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereNot.whereNot-1.Schema-8">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#whereNot.whereNot-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies a whereNot statement to the Query instance</p>
445
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1260">src/dream/Query.ts:1260</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="whereNot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>where<wbr/>Not</span><a href="#whereNot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="whereNot.whereNot-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">where<wbr/>Not</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereNot.whereNot-1.DB-13">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereNot.whereNot-1.Schema-8">Schema</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">whereStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span><a href="#whereNot.whereNot-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies a whereNot statement to the Query instance</p>
446
446
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">User</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">whereNot</span><span class="hl-1">({ </span><span class="hl-4">email:</span><span class="hl-1"> </span><span class="hl-6">&#39;how@yadoin&#39;</span><span class="hl-1"> }).</span><span class="hl-5">first</span><span class="hl-1">()</span><br/><span class="hl-7">// User{email: &#39;hello@world&#39;}</span>
447
447
  </code><button type="button">Copy</button></pre>
448
448
 
449
449
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="whereNot.whereNot-1.DB-13" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li><li><span><a id="whereNot.whereNot-1.Schema-8" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Schema</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">whereStatement</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">WhereStatementForJoinedAssociation</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;joinedAssociations&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereNot.whereNot-1.DB-13">DB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#whereNot.whereNot-1.Schema-8">Schema</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;rootTableName&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>A where statement to negate and apply to the Query</p>
450
450
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#constructor.new_Query.QueryTypeOpts-1">QueryTypeOpts</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A cloned Query with the whereNot clause applied</p>
451
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1286">src/dream/Query.ts:1286</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbDriverClass" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>db<wbr/>Driver<wbr/>Class</span><a href="#dbDriverClass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dbDriverClass.dbDriverClass-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Driver<wbr/>Class</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#dbDriverClass.dbDriverClass-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="QueryDriverBase.html" class="tsd-signature-type tsd-kind-class">QueryDriverBase</a><a href="#dbDriverClass.dbDriverClass-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="dbDriverClass.dbDriverClass-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connectionName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-keyword">typeof </span><a href="QueryDriverBase.html" class="tsd-signature-type tsd-kind-class">QueryDriverBase</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/bf66268be4face2a7678ae023c60356ed7938e66/src/dream/Query.ts#L1775">src/dream/Query.ts:1775</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#connectionOverride" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Override</span></a><a href="#dreamClass" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dream<wbr/>Class</span></a><a href="#dreamInstance-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dream<wbr/>Instance</span></a><a href="#dreamTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dream<wbr/>Transaction</span></a><a href="#innerJoinDreamClasses" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inner<wbr/>Join<wbr/>Dream<wbr/>Classes</span></a><a href="#queryTypeOpts-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>query<wbr/>Type<wbr/>Opts</span></a><a href="#BATCH_SIZES" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>BATCH_<wbr/>SIZES</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#connectionName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>connection<wbr/>Name</span></a><a href="#isDreamQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Dream<wbr/>Query</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#all" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>all</span></a><a href="#clone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a><a href="#connection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connection</span></a><a href="#count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count</span></a><a href="#dbDriverInstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Driver<wbr/>Instance</span></a><a href="#delete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#distinct" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>distinct</span></a><a href="#exists" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exists</span></a><a href="#find" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find</span></a><a href="#findBy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>By</span></a><a href="#findEach" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Each</span></a><a href="#findOrFail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Or<wbr/>Fail</span></a><a href="#findOrFailBy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Or<wbr/>Fail<wbr/>By</span></a><a href="#first" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>first</span></a><a href="#firstOrFail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>first<wbr/>Or<wbr/>Fail</span></a><a href="#innerJoin" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>inner<wbr/>Join</span></a><a href="#last" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>last</span></a><a href="#lastOrFail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>last<wbr/>Or<wbr/>Fail</span></a><a href="#leftJoin" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>left<wbr/>Join</span></a><a href="#leftJoinPreload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>left<wbr/>Join<wbr/>Preload</span></a><a href="#leftJoinPreloadFor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>left<wbr/>Join<wbr/>Preload<wbr/>For</span></a><a href="#limit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>limit</span></a><a href="#max" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>max</span></a><a href="#min" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a><a href="#nestedSelect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>nested<wbr/>Select</span></a><a href="#offset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>offset</span></a><a href="#order" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>order</span></a><a href="#paginate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>paginate</span></a><a href="#passthrough" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>passthrough</span></a><a href="#pluck" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pluck</span></a><a href="#pluckEach" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pluck<wbr/>Each</span></a><a href="#preload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preload</span></a><a href="#preloadFor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preload<wbr/>For</span></a><a href="#reallyDestroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>really<wbr/>Destroy</span></a><a href="#removeAllDefaultScopes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Default<wbr/>Scopes</span></a><a href="#removeAllDefaultScopesExceptOnAssociations" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Default<wbr/>Scopes<wbr/>Except<wbr/>On<wbr/>Associations</span></a><a href="#removeDefaultScope" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Default<wbr/>Scope</span></a><a href="#removeDefaultScopeExceptOnAssociations" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Default<wbr/>Scope<wbr/>Except<wbr/>On<wbr/>Associations</span></a><a href="#scrollPaginate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>scroll<wbr/>Paginate</span></a><a href="#sql" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sql</span></a><a href="#toKysely" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Kysely</span></a><a href="#txn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>txn</span></a><a href="#undestroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>undestroy</span></a><a href="#update" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a><a href="#where" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>where</span></a><a href="#whereAny" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>where<wbr/>Any</span></a><a href="#whereNot" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>where<wbr/>Not</span></a><a href="#dbDriverClass" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Driver<wbr/>Class</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
451
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1286">src/dream/Query.ts:1286</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbDriverClass" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>db<wbr/>Driver<wbr/>Class</span><a href="#dbDriverClass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dbDriverClass.dbDriverClass-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Driver<wbr/>Class</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Query.html#dbDriverClass.dbDriverClass-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="QueryDriverBase.html" class="tsd-signature-type tsd-kind-class">QueryDriverBase</a><a href="#dbDriverClass.dbDriverClass-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="dbDriverClass.dbDriverClass-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connectionName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-keyword">typeof </span><a href="QueryDriverBase.html" class="tsd-signature-type tsd-kind-class">QueryDriverBase</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/b54c9ad9b991601718e6a9905db8c21aecbef935/src/dream/Query.ts#L1775">src/dream/Query.ts:1775</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#connectionOverride" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Override</span></a><a href="#dreamClass" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dream<wbr/>Class</span></a><a href="#dreamInstance-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dream<wbr/>Instance</span></a><a href="#dreamTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dream<wbr/>Transaction</span></a><a href="#innerJoinDreamClasses" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inner<wbr/>Join<wbr/>Dream<wbr/>Classes</span></a><a href="#queryTypeOpts-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>query<wbr/>Type<wbr/>Opts</span></a><a href="#BATCH_SIZES" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>BATCH_<wbr/>SIZES</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#connectionName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>connection<wbr/>Name</span></a><a href="#isDreamQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Dream<wbr/>Query</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#all" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>all</span></a><a href="#clone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a><a href="#connection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connection</span></a><a href="#count" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count</span></a><a href="#dbDriverInstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Driver<wbr/>Instance</span></a><a href="#delete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#distinct" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>distinct</span></a><a href="#exists" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exists</span></a><a href="#find" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find</span></a><a href="#findBy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>By</span></a><a href="#findEach" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Each</span></a><a href="#findOrFail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Or<wbr/>Fail</span></a><a href="#findOrFailBy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Or<wbr/>Fail<wbr/>By</span></a><a href="#first" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>first</span></a><a href="#firstOrFail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>first<wbr/>Or<wbr/>Fail</span></a><a href="#innerJoin" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>inner<wbr/>Join</span></a><a href="#last" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>last</span></a><a href="#lastOrFail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>last<wbr/>Or<wbr/>Fail</span></a><a href="#leftJoin" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>left<wbr/>Join</span></a><a href="#leftJoinPreload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>left<wbr/>Join<wbr/>Preload</span></a><a href="#leftJoinPreloadFor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>left<wbr/>Join<wbr/>Preload<wbr/>For</span></a><a href="#limit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>limit</span></a><a href="#max" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>max</span></a><a href="#min" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>min</span></a><a href="#nestedSelect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>nested<wbr/>Select</span></a><a href="#offset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>offset</span></a><a href="#order" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>order</span></a><a href="#paginate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>paginate</span></a><a href="#passthrough" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>passthrough</span></a><a href="#pluck" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pluck</span></a><a href="#pluckEach" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pluck<wbr/>Each</span></a><a href="#preload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preload</span></a><a href="#preloadFor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preload<wbr/>For</span></a><a href="#reallyDestroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>really<wbr/>Destroy</span></a><a href="#removeAllDefaultScopes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Default<wbr/>Scopes</span></a><a href="#removeAllDefaultScopesExceptOnAssociations" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Default<wbr/>Scopes<wbr/>Except<wbr/>On<wbr/>Associations</span></a><a href="#removeDefaultScope" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Default<wbr/>Scope</span></a><a href="#removeDefaultScopeExceptOnAssociations" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Default<wbr/>Scope<wbr/>Except<wbr/>On<wbr/>Associations</span></a><a href="#scrollPaginate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>scroll<wbr/>Paginate</span></a><a href="#sql" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sql</span></a><a href="#toKysely" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Kysely</span></a><a href="#txn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>txn</span></a><a href="#undestroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>undestroy</span></a><a href="#update" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a><a href="#where" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>where</span></a><a href="#whereAny" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>where<wbr/>Any</span></a><a href="#whereNot" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>where<wbr/>Not</span></a><a href="#dbDriverClass" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Driver<wbr/>Class</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@rvoh/dream</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>