@rvoh/dream 2.3.0 → 2.3.1

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 (187) hide show
  1. package/dist/cjs/src/dream/QueryDriver/Kysely.js +11 -10
  2. package/dist/esm/src/dream/QueryDriver/Kysely.js +11 -10
  3. package/docs/classes/db.DreamMigrationHelpers.html +9 -9
  4. package/docs/classes/db.KyselyQueryDriver.html +32 -32
  5. package/docs/classes/db.PostgresQueryDriver.html +33 -33
  6. package/docs/classes/db.QueryDriverBase.html +31 -31
  7. package/docs/classes/errors.CheckConstraintViolation.html +3 -3
  8. package/docs/classes/errors.ColumnOverflow.html +3 -3
  9. package/docs/classes/errors.CreateOrFindByFailedToCreateAndFind.html +3 -3
  10. package/docs/classes/errors.DataIncompatibleWithDatabaseField.html +3 -3
  11. package/docs/classes/errors.DataTypeColumnTypeMismatch.html +3 -3
  12. package/docs/classes/errors.GlobalNameNotSet.html +3 -3
  13. package/docs/classes/errors.InvalidCalendarDate.html +2 -2
  14. package/docs/classes/errors.InvalidClockTime.html +2 -2
  15. package/docs/classes/errors.InvalidClockTimeTz.html +2 -2
  16. package/docs/classes/errors.InvalidDateTime.html +2 -2
  17. package/docs/classes/errors.MissingSerializersDefinition.html +3 -3
  18. package/docs/classes/errors.NonLoadedAssociation.html +3 -3
  19. package/docs/classes/errors.NotNullViolation.html +3 -3
  20. package/docs/classes/errors.RecordNotFound.html +3 -3
  21. package/docs/classes/errors.ValidationError.html +3 -3
  22. package/docs/classes/index.CalendarDate.html +33 -33
  23. package/docs/classes/index.ClockTime.html +32 -32
  24. package/docs/classes/index.ClockTimeTz.html +35 -35
  25. package/docs/classes/index.DateTime.html +71 -71
  26. package/docs/classes/index.Decorators.html +19 -19
  27. package/docs/classes/index.Dream.html +116 -116
  28. package/docs/classes/index.DreamApp.html +5 -5
  29. package/docs/classes/index.DreamTransaction.html +2 -2
  30. package/docs/classes/index.Env.html +2 -2
  31. package/docs/classes/index.Query.html +56 -56
  32. package/docs/classes/system.CliFileWriter.html +2 -2
  33. package/docs/classes/system.DreamBin.html +2 -2
  34. package/docs/classes/system.DreamCLI.html +5 -5
  35. package/docs/classes/system.DreamImporter.html +2 -2
  36. package/docs/classes/system.DreamLogos.html +2 -2
  37. package/docs/classes/system.DreamSerializerBuilder.html +8 -8
  38. package/docs/classes/system.ObjectSerializerBuilder.html +8 -8
  39. package/docs/classes/system.PathHelpers.html +3 -3
  40. package/docs/classes/utils.Encrypt.html +2 -2
  41. package/docs/classes/utils.Range.html +2 -2
  42. package/docs/functions/db.closeAllDbConnections.html +1 -1
  43. package/docs/functions/db.dreamDbConnections.html +1 -1
  44. package/docs/functions/db.untypedDb.html +1 -1
  45. package/docs/functions/db.validateColumn.html +1 -1
  46. package/docs/functions/db.validateTable.html +1 -1
  47. package/docs/functions/errors.pgErrorType.html +1 -1
  48. package/docs/functions/index.DreamSerializer.html +1 -1
  49. package/docs/functions/index.ObjectSerializer.html +1 -1
  50. package/docs/functions/index.ReplicaSafe.html +1 -1
  51. package/docs/functions/index.STI.html +1 -1
  52. package/docs/functions/index.SoftDelete.html +1 -1
  53. package/docs/functions/utils.camelize.html +1 -1
  54. package/docs/functions/utils.capitalize.html +1 -1
  55. package/docs/functions/utils.cloneDeepSafe.html +1 -1
  56. package/docs/functions/utils.compact.html +1 -1
  57. package/docs/functions/utils.groupBy.html +1 -1
  58. package/docs/functions/utils.hyphenize.html +1 -1
  59. package/docs/functions/utils.intersection.html +1 -1
  60. package/docs/functions/utils.isEmpty.html +1 -1
  61. package/docs/functions/utils.normalizeUnicode.html +1 -1
  62. package/docs/functions/utils.pascalize.html +1 -1
  63. package/docs/functions/utils.percent.html +1 -1
  64. package/docs/functions/utils.range-1.html +1 -1
  65. package/docs/functions/utils.round.html +1 -1
  66. package/docs/functions/utils.sanitizeString.html +1 -1
  67. package/docs/functions/utils.snakeify.html +1 -1
  68. package/docs/functions/utils.sort.html +1 -1
  69. package/docs/functions/utils.sortBy.html +1 -1
  70. package/docs/functions/utils.sortObjectByKey.html +1 -1
  71. package/docs/functions/utils.sortObjectByValue.html +1 -1
  72. package/docs/functions/utils.uncapitalize.html +1 -1
  73. package/docs/functions/utils.uniq.html +1 -1
  74. package/docs/interfaces/openapi.OpenapiDescription.html +2 -2
  75. package/docs/interfaces/openapi.OpenapiSchemaProperties.html +1 -1
  76. package/docs/interfaces/openapi.OpenapiSchemaPropertiesShorthand.html +1 -1
  77. package/docs/interfaces/openapi.OpenapiTypeFieldObject.html +1 -1
  78. package/docs/interfaces/types.BelongsToStatement.html +2 -2
  79. package/docs/interfaces/types.DecoratorContext.html +2 -2
  80. package/docs/interfaces/types.DreamAppInitOptions.html +2 -2
  81. package/docs/interfaces/types.DreamAppOpts.html +2 -2
  82. package/docs/interfaces/types.DurationObject.html +2 -2
  83. package/docs/interfaces/types.EncryptOptions.html +2 -2
  84. package/docs/interfaces/types.InternalAnyTypedSerializerRendersMany.html +2 -2
  85. package/docs/interfaces/types.InternalAnyTypedSerializerRendersOne.html +2 -2
  86. package/docs/interfaces/types.SerializerRendererOpts.html +2 -2
  87. package/docs/modules/db.html +1 -1
  88. package/docs/modules/errors.html +1 -1
  89. package/docs/modules/index.html +1 -1
  90. package/docs/modules/openapi.html +1 -1
  91. package/docs/modules/system.html +1 -1
  92. package/docs/modules/types.html +1 -1
  93. package/docs/modules/utils.html +1 -1
  94. package/docs/types/openapi.CommonOpenapiSchemaObjectFields.html +1 -1
  95. package/docs/types/openapi.OpenapiAllTypes.html +1 -1
  96. package/docs/types/openapi.OpenapiFormats.html +1 -1
  97. package/docs/types/openapi.OpenapiNumberFormats.html +1 -1
  98. package/docs/types/openapi.OpenapiPrimitiveBaseTypes.html +1 -1
  99. package/docs/types/openapi.OpenapiPrimitiveTypes.html +1 -1
  100. package/docs/types/openapi.OpenapiSchemaArray.html +1 -1
  101. package/docs/types/openapi.OpenapiSchemaArrayShorthand.html +1 -1
  102. package/docs/types/openapi.OpenapiSchemaBase.html +1 -1
  103. package/docs/types/openapi.OpenapiSchemaBody.html +1 -1
  104. package/docs/types/openapi.OpenapiSchemaBodyShorthand.html +1 -1
  105. package/docs/types/openapi.OpenapiSchemaCommonFields.html +1 -1
  106. package/docs/types/openapi.OpenapiSchemaExpressionAllOf.html +1 -1
  107. package/docs/types/openapi.OpenapiSchemaExpressionAnyOf.html +1 -1
  108. package/docs/types/openapi.OpenapiSchemaExpressionOneOf.html +1 -1
  109. package/docs/types/openapi.OpenapiSchemaExpressionRef.html +1 -1
  110. package/docs/types/openapi.OpenapiSchemaExpressionRefSchemaShorthand.html +1 -1
  111. package/docs/types/openapi.OpenapiSchemaInteger.html +1 -1
  112. package/docs/types/openapi.OpenapiSchemaNull.html +1 -1
  113. package/docs/types/openapi.OpenapiSchemaNumber.html +1 -1
  114. package/docs/types/openapi.OpenapiSchemaObject.html +1 -1
  115. package/docs/types/openapi.OpenapiSchemaObjectAllOf.html +1 -1
  116. package/docs/types/openapi.OpenapiSchemaObjectAllOfShorthand.html +1 -1
  117. package/docs/types/openapi.OpenapiSchemaObjectAnyOf.html +1 -1
  118. package/docs/types/openapi.OpenapiSchemaObjectAnyOfShorthand.html +1 -1
  119. package/docs/types/openapi.OpenapiSchemaObjectBase.html +1 -1
  120. package/docs/types/openapi.OpenapiSchemaObjectBaseShorthand.html +1 -1
  121. package/docs/types/openapi.OpenapiSchemaObjectOneOf.html +1 -1
  122. package/docs/types/openapi.OpenapiSchemaObjectOneOfShorthand.html +1 -1
  123. package/docs/types/openapi.OpenapiSchemaObjectShorthand.html +1 -1
  124. package/docs/types/openapi.OpenapiSchemaPrimitiveGeneric.html +1 -1
  125. package/docs/types/openapi.OpenapiSchemaShorthandExpressionAllOf.html +1 -1
  126. package/docs/types/openapi.OpenapiSchemaShorthandExpressionAnyOf.html +1 -1
  127. package/docs/types/openapi.OpenapiSchemaShorthandExpressionOneOf.html +1 -1
  128. package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializableRef.html +1 -1
  129. package/docs/types/openapi.OpenapiSchemaShorthandExpressionSerializerRef.html +1 -1
  130. package/docs/types/openapi.OpenapiSchemaShorthandPrimitiveGeneric.html +1 -1
  131. package/docs/types/openapi.OpenapiSchemaString.html +1 -1
  132. package/docs/types/openapi.OpenapiShorthandAllTypes.html +1 -1
  133. package/docs/types/openapi.OpenapiShorthandPrimitiveBaseTypes.html +1 -1
  134. package/docs/types/openapi.OpenapiShorthandPrimitiveTypes.html +1 -1
  135. package/docs/types/openapi.OpenapiTypeField.html +1 -1
  136. package/docs/types/system.DreamAppAllowedPackageManagersEnum.html +1 -1
  137. package/docs/types/types.CalendarDateDurationUnit.html +1 -1
  138. package/docs/types/types.CalendarDateObject.html +1 -1
  139. package/docs/types/types.Camelized.html +1 -1
  140. package/docs/types/types.ClockTimeObject.html +1 -1
  141. package/docs/types/types.DbConnectionType.html +1 -1
  142. package/docs/types/types.DbTypes.html +1 -1
  143. package/docs/types/types.DreamAssociationMetadata.html +1 -1
  144. package/docs/types/types.DreamAttributes.html +1 -1
  145. package/docs/types/types.DreamClassAssociationAndStatement.html +1 -1
  146. package/docs/types/types.DreamClassColumn.html +1 -1
  147. package/docs/types/types.DreamColumn.html +1 -1
  148. package/docs/types/types.DreamColumnNames.html +1 -1
  149. package/docs/types/types.DreamLogLevel.html +1 -1
  150. package/docs/types/types.DreamLogger.html +1 -1
  151. package/docs/types/types.DreamModelSerializerType.html +1 -1
  152. package/docs/types/types.DreamOrViewModelClassSerializerKey.html +1 -1
  153. package/docs/types/types.DreamOrViewModelSerializerKey.html +1 -1
  154. package/docs/types/types.DreamParamSafeAttributes.html +1 -1
  155. package/docs/types/types.DreamParamSafeColumnNames.html +1 -1
  156. package/docs/types/types.DreamSerializable.html +1 -1
  157. package/docs/types/types.DreamSerializableArray.html +1 -1
  158. package/docs/types/types.DreamSerializerKey.html +1 -1
  159. package/docs/types/types.DreamSerializers.html +1 -1
  160. package/docs/types/types.DreamVirtualColumns.html +1 -1
  161. package/docs/types/types.DurationUnit.html +1 -1
  162. package/docs/types/types.EncryptAlgorithm.html +1 -1
  163. package/docs/types/types.HasManyStatement.html +1 -1
  164. package/docs/types/types.HasOneStatement.html +1 -1
  165. package/docs/types/types.Hyphenized.html +1 -1
  166. package/docs/types/types.Pascalized.html +1 -1
  167. package/docs/types/types.PrimaryKeyType.html +1 -1
  168. package/docs/types/types.RoundingPrecision.html +1 -1
  169. package/docs/types/types.SerializerCasing.html +1 -1
  170. package/docs/types/types.SimpleObjectSerializerType.html +1 -1
  171. package/docs/types/types.Snakeified.html +1 -1
  172. package/docs/types/types.StrictInterface.html +1 -1
  173. package/docs/types/types.UpdateableAssociationProperties.html +1 -1
  174. package/docs/types/types.UpdateableProperties.html +1 -1
  175. package/docs/types/types.ValidationType.html +1 -1
  176. package/docs/types/types.ViewModel.html +1 -1
  177. package/docs/types/types.ViewModelClass.html +1 -1
  178. package/docs/types/types.WeekdayName.html +1 -1
  179. package/docs/types/types.WhereStatementForDream.html +1 -1
  180. package/docs/types/types.WhereStatementForDreamClass.html +1 -1
  181. package/docs/variables/index.DreamConst.html +1 -1
  182. package/docs/variables/index.ops.html +1 -1
  183. package/docs/variables/openapi.openapiPrimitiveTypes-1.html +1 -1
  184. package/docs/variables/openapi.openapiShorthandPrimitiveTypes-1.html +1 -1
  185. package/docs/variables/system.DreamAppAllowedPackageManagersEnumValues.html +1 -1
  186. package/docs/variables/system.primaryKeyTypes.html +1 -1
  187. package/package.json +1 -1
package/docs/classes/db.KyselyQueryDriver.html CHANGED
@@ -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>KyselyQueryDriver | @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="../index.html">@rvoh/dream</a></li><li><a href="../modules/db.html">db</a></li><li><a href="db.KyselyQueryDriver.html">KyselyQueryDriver</a></li></ul><h1>Class KyselyQueryDriver&lt;DreamInstance&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="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#db.KyselyQueryDriver">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="db.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">KyselyQueryDriver</span><ul class="tsd-hierarchy"><li><a href="db.PostgresQueryDriver.html" class="tsd-signature-type tsd-kind-class">PostgresQueryDriver</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L131">src/dream/QueryDriver/Kysely.ts:131</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="db.KyselyQueryDriver.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>KyselyQueryDriver | @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="../index.html">@rvoh/dream</a></li><li><a href="../modules/db.html">db</a></li><li><a href="db.KyselyQueryDriver.html">KyselyQueryDriver</a></li></ul><h1>Class KyselyQueryDriver&lt;DreamInstance&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="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#db.KyselyQueryDriver">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="db.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">KyselyQueryDriver</span><ul class="tsd-hierarchy"><li><a href="db.PostgresQueryDriver.html" class="tsd-signature-type tsd-kind-class">PostgresQueryDriver</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L130">src/dream/QueryDriver/Kysely.ts:130</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="db.KyselyQueryDriver.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="db.KyselyQueryDriver.html#connectionOverride" class="tsd-index-link tsd-is-protected tsd-is-inherited"><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="db.KyselyQueryDriver.html#dreamClass" class="tsd-index-link tsd-is-protected tsd-is-inherited"><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="db.KyselyQueryDriver.html#dreamInstance-2" class="tsd-index-link tsd-is-protected tsd-is-inherited"><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>
@@ -43,20 +43,20 @@
43
43
  <a href="db.KyselyQueryDriver.html#setDatabaseTypeParsers" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Database<wbr/>Type<wbr/>Parsers</span></a>
44
44
  <a href="db.KyselyQueryDriver.html#sync" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sync</span></a>
45
45
  <a href="db.KyselyQueryDriver.html#transaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>transaction</span></a>
46
- </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_KyselyQueryDriver" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Kysely<wbr/>Query<wbr/>Driver</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</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><a href="db.KyselyQueryDriver.html" class="tsd-signature-type tsd-kind-class">KyselyQueryDriver</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_KyselyQueryDriver" 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_KyselyQueryDriver.DreamInstance-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamInstance</span><span class="tsd-signature-keyword"> extends </span><a href="index.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">query</span>: <a href="index.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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></ul></div><h4 class="tsd-returns-title">Returns <a href="db.KyselyQueryDriver.html" class="tsd-signature-type tsd-kind-class">KyselyQueryDriver</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L28">src/dream/QueryDriver/Base.ts:28</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 tsd-is-inherited"><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/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#connectionOverride">connectionOverride</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L19">src/dream/QueryDriver/Base.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dreamClass">dreamClass</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L16">src/dream/QueryDriver/Base.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="dreamInstance-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dreamInstance-2">dreamInstance</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L17">src/dream/QueryDriver/Base.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="dreamTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</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="index.DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a href="index.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><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dreamTransaction">dreamTransaction</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L18">src/dream/QueryDriver/Base.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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="index.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>
47
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#innerJoinDreamClasses">innerJoinDreamClasses</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L26">src/dream/QueryDriver/Base.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="query" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query</span><a href="#query" 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</span><span class="tsd-signature-symbol">:</span> <a href="index.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#query">query</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L28">src/dream/QueryDriver/Base.ts:28</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="syncDialect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>sync<wbr/>Dialect</span><a href="#syncDialect" 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="syncDialect.syncDialect-1"><span class="tsd-signature-keyword">get</span> syncDialect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Overrides QueryDriverBase.syncDialect</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L317">src/dream/QueryDriver/Kysely.ts:317</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="avg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>avg</span><a href="#avg" 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="avg.avg-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">avg</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#avg.avg-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 average value of the specified column
46
+ </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_KyselyQueryDriver" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Kysely<wbr/>Query<wbr/>Driver</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</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><a href="db.KyselyQueryDriver.html" class="tsd-signature-type tsd-kind-class">KyselyQueryDriver</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_KyselyQueryDriver" 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_KyselyQueryDriver.DreamInstance-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamInstance</span><span class="tsd-signature-keyword"> extends </span><a href="index.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">query</span>: <a href="index.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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></ul></div><h4 class="tsd-returns-title">Returns <a href="db.KyselyQueryDriver.html" class="tsd-signature-type tsd-kind-class">KyselyQueryDriver</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L28">src/dream/QueryDriver/Base.ts:28</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 tsd-is-inherited"><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/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#connectionOverride">connectionOverride</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L19">src/dream/QueryDriver/Base.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dreamClass">dreamClass</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L16">src/dream/QueryDriver/Base.ts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="dreamInstance-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dreamInstance-2">dreamInstance</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L17">src/dream/QueryDriver/Base.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="dreamTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</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="index.DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a href="index.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><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dreamTransaction">dreamTransaction</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L18">src/dream/QueryDriver/Base.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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="index.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>
47
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#innerJoinDreamClasses">innerJoinDreamClasses</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L26">src/dream/QueryDriver/Base.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="query" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query</span><a href="#query" 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</span><span class="tsd-signature-symbol">:</span> <a href="index.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#query">query</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L28">src/dream/QueryDriver/Base.ts:28</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="syncDialect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>sync<wbr/>Dialect</span><a href="#syncDialect" 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="syncDialect.syncDialect-1"><span class="tsd-signature-keyword">get</span> syncDialect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Overrides QueryDriverBase.syncDialect</p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L316">src/dream/QueryDriver/Kysely.ts:316</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="avg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>avg</span><a href="#avg" 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="avg.avg-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">avg</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#avg.avg-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 average value of the specified column
48
48
  for this Query</p>
49
49
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">Game</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">avg</span><span class="hl-1">(</span><span class="hl-6">&#39;score&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// 1</span>
50
50
  </code><button type="button">Copy</button></pre>
51
51
 
52
52
  </div><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>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>a column name on the model</p>
53
53
  </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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the average of the values of the specified column for this Query</p>
54
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#avg">avg</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L673">src/dream/QueryDriver/Kysely.ts:673</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 in the database</p>
54
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#avg">avg</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L672">src/dream/QueryDriver/Kysely.ts:672</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 in the database</p>
55
55
  <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>
56
56
  </code><button type="button">Copy</button></pre>
57
57
 
58
58
  </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 in the database</p>
59
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#count">count</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L695">src/dream/QueryDriver/Kysely.ts:695</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbConnectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db<wbr/>Connection<wbr/>Type</span><a href="#dbConnectionType" 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="dbConnectionType.dbConnectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Connection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sqlCommandType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a><a href="#dbConnectionType.dbConnectionType-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">sqlCommandType</span>: <span class="tsd-signature-type">SqlCommandType</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L845">src/dream/QueryDriver/Kysely.ts:845</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbFor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db<wbr/>For</span><a href="#dbFor" 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="dbFor.dbFor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>For</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sqlCommandType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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">&gt;</span><a href="#dbFor.dbFor-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">sqlCommandType</span>: <span class="tsd-signature-type">SqlCommandType</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L140">src/dream/QueryDriver/Kysely.ts:140</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbResultToDreamInstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db<wbr/>Result<wbr/>To<wbr/>Dream<wbr/>Instance</span><a href="#dbResultToDreamInstance" 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="dbResultToDreamInstance.dbResultToDreamInstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Result<wbr/>To<wbr/>Dream<wbr/>Instance</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.DreamClass-1">DreamClass</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.RetType">RetType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span>, <span class="tsd-kind-parameter">dreamClass</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.RetType">RetType</a><a href="#dbResultToDreamInstance.dbResultToDreamInstance-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>This method is used internally by a Query driver to
59
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#count">count</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L694">src/dream/QueryDriver/Kysely.ts:694</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbConnectionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db<wbr/>Connection<wbr/>Type</span><a href="#dbConnectionType" 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="dbConnectionType.dbConnectionType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Connection<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sqlCommandType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a><a href="#dbConnectionType.dbConnectionType-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">sqlCommandType</span>: <span class="tsd-signature-type">SqlCommandType</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L846">src/dream/QueryDriver/Kysely.ts:846</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbFor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db<wbr/>For</span><a href="#dbFor" 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="dbFor.dbFor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>For</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sqlCommandType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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">&gt;</span><a href="#dbFor.dbFor-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">sqlCommandType</span>: <span class="tsd-signature-type">SqlCommandType</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L139">src/dream/QueryDriver/Kysely.ts:139</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbResultToDreamInstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>db<wbr/>Result<wbr/>To<wbr/>Dream<wbr/>Instance</span><a href="#dbResultToDreamInstance" 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="dbResultToDreamInstance.dbResultToDreamInstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Result<wbr/>To<wbr/>Dream<wbr/>Instance</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.DreamClass-1">DreamClass</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.RetType">RetType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span>, <span class="tsd-kind-parameter">dreamClass</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.RetType">RetType</a><a href="#dbResultToDreamInstance.dbResultToDreamInstance-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>This method is used internally by a Query driver to
60
60
  take the result of a single row in a database, and
61
61
  turn that row into the provided dream instance.</p>
62
62
  <p>If needed, the return type can be overriden to
@@ -66,46 +66,46 @@ cannot be inferred, i.e.</p>
66
66
  <pre><code class="ts"><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-5">dbResultToDreamInstance</span><span class="hl-1">&lt;</span><span class="hl-0">typeof</span><span class="hl-1"> </span><span class="hl-4">Dream</span><span class="hl-1">, </span><span class="hl-9">DreamInstance</span><span class="hl-1">&gt;(</span><span class="hl-4">result</span><span class="hl-1">, </span><span class="hl-0">this</span><span class="hl-1">.</span><span class="hl-4">dreamClass</span><span class="hl-1">)</span>
67
67
  </code><button type="button">Copy</button></pre>
68
68
 
69
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="dbResultToDreamInstance.dbResultToDreamInstance-1.DreamClass-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamClass</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">typeof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="dbResultToDreamInstance.dbResultToDreamInstance-1.RetType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetType</span> = <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.DreamClass-1">DreamClass</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">result</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">dreamClass</span>: <span class="tsd-signature-keyword">typeof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.RetType">RetType</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dbResultToDreamInstance">dbResultToDreamInstance</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L491">src/dream/QueryDriver/Kysely.ts:491</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>executes provided query instance as a deletion query.</p>
69
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="dbResultToDreamInstance.dbResultToDreamInstance-1.DreamClass-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamClass</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">typeof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="dbResultToDreamInstance.dbResultToDreamInstance-1.RetType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetType</span> = <span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.DreamClass-1">DreamClass</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">result</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">dreamClass</span>: <span class="tsd-signature-keyword">typeof </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbResultToDreamInstance.dbResultToDreamInstance-1.RetType">RetType</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dbResultToDreamInstance">dbResultToDreamInstance</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L490">src/dream/QueryDriver/Kysely.ts:490</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>executes provided query instance as a deletion query.</p>
70
70
  </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 deleted rows</p>
71
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#delete">delete</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L778">src/dream/QueryDriver/Kysely.ts:778</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hydrateAssociation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hydrate<wbr/>Association</span><a href="#hydrateAssociation" 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="hydrateAssociation.hydrateAssociation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hydrate<wbr/>Association</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dreams</span>, <span class="tsd-kind-parameter">association</span>, <span class="tsd-kind-parameter">preloadedDreamsAndWhatTheyPointTo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#hydrateAssociation.hydrateAssociation-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>Used to hydrate dreams with the provided associations</p>
72
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dreams</span>: <a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">association</span>: <span class="tsd-signature-type">AssociationStatement</span></span></li><li><span><span class="tsd-kind-parameter">preloadedDreamsAndWhatTheyPointTo</span>: <span class="tsd-signature-type">PreloadedDreamsAndWhatTheyPointTo</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#hydrateAssociation">hydrateAssociation</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L1004">src/dream/QueryDriver/Kysely.ts:1004</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hydratePreload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hydrate<wbr/>Preload</span><a href="#hydratePreload" 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="hydratePreload.hydratePreload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hydrate<wbr/>Preload</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">dream</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="#hydratePreload.hydratePreload-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>Used by loadBuider</p>
73
- </div><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="db.KyselyQueryDriver.html" class="tsd-signature-type tsd-kind-class">KyselyQueryDriver</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><span class="tsd-kind-parameter">dream</span>: <a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#hydratePreload">hydratePreload</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L1052">src/dream/QueryDriver/Kysely.ts:1052</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">(</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><span class="tsd-signature-type">any</span><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
71
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#delete">delete</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L779">src/dream/QueryDriver/Kysely.ts:779</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hydrateAssociation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hydrate<wbr/>Association</span><a href="#hydrateAssociation" 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="hydrateAssociation.hydrateAssociation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hydrate<wbr/>Association</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dreams</span>, <span class="tsd-kind-parameter">association</span>, <span class="tsd-kind-parameter">preloadedDreamsAndWhatTheyPointTo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#hydrateAssociation.hydrateAssociation-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>Used to hydrate dreams with the provided associations</p>
72
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dreams</span>: <a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">association</span>: <span class="tsd-signature-type">AssociationStatement</span></span></li><li><span><span class="tsd-kind-parameter">preloadedDreamsAndWhatTheyPointTo</span>: <span class="tsd-signature-type">PreloadedDreamsAndWhatTheyPointTo</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#hydrateAssociation">hydrateAssociation</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L1005">src/dream/QueryDriver/Kysely.ts:1005</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hydratePreload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hydrate<wbr/>Preload</span><a href="#hydratePreload" 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="hydratePreload.hydratePreload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hydrate<wbr/>Preload</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">dream</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="#hydratePreload.hydratePreload-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>Used by loadBuider</p>
73
+ </div><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="db.KyselyQueryDriver.html" class="tsd-signature-type tsd-kind-class">KyselyQueryDriver</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span></li><li><span><span class="tsd-kind-parameter">dream</span>: <a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#hydratePreload">hydratePreload</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L1053">src/dream/QueryDriver/Kysely.ts:1053</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">(</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><span class="tsd-signature-type">any</span><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
74
74
  for this Query</p>
75
75
  <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>
76
76
  </code><button type="button">Copy</button></pre>
77
77
 
78
78
  </div><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>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>a column name on the model</p>
79
79
  </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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the max value of the specified column for this Query</p>
80
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#max">max</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L595">src/dream/QueryDriver/Kysely.ts:595</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">(</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><span class="tsd-signature-type">any</span><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
80
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#max">max</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L594">src/dream/QueryDriver/Kysely.ts:594</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">(</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><span class="tsd-signature-type">any</span><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
81
81
  for this Query</p>
82
82
  <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>
83
83
  </code><button type="button">Copy</button></pre>
84
84
 
85
85
  </div><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>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>a column name on the model</p>
86
86
  </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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the min value of the specified column for this Query</p>
87
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#min">min</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L622">src/dream/QueryDriver/Kysely.ts:622</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="db.KyselyQueryDriver.html#nestedSelect.nestedSelect-1.SimpleFieldType">SimpleFieldType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.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
87
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#min">min</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L621">src/dream/QueryDriver/Kysely.ts:621</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="db.KyselyQueryDriver.html#nestedSelect.nestedSelect-1.SimpleFieldType">SimpleFieldType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.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
88
88
  in a sub Query</p>
89
89
  <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>
90
90
  </code><button type="button">Copy</button></pre>
91
91
 
92
92
  </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;toString&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;valueOf&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></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="db.KyselyQueryDriver.html" class="tsd-signature-type tsd-kind-class">KyselyQueryDriver</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</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="db.KyselyQueryDriver.html#nestedSelect.nestedSelect-1.SimpleFieldType">SimpleFieldType</a><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#nestedSelect.nestedSelect-1.PluckThroughFieldType">PluckThroughFieldType</a></span><div class="tsd-comment tsd-typography"><p>the column to use for your nested Query</p>
93
93
  </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>
94
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#nestedSelect">nestedSelect</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L760">src/dream/QueryDriver/Kysely.ts:760</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="orderByDirection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>order<wbr/>By<wbr/>Direction</span><a href="#orderByDirection" 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="orderByDirection.orderByDirection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">order<wbr/>By<wbr/>Direction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">OrderByItemBuilder</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">OrderByItemBuilder</span><span class="tsd-signature-symbol">)</span><a href="#orderByDirection.orderByDirection-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">direction</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OrderDir</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">OrderByItemBuilder</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">OrderByItemBuilder</span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="orderByDirection.orderByDirection-1.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">OrderByItemBuilder</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">obj</span>: <span class="tsd-signature-type">OrderByItemBuilder</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OrderByItemBuilder</span></h4></li></ul></li></ul><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L980">src/dream/QueryDriver/Kysely.ts:980</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">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">fields</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">any</span><span class="tsd-signature-symbol">[]</span><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"><code class="tsd-tag">Internal</code><div class="tsd-comment tsd-typography"><p>Runs the query and extracts plucked values</p>
94
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#nestedSelect">nestedSelect</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L761">src/dream/QueryDriver/Kysely.ts:761</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="orderByDirection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>order<wbr/>By<wbr/>Direction</span><a href="#orderByDirection" 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="orderByDirection.orderByDirection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">order<wbr/>By<wbr/>Direction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">OrderByItemBuilder</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">OrderByItemBuilder</span><span class="tsd-signature-symbol">)</span><a href="#orderByDirection.orderByDirection-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">direction</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">OrderDir</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">OrderByItemBuilder</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">OrderByItemBuilder</span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="orderByDirection.orderByDirection-1.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">OrderByItemBuilder</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">obj</span>: <span class="tsd-signature-type">OrderByItemBuilder</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OrderByItemBuilder</span></h4></li></ul></li></ul><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L981">src/dream/QueryDriver/Kysely.ts:981</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">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">fields</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">any</span><span class="tsd-signature-symbol">[]</span><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"><code class="tsd-tag">Internal</code><div class="tsd-comment tsd-typography"><p>Runs the query and extracts plucked values</p>
95
95
  </div><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">fields</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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></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">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>An array of plucked values</p>
96
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#pluck">pluck</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L724">src/dream/QueryDriver/Kysely.ts:724</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-symbol">{}</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>
96
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#pluck">pluck</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L723">src/dream/QueryDriver/Kysely.ts:723</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-symbol">{}</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>
97
97
  <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>
98
98
  </code><button type="button">Copy</button></pre>
99
99
 
100
100
  </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-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></h4><p>An object representing the underlying sql statement</p>
101
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#sql">sql</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L896">src/dream/QueryDriver/Kysely.ts:896</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sum" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sum</span><a href="#sum" 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="sum.sum-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sum</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#sum.sum-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 sum value of the specified column
101
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#sql">sql</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L897">src/dream/QueryDriver/Kysely.ts:897</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sum" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sum</span><a href="#sum" 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="sum.sum-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sum</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#sum.sum-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 sum value of the specified column
102
102
  for this Query</p>
103
103
  <pre><code class="ts"><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">Game</span><span class="hl-1">.</span><span class="hl-5">query</span><span class="hl-1">().</span><span class="hl-5">sum</span><span class="hl-1">(</span><span class="hl-6">&#39;score&#39;</span><span class="hl-1">)</span><br/><span class="hl-7">// 1</span>
104
104
  </code><button type="button">Copy</button></pre>
105
105
 
106
106
  </div><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>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>a column name on the model</p>
107
107
  </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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the sum of the values of the specified column for this Query</p>
108
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#sum">sum</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L648">src/dream/QueryDriver/Kysely.ts:648</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="takeAll" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>take<wbr/>All</span><a href="#takeAll" 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="takeAll.takeAll-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">take<wbr/>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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#takeAll.takeAll-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>Retrieves an array containing all records matching the Query.
108
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#sum">sum</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L647">src/dream/QueryDriver/Kysely.ts:647</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="takeAll" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>take<wbr/>All</span><a href="#takeAll" 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="takeAll.takeAll-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">take<wbr/>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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#takeAll.takeAll-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>Retrieves an array containing all records matching the Query.
109
109
  Be careful using this, since it will attempt to pull every
110
110
  record into memory at once. When querying might return a large
111
111
  number of records, consider using <code>.findEach</code>, which will pull
@@ -114,53 +114,53 @@ the records in batches.</p>
114
114
  </code><button type="button">Copy</button></pre>
115
115
 
116
116
  </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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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><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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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></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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>an array of dreams</p>
117
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#takeAll">takeAll</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L563">src/dream/QueryDriver/Kysely.ts:563</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="takeOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>take<wbr/>One</span><a href="#takeOne" 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="takeOne.takeOne-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">take<wbr/>One</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#takeOne.takeOne-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>Used for applying first and last queries</p>
117
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#takeAll">takeAll</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L562">src/dream/QueryDriver/Kysely.ts:562</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="takeOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>take<wbr/>One</span><a href="#takeOne" 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="takeOne.takeOne-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">take<wbr/>One</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span><a href="#takeOne.takeOne-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>Used for applying first and last queries</p>
118
118
  </div><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="db.KyselyQueryDriver.html" class="tsd-signature-type tsd-kind-class">KyselyQueryDriver</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span></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="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A dream instance or null</p>
119
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#takeOne">takeOne</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L505">src/dream/QueryDriver/Kysely.ts:505</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="db.KyselyQueryDriver.html#toKysely.toKysely-1.QueryType">QueryType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#toKysely.toKysely-1.TableNames">TableNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.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="db.KyselyQueryDriver.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
119
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#takeOne">takeOne</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L504">src/dream/QueryDriver/Kysely.ts:504</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="db.KyselyQueryDriver.html#toKysely.toKysely-1.QueryType">QueryType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#toKysely.toKysely-1.TableNames">TableNames</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.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="db.KyselyQueryDriver.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
120
120
  you to build custom queries using the Kysely API</p>
121
121
  <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>
122
122
  </code><button type="button">Copy</button></pre>
123
123
 
124
124
  </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;delete&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;select&quot;</span></span></li><li><span><a id="toKysely.toKysely-1.DbType" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DbType</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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></li><li><span><a id="toKysely.toKysely-1.TableNames" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TableNames</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.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="db.KyselyQueryDriver.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="db.KyselyQueryDriver.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.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="db.KyselyQueryDriver.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="db.KyselyQueryDriver.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="db.KyselyQueryDriver.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.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="db.KyselyQueryDriver.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="db.KyselyQueryDriver.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="db.KyselyQueryDriver.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.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="db.KyselyQueryDriver.html#toKysely.toKysely-1.DbType">DbType</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.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="db.KyselyQueryDriver.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="db.KyselyQueryDriver.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>
125
125
  </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="db.KyselyQueryDriver.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>
126
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#toKysely">toKysely</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L397">src/dream/QueryDriver/Kysely.ts:397</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-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>executes provided query instance as an update query.</p>
126
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#toKysely">toKysely</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L396">src/dream/QueryDriver/Kysely.ts:396</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-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>executes provided query instance as an update query.</p>
127
127
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">attributes</span>: <span class="tsd-signature-type">DreamTableSchema</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#constructor.new_KyselyQueryDriver.DreamInstance-1">DreamInstance</a><span class="tsd-signature-symbol">&gt;</span></span></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 updated rows</p>
128
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#update">update</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L787">src/dream/QueryDriver/Kysely.ts:787</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="dbCreate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>db<wbr/>Create</span><a href="#dbCreate" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="dbCreate.dbCreate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Create</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-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="#dbCreate.dbCreate-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>create the database. Must respond to the NODE_ENV value.</p>
129
- </div><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-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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dbCreate">dbCreate</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L67">src/dream/QueryDriver/Base.ts:67</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="dbDrop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>db<wbr/>Drop</span><a href="#dbDrop" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="dbDrop.dbDrop-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Drop</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-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="#dbDrop.dbDrop-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>delete the database. Must respond to the NODE_ENV value.</p>
130
- </div><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-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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dbDrop">dbDrop</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L78">src/dream/QueryDriver/Base.ts:78</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbFor-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>db<wbr/>For</span><a href="#dbFor-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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dbFor-2.dbFor-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>For</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">dbConnectionType</span>, <span class="tsd-kind-parameter">dreamTransaction</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span><a href="#dbFor-2.dbFor-3" 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="dbFor-2.dbFor-3.I" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">I</span><span class="tsd-signature-keyword"> extends </span><a href="index.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><li><span><span class="tsd-kind-parameter">dbConnectionType</span>: <a href="../types/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">dreamTransaction</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="index.DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L156">src/dream/QueryDriver/Kysely.ts:156</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="destroyDream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>destroy<wbr/>Dream</span><a href="#destroyDream" 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="destroyDream.destroyDream-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy<wbr/>Dream</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dream</span>, <span class="tsd-kind-parameter">txn</span>, <span class="tsd-kind-parameter">reallyDestroy</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="#destroyDream.destroyDream-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 a dream, possibly implementing soft delete if reallyDestroy is false
128
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#update">update</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L788">src/dream/QueryDriver/Kysely.ts:788</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="dbCreate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>db<wbr/>Create</span><a href="#dbCreate" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="dbCreate.dbCreate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Create</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-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="#dbCreate.dbCreate-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>create the database. Must respond to the NODE_ENV value.</p>
129
+ </div><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-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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dbCreate">dbCreate</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L67">src/dream/QueryDriver/Base.ts:67</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="dbDrop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>db<wbr/>Drop</span><a href="#dbDrop" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="dbDrop.dbDrop-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>Drop</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-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="#dbDrop.dbDrop-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>delete the database. Must respond to the NODE_ENV value.</p>
130
+ </div><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-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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#dbDrop">dbDrop</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L78">src/dream/QueryDriver/Base.ts:78</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dbFor-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>db<wbr/>For</span><a href="#dbFor-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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="dbFor-2.dbFor-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">db<wbr/>For</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">dbConnectionType</span>, <span class="tsd-kind-parameter">dreamTransaction</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span><a href="#dbFor-2.dbFor-3" 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="dbFor-2.dbFor-3.I" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">I</span><span class="tsd-signature-keyword"> extends </span><a href="index.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><li><span><span class="tsd-kind-parameter">dbConnectionType</span>: <a href="../types/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">dreamTransaction</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="index.DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Kysely</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#dbFor-2.dbFor-3.I">I</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">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L155">src/dream/QueryDriver/Kysely.ts:155</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="destroyDream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>destroy<wbr/>Dream</span><a href="#destroyDream" 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="destroyDream.destroyDream-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy<wbr/>Dream</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dream</span>, <span class="tsd-kind-parameter">txn</span>, <span class="tsd-kind-parameter">reallyDestroy</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="#destroyDream.destroyDream-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 a dream, possibly implementing soft delete if reallyDestroy is false
131
131
  and the record being deleted implements soft delete.</p>
132
132
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dream</span>: <a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span><div class="tsd-comment tsd-typography"><p>the dream instance you wish to destroy</p>
133
133
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">txn</span>: <a href="index.DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a href="index.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 transaction to encapsulate, consistently provided by underlying dream mechanisms</p>
134
134
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">reallyDestroy</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>whether or not to reallyDestroy. If false, soft delete will be attempted when relevant</p>
135
- </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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#destroyDream">destroyDream</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L371">src/dream/QueryDriver/Kysely.ts:371</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dialectProvider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>dialect<wbr/>Provider</span><a href="#dialectProvider" 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="dialectProvider.dialectProvider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dialect<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">dbConnectionType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DialectProviderCb</span><a href="#dialectProvider.dialectProvider-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">connectionName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">dbConnectionType</span>: <a href="../types/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DialectProviderCb</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L169">src/dream/QueryDriver/Kysely.ts:169</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="duplicateDatabase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>duplicate<wbr/>Database</span><a href="#duplicateDatabase" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="duplicateDatabase.duplicateDatabase-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">duplicate<wbr/>Database</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-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="#duplicateDatabase.duplicateDatabase-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">connectionName</span>: <span class="tsd-signature-type">string</span></span></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><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#duplicateDatabase">duplicateDatabase</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L219">src/dream/QueryDriver/Base.ts:219</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="ensureAllMigrationsHaveBeenRun" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>ensure<wbr/>All<wbr/>Migrations<wbr/>Have<wbr/>Been<wbr/>Run</span><a href="#ensureAllMigrationsHaveBeenRun" 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="ensureAllMigrationsHaveBeenRun.ensureAllMigrationsHaveBeenRun-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ensure<wbr/>All<wbr/>Migrations<wbr/>Have<wbr/>Been<wbr/>Run</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-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="#ensureAllMigrationsHaveBeenRun.ensureAllMigrationsHaveBeenRun-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">connectionName</span>: <span class="tsd-signature-type">string</span></span></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><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#ensureAllMigrationsHaveBeenRun">ensureAllMigrationsHaveBeenRun</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L186">src/dream/QueryDriver/Kysely.ts:186</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="enumType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>enum<wbr/>Type</span><a href="#enumType" 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="enumType.enumType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enum<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Capitalize</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#enumType.enumType-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>this is used by getColumnData to serialize enums</p>
136
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <span class="tsd-signature-type">SchemaBuilderInformationSchemaRow</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Capitalize</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L470">src/dream/QueryDriver/Kysely.ts:470</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="foreignKeyTypeFromPrimaryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>foreign<wbr/>Key<wbr/>Type<wbr/>From<wbr/>Primary<wbr/>Key</span><a href="#foreignKeyTypeFromPrimaryKey" 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="foreignKeyTypeFromPrimaryKey.foreignKeyTypeFromPrimaryKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">foreign<wbr/>Key<wbr/>Type<wbr/>From<wbr/>Primary<wbr/>Key</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">&quot;bigint&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;integer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;uuid&quot;</span><a href="#foreignKeyTypeFromPrimaryKey.foreignKeyTypeFromPrimaryKey-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 the foreign key type based on the primary key received.
135
+ </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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#destroyDream">destroyDream</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L370">src/dream/QueryDriver/Kysely.ts:370</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="dialectProvider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>dialect<wbr/>Provider</span><a href="#dialectProvider" 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="dialectProvider.dialectProvider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dialect<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">dbConnectionType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DialectProviderCb</span><a href="#dialectProvider.dialectProvider-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">connectionName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">dbConnectionType</span>: <a href="../types/types.DbConnectionType.html" class="tsd-signature-type tsd-kind-type-alias">DbConnectionType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DialectProviderCb</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L168">src/dream/QueryDriver/Kysely.ts:168</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="duplicateDatabase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>duplicate<wbr/>Database</span><a href="#duplicateDatabase" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="duplicateDatabase.duplicateDatabase-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">duplicate<wbr/>Database</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-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="#duplicateDatabase.duplicateDatabase-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">connectionName</span>: <span class="tsd-signature-type">string</span></span></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><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#duplicateDatabase">duplicateDatabase</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L219">src/dream/QueryDriver/Base.ts:219</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="ensureAllMigrationsHaveBeenRun" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>ensure<wbr/>All<wbr/>Migrations<wbr/>Have<wbr/>Been<wbr/>Run</span><a href="#ensureAllMigrationsHaveBeenRun" 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="ensureAllMigrationsHaveBeenRun.ensureAllMigrationsHaveBeenRun-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ensure<wbr/>All<wbr/>Migrations<wbr/>Have<wbr/>Been<wbr/>Run</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-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="#ensureAllMigrationsHaveBeenRun.ensureAllMigrationsHaveBeenRun-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">connectionName</span>: <span class="tsd-signature-type">string</span></span></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><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#ensureAllMigrationsHaveBeenRun">ensureAllMigrationsHaveBeenRun</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L185">src/dream/QueryDriver/Kysely.ts:185</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="enumType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>enum<wbr/>Type</span><a href="#enumType" 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="enumType.enumType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enum<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Capitalize</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#enumType.enumType-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>this is used by getColumnData to serialize enums</p>
136
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <span class="tsd-signature-type">SchemaBuilderInformationSchemaRow</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Capitalize</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L469">src/dream/QueryDriver/Kysely.ts:469</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="foreignKeyTypeFromPrimaryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>foreign<wbr/>Key<wbr/>Type<wbr/>From<wbr/>Primary<wbr/>Key</span><a href="#foreignKeyTypeFromPrimaryKey" 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="foreignKeyTypeFromPrimaryKey.foreignKeyTypeFromPrimaryKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">foreign<wbr/>Key<wbr/>Type<wbr/>From<wbr/>Primary<wbr/>Key</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">&quot;bigint&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;integer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;uuid&quot;</span><a href="#foreignKeyTypeFromPrimaryKey.foreignKeyTypeFromPrimaryKey-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 the foreign key type based on the primary key received.
137
137
  gives the driver the opportunity to switch i.e. bigserial to bigint.</p>
138
- </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">LegacyCompatiblePrimaryKeyType</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;bigint&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;integer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;uuid&quot;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#foreignKeyTypeFromPrimaryKey">foreignKeyTypeFromPrimaryKey</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L327">src/dream/QueryDriver/Kysely.ts:327</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="generateMigration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>generate<wbr/>Migration</span><a href="#generateMigration" 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="generateMigration.generateMigration-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>Migration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">migrationName</span>, <span class="tsd-kind-parameter">columnsWithTypes</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="#generateMigration.generateMigration-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>This should build a new migration file in the migrations folder
138
+ </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">LegacyCompatiblePrimaryKeyType</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;bigint&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;integer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;uuid&quot;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#foreignKeyTypeFromPrimaryKey">foreignKeyTypeFromPrimaryKey</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L326">src/dream/QueryDriver/Kysely.ts:326</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="generateMigration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>generate<wbr/>Migration</span><a href="#generateMigration" 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="generateMigration.generateMigration-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>Migration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">migrationName</span>, <span class="tsd-kind-parameter">columnsWithTypes</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="#generateMigration.generateMigration-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>This should build a new migration file in the migrations folder
139
139
  of your application. This will then need to be read and run
140
140
  whenever the <code>migrate</code> method is called. The filename should
141
141
  contain a timestamp at the front of the filename, so that it
142
142
  is sorted by date in the file tree, and, more importantly, so
143
143
  they can be run in order by your migration runner.</p>
144
- </div><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><li><span><span class="tsd-kind-parameter">migrationName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">columnsWithTypes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#generateMigration">generateMigration</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L243">src/dream/QueryDriver/Kysely.ts:243</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getColumnData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>get<wbr/>Column<wbr/>Data</span><a href="#getColumnData" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getColumnData.getColumnData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Column<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">tableName</span>, <span class="tsd-kind-parameter">allTableAssociationData</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-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SchemaBuilderColumnData</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><a href="#getColumnData.getColumnData-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">connectionName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">tableName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">allTableAssociationData</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SchemaBuilderAssociationData</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">SchemaBuilderAssociationData</span></h5></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-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SchemaBuilderColumnData</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#getColumnData">getColumnData</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L222">src/dream/QueryDriver/Base.ts:222</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="migrate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>migrate</span><a href="#migrate" 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="migrate.migrate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">migrate</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-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="#migrate.migrate-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>migrate the database. Must respond to the NODE_ENV value.</p>
145
- </div><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-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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#migrate">migrate</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L198">src/dream/QueryDriver/Kysely.ts:198</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="primaryKeyType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>primary<wbr/>Key<wbr/>Type</span><a href="#primaryKeyType" 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="primaryKeyType.primaryKeyType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">primary<wbr/>Key<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LegacyCompatiblePrimaryKeyType</span><a href="#primaryKeyType.primaryKeyType-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>used to return the computed primary key type based
144
+ </div><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><li><span><span class="tsd-kind-parameter">migrationName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">columnsWithTypes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#generateMigration">generateMigration</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L242">src/dream/QueryDriver/Kysely.ts:242</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getColumnData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>get<wbr/>Column<wbr/>Data</span><a href="#getColumnData" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getColumnData.getColumnData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Column<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">tableName</span>, <span class="tsd-kind-parameter">allTableAssociationData</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-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SchemaBuilderColumnData</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><a href="#getColumnData.getColumnData-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">connectionName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">tableName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">allTableAssociationData</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SchemaBuilderAssociationData</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">SchemaBuilderAssociationData</span></h5></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-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SchemaBuilderColumnData</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#getColumnData">getColumnData</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L222">src/dream/QueryDriver/Base.ts:222</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="migrate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>migrate</span><a href="#migrate" 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="migrate.migrate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">migrate</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-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="#migrate.migrate-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>migrate the database. Must respond to the NODE_ENV value.</p>
145
+ </div><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-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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#migrate">migrate</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L197">src/dream/QueryDriver/Kysely.ts:197</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="primaryKeyType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>primary<wbr/>Key<wbr/>Type</span><a href="#primaryKeyType" 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="primaryKeyType.primaryKeyType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">primary<wbr/>Key<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LegacyCompatiblePrimaryKeyType</span><a href="#primaryKeyType.primaryKeyType-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>used to return the computed primary key type based
146
146
  on the primaryKeyType set in the DreamApp class.</p>
147
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">LegacyCompatiblePrimaryKeyType</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#primaryKeyType">primaryKeyType</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L337">src/dream/QueryDriver/Kysely.ts:337</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rollback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>rollback</span><a href="#rollback" 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="rollback.rollback-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rollback</span><span class="tsd-signature-symbol">(</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#rollback.rollback-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>rollback the database. Must respond to the NODE_ENV value.</p>
148
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">connectionName</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">steps</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">connection<wbr/>Name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">steps</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#rollback">rollback</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L216">src/dream/QueryDriver/Kysely.ts:216</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveDream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>save<wbr/>Dream</span><a href="#saveDream" 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="saveDream.saveDream-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Dream</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dream</span>, <span class="tsd-kind-parameter">txn</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#saveDream.saveDream-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>persists any unsaved changes to the database. If a transaction
147
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">LegacyCompatiblePrimaryKeyType</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#primaryKeyType">primaryKeyType</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L336">src/dream/QueryDriver/Kysely.ts:336</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rollback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>rollback</span><a href="#rollback" 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="rollback.rollback-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rollback</span><span class="tsd-signature-symbol">(</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#rollback.rollback-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>rollback the database. Must respond to the NODE_ENV value.</p>
148
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">connectionName</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">steps</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">connection<wbr/>Name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">steps</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#rollback">rollback</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L215">src/dream/QueryDriver/Kysely.ts:215</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveDream" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>save<wbr/>Dream</span><a href="#saveDream" 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="saveDream.saveDream-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Dream</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dream</span>, <span class="tsd-kind-parameter">txn</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">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#saveDream.saveDream-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>persists any unsaved changes to the database. If a transaction
149
149
  is provided as a second argument, it will use that transaction
150
150
  to encapsulate the persisting of the dream, as well as any
151
151
  subsequent model hooks that are fired.</p>
152
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dream</span>: <a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><span class="tsd-kind-parameter">txn</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="index.DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a href="index.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></span></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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#saveDream">saveDream</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L800">src/dream/QueryDriver/Kysely.ts:800</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setDatabaseTypeParsers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>set<wbr/>Database<wbr/>Type<wbr/>Parsers</span><a href="#setDatabaseTypeParsers" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="setDatabaseTypeParsers.setDatabaseTypeParsers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Database<wbr/>Type<wbr/>Parsers</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-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="#setDatabaseTypeParsers.setDatabaseTypeParsers-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>this method is called when dream is initializing, and is used
152
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dream</span>: <a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><span class="tsd-kind-parameter">txn</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="index.DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a href="index.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></span></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">any</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#saveDream">saveDream</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L801">src/dream/QueryDriver/Kysely.ts:801</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setDatabaseTypeParsers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>set<wbr/>Database<wbr/>Type<wbr/>Parsers</span><a href="#setDatabaseTypeParsers" 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-inherited"><li class="tsd-signature tsd-anchor-link"><a id="setDatabaseTypeParsers.setDatabaseTypeParsers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Database<wbr/>Type<wbr/>Parsers</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-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="#setDatabaseTypeParsers.setDatabaseTypeParsers-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>this method is called when dream is initializing, and is used
153
153
  to configure the database to utilize custom type parsers for
154
154
  a variety of data types.</p>
155
155
  </div><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><div class="tsd-comment tsd-typography"><p>the name of the connection you are doing this for</p>
156
156
  </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>
157
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#setDatabaseTypeParsers">setDatabaseTypeParsers</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Base.ts#L216">src/dream/QueryDriver/Base.ts:216</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sync" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>sync</span><a href="#sync" 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="sync.sync-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sync</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">onSync</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#sync.sync-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>defines the syncing behavior for dream and psychic,
157
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#setDatabaseTypeParsers">setDatabaseTypeParsers</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Base.ts#L216">src/dream/QueryDriver/Base.ts:216</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sync" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>sync</span><a href="#sync" 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="sync.sync-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sync</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectionName</span>, <span class="tsd-kind-parameter">onSync</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">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#sync.sync-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>defines the syncing behavior for dream and psychic,
158
158
  which is run whenever the <code>sync</code> command is called.</p>
159
- </div><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><li><span><span class="tsd-kind-parameter">onSync</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-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><span class="tsd-signature-symbol">)</span></span><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-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"><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">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">schemaOnly</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">schema<wbr/>Only</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#sync">sync</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L255">src/dream/QueryDriver/Kysely.ts:255</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>transaction</span><a href="#transaction" 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="transaction.transaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.DreamInstance-3">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.CB">CB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.RetType-1">RetType</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">callback</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="db.KyselyQueryDriver.html#transaction.transaction-1.RetType-1">RetType</a><span class="tsd-signature-symbol">&gt;</span><a href="#transaction.transaction-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>Builds a new DreamTransaction instance, provides
159
+ </div><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><li><span><span class="tsd-kind-parameter">onSync</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-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><span class="tsd-signature-symbol">)</span></span><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-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"><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">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">schemaOnly</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">schema<wbr/>Only</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#sync">sync</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L254">src/dream/QueryDriver/Kysely.ts:254</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="transaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>transaction</span><a href="#transaction" 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="transaction.transaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">transaction</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.DreamInstance-3">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.CB">CB</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.RetType-1">RetType</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">callback</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="db.KyselyQueryDriver.html#transaction.transaction-1.RetType-1">RetType</a><span class="tsd-signature-symbol">&gt;</span><a href="#transaction.transaction-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>Builds a new DreamTransaction instance, provides
160
160
  the instance to the provided callback.</p>
161
161
  <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-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">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><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">Pet</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">user</span><span class="hl-1"> })</span><br/><span class="hl-1">})</span>
162
162
  </code><button type="button">Copy</button></pre>
163
163
 
164
164
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="transaction.transaction-1.DreamInstance-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">DreamInstance</span><span class="tsd-signature-keyword"> extends </span><a href="index.Dream.html" class="tsd-signature-type tsd-kind-class">Dream</a></span></li><li><span><a id="transaction.transaction-1.CB" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">CB</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">txn</span><span class="tsd-signature-symbol">: </span><a href="index.DreamTransaction.html" class="tsd-signature-type tsd-kind-class">DreamTransaction</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.DreamInstance-3">DreamInstance</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.DreamInstance-3">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">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></span></li><li><span><a id="transaction.transaction-1.RetType-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">RetType</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">unknown</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="db.KyselyQueryDriver.html#transaction.transaction-1.DreamInstance-3">DreamInstance</a></span></li><li><span><span class="tsd-kind-parameter">callback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="db.KyselyQueryDriver.html#transaction.transaction-1.CB">CB</a></span><div class="tsd-comment tsd-typography"><p>A callback function to call. The transaction provided to the callback can be passed to subsequent database calls within the transaction callback</p>
165
165
  </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="db.KyselyQueryDriver.html#transaction.transaction-1.RetType-1">RetType</a><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
166
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#transaction">transaction</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/dac2c8d2a2fe39515548f72d70f626dfa3062b02/src/dream/QueryDriver/Kysely.ts#L443">src/dream/QueryDriver/Kysely.ts:443</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 tsd-is-inherited"><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 tsd-is-inherited"><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="tsd-is-protected tsd-is-inherited"><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="tsd-is-protected tsd-is-inherited"><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 tsd-is-inherited"><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="#query" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>query</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="#syncDialect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sync<wbr/>Dialect</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="#avg" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>avg</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="#dbConnectionType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Connection<wbr/>Type</span></a><a href="#dbFor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>For</span></a><a href="#dbResultToDreamInstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Result<wbr/>To<wbr/>Dream<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="#hydrateAssociation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hydrate<wbr/>Association</span></a><a href="#hydratePreload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hydrate<wbr/>Preload</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="#orderByDirection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>order<wbr/>By<wbr/>Direction</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="#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="#sum" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sum</span></a><a href="#takeAll" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>take<wbr/>All</span></a><a href="#takeOne" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>take<wbr/>One</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="#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="#dbCreate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Create</span></a><a href="#dbDrop" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Drop</span></a><a href="#dbFor-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>For</span></a><a href="#destroyDream" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy<wbr/>Dream</span></a><a href="#dialectProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dialect<wbr/>Provider</span></a><a href="#duplicateDatabase" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>duplicate<wbr/>Database</span></a><a href="#ensureAllMigrationsHaveBeenRun" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ensure<wbr/>All<wbr/>Migrations<wbr/>Have<wbr/>Been<wbr/>Run</span></a><a href="#enumType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enum<wbr/>Type</span></a><a href="#foreignKeyTypeFromPrimaryKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>foreign<wbr/>Key<wbr/>Type<wbr/>From<wbr/>Primary<wbr/>Key</span></a><a href="#generateMigration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Migration</span></a><a href="#getColumnData" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Column<wbr/>Data</span></a><a href="#migrate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>migrate</span></a><a href="#primaryKeyType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>primary<wbr/>Key<wbr/>Type</span></a><a href="#rollback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rollback</span></a><a href="#saveDream" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Dream</span></a><a href="#setDatabaseTypeParsers" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Database<wbr/>Type<wbr/>Parsers</span></a><a href="#sync" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sync</span></a><a href="#transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>transaction</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.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>
166
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="db.QueryDriverBase.html">QueryDriverBase</a>.<a href="db.QueryDriverBase.html#transaction">transaction</a></p><ul><li>Defined in <a href="https://github.com/rvohealth/dream/blob/913541641d5dd6cefec860a80215ad469ba25dcd/src/dream/QueryDriver/Kysely.ts#L442">src/dream/QueryDriver/Kysely.ts:442</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 tsd-is-inherited"><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 tsd-is-inherited"><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="tsd-is-protected tsd-is-inherited"><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="tsd-is-protected tsd-is-inherited"><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 tsd-is-inherited"><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="#query" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>query</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="#syncDialect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sync<wbr/>Dialect</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="#avg" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>avg</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="#dbConnectionType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Connection<wbr/>Type</span></a><a href="#dbFor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>For</span></a><a href="#dbResultToDreamInstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Result<wbr/>To<wbr/>Dream<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="#hydrateAssociation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hydrate<wbr/>Association</span></a><a href="#hydratePreload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hydrate<wbr/>Preload</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="#orderByDirection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>order<wbr/>By<wbr/>Direction</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="#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="#sum" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sum</span></a><a href="#takeAll" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>take<wbr/>All</span></a><a href="#takeOne" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>take<wbr/>One</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="#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="#dbCreate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Create</span></a><a href="#dbDrop" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>Drop</span></a><a href="#dbFor-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>db<wbr/>For</span></a><a href="#destroyDream" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy<wbr/>Dream</span></a><a href="#dialectProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dialect<wbr/>Provider</span></a><a href="#duplicateDatabase" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>duplicate<wbr/>Database</span></a><a href="#ensureAllMigrationsHaveBeenRun" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ensure<wbr/>All<wbr/>Migrations<wbr/>Have<wbr/>Been<wbr/>Run</span></a><a href="#enumType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enum<wbr/>Type</span></a><a href="#foreignKeyTypeFromPrimaryKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>foreign<wbr/>Key<wbr/>Type<wbr/>From<wbr/>Primary<wbr/>Key</span></a><a href="#generateMigration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Migration</span></a><a href="#getColumnData" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Column<wbr/>Data</span></a><a href="#migrate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>migrate</span></a><a href="#primaryKeyType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>primary<wbr/>Key<wbr/>Type</span></a><a href="#rollback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rollback</span></a><a href="#saveDream" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Dream</span></a><a href="#setDatabaseTypeParsers" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Database<wbr/>Type<wbr/>Parsers</span></a><a href="#sync" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sync</span></a><a href="#transaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>transaction</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.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>