@byline/db-mysql 4.8.0

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 (75) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +283 -0
  3. package/dist/database/schema/auth.d.ts +951 -0
  4. package/dist/database/schema/auth.js +226 -0
  5. package/dist/database/schema/common.d.ts +168 -0
  6. package/dist/database/schema/common.js +130 -0
  7. package/dist/database/schema/index.d.ts +3419 -0
  8. package/dist/database/schema/index.js +895 -0
  9. package/dist/database/schema/schema-pins.test.node.d.ts +52 -0
  10. package/dist/database/schema/schema-pins.test.node.js +398 -0
  11. package/dist/index.d.ts +79 -0
  12. package/dist/index.js +151 -0
  13. package/dist/lib/boot-check.d.ts +22 -0
  14. package/dist/lib/boot-check.js +42 -0
  15. package/dist/lib/boot-check.test.node.d.ts +8 -0
  16. package/dist/lib/boot-check.test.node.js +46 -0
  17. package/dist/lib/db-manager.d.ts +54 -0
  18. package/dist/lib/db-manager.js +49 -0
  19. package/dist/lib/test-db.d.ts +37 -0
  20. package/dist/lib/test-db.js +111 -0
  21. package/dist/lib/test-helper.d.ts +33 -0
  22. package/dist/lib/test-helper.js +68 -0
  23. package/dist/modules/admin/admin-permissions-repository.d.ts +35 -0
  24. package/dist/modules/admin/admin-permissions-repository.js +101 -0
  25. package/dist/modules/admin/admin-preferences-repository.d.ts +62 -0
  26. package/dist/modules/admin/admin-preferences-repository.js +156 -0
  27. package/dist/modules/admin/admin-roles-repository.d.ts +11 -0
  28. package/dist/modules/admin/admin-roles-repository.js +209 -0
  29. package/dist/modules/admin/admin-store.d.ts +20 -0
  30. package/dist/modules/admin/admin-store.js +30 -0
  31. package/dist/modules/admin/admin-users-repository.d.ts +11 -0
  32. package/dist/modules/admin/admin-users-repository.js +303 -0
  33. package/dist/modules/admin/index.d.ts +27 -0
  34. package/dist/modules/admin/index.js +27 -0
  35. package/dist/modules/admin/refresh-tokens-repository.d.ts +34 -0
  36. package/dist/modules/admin/refresh-tokens-repository.js +160 -0
  37. package/dist/modules/audit/audit-commands.d.ts +29 -0
  38. package/dist/modules/audit/audit-commands.js +40 -0
  39. package/dist/modules/audit/audit-queries.d.ts +41 -0
  40. package/dist/modules/audit/audit-queries.js +169 -0
  41. package/dist/modules/counters/counters-commands.d.ts +54 -0
  42. package/dist/modules/counters/counters-commands.js +121 -0
  43. package/dist/modules/counters/tests/counters-concurrency.test.d.ts +8 -0
  44. package/dist/modules/counters/tests/counters-concurrency.test.js +111 -0
  45. package/dist/modules/storage/classify-error.d.ts +34 -0
  46. package/dist/modules/storage/classify-error.js +50 -0
  47. package/dist/modules/storage/classify-error.test.node.d.ts +8 -0
  48. package/dist/modules/storage/classify-error.test.node.js +89 -0
  49. package/dist/modules/storage/normalize-row.d.ts +55 -0
  50. package/dist/modules/storage/normalize-row.js +135 -0
  51. package/dist/modules/storage/normalize-row.test.node.d.ts +8 -0
  52. package/dist/modules/storage/normalize-row.test.node.js +89 -0
  53. package/dist/modules/storage/storage-commands.d.ts +443 -0
  54. package/dist/modules/storage/storage-commands.js +1263 -0
  55. package/dist/modules/storage/storage-insert.d.ts +21 -0
  56. package/dist/modules/storage/storage-insert.js +152 -0
  57. package/dist/modules/storage/storage-queries.d.ts +805 -0
  58. package/dist/modules/storage/storage-queries.js +1815 -0
  59. package/dist/modules/storage/storage-store-manifest.d.ts +77 -0
  60. package/dist/modules/storage/storage-store-manifest.js +168 -0
  61. package/dist/modules/storage/storage-utils.d.ts +49 -0
  62. package/dist/modules/storage/storage-utils.js +76 -0
  63. package/dist/modules/storage/tests/dialect-pins.integration.test.d.ts +8 -0
  64. package/dist/modules/storage/tests/dialect-pins.integration.test.js +266 -0
  65. package/dist/modules/storage/tests/storage-commands.test.d.ts +8 -0
  66. package/dist/modules/storage/tests/storage-commands.test.js +324 -0
  67. package/dist/modules/storage/tests/storage-document-paths.test.d.ts +8 -0
  68. package/dist/modules/storage/tests/storage-document-paths.test.js +214 -0
  69. package/dist/modules/storage/tests/storage-document-tree.test.d.ts +8 -0
  70. package/dist/modules/storage/tests/storage-document-tree.test.js +361 -0
  71. package/dist/modules/storage/tests/storage-queries.test.d.ts +8 -0
  72. package/dist/modules/storage/tests/storage-queries.test.js +685 -0
  73. package/dist/modules/storage/tests/storage-status-and-lifecycle.test.d.ts +8 -0
  74. package/dist/modules/storage/tests/storage-status-and-lifecycle.test.js +268 -0
  75. package/package.json +91 -0
package/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md ADDED
@@ -0,0 +1,283 @@
1
+ # @byline/db-mysql
2
+
3
+ > **Status: preliminary.** This adapter is published so it can be evaluated and
4
+ > exercised, not because MySQL is a fully supported Byline backend yet. The
5
+ > storage layer is complete and proven — it passes the entire shared
6
+ > `@byline/db-conformance` behavioural suite, the same suite `@byline/db-postgres`
7
+ > passes, with identical results. What is missing is the surrounding ecosystem:
8
+ >
9
+ > - **No search provider.** `@byline/search-postgres` has no MySQL counterpart, and
10
+ > this is not merely a missing feature — `initBylineCore()` **throws at boot** if
11
+ > any collection declares `search` and no provider is registered. See
12
+ > [Search on MySQL](#search-on-mysql) below for the one-step workaround you will
13
+ > need. Tracked in
14
+ > [#52](https://github.com/Byline-CMS/bylinecms.dev/issues/52).
15
+ > - **No CLI support.** `byline init` scaffolds a Postgres installation; wiring
16
+ > MySQL is a manual edit to your `server.config.ts`.
17
+ > - **Narrower CI coverage than Postgres.** Continuous integration pins MySQL 8.0
18
+ > — the engine floor — so nothing yet exercises 9.x automatically, and no leg
19
+ > runs under a non-UTC timezone. Tracked in
20
+ > [#55](https://github.com/Byline-CMS/bylinecms.dev/issues/55).
21
+ >
22
+ > Treat it as suitable for evaluation, prototypes, and installations that do not
23
+ > need search. The criteria for general availability are tracked in
24
+ > [#58](https://github.com/Byline-CMS/bylinecms.dev/issues/58).
25
+
26
+ MySQL adapter for Byline CMS — Drizzle schema, migrations, and the storage /
27
+ queries / commands implementation behind `IDbAdapter`. It is Byline's second
28
+ database adapter, alongside `@byline/db-postgres`. The subpath
29
+ `@byline/db-mysql/admin` ships the MySQL-backed admin-store repositories that
30
+ plug into `@byline/admin`, the same way `@byline/db-postgres/admin` does.
31
+
32
+ Both adapters implement the same `IDbAdapter` contract and pass the same
33
+ shared `@byline/db-conformance` behavioural suite, so document storage,
34
+ versioning, patches, workflow, populate, and admin auth behave identically
35
+ regardless of which database backs an installation. See
36
+ [Core Document Storage](https://github.com/Byline-CMS/bylinecms.dev/blob/develop/docs/03-architecture/01-document-storage.md)
37
+ for the storage model both adapters implement.
38
+
39
+ This package is part of [Byline CMS](https://github.com/Byline-CMS/bylinecms.dev)
40
+ — a developer-friendly, open-source headless CMS with versioning, editorial
41
+ workflow, and content translation as first-class concerns.
42
+
43
+ ## Install
44
+
45
+ ```sh
46
+ pnpm add @byline/db-mysql
47
+ ```
48
+
49
+ `mysql2` is a direct dependency, so no separate driver install is required.
50
+
51
+ ## Usage
52
+
53
+ `mysqlAdapter()` takes a connection string, your `CollectionDefinition[]`, and
54
+ the installation's default content locale, and returns an `IDbAdapter` (plus
55
+ the underlying `drizzle` handle and `pool`, exposed for housekeeping and
56
+ migration tooling):
57
+
58
+ ```ts
59
+ import { initBylineCore } from '@byline/core'
60
+ import { mysqlAdapter } from '@byline/db-mysql'
61
+ import { createAdminStore } from '@byline/db-mysql/admin'
62
+
63
+ import { collections } from './byline/collections/index.js'
64
+ import { i18n } from './byline/i18n.js'
65
+ import { routes } from './byline/routes.js'
66
+
67
+ const db = mysqlAdapter({
68
+ connectionString: process.env.BYLINE_DB_MYSQL_CONNECTION_STRING!,
69
+ collections,
70
+ defaultContentLocale: i18n.content.defaultLocale,
71
+ connectionLimit: 20, // optional — mysql2 pool size, defaults to 20
72
+ })
73
+
74
+ const core = await initBylineCore({
75
+ serverURL: process.env.VITE_SERVER_URL!,
76
+ i18n,
77
+ routes,
78
+ collections,
79
+ db,
80
+ adminStore: createAdminStore(db.drizzle),
81
+ // storage, search, hooks, … — see @byline/core's ServerConfig type
82
+ })
83
+ ```
84
+
85
+ This mirrors how `apps/webapp/byline/server.config.ts` wires `@byline/db-postgres` today —
86
+ swap `pgAdapter` / `@byline/db-postgres/admin` for `mysqlAdapter` /
87
+ `@byline/db-mysql/admin` and the rest of an existing Byline server config is unchanged,
88
+ because both adapters implement the same `IDbAdapter` and `AdminStore` contracts.
89
+
90
+ `connectionString` is the **only** connection input `mysqlAdapter` takes, and
91
+ it must be a `mysql://` URL — mysql2 parses connection URLs natively (`uri`
92
+ is a first-class `createPool` option), so there is no separate host / port /
93
+ user / password / database set of fields to keep in sync with it. An earlier
94
+ version of this package's `.env.example` implied the URL existed only to
95
+ serve the `db_init.sh` / `db_init_test.sh` shell scripts, which had the
96
+ relationship backwards: the connection string is the adapter's own input
97
+ first, and the shell scripts parse the same string only because the `mysql`
98
+ CLI takes discrete flags rather than a URL.
99
+
100
+ Special characters in the connection string's user or password must be
101
+ percent-encoded (`@` as `%40`, `#` as `%23`, `/` as `%2F`, …) — mysql2 and
102
+ the init scripts' shell-side URL parsing both percent-decode the userinfo the
103
+ same way, so an unencoded reserved character parses differently, or fails to
104
+ parse, on one side or the other.
105
+
106
+ ## Engine floor: MySQL 8.0.14+
107
+
108
+ `mysqlAdapter` runs a boot-time `SELECT VERSION()` check against the pool's
109
+ first connection and throws if the server is older than 8.0.14 or is
110
+ MariaDB (MariaDB reports version strings that would otherwise satisfy the
111
+ numeric floor, so it is rejected explicitly by name — see
112
+ `src/lib/boot-check.ts`). A too-old server or MariaDB is a configuration
113
+ error, so the check fails fast at `initBylineCore()` boot rather than
114
+ surfacing later as an obscure SQL error the first time a query needs a
115
+ feature the server doesn't have.
116
+
117
+ 8.0.14 is not an arbitrary floor — it is the first MySQL release with two
118
+ features this adapter's storage layer depends on:
119
+
120
+ - **`LEFT JOIN LATERAL`**, used for the field-level sort path in
121
+ `findDocuments`.
122
+ - **Subqueries in a view's `FROM` clause**, which MySQL forbade before
123
+ 8.0.14. Both current-version views
124
+ (`byline_current_documents`, `byline_current_published_documents`) resolve
125
+ the current version per document via a `ROW_NUMBER() OVER (PARTITION BY
126
+ document_id)` window inside a derived table in their `FROM` clause — the
127
+ same shape as the Postgres adapter's views — so this restriction, not the
128
+ `LATERAL` requirement, is the adapter's real engine floor.
129
+
130
+ MariaDB is out of scope for this release: it lacks `LATERAL` joins, so
131
+ supporting it would need a correlated-subquery rewrite of the field-sort
132
+ path. Tracked as
133
+ [on-demand follow-up work](https://github.com/Byline-CMS/bylinecms.dev/issues/54)
134
+ if you need it sooner than "on demand."
135
+
136
+ ## UUID and timestamp conventions
137
+
138
+ - **Ids are `CHAR(36) CHARACTER SET ascii COLLATE ascii_bin`** — canonical
139
+ UUID text, compared byte-wise rather than under an accent- or
140
+ case-folding collation. Every id and foreign-key column in the schema
141
+ uses this type. Ids are always app-generated UUIDv7 (the `uuid` package's
142
+ `v7()`), never database-generated — UUIDv7's canonical text form is
143
+ time-ordered, so `ORDER BY id DESC` version resolution works the same way
144
+ it does on the numeric-friendly ids some other schemas use.
145
+ - **Audit timestamps are `DATETIME(6)`** (microsecond precision), matching
146
+ the Postgres adapter's `timestamp(name, { precision: 6, withTimezone: true })`
147
+ convention exactly. Every table's `created_at` / `updated_at` uses this
148
+ shape. `TIMESTAMP` (MySQL's other temporal type) is not used anywhere in
149
+ this schema — its year-2038 range limit makes it unsuitable for an
150
+ audit trail with no defined retention horizon.
151
+ - **Every `DATETIME` column is UTC by convention.** MySQL's `DATETIME` type
152
+ carries no time zone identity the way Postgres's `TIMESTAMPTZ` does, so
153
+ UTC discipline is enforced entirely at the connection layer: the mysql2
154
+ pool is opened with `timezone: 'Z'`, which stops the driver from
155
+ reinterpreting stored UTC values against the server's or session's local
156
+ time zone on the way in or out.
157
+ - **`document_paths.path` is pinned `utf8mb4_bin`** rather than the
158
+ database's default collation, so path lookups compare bytes exactly and
159
+ agree with the Postgres adapter's default (accent- and case-sensitive)
160
+ comparison — see "Differences from the Postgres adapter" below for why
161
+ this column needed a deliberate override.
162
+
163
+ ## Counters emulation
164
+
165
+ MySQL has no `CREATE SEQUENCE`. Byline's counter groups (used for
166
+ per-installation and per-scope sequential numbering) are emulated with a
167
+ registry table, `byline_counter_groups`, that **is** the allocator rather
168
+ than a wrapper around a database sequence object: `current_value` holds the
169
+ counter's live state, and each allocation issues an atomic
170
+ `UPDATE`/`INSERT ... ON DUPLICATE KEY UPDATE` followed by a same-connection
171
+ `SELECT LAST_INSERT_ID()` to read back the value it just set — the classic
172
+ `LAST_INSERT_ID(expr)` idiom, requiring no separate `SELECT ... FOR UPDATE`
173
+ round trip. Because `LAST_INSERT_ID()` is per-connection session state, the
174
+ two-statement sequence is issued over a single checked-out pool connection
175
+ rather than through `pool.query()` directly, which could otherwise hand the
176
+ two statements to two different physical connections and return the wrong
177
+ session's value. See `src/modules/counters/counters-commands.ts` for the
178
+ full implementation.
179
+
180
+ ## Differences from the Postgres adapter
181
+
182
+ Both adapters implement the same storage model and pass the same
183
+ `@byline/db-conformance` suite, but MySQL and Postgres are different
184
+ databases, and a few divergences are real rather than papered over.
185
+
186
+ - **`LIKE` is case- *and* accent-insensitive**, unlike Postgres's `ILIKE`,
187
+ which is case-insensitive only. Store *value* columns keep the database's
188
+ default collation, `utf8mb4_0900_ai_ci` (`ai` = accent-insensitive, `ci` =
189
+ case-insensitive), so a `query` search against `store_text` values will
190
+ match `café` when searching `cafe`, and `Café` when searching `cafe`,
191
+ where the same search against the Postgres adapter would match neither.
192
+ This is a deliberate, spec-elected divergence, not an oversight — see
193
+ `packages/db-mysql/src/database/schema/common.ts`'s `varcharCaseSensitive`
194
+ docblock for the evidence that ruled it in. The one place this divergence
195
+ is *not* allowed to stand is `byline_document_paths.path`: that column is
196
+ pinned to `utf8mb4_bin` (byte-exact) instead, so `/About` and `/about`
197
+ remain two distinct paths on both adapters, and so combining marks that
198
+ are meaning-bearing in some scripts (a Thai tone mark, a Devanagari
199
+ anusvara, Hebrew niqqud) are never silently folded together the way
200
+ `ai_ci` would fold them.
201
+ - **No search provider yet.** `@byline/search-postgres` has no MySQL
202
+ counterpart today — a collection's `search` config
203
+ (`CollectionDefinition.search`) requires a registered `SearchProvider`,
204
+ and none ships for MySQL yet. Track
205
+ [the `@byline/search-mysql` follow-up issue](https://github.com/Byline-CMS/bylinecms.dev/issues/52)
206
+ for status.
207
+ - **The connection string is the only connection input.** See "Usage"
208
+ above — this is called out here too because it is the most common way
209
+ this adapter is misconfigured by a reader coming from the Postgres
210
+ adapter's `.env.example`, which historically documented the same shape
211
+ for a different reason.
212
+ - **Temporal field values.** As of this release both adapters return `date`
213
+ and `datetime` field values as `Date` objects (`date` anchored to UTC
214
+ midnight for its calendar day; `time` remains a string on both adapters).
215
+ This adapter always returned `Date` here; the Postgres adapter converged
216
+ onto the same shape in this release. See the changeset for what a
217
+ consumer upgrading `@byline/db-postgres` needs to check.
218
+
219
+ ## Search on MySQL
220
+
221
+ There is no MySQL search provider yet, and the absence is load-bearing rather
222
+ than cosmetic: `validateSearchConfig` runs inside `initBylineCore()` and
223
+ **throws** when any collection declares a `search` block but no provider is
224
+ registered. Byline's own reference application opts five collections into
225
+ search, so a MySQL installation that copies it fails at boot with an error that
226
+ does not mention MySQL at all.
227
+
228
+ Until `@byline/search-mysql` exists, register a no-op provider. It satisfies
229
+ validation, and indexing and querying become silent no-ops rather than errors —
230
+ the admin Reindex action and any search page return nothing, which is the honest
231
+ answer on this adapter today:
232
+
233
+ ```ts
234
+ const noopSearch = {
235
+ capabilities: {
236
+ facets: false,
237
+ typoTolerance: false,
238
+ semantic: false,
239
+ bm25: false,
240
+ weighting: false,
241
+ highlights: false,
242
+ },
243
+ async upsert() {},
244
+ async remove() {},
245
+ async search() {
246
+ return { hits: [], total: 0 }
247
+ },
248
+ }
249
+
250
+ await initBylineCore({
251
+ // …
252
+ db,
253
+ search: noopSearch,
254
+ })
255
+ ```
256
+
257
+ The alternative — removing the `search` block from every collection definition —
258
+ also works, but it discards configuration you will want back when a provider
259
+ lands. The no-op keeps your collections declarative and confines the workaround
260
+ to one place.
261
+
262
+ ## Not yet shipped
263
+
264
+ - **`@byline/search-mysql`** — see [Search on MySQL](#search-on-mysql) above.
265
+ Tracked in [issue #52](https://github.com/Byline-CMS/bylinecms.dev/issues/52).
266
+ - **CLI support.** `byline init` scaffolds a Postgres installation. Adding MySQL
267
+ to an existing project is a manual edit to `byline/server.config.ts` — swap
268
+ `pgAdapter` for `mysqlAdapter`, swap the `@byline/db-postgres/admin` import for
269
+ `@byline/db-mysql/admin`, drop the `@byline/search-postgres` migrate call, and
270
+ register the no-op search provider above.
271
+ - **A MySQL storage-benchmark target.** The design spec flags view
272
+ materialisation (the `ROW_NUMBER()` window inside a derived table, used
273
+ by both current-version views) as a question to answer before this
274
+ adapter's GA — Postgres's own benchmark sweep
275
+ ([`docs/03-architecture/01-document-storage.md`](https://github.com/Byline-CMS/bylinecms.dev/blob/develop/docs/03-architecture/01-document-storage.md#indicative-benchmarks))
276
+ has no MySQL counterpart yet. Tracked in
277
+ [issue #53](https://github.com/Byline-CMS/bylinecms.dev/issues/53).
278
+ - **MariaDB support** — see "Engine floor" above. Tracked in
279
+ [issue #54](https://github.com/Byline-CMS/bylinecms.dev/issues/54).
280
+
281
+ ## License
282
+
283
+ MPL-2.0