@bolvrk/engine-sqlite 0.1.4
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.
- package/LICENSE.md +105 -0
- package/README.md +26 -0
- package/dist/engine.d.ts +24 -0
- package/dist/helpers.d.ts +77 -0
- package/dist/index-m4sztshc.js +615 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +1421 -0
- package/dist/metas/index.d.ts +53 -0
- package/dist/metas/index.js +80 -0
- package/dist/parser.d.ts +33 -0
- package/dist/rule.d.ts +17 -0
- package/dist/rules/add-column.d.ts +13 -0
- package/dist/rules/dml-and-maintenance.d.ts +7 -0
- package/dist/rules/index.d.ts +5 -0
- package/dist/rules/indexes-and-types.d.ts +7 -0
- package/dist/rules/performance.d.ts +11 -0
- package/dist/rules/rebuild-pragmas.d.ts +11 -0
- package/dist/rules/schema-and-transactions.d.ts +23 -0
- package/dist/rules/table-shape.d.ts +5 -0
- package/package.json +45 -0
- package/src/engine.ts +89 -0
- package/src/helpers.ts +254 -0
- package/src/index.ts +5 -0
- package/src/metas/LICENSE +202 -0
- package/src/metas/index.ts +598 -0
- package/src/parser.ts +68 -0
- package/src/rule.ts +36 -0
- package/src/rules/LICENSE +202 -0
- package/src/rules/add-column.ts +180 -0
- package/src/rules/dml-and-maintenance.ts +75 -0
- package/src/rules/index.ts +18 -0
- package/src/rules/indexes-and-types.ts +99 -0
- package/src/rules/performance.ts +207 -0
- package/src/rules/rebuild-pragmas.ts +142 -0
- package/src/rules/schema-and-transactions.ts +446 -0
- package/src/rules/table-shape.ts +76 -0
package/src/parser.ts
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
// SPDX-License-Identifier: FSL-1.1-ALv2
|
|
2
|
+
/**
|
|
3
|
+
* SQLite parse layer: sql-parser-cst (MIT, pure TypeScript, a real
|
|
4
|
+
* dialect-aware grammar with source ranges). The only place SQLite SQL is
|
|
5
|
+
* turned into structure — rules walk the CST, never regex over SQL. Anything
|
|
6
|
+
* the grammar rejects fails the whole check: a partial check could hide a
|
|
7
|
+
* danger, so the engine reports "not checked" rather than guessing.
|
|
8
|
+
*/
|
|
9
|
+
import { parse, type Node, type Program, type Statement } from "sql-parser-cst";
|
|
10
|
+
|
|
11
|
+
export type { Node, Statement };
|
|
12
|
+
|
|
13
|
+
export class SqliteMigrationParseError extends Error {
|
|
14
|
+
constructor(message: string, public readonly cause?: unknown) {
|
|
15
|
+
super(message);
|
|
16
|
+
this.name = "SqliteMigrationParseError";
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export interface ParsedSqliteStatement {
|
|
21
|
+
/** 0-based position in the migration file (empty statements — a stray `;` — are skipped). */
|
|
22
|
+
index: number;
|
|
23
|
+
/** CST node type, e.g. "alter_table_stmt", "pragma_stmt". */
|
|
24
|
+
type: Statement["type"];
|
|
25
|
+
/** The statement node; rules descend from here. */
|
|
26
|
+
node: Statement;
|
|
27
|
+
/** Verbatim SQL text of this statement, trimmed. */
|
|
28
|
+
sql: string;
|
|
29
|
+
/** Character offset of the statement's start in the migration text. */
|
|
30
|
+
location: number;
|
|
31
|
+
/** Character offset one past the statement's end. */
|
|
32
|
+
end: number;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export interface ParsedSqliteMigration {
|
|
36
|
+
statements: ParsedSqliteStatement[];
|
|
37
|
+
/** sql-parser-cst version the tree came from. */
|
|
38
|
+
parserVersion: string;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
import packageJson from "../package.json";
|
|
42
|
+
const PARSER_VERSION: string = packageJson.dependencies["sql-parser-cst"];
|
|
43
|
+
|
|
44
|
+
export function parseSqliteMigration(sql: string): ParsedSqliteMigration {
|
|
45
|
+
let program: Program;
|
|
46
|
+
try {
|
|
47
|
+
program = parse(sql, { dialect: "sqlite", includeRange: true });
|
|
48
|
+
} catch (err: any) {
|
|
49
|
+
const message = String(err?.message ?? err).split("\n")[0];
|
|
50
|
+
throw new SqliteMigrationParseError(`Migration is not valid SQLite SQL: ${message}`, err);
|
|
51
|
+
}
|
|
52
|
+
const statements: ParsedSqliteStatement[] = [];
|
|
53
|
+
for (const node of program.statements) {
|
|
54
|
+
if (node.type === "empty") continue;
|
|
55
|
+
const [start, stop] = node.range ?? [0, sql.length];
|
|
56
|
+
// Ranges are inclusive of the last token character.
|
|
57
|
+
const end = Math.min(stop + 1, sql.length);
|
|
58
|
+
statements.push({
|
|
59
|
+
index: statements.length,
|
|
60
|
+
type: node.type,
|
|
61
|
+
node,
|
|
62
|
+
sql: sql.slice(start, end).trim(),
|
|
63
|
+
location: start,
|
|
64
|
+
end,
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
return { statements, parserVersion: PARSER_VERSION };
|
|
68
|
+
}
|
package/src/rule.ts
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
// SPDX-License-Identifier: FSL-1.1-ALv2
|
|
2
|
+
/**
|
|
3
|
+
* SL rule interface — the same shape as the Postgres engine's Rule
|
|
4
|
+
* (packages/engine/src/rule.ts) over the SQLite parse tree. Deliberately NOT
|
|
5
|
+
* shared code: the only shared abstractions between engines are the findings
|
|
6
|
+
* contract, the RuleMeta shape and the severity taxonomy.
|
|
7
|
+
*/
|
|
8
|
+
import type { Finding, RuleMeta } from "@bolvrk/engine";
|
|
9
|
+
import type { ParsedSqliteMigration, ParsedSqliteStatement } from "./parser";
|
|
10
|
+
|
|
11
|
+
export interface SlRuleContext {
|
|
12
|
+
migration: ParsedSqliteMigration;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export interface SlRule {
|
|
16
|
+
meta: RuleMeta;
|
|
17
|
+
check(ctx: SlRuleContext): Finding[];
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/** Helper for building a finding with the rule's identity filled in. */
|
|
21
|
+
export function finding(
|
|
22
|
+
rule: SlRule,
|
|
23
|
+
stmt: ParsedSqliteStatement,
|
|
24
|
+
props: Omit<Finding, "ruleId" | "ruleVersion" | "tier" | "statementIndex" | "sql" | "severity"> &
|
|
25
|
+
Partial<Pick<Finding, "severity">>,
|
|
26
|
+
): Finding {
|
|
27
|
+
return {
|
|
28
|
+
ruleId: rule.meta.id,
|
|
29
|
+
ruleVersion: rule.meta.version,
|
|
30
|
+
tier: rule.meta.tier,
|
|
31
|
+
severity: props.severity ?? rule.meta.defaultSeverity,
|
|
32
|
+
statementIndex: stmt.index,
|
|
33
|
+
sql: stmt.sql,
|
|
34
|
+
...props,
|
|
35
|
+
};
|
|
36
|
+
}
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
2
|
+
/**
|
|
3
|
+
* ALTER TABLE ADD COLUMN forms SQLite refuses or scans for. The manual lists
|
|
4
|
+
* every restriction in one paragraph; each is its own rule so a finding says
|
|
5
|
+
* exactly which one the statement hit.
|
|
6
|
+
*/
|
|
7
|
+
import type { Finding } from "@bolvrk/engine";
|
|
8
|
+
import { addedColumns, constraintOf, nameOf, tableCreatedInMigration, tableOf } from "../helpers";
|
|
9
|
+
import { sl001Meta, sl002Meta, sl003Meta, sl004Meta, sl005Meta, sl008Meta } from "../metas/index";
|
|
10
|
+
import { finding, type SlRule, type SlRuleContext } from "../rule";
|
|
11
|
+
|
|
12
|
+
type AnyNode = Record<string, any>;
|
|
13
|
+
|
|
14
|
+
/** Every ADD COLUMN in the migration with its statement and target table; new tables excluded (a column added to a table created in the same file has no rows to hurt). */
|
|
15
|
+
function eachAddedColumn(ctx: SlRuleContext, visit: (stmt: SlRuleContext["migration"]["statements"][number], table: string, column: AnyNode) => void): void {
|
|
16
|
+
for (const stmt of ctx.migration.statements) {
|
|
17
|
+
const columns = addedColumns(stmt);
|
|
18
|
+
if (columns.length === 0) continue;
|
|
19
|
+
const table = tableOf(stmt) ?? "";
|
|
20
|
+
if (table && tableCreatedInMigration(ctx.migration, stmt.index, table)) continue;
|
|
21
|
+
for (const column of columns) visit(stmt, table, column);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
function isNullDefault(column: AnyNode): boolean {
|
|
26
|
+
const def = constraintOf(column, "constraint_default");
|
|
27
|
+
return !def || def.expr?.type === "null_literal" || def.constraint?.expr?.type === "null_literal";
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/** SL001: NOT NULL with no default (or DEFAULT NULL) — the statement fails. */
|
|
31
|
+
export const sl001: SlRule = {
|
|
32
|
+
meta: sl001Meta,
|
|
33
|
+
check(ctx) {
|
|
34
|
+
const out: Finding[] = [];
|
|
35
|
+
eachAddedColumn(ctx, (stmt, table, column) => {
|
|
36
|
+
if (!constraintOf(column, "constraint_not_null")) return;
|
|
37
|
+
// A generated column is computed, never NULL by omission — the NOT NULL restriction does not apply to it.
|
|
38
|
+
if (constraintOf(column, "constraint_generated")) return;
|
|
39
|
+
if (!isNullDefault(column)) return;
|
|
40
|
+
const name = nameOf(column.name);
|
|
41
|
+
out.push(
|
|
42
|
+
finding(sl001, stmt, {
|
|
43
|
+
title: `ADD COLUMN "${name}" NOT NULL has no default — SQLite refuses it`,
|
|
44
|
+
message:
|
|
45
|
+
`SQLite cannot fill existing rows of "${table}" with NULL for a NOT NULL column, so the statement fails: "Cannot add a NOT NULL column with default value NULL". ` +
|
|
46
|
+
`Add a non-NULL DEFAULT (schema-only, no rewrite), or add the column nullable and enforce NOT NULL in a later rebuild.`,
|
|
47
|
+
object: { table, column: name },
|
|
48
|
+
}),
|
|
49
|
+
);
|
|
50
|
+
});
|
|
51
|
+
return out;
|
|
52
|
+
},
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
/** SL002: PRIMARY KEY or UNIQUE on an added column — the statement fails. */
|
|
56
|
+
export const sl002: SlRule = {
|
|
57
|
+
meta: sl002Meta,
|
|
58
|
+
check(ctx) {
|
|
59
|
+
const out: Finding[] = [];
|
|
60
|
+
eachAddedColumn(ctx, (stmt, table, column) => {
|
|
61
|
+
const kind = constraintOf(column, "constraint_primary_key") ? "PRIMARY KEY" : constraintOf(column, "constraint_unique") ? "UNIQUE" : undefined;
|
|
62
|
+
if (!kind) return;
|
|
63
|
+
const name = nameOf(column.name);
|
|
64
|
+
out.push(
|
|
65
|
+
finding(sl002, stmt, {
|
|
66
|
+
title: `ADD COLUMN "${name}" ${kind} is rejected by SQLite`,
|
|
67
|
+
message:
|
|
68
|
+
`ALTER TABLE ADD COLUMN may not carry a ${kind} constraint; SQLite fails the statement and "${table}" is unchanged. ` +
|
|
69
|
+
(kind === "UNIQUE"
|
|
70
|
+
? `Add the column plain and CREATE UNIQUE INDEX as its own statement.`
|
|
71
|
+
: `A new primary key needs the table rebuilt (create, copy, drop, rename).`),
|
|
72
|
+
object: { table, column: name },
|
|
73
|
+
}),
|
|
74
|
+
);
|
|
75
|
+
});
|
|
76
|
+
return out;
|
|
77
|
+
},
|
|
78
|
+
};
|
|
79
|
+
|
|
80
|
+
const NON_CONSTANT_DEFAULTS = new Set(["CURRENT_TIME", "CURRENT_DATE", "CURRENT_TIMESTAMP"]);
|
|
81
|
+
|
|
82
|
+
/** SL003: DEFAULT CURRENT_* or a parenthesised expression — the statement fails. */
|
|
83
|
+
export const sl003: SlRule = {
|
|
84
|
+
meta: sl003Meta,
|
|
85
|
+
check(ctx) {
|
|
86
|
+
const out: Finding[] = [];
|
|
87
|
+
eachAddedColumn(ctx, (stmt, table, column) => {
|
|
88
|
+
const def = constraintOf(column, "constraint_default");
|
|
89
|
+
const expr = def?.expr ?? def?.constraint?.expr;
|
|
90
|
+
if (!expr) return;
|
|
91
|
+
const isCurrent = expr.type === "func_call" && NON_CONSTANT_DEFAULTS.has(String(nameOf(expr.name) ?? "").toUpperCase());
|
|
92
|
+
const isExpression = expr.type === "paren_expr";
|
|
93
|
+
if (!isCurrent && !isExpression) return;
|
|
94
|
+
const name = nameOf(column.name);
|
|
95
|
+
out.push(
|
|
96
|
+
finding(sl003, stmt, {
|
|
97
|
+
title: `ADD COLUMN "${name}" has a non-constant default — SQLite refuses it`,
|
|
98
|
+
message:
|
|
99
|
+
`ALTER TABLE ADD COLUMN only accepts a constant default; ${isCurrent ? String(nameOf(expr.name)).toUpperCase() : "an expression in parentheses"} fails with "Cannot add a column with non-constant default" and "${table}" is unchanged. ` +
|
|
100
|
+
`Use a constant default (or none) and set the value from the application or a trigger.`,
|
|
101
|
+
object: { table, column: name },
|
|
102
|
+
}),
|
|
103
|
+
);
|
|
104
|
+
});
|
|
105
|
+
return out;
|
|
106
|
+
},
|
|
107
|
+
};
|
|
108
|
+
|
|
109
|
+
/** SL004: GENERATED ... STORED on an added column — the statement fails. */
|
|
110
|
+
export const sl004: SlRule = {
|
|
111
|
+
meta: sl004Meta,
|
|
112
|
+
check(ctx) {
|
|
113
|
+
const out: Finding[] = [];
|
|
114
|
+
eachAddedColumn(ctx, (stmt, table, column) => {
|
|
115
|
+
const generated = constraintOf(column, "constraint_generated");
|
|
116
|
+
const storage = generated?.storageKw ?? generated?.constraint?.storageKw;
|
|
117
|
+
if (!generated || String(storage?.name ?? "").toUpperCase() !== "STORED") return;
|
|
118
|
+
const name = nameOf(column.name);
|
|
119
|
+
out.push(
|
|
120
|
+
finding(sl004, stmt, {
|
|
121
|
+
title: `ADD COLUMN "${name}" GENERATED ... STORED is rejected by SQLite`,
|
|
122
|
+
message:
|
|
123
|
+
`Only VIRTUAL generated columns can be added with ALTER TABLE; a STORED one fails ("cannot add a STORED column") and "${table}" is unchanged. ` +
|
|
124
|
+
`Declare it VIRTUAL, or make it part of a table rebuild.`,
|
|
125
|
+
object: { table, column: name },
|
|
126
|
+
}),
|
|
127
|
+
);
|
|
128
|
+
});
|
|
129
|
+
return out;
|
|
130
|
+
},
|
|
131
|
+
};
|
|
132
|
+
|
|
133
|
+
/** SL005: REFERENCES with a non-NULL default — fails whenever foreign keys are enforced. */
|
|
134
|
+
export const sl005: SlRule = {
|
|
135
|
+
meta: sl005Meta,
|
|
136
|
+
check(ctx) {
|
|
137
|
+
const out: Finding[] = [];
|
|
138
|
+
eachAddedColumn(ctx, (stmt, table, column) => {
|
|
139
|
+
const references = constraintOf(column, "references_specification") ?? constraintOf(column, "constraint_foreign_key");
|
|
140
|
+
if (!references) return;
|
|
141
|
+
if (isNullDefault(column)) return;
|
|
142
|
+
const name = nameOf(column.name);
|
|
143
|
+
out.push(
|
|
144
|
+
finding(sl005, stmt, {
|
|
145
|
+
title: `ADD COLUMN "${name}" REFERENCES with a non-NULL default fails when foreign keys are on`,
|
|
146
|
+
message:
|
|
147
|
+
`With PRAGMA foreign_keys=ON — the setting most applications use — SQLite rejects this statement ("Cannot add a REFERENCES column with non-NULL default value"); with it off the statement passes, so the outcome depends on the runner's connection. ` +
|
|
148
|
+
`Add the column with a NULL default and backfill it.`,
|
|
149
|
+
object: { table, column: name },
|
|
150
|
+
}),
|
|
151
|
+
);
|
|
152
|
+
});
|
|
153
|
+
return out;
|
|
154
|
+
},
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
/** SL008: a CHECK constraint on an added column makes SQLite scan the whole table. */
|
|
158
|
+
export const sl008: SlRule = {
|
|
159
|
+
meta: sl008Meta,
|
|
160
|
+
check(ctx) {
|
|
161
|
+
const out: Finding[] = [];
|
|
162
|
+
eachAddedColumn(ctx, (stmt, table, column) => {
|
|
163
|
+
const check = constraintOf(column, "constraint_check");
|
|
164
|
+
const generatedNotNull = constraintOf(column, "constraint_generated") && constraintOf(column, "constraint_not_null");
|
|
165
|
+
if (!check && !generatedNotNull) return;
|
|
166
|
+
const name = nameOf(column.name);
|
|
167
|
+
const what = check ? "a CHECK constraint" : "NOT NULL on a generated column";
|
|
168
|
+
out.push(
|
|
169
|
+
finding(sl008, stmt, {
|
|
170
|
+
title: `ADD COLUMN "${name}" with ${what} scans every row of "${table}"`,
|
|
171
|
+
message:
|
|
172
|
+
`Adding a column is schema-only in SQLite — except with ${what}, where the whole table is read under the write lock to verify existing rows before the change commits. ` +
|
|
173
|
+
`On a large table, schedule it; or add the column without the constraint and enforce it in a later rebuild.`,
|
|
174
|
+
object: { table, column: name },
|
|
175
|
+
}),
|
|
176
|
+
);
|
|
177
|
+
});
|
|
178
|
+
return out;
|
|
179
|
+
},
|
|
180
|
+
};
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
2
|
+
/** Statements that hold SQLite's single write lock for the size of the database rather than the size of the change. */
|
|
3
|
+
import type { Finding } from "@bolvrk/engine";
|
|
4
|
+
import { hasWhere, insideTransaction, tableCreatedInMigration, tableOf } from "../helpers";
|
|
5
|
+
import { sl013Meta, sl014Meta, sl015Meta } from "../metas/index";
|
|
6
|
+
import { finding, type SlRule } from "../rule";
|
|
7
|
+
|
|
8
|
+
/** SL013: UPDATE / DELETE with no WHERE. */
|
|
9
|
+
export const sl013: SlRule = {
|
|
10
|
+
meta: sl013Meta,
|
|
11
|
+
check(ctx) {
|
|
12
|
+
const out: Finding[] = [];
|
|
13
|
+
for (const stmt of ctx.migration.statements) {
|
|
14
|
+
if (stmt.node.type !== "update_stmt" && stmt.node.type !== "delete_stmt") continue;
|
|
15
|
+
if (hasWhere(stmt)) continue;
|
|
16
|
+
const table = tableOf(stmt) ?? "";
|
|
17
|
+
if (table && tableCreatedInMigration(ctx.migration, stmt.index, table)) continue;
|
|
18
|
+
const kind = stmt.node.type === "update_stmt" ? "UPDATE" : "DELETE";
|
|
19
|
+
out.push(
|
|
20
|
+
finding(sl013, stmt, {
|
|
21
|
+
title: `${kind} with no WHERE touches every row of "${table}"`,
|
|
22
|
+
message:
|
|
23
|
+
`Every row changes in one write transaction; SQLite's single writer holds the lock for the whole statement and every other writer waits or fails with SQLITE_BUSY, while the journal grows by the size of the change. ` +
|
|
24
|
+
`Add the predicate — and if this is a backfill, batch it by rowid range from a job.`,
|
|
25
|
+
object: { table },
|
|
26
|
+
}),
|
|
27
|
+
);
|
|
28
|
+
}
|
|
29
|
+
return out;
|
|
30
|
+
},
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
/** SL014: VACUUM — an error inside a transaction, a whole-file rewrite outside one. */
|
|
34
|
+
export const sl014: SlRule = {
|
|
35
|
+
meta: sl014Meta,
|
|
36
|
+
check(ctx) {
|
|
37
|
+
const out: Finding[] = [];
|
|
38
|
+
const inTx = insideTransaction(ctx.migration);
|
|
39
|
+
for (const stmt of ctx.migration.statements) {
|
|
40
|
+
if (stmt.node.type !== "vacuum_stmt") continue;
|
|
41
|
+
// VACUUM INTO writes a copy elsewhere and leaves the live file alone — a backup, not a rewrite.
|
|
42
|
+
if ((stmt.node as Record<string, any>).intoKw) continue;
|
|
43
|
+
const inside = inTx[stmt.index] === true;
|
|
44
|
+
out.push(
|
|
45
|
+
finding(sl014, stmt, {
|
|
46
|
+
severity: inside ? "critical" : sl014Meta.defaultSeverity,
|
|
47
|
+
title: inside ? "VACUUM inside a transaction fails" : "VACUUM rewrites the whole database file",
|
|
48
|
+
message: inside
|
|
49
|
+
? `SQLite refuses VACUUM while a transaction is open ("cannot VACUUM from within a transaction"), so the migration stops here. Vacuum from an operational job, outside any transaction.`
|
|
50
|
+
: `VACUUM copies the entire database into a temporary file and swaps it in: up to twice the database's size in free space, and the write lock held for the whole rewrite. It belongs in a maintenance job, not a migration — and if the runner wraps this file in a transaction it fails outright.`,
|
|
51
|
+
}),
|
|
52
|
+
);
|
|
53
|
+
}
|
|
54
|
+
return out;
|
|
55
|
+
},
|
|
56
|
+
};
|
|
57
|
+
|
|
58
|
+
/** SL015: REINDEX with no target. */
|
|
59
|
+
export const sl015: SlRule = {
|
|
60
|
+
meta: sl015Meta,
|
|
61
|
+
check(ctx) {
|
|
62
|
+
const out: Finding[] = [];
|
|
63
|
+
for (const stmt of ctx.migration.statements) {
|
|
64
|
+
if (stmt.node.type !== "reindex_stmt") continue;
|
|
65
|
+
if ((stmt.node as Record<string, any>).name) continue;
|
|
66
|
+
out.push(
|
|
67
|
+
finding(sl015, stmt, {
|
|
68
|
+
title: "REINDEX with no argument rebuilds every index in the database",
|
|
69
|
+
message: `All indexes of every attached database are rebuilt in one write transaction — the lock is held for the total. Name the index or table that needs it (REINDEX is only needed after a collation change).`,
|
|
70
|
+
}),
|
|
71
|
+
);
|
|
72
|
+
}
|
|
73
|
+
return out;
|
|
74
|
+
},
|
|
75
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
2
|
+
import type { SlRule } from "../rule";
|
|
3
|
+
import { sl001, sl002, sl003, sl004, sl005, sl008 } from "./add-column";
|
|
4
|
+
import { sl013, sl014, sl015 } from "./dml-and-maintenance";
|
|
5
|
+
import { sl016, sl017, sl018 } from "./indexes-and-types";
|
|
6
|
+
import { sl031, sl032, sl033, sl034, sl035 } from "./performance";
|
|
7
|
+
import { sl009, sl010, sl011, sl012, sl019 } from "./rebuild-pragmas";
|
|
8
|
+
import { sl020, sl021, sl022, sl023, sl024, sl025, sl026, sl027, sl028, sl029, sl030 } from "./schema-and-transactions";
|
|
9
|
+
import { sl006, sl007 } from "./table-shape";
|
|
10
|
+
|
|
11
|
+
export { SL_RULE_CORPUS_VERSION, SQLITE_RULE_IDS, sqliteMetas } from "../metas/index";
|
|
12
|
+
export type { SlRule, SlRuleContext } from "../rule";
|
|
13
|
+
|
|
14
|
+
/** The SL corpus, in id order. */
|
|
15
|
+
export const allSqliteRules: readonly SlRule[] = [
|
|
16
|
+
sl001, sl002, sl003, sl004, sl005, sl006, sl007, sl008, sl009, sl010, sl011, sl012, sl013, sl014, sl015, sl016, sl017, sl018, sl019,
|
|
17
|
+
sl020, sl021, sl022, sl023, sl024, sl025, sl026, sl027, sl028, sl029, sl030, sl031, sl032, sl033, sl034, sl035,
|
|
18
|
+
];
|